Файловый менеджер - Редактировать - /home/tuudkjt/globeasy/wp-includes/ID3/packages.tar
Назад
email-editor/composer.json 0000777 00000003345 15252010675 0011660 0 ustar 00 { "name": "woocommerce/email-editor", "description": "Email editor based on WordPress Gutenberg package.", "type": "wordpress-plugin", "license": "GPL-2.0-or-later", "prefer-stable": true, "minimum-stability": "dev", "version": "2.3.0", "autoload": { "classmap": [ "src/", "vendor-prefixed/" ] }, "autoload-dev": { "classmap": [ "tests/unit/" ] }, "require": { "php": ">=7.4" }, "require-dev": { "automattic/jetpack-changelogger": "3.3.0", "phpunit/phpunit": "^9.6", "woocommerce/woocommerce-sniffs": "1.0.0", "yoast/phpunit-polyfills": "^4.0" }, "config": { "platform": { "php": "7.4" }, "allow-plugins": { "dealerdirect/phpcodesniffer-composer-installer": true } }, "scripts": { "post-install-cmd": [ "composer dump-autoload -o" ], "post-update-cmd": [ "composer dump-autoload -o" ], "env:destroy": "wp-env destroy", "env:stop": "wp-env stop", "env:start": "wp-env start", "test:unit": "wp-env run tests-cli --env-cwd=wp-content/plugins/email-editor ./vendor/bin/phpunit", "test:integration": "wp-env run tests-cli --env-cwd=wp-content/plugins/email-editor ./vendor/bin/phpunit --configuration phpunit-integration.xml.dist", "phpcs": "phpcs -s -p", "phpcbf": "phpcbf -p" }, "extra": { "changelogger": { "formatter": { "filename": "../../../tools/changelogger/class-php-package-formatter.php" }, "types": { "fix": "Fixes an existing bug", "add": "Adds functionality", "update": "Update existing functionality", "dev": "Development related task", "tweak": "A minor adjustment to the codebase", "performance": "Address performance issues", "enhancement": "Improve existing functionality" }, "changelog": "changelog.md" } } } email-editor/vendor-prefixed/LICENSE 0000777 00000001276 15252010675 0013245 0 ustar 00 The folder contains auto generated content. This program incorporates work covered by the following copyright and permission notices: Pelago/Emogrifier pelago/emogrifier is Copyright (c) 2008-2018 Pelago https://github.com/MyIntervals/emogrifier pelago/emogrifier is released under the MIT License https://github.com/MyIntervals/emogrifier/blob/2cb1701ab3f23e979a7201d20615b33e31c365d3/LICENSE Sabberworm/PHP CSS Parser sabberworm/php-css-parser is Copyright (c) 2011 Raphael Schweikert, https://www.sabberworm.com/ sabberworm/php-css-parser is released under the MIT License https://github.com/MyIntervals/PHP-CSS-Parser/blob/92432abc08758613a166fc5af5fa89c15aca4af3/LICENSE email-editor/vendor-prefixed/setup.sh 0000777 00000001072 15252010675 0013726 0 ustar 00 #!/usr/bin/env bash set -e # Exit immediately on error cd "$(dirname "$0")" # Ensure we're in the correct directory # Ensure composer is installed if ! command -v composer >/dev/null 2>&1; then echo "❌ Composer is not installed. Please install Composer first." exit 1 fi # Skip if we are not in the monorepo if [ ! -f "../../../../plugins/woocommerce/vendor/bin/mozart" ]; then echo "❌ We are not in the monorepo. Skipping vendor-prefixed setup." exit 0 # Returning 0 incase we are in CI environment fi # Run composer install composer install --quiet email-editor/vendor-prefixed/classes/symfony/polyfill-php80/Resources/stubs/PhpToken.php 0000777 00000000633 15252010675 0025537 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000 && extension_loaded('tokenizer')) { class EmailEditorVendor_PhpToken extends Symfony\Polyfill\Php80\EmailEditorVendor_PhpToken { } } email-editor/vendor-prefixed/classes/symfony/polyfill-php80/Resources/stubs/Attribute.php 0000777 00000001424 15252010675 0025751 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ #[EmailEditorVendor_Attribute(Attribute::TARGET_CLASS)] final class EmailEditorVendor_Attribute { public const TARGET_CLASS = 1; public const TARGET_FUNCTION = 2; public const TARGET_METHOD = 4; public const TARGET_PROPERTY = 8; public const TARGET_CLASS_CONSTANT = 16; public const TARGET_PARAMETER = 32; public const TARGET_ALL = 63; public const IS_REPEATABLE = 64; /** @var int */ public $flags; public function __construct(int $flags = self::TARGET_ALL) { $this->flags = $flags; } } email-editor/vendor-prefixed/classes/symfony/polyfill-php80/Resources/stubs/ValueError.php 0000777 00000000520 15252010675 0026070 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000) { class EmailEditorVendor_ValueError extends Error { } } email-editor/vendor-prefixed/classes/symfony/polyfill-php80/Resources/stubs/Stringable.php 0000777 00000000636 15252010675 0026104 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000) { interface EmailEditorVendor_Stringable { /** * @return string */ public function __toString(); } } email-editor/vendor-prefixed/classes/symfony/polyfill-php80/Resources/stubs/UnhandledMatchError.php 0000777 00000000531 15252010675 0027675 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000) { class EmailEditorVendor_UnhandledMatchError extends Error { } } email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/LICENSE 0000777 00000002054 15252010675 0021153 0 ustar 00 Copyright (c) 2020-present Fabien Potencier Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/composer.json 0000777 00000001765 15252010675 0022700 0 ustar 00 { "name": "symfony/polyfill-php80", "type": "library", "description": "Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions", "keywords": ["polyfill", "shim", "compatibility", "portable"], "homepage": "https://symfony.com", "license": "MIT", "authors": [ { "name": "Ion Bazan", "email": "ion.bazan@gmail.com" }, { "name": "Nicolas Grekas", "email": "p@tchwork.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "require": { "php": ">=7.2" }, "autoload": { "psr-4": { "Symfony\\Polyfill\\Php80\\": "" }, "files": [ "bootstrap.php" ], "classmap": [ "Resources/stubs" ] }, "minimum-stability": "dev", "extra": { "thanks": { "name": "symfony/polyfill", "url": "https://github.com/symfony/polyfill" } } } email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/bootstrap.php 0000777 00000003045 15252010675 0022675 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ use Automattic\WooCommerce\EmailEditorVendor\Symfony\Polyfill\Php80 as p; if (\PHP_VERSION_ID >= 80000) { return; } if (!defined('FILTER_VALIDATE_BOOL') && defined('FILTER_VALIDATE_BOOLEAN')) { define('FILTER_VALIDATE_BOOL', \FILTER_VALIDATE_BOOLEAN); } if (!function_exists('fdiv')) { function fdiv(float $num1, float $num2): float { return p\Php80::fdiv($num1, $num2); } } if (!function_exists('preg_last_error_msg')) { function preg_last_error_msg(): string { return p\Php80::preg_last_error_msg(); } } if (!function_exists('str_contains')) { function str_contains(?string $haystack, ?string $needle): bool { return p\Php80::str_contains($haystack ?? '', $needle ?? ''); } } if (!function_exists('str_starts_with')) { function str_starts_with(?string $haystack, ?string $needle): bool { return p\Php80::str_starts_with($haystack ?? '', $needle ?? ''); } } if (!function_exists('str_ends_with')) { function str_ends_with(?string $haystack, ?string $needle): bool { return p\Php80::str_ends_with($haystack ?? '', $needle ?? ''); } } if (!function_exists('get_debug_type')) { function get_debug_type($value): string { return p\Php80::get_debug_type($value); } } if (!function_exists('get_resource_id')) { function get_resource_id($resource): int { return p\Php80::get_resource_id($resource); } } email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/PhpToken.php 0000777 00000004366 15252010675 0022417 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Polyfill\Php80; /** * @author Fedonyuk Anton <info@ensostudio.ru> * * @internal */ class PhpToken implements \Stringable { /** * @var int */ public $id; /** * @var string */ public $text; /** * @var -1|positive-int */ public $line; /** * @var int */ public $pos; /** * @param -1|positive-int $line */ public function __construct(int $id, string $text, int $line = -1, int $position = -1) { $this->id = $id; $this->text = $text; $this->line = $line; $this->pos = $position; } public function getTokenName(): ?string { if ('UNKNOWN' === $name = token_name($this->id)) { $name = \strlen($this->text) > 1 || \ord($this->text) < 32 ? null : $this->text; } return $name; } /** * @param int|string|array $kind */ public function is($kind): bool { foreach ((array) $kind as $value) { if (\in_array($value, [$this->id, $this->text], true)) { return true; } } return false; } public function isIgnorable(): bool { return \in_array($this->id, [\T_WHITESPACE, \T_COMMENT, \T_DOC_COMMENT, \T_OPEN_TAG], true); } public function __toString(): string { return (string) $this->text; } /** * @return list<static> */ public static function tokenize(string $code, int $flags = 0): array { $line = 1; $position = 0; $tokens = token_get_all($code, $flags); foreach ($tokens as $index => $token) { if (\is_string($token)) { $id = \ord($token); $text = $token; } else { [$id, $text, $line] = $token; } $tokens[$index] = new static($id, $text, $line, $position); $position += \strlen($text); } return $tokens; } } email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/Php80.php 0000777 00000007042 15252010675 0021560 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Polyfill\Php80; /** * @author Ion Bazan <ion.bazan@gmail.com> * @author Nico Oelgart <nicoswd@gmail.com> * @author Nicolas Grekas <p@tchwork.com> * * @internal */ final class Php80 { public static function fdiv(float $dividend, float $divisor): float { return @($dividend / $divisor); } public static function get_debug_type($value): string { switch (true) { case null === $value: return 'null'; case \is_bool($value): return 'bool'; case \is_string($value): return 'string'; case \is_array($value): return 'array'; case \is_int($value): return 'int'; case \is_float($value): return 'float'; case \is_object($value): break; case $value instanceof \__PHP_Incomplete_Class: return '__PHP_Incomplete_Class'; default: if (null === $type = @get_resource_type($value)) { return 'unknown'; } if ('Unknown' === $type) { $type = 'closed'; } return "resource ($type)"; } $class = \get_class($value); if (false === strpos($class, '@')) { return $class; } return (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous'; } public static function get_resource_id($res): int { if (!\is_resource($res) && null === @get_resource_type($res)) { throw new \TypeError(sprintf('Argument 1 passed to get_resource_id() must be of the type resource, %s given', get_debug_type($res))); } return (int) $res; } public static function preg_last_error_msg(): string { switch (preg_last_error()) { case \PREG_INTERNAL_ERROR: return 'Internal error'; case \PREG_BAD_UTF8_ERROR: return 'Malformed UTF-8 characters, possibly incorrectly encoded'; case \PREG_BAD_UTF8_OFFSET_ERROR: return 'The offset did not correspond to the beginning of a valid UTF-8 code point'; case \PREG_BACKTRACK_LIMIT_ERROR: return 'Backtrack limit exhausted'; case \PREG_RECURSION_LIMIT_ERROR: return 'Recursion limit exhausted'; case \PREG_JIT_STACKLIMIT_ERROR: return 'JIT stack limit exhausted'; case \PREG_NO_ERROR: return 'No error'; default: return 'Unknown error'; } } public static function str_contains(string $haystack, string $needle): bool { return '' === $needle || false !== strpos($haystack, $needle); } public static function str_starts_with(string $haystack, string $needle): bool { return 0 === strncmp($haystack, $needle, \strlen($needle)); } public static function str_ends_with(string $haystack, string $needle): bool { if ('' === $needle || $needle === $haystack) { return true; } if ('' === $haystack) { return false; } $needleLength = \strlen($needle); return $needleLength <= \strlen($haystack) && 0 === substr_compare($haystack, $needle, -$needleLength); } } email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/Resources/stubs/PhpToken.php 0000777 00000000640 15252010675 0025520 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000 && extension_loaded('tokenizer')) { class PhpToken extends Automattic\WooCommerce\EmailEditorVendor\Symfony\Polyfill\Php80\PhpToken { } } email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/Resources/stubs/ValueError.php 0000777 00000000476 15252010675 0026065 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000) { class ValueError extends Error { } } email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/Resources/stubs/UnhandledMatchError.php0000777 00000000507 15252010675 0027663 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000) { class UnhandledMatchError extends Error { } } email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/Resources/stubs/Stringable.php 0000777 00000000614 15252010675 0026063 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000) { interface Stringable { /** * @return string */ public function __toString(); } } email-editor/vendor-prefixed/packages/Symfony/Polyfill/Php80/Resources/stubs/Attribute.php 0000777 00000001360 15252010675 0025733 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ #[Attribute(Attribute::TARGET_CLASS)] final class Attribute { public const TARGET_CLASS = 1; public const TARGET_FUNCTION = 2; public const TARGET_METHOD = 4; public const TARGET_PROPERTY = 8; public const TARGET_CLASS_CONSTANT = 16; public const TARGET_PARAMETER = 32; public const TARGET_ALL = 63; public const IS_REPEATABLE = 64; /** @var int */ public $flags; public function __construct(int $flags = self::TARGET_ALL) { $this->flags = $flags; } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/TokenStream.php 0000777 00000006663 15252010675 0026063 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\InternalErrorException; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\SyntaxErrorException; /** * CSS selector token stream. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class TokenStream { /** * @var Token[] */ private $tokens = []; /** * @var Token[] */ private $used = []; /** * @var int */ private $cursor = 0; /** * @var Token|null */ private $peeked; /** * @var bool */ private $peeking = false; /** * Pushes a token. * * @return $this */ public function push(Token $token): self { $this->tokens[] = $token; return $this; } /** * Freezes stream. * * @return $this */ public function freeze(): self { return $this; } /** * Returns next token. * * @throws InternalErrorException If there is no more token */ public function getNext(): Token { if ($this->peeking) { $this->peeking = false; $this->used[] = $this->peeked; return $this->peeked; } if (!isset($this->tokens[$this->cursor])) { throw new InternalErrorException('Unexpected token stream end.'); } return $this->tokens[$this->cursor++]; } /** * Returns peeked token. */ public function getPeek(): Token { if (!$this->peeking) { $this->peeked = $this->getNext(); $this->peeking = true; } return $this->peeked; } /** * Returns used tokens. * * @return Token[] */ public function getUsed(): array { return $this->used; } /** * Returns next identifier token. * * @throws SyntaxErrorException If next token is not an identifier */ public function getNextIdentifier(): string { $next = $this->getNext(); if (!$next->isIdentifier()) { throw SyntaxErrorException::unexpectedToken('identifier', $next); } return $next->getValue(); } /** * Returns next identifier or null if star delimiter token is found. * * @throws SyntaxErrorException If next token is not an identifier or a star delimiter */ public function getNextIdentifierOrStar(): ?string { $next = $this->getNext(); if ($next->isIdentifier()) { return $next->getValue(); } if ($next->isDelimiter(['*'])) { return null; } throw SyntaxErrorException::unexpectedToken('identifier or "*"', $next); } /** * Skips next whitespace if any. */ public function skipWhitespace() { $peek = $this->getPeek(); if ($peek->isWhitespace()) { $this->getNext(); } } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Parser.php 0000777 00000027007 15252010675 0025056 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\SyntaxErrorException; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer\Tokenizer; /** * CSS selector parser. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Parser implements ParserInterface { private $tokenizer; public function __construct(?Tokenizer $tokenizer = null) { $this->tokenizer = $tokenizer ?? new Tokenizer(); } /** * {@inheritdoc} */ public function parse(string $source): array { $reader = new Reader($source); $stream = $this->tokenizer->tokenize($reader); return $this->parseSelectorList($stream); } /** * Parses the arguments for ":nth-child()" and friends. * * @param Token[] $tokens * * @throws SyntaxErrorException */ public static function parseSeries(array $tokens): array { foreach ($tokens as $token) { if ($token->isString()) { throw SyntaxErrorException::stringAsFunctionArgument(); } } $joined = trim(implode('', array_map(function (Token $token) { return $token->getValue(); }, $tokens))); $int = function ($string) { if (!is_numeric($string)) { throw SyntaxErrorException::stringAsFunctionArgument(); } return (int) $string; }; switch (true) { case 'odd' === $joined: return [2, 1]; case 'even' === $joined: return [2, 0]; case 'n' === $joined: return [1, 0]; case !str_contains($joined, 'n'): return [0, $int($joined)]; } $split = explode('n', $joined); $first = $split[0] ?? null; return [ $first ? ('-' === $first || '+' === $first ? $int($first.'1') : $int($first)) : 1, isset($split[1]) && $split[1] ? $int($split[1]) : 0, ]; } private function parseSelectorList(TokenStream $stream): array { $stream->skipWhitespace(); $selectors = []; while (true) { $selectors[] = $this->parserSelectorNode($stream); if ($stream->getPeek()->isDelimiter([','])) { $stream->getNext(); $stream->skipWhitespace(); } else { break; } } return $selectors; } private function parserSelectorNode(TokenStream $stream): Node\SelectorNode { [$result, $pseudoElement] = $this->parseSimpleSelector($stream); while (true) { $stream->skipWhitespace(); $peek = $stream->getPeek(); if ($peek->isFileEnd() || $peek->isDelimiter([','])) { break; } if (null !== $pseudoElement) { throw SyntaxErrorException::pseudoElementFound($pseudoElement, 'not at the end of a selector'); } if ($peek->isDelimiter(['+', '>', '~'])) { $combinator = $stream->getNext()->getValue(); $stream->skipWhitespace(); } else { $combinator = ' '; } [$nextSelector, $pseudoElement] = $this->parseSimpleSelector($stream); $result = new Node\CombinedSelectorNode($result, $combinator, $nextSelector); } return new Node\SelectorNode($result, $pseudoElement); } /** * Parses next simple node (hash, class, pseudo, negation). * * @throws SyntaxErrorException */ private function parseSimpleSelector(TokenStream $stream, bool $insideNegation = false): array { $stream->skipWhitespace(); $selectorStart = \count($stream->getUsed()); $result = $this->parseElementNode($stream); $pseudoElement = null; while (true) { $peek = $stream->getPeek(); if ($peek->isWhitespace() || $peek->isFileEnd() || $peek->isDelimiter([',', '+', '>', '~']) || ($insideNegation && $peek->isDelimiter([')'])) ) { break; } if (null !== $pseudoElement) { throw SyntaxErrorException::pseudoElementFound($pseudoElement, 'not at the end of a selector'); } if ($peek->isHash()) { $result = new Node\HashNode($result, $stream->getNext()->getValue()); } elseif ($peek->isDelimiter(['.'])) { $stream->getNext(); $result = new Node\ClassNode($result, $stream->getNextIdentifier()); } elseif ($peek->isDelimiter(['['])) { $stream->getNext(); $result = $this->parseAttributeNode($result, $stream); } elseif ($peek->isDelimiter([':'])) { $stream->getNext(); if ($stream->getPeek()->isDelimiter([':'])) { $stream->getNext(); $pseudoElement = $stream->getNextIdentifier(); continue; } $identifier = $stream->getNextIdentifier(); if (\in_array(strtolower($identifier), ['first-line', 'first-letter', 'before', 'after'])) { // Special case: CSS 2.1 pseudo-elements can have a single ':'. // Any new pseudo-element must have two. $pseudoElement = $identifier; continue; } if (!$stream->getPeek()->isDelimiter(['('])) { $result = new Node\PseudoNode($result, $identifier); continue; } $stream->getNext(); $stream->skipWhitespace(); if ('not' === strtolower($identifier)) { if ($insideNegation) { throw SyntaxErrorException::nestedNot(); } [$argument, $argumentPseudoElement] = $this->parseSimpleSelector($stream, true); $next = $stream->getNext(); if (null !== $argumentPseudoElement) { throw SyntaxErrorException::pseudoElementFound($argumentPseudoElement, 'inside ::not()'); } if (!$next->isDelimiter([')'])) { throw SyntaxErrorException::unexpectedToken('")"', $next); } $result = new Node\NegationNode($result, $argument); } else { $arguments = []; $next = null; while (true) { $stream->skipWhitespace(); $next = $stream->getNext(); if ($next->isIdentifier() || $next->isString() || $next->isNumber() || $next->isDelimiter(['+', '-']) ) { $arguments[] = $next; } elseif ($next->isDelimiter([')'])) { break; } else { throw SyntaxErrorException::unexpectedToken('an argument', $next); } } if (empty($arguments)) { throw SyntaxErrorException::unexpectedToken('at least one argument', $next); } $result = new Node\FunctionNode($result, $identifier, $arguments); } } else { throw SyntaxErrorException::unexpectedToken('selector', $peek); } } if (\count($stream->getUsed()) === $selectorStart) { throw SyntaxErrorException::unexpectedToken('selector', $stream->getPeek()); } return [$result, $pseudoElement]; } private function parseElementNode(TokenStream $stream): Node\ElementNode { $peek = $stream->getPeek(); if ($peek->isIdentifier() || $peek->isDelimiter(['*'])) { if ($peek->isIdentifier()) { $namespace = $stream->getNext()->getValue(); } else { $stream->getNext(); $namespace = null; } if ($stream->getPeek()->isDelimiter(['|'])) { $stream->getNext(); $element = $stream->getNextIdentifierOrStar(); } else { $element = $namespace; $namespace = null; } } else { $element = $namespace = null; } return new Node\ElementNode($namespace, $element); } private function parseAttributeNode(Node\NodeInterface $selector, TokenStream $stream): Node\AttributeNode { $stream->skipWhitespace(); $attribute = $stream->getNextIdentifierOrStar(); if (null === $attribute && !$stream->getPeek()->isDelimiter(['|'])) { throw SyntaxErrorException::unexpectedToken('"|"', $stream->getPeek()); } if ($stream->getPeek()->isDelimiter(['|'])) { $stream->getNext(); if ($stream->getPeek()->isDelimiter(['='])) { $namespace = null; $stream->getNext(); $operator = '|='; } else { $namespace = $attribute; $attribute = $stream->getNextIdentifier(); $operator = null; } } else { $namespace = $operator = null; } if (null === $operator) { $stream->skipWhitespace(); $next = $stream->getNext(); if ($next->isDelimiter([']'])) { return new Node\AttributeNode($selector, $namespace, $attribute, 'exists', null); } elseif ($next->isDelimiter(['='])) { $operator = '='; } elseif ($next->isDelimiter(['^', '$', '*', '~', '|', '!']) && $stream->getPeek()->isDelimiter(['=']) ) { $operator = $next->getValue().'='; $stream->getNext(); } else { throw SyntaxErrorException::unexpectedToken('operator', $next); } } $stream->skipWhitespace(); $value = $stream->getNext(); if ($value->isNumber()) { // if the value is a number, it's casted into a string $value = new Token(Token::TYPE_STRING, (string) $value->getValue(), $value->getPosition()); } if (!($value->isIdentifier() || $value->isString())) { throw SyntaxErrorException::unexpectedToken('string or identifier', $value); } $stream->skipWhitespace(); $next = $stream->getNext(); if (!$next->isDelimiter([']'])) { throw SyntaxErrorException::unexpectedToken('"]"', $next); } return new Node\AttributeNode($selector, $namespace, $attribute, $operator, $value->getValue()); } } vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Tokenizer/TokenizerPatterns.php 0000777 00000005403 15252010675 0031204 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer; /** * CSS selector tokenizer patterns builder. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class TokenizerPatterns { private $unicodeEscapePattern; private $simpleEscapePattern; private $newLineEscapePattern; private $escapePattern; private $stringEscapePattern; private $nonAsciiPattern; private $nmCharPattern; private $nmStartPattern; private $identifierPattern; private $hashPattern; private $numberPattern; private $quotedStringPattern; public function __construct() { $this->unicodeEscapePattern = '\\\\([0-9a-f]{1,6})(?:\r\n|[ \n\r\t\f])?'; $this->simpleEscapePattern = '\\\\(.)'; $this->newLineEscapePattern = '\\\\(?:\n|\r\n|\r|\f)'; $this->escapePattern = $this->unicodeEscapePattern.'|\\\\[^\n\r\f0-9a-f]'; $this->stringEscapePattern = $this->newLineEscapePattern.'|'.$this->escapePattern; $this->nonAsciiPattern = '[^\x00-\x7F]'; $this->nmCharPattern = '[_a-z0-9-]|'.$this->escapePattern.'|'.$this->nonAsciiPattern; $this->nmStartPattern = '[_a-z]|'.$this->escapePattern.'|'.$this->nonAsciiPattern; $this->identifierPattern = '-?(?:'.$this->nmStartPattern.')(?:'.$this->nmCharPattern.')*'; $this->hashPattern = '#((?:'.$this->nmCharPattern.')+)'; $this->numberPattern = '[+-]?(?:[0-9]*\.[0-9]+|[0-9]+)'; $this->quotedStringPattern = '([^\n\r\f\\\\%s]|'.$this->stringEscapePattern.')*'; } public function getNewLineEscapePattern(): string { return '~'.$this->newLineEscapePattern.'~'; } public function getSimpleEscapePattern(): string { return '~'.$this->simpleEscapePattern.'~'; } public function getUnicodeEscapePattern(): string { return '~'.$this->unicodeEscapePattern.'~i'; } public function getIdentifierPattern(): string { return '~^'.$this->identifierPattern.'~i'; } public function getHashPattern(): string { return '~^'.$this->hashPattern.'~i'; } public function getNumberPattern(): string { return '~^'.$this->numberPattern.'~'; } public function getQuotedStringPattern(string $quote): string { return '~^'.sprintf($this->quotedStringPattern, $quote).'~i'; } } vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Tokenizer/TokenizerEscaping.php 0000777 00000003431 15252010675 0031134 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer; /** * CSS selector tokenizer escaping applier. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class TokenizerEscaping { private $patterns; public function __construct(TokenizerPatterns $patterns) { $this->patterns = $patterns; } public function escapeUnicode(string $value): string { $value = $this->replaceUnicodeSequences($value); return preg_replace($this->patterns->getSimpleEscapePattern(), '$1', $value); } public function escapeUnicodeAndNewLine(string $value): string { $value = preg_replace($this->patterns->getNewLineEscapePattern(), '', $value); return $this->escapeUnicode($value); } private function replaceUnicodeSequences(string $value): string { return preg_replace_callback($this->patterns->getUnicodeEscapePattern(), function ($match) { $c = hexdec($match[1]); if (0x80 > $c %= 0x200000) { return \chr($c); } if (0x800 > $c) { return \chr(0xC0 | $c >> 6).\chr(0x80 | $c & 0x3F); } if (0x10000 > $c) { return \chr(0xE0 | $c >> 12).\chr(0x80 | $c >> 6 & 0x3F).\chr(0x80 | $c & 0x3F); } return ''; }, $value); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Tokenizer/Tokenizer.php 0000777 00000004277 15252010675 0027552 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector tokenizer. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Tokenizer { /** * @var Handler\HandlerInterface[] */ private $handlers; public function __construct() { $patterns = new TokenizerPatterns(); $escaping = new TokenizerEscaping($patterns); $this->handlers = [ new Handler\WhitespaceHandler(), new Handler\IdentifierHandler($patterns, $escaping), new Handler\HashHandler($patterns, $escaping), new Handler\StringHandler($patterns, $escaping), new Handler\NumberHandler($patterns), new Handler\CommentHandler(), ]; } /** * Tokenize selector source code. */ public function tokenize(Reader $reader): TokenStream { $stream = new TokenStream(); while (!$reader->isEOF()) { foreach ($this->handlers as $handler) { if ($handler->handle($reader, $stream)) { continue 2; } } $stream->push(new Token(Token::TYPE_DELIMITER, $reader->getSubstring(1), $reader->getPosition())); $reader->moveForward(1); } return $stream ->push(new Token(Token::TYPE_FILE_END, null, $reader->getPosition())) ->freeze(); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/ParserInterface.php 0000777 00000001573 15252010675 0026677 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\SelectorNode; /** * CSS selector parser interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface ParserInterface { /** * Parses given selector source into an array of tokens. * * @return SelectorNode[] */ public function parse(string $source): array; } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Handler/HashHandler.php 0000777 00000003472 15252010675 0027360 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerEscaping; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerPatterns; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class HashHandler implements HandlerInterface { private $patterns; private $escaping; public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $escaping) { $this->patterns = $patterns; $this->escaping = $escaping; } /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $match = $reader->findPattern($this->patterns->getHashPattern()); if (!$match) { return false; } $value = $this->escaping->escapeUnicode($match[1]); $stream->push(new Token(Token::TYPE_HASH, $value, $reader->getPosition())); $reader->moveForward(\strlen($match[0])); return true; } } vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Handler/CommentHandler.php 0000777 00000002355 15252010675 0030017 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class CommentHandler implements HandlerInterface { /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { if ('/*' !== $reader->getSubstring(2)) { return false; } $offset = $reader->getOffset('*/'); if (false === $offset) { $reader->moveToEnd(); } else { $reader->moveForward($offset + 2); } return true; } } vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Handler/IdentifierHandler.php 0000777 00000003514 15252010675 0030475 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerEscaping; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerPatterns; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class IdentifierHandler implements HandlerInterface { private $patterns; private $escaping; public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $escaping) { $this->patterns = $patterns; $this->escaping = $escaping; } /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $match = $reader->findPattern($this->patterns->getIdentifierPattern()); if (!$match) { return false; } $value = $this->escaping->escapeUnicode($match[0]); $stream->push(new Token(Token::TYPE_IDENTIFIER, $value, $reader->getPosition())); $reader->moveForward(\strlen($match[0])); return true; } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Handler/NumberHandler.php0000777 00000003077 15252010675 0027726 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerPatterns; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class NumberHandler implements HandlerInterface { private $patterns; public function __construct(TokenizerPatterns $patterns) { $this->patterns = $patterns; } /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $match = $reader->findPattern($this->patterns->getNumberPattern()); if (!$match) { return false; } $stream->push(new Token(Token::TYPE_NUMBER, $match[0], $reader->getPosition())); $reader->moveForward(\strlen($match[0])); return true; } } vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Handler/WhitespaceHandler.php 0000777 00000002513 15252010675 0030505 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector whitespace handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class WhitespaceHandler implements HandlerInterface { /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $match = $reader->findPattern('~^[ \t\r\n\f]+~'); if (false === $match) { return false; } $stream->push(new Token(Token::TYPE_WHITESPACE, $match[0], $reader->getPosition())); $reader->moveForward(\strlen($match[0])); return true; } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Handler/StringHandler.php0000777 00000005317 15252010675 0027743 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\InternalErrorException; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\SyntaxErrorException; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerEscaping; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerPatterns; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class StringHandler implements HandlerInterface { private $patterns; private $escaping; public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $escaping) { $this->patterns = $patterns; $this->escaping = $escaping; } /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $quote = $reader->getSubstring(1); if (!\in_array($quote, ["'", '"'])) { return false; } $reader->moveForward(1); $match = $reader->findPattern($this->patterns->getQuotedStringPattern($quote)); if (!$match) { throw new InternalErrorException(sprintf('Should have found at least an empty match at %d.', $reader->getPosition())); } // check unclosed strings if (\strlen($match[0]) === $reader->getRemainingLength()) { throw SyntaxErrorException::unclosedString($reader->getPosition() - 1); } // check quotes pairs validity if ($quote !== $reader->getSubstring(1, \strlen($match[0]))) { throw SyntaxErrorException::unclosedString($reader->getPosition() - 1); } $string = $this->escaping->escapeUnicodeAndNewLine($match[0]); $stream->push(new Token(Token::TYPE_STRING, $string, $reader->getPosition())); $reader->moveForward(\strlen($match[0]) + 1); return true; } } vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Handler/HandlerInterface.php 0000777 00000001603 15252010675 0030310 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector handler interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface HandlerInterface { public function handle(Reader $reader, TokenStream $stream): bool; } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Reader.php 0000777 00000003603 15252010675 0025020 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser; /** * CSS selector reader. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Reader { private $source; private $length; private $position = 0; public function __construct(string $source) { $this->source = $source; $this->length = \strlen($source); } public function isEOF(): bool { return $this->position >= $this->length; } public function getPosition(): int { return $this->position; } public function getRemainingLength(): int { return $this->length - $this->position; } public function getSubstring(int $length, int $offset = 0): string { return substr($this->source, $this->position + $offset, $length); } public function getOffset(string $string) { $position = strpos($this->source, $string, $this->position); return false === $position ? false : $position - $this->position; } /** * @return array|false */ public function findPattern(string $pattern) { $source = substr($this->source, $this->position); if (preg_match($pattern, $source, $matches)) { return $matches; } return false; } public function moveForward(int $length) { $this->position += $length; } public function moveToEnd() { $this->position = $this->length; } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Shortcut/ClassParser.php 0000777 00000003411 15252010675 0027650 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Shortcut; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\ClassNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\ElementNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * CSS selector class parser shortcut. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class ClassParser implements ParserInterface { /** * {@inheritdoc} */ public function parse(string $source): array { // Matches an optional namespace, optional element, and required class // $source = 'test|input.ab6bd_field'; // $matches = array (size=4) // 0 => string 'test|input.ab6bd_field' (length=22) // 1 => string 'test' (length=4) // 2 => string 'input' (length=5) // 3 => string 'ab6bd_field' (length=11) if (preg_match('/^(?:([a-z]++)\|)?+([\w-]++|\*)?+\.([\w-]++)$/i', trim($source), $matches)) { return [ new SelectorNode(new ClassNode(new ElementNode($matches[1] ?: null, $matches[2] ?: null), $matches[3])), ]; } return []; } } vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Shortcut/ElementParser.php 0000777 00000003020 15252010675 0030111 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Shortcut; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\ElementNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * CSS selector element parser shortcut. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class ElementParser implements ParserInterface { /** * {@inheritdoc} */ public function parse(string $source): array { // Matches an optional namespace, required element or `*` // $source = 'testns|testel'; // $matches = array (size=3) // 0 => string 'testns|testel' (length=13) // 1 => string 'testns' (length=6) // 2 => string 'testel' (length=6) if (preg_match('/^(?:([a-z]++)\|)?([\w-]++|\*)$/i', trim($source), $matches)) { return [new SelectorNode(new ElementNode($matches[1] ?: null, $matches[2]))]; } return []; } } vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Shortcut/EmptyStringParser.php 0000777 00000002562 15252010675 0031017 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Shortcut; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\ElementNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * CSS selector class parser shortcut. * * This shortcut ensure compatibility with previous version. * - The parser fails to parse an empty string. * - In the previous version, an empty string matches each tags. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class EmptyStringParser implements ParserInterface { /** * {@inheritdoc} */ public function parse(string $source): array { // Matches an empty string if ('' == $source) { return [new SelectorNode(new ElementNode(null, '*'))]; } return []; } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Shortcut/HashParser.php 0000777 00000003401 15252010675 0027465 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Shortcut; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\ElementNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\HashNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * CSS selector hash parser shortcut. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class HashParser implements ParserInterface { /** * {@inheritdoc} */ public function parse(string $source): array { // Matches an optional namespace, optional element, and required id // $source = 'test|input#ab6bd_field'; // $matches = array (size=4) // 0 => string 'test|input#ab6bd_field' (length=22) // 1 => string 'test' (length=4) // 2 => string 'input' (length=5) // 3 => string 'ab6bd_field' (length=11) if (preg_match('/^(?:([a-z]++)\|)?+([\w-]++|\*)?+#([\w-]++)$/i', trim($source), $matches)) { return [ new SelectorNode(new HashNode(new ElementNode($matches[1] ?: null, $matches[2] ?: null), $matches[3])), ]; } return []; } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Parser/Token.php 0000777 00000004765 15252010675 0024710 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser; /** * CSS selector token. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Token { public const TYPE_FILE_END = 'eof'; public const TYPE_DELIMITER = 'delimiter'; public const TYPE_WHITESPACE = 'whitespace'; public const TYPE_IDENTIFIER = 'identifier'; public const TYPE_HASH = 'hash'; public const TYPE_NUMBER = 'number'; public const TYPE_STRING = 'string'; private $type; private $value; private $position; public function __construct(?string $type, ?string $value, ?int $position) { $this->type = $type; $this->value = $value; $this->position = $position; } public function getType(): ?int { return $this->type; } public function getValue(): ?string { return $this->value; } public function getPosition(): ?int { return $this->position; } public function isFileEnd(): bool { return self::TYPE_FILE_END === $this->type; } public function isDelimiter(array $values = []): bool { if (self::TYPE_DELIMITER !== $this->type) { return false; } if (empty($values)) { return true; } return \in_array($this->value, $values); } public function isWhitespace(): bool { return self::TYPE_WHITESPACE === $this->type; } public function isIdentifier(): bool { return self::TYPE_IDENTIFIER === $this->type; } public function isHash(): bool { return self::TYPE_HASH === $this->type; } public function isNumber(): bool { return self::TYPE_NUMBER === $this->type; } public function isString(): bool { return self::TYPE_STRING === $this->type; } public function __toString(): string { if ($this->value) { return sprintf('<%s "%s" at %s>', $this->type, $this->value, $this->position); } return sprintf('<%s at %s>', $this->type, $this->position); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/XPathExpr.php 0000777 00000004741 15252010675 0025275 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath; /** * XPath expression translator interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class XPathExpr { private $path; private $element; private $condition; public function __construct(string $path = '', string $element = '*', string $condition = '', bool $starPrefix = false) { $this->path = $path; $this->element = $element; $this->condition = $condition; if ($starPrefix) { $this->addStarPrefix(); } } public function getElement(): string { return $this->element; } /** * @return $this */ public function addCondition(string $condition): self { $this->condition = $this->condition ? sprintf('(%s) and (%s)', $this->condition, $condition) : $condition; return $this; } public function getCondition(): string { return $this->condition; } /** * @return $this */ public function addNameTest(): self { if ('*' !== $this->element) { $this->addCondition('name() = '.Translator::getXpathLiteral($this->element)); $this->element = '*'; } return $this; } /** * @return $this */ public function addStarPrefix(): self { $this->path .= '*/'; return $this; } /** * Joins another XPathExpr with a combiner. * * @return $this */ public function join(string $combiner, self $expr): self { $path = $this->__toString().$combiner; if ('*/' !== $expr->path) { $path .= $expr->path; } $this->path = $path; $this->element = $expr->element; $this->condition = $expr->condition; return $this; } public function __toString(): string { $path = $this->path.$this->element; $condition = null === $this->condition || '' === $this->condition ? '' : '['.$this->condition.']'; return $path.$condition; } } packages/Symfony/Component/CssSelector/XPath/Extension/AttributeMatchingExtension.php 0000777 00000007551 15252010675 0032624 0 ustar 00 email-editor/vendor-prefixed <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Translator; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator attribute extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class AttributeMatchingExtension extends AbstractExtension { /** * {@inheritdoc} */ public function getAttributeMatchingTranslators(): array { return [ 'exists' => [$this, 'translateExists'], '=' => [$this, 'translateEquals'], '~=' => [$this, 'translateIncludes'], '|=' => [$this, 'translateDashMatch'], '^=' => [$this, 'translatePrefixMatch'], '$=' => [$this, 'translateSuffixMatch'], '*=' => [$this, 'translateSubstringMatch'], '!=' => [$this, 'translateDifferent'], ]; } public function translateExists(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($attribute); } public function translateEquals(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition(sprintf('%s = %s', $attribute, Translator::getXpathLiteral($value))); } public function translateIncludes(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($value ? sprintf( '%1$s and contains(concat(\' \', normalize-space(%1$s), \' \'), %2$s)', $attribute, Translator::getXpathLiteral(' '.$value.' ') ) : '0'); } public function translateDashMatch(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition(sprintf( '%1$s and (%1$s = %2$s or starts-with(%1$s, %3$s))', $attribute, Translator::getXpathLiteral($value), Translator::getXpathLiteral($value.'-') )); } public function translatePrefixMatch(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($value ? sprintf( '%1$s and starts-with(%1$s, %2$s)', $attribute, Translator::getXpathLiteral($value) ) : '0'); } public function translateSuffixMatch(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($value ? sprintf( '%1$s and substring(%1$s, string-length(%1$s)-%2$s) = %3$s', $attribute, \strlen($value) - 1, Translator::getXpathLiteral($value) ) : '0'); } public function translateSubstringMatch(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($value ? sprintf( '%1$s and contains(%1$s, %2$s)', $attribute, Translator::getXpathLiteral($value) ) : '0'); } public function translateDifferent(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition(sprintf( $value ? 'not(%1$s) or %1$s != %2$s' : '%s != %s', $attribute, Translator::getXpathLiteral($value) )); } /** * {@inheritdoc} */ public function getName(): string { return 'attribute-matching'; } } vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/Extension/CombinationExtension.php 0000777 00000003747 15252010675 0031453 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator combination extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class CombinationExtension extends AbstractExtension { /** * {@inheritdoc} */ public function getCombinationTranslators(): array { return [ ' ' => [$this, 'translateDescendant'], '>' => [$this, 'translateChild'], '+' => [$this, 'translateDirectAdjacent'], '~' => [$this, 'translateIndirectAdjacent'], ]; } public function translateDescendant(XPathExpr $xpath, XPathExpr $combinedXpath): XPathExpr { return $xpath->join('/descendant-or-self::*/', $combinedXpath); } public function translateChild(XPathExpr $xpath, XPathExpr $combinedXpath): XPathExpr { return $xpath->join('/', $combinedXpath); } public function translateDirectAdjacent(XPathExpr $xpath, XPathExpr $combinedXpath): XPathExpr { return $xpath ->join('/following-sibling::', $combinedXpath) ->addNameTest() ->addCondition('position() = 1'); } public function translateIndirectAdjacent(XPathExpr $xpath, XPathExpr $combinedXpath): XPathExpr { return $xpath->join('/following-sibling::', $combinedXpath); } /** * {@inheritdoc} */ public function getName(): string { return 'combination'; } } vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/Extension/PseudoClassExtension.php 0000777 00000006720 15252010675 0031430 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\ExpressionErrorException; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator pseudo-class extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class PseudoClassExtension extends AbstractExtension { /** * {@inheritdoc} */ public function getPseudoClassTranslators(): array { return [ 'root' => [$this, 'translateRoot'], 'first-child' => [$this, 'translateFirstChild'], 'last-child' => [$this, 'translateLastChild'], 'first-of-type' => [$this, 'translateFirstOfType'], 'last-of-type' => [$this, 'translateLastOfType'], 'only-child' => [$this, 'translateOnlyChild'], 'only-of-type' => [$this, 'translateOnlyOfType'], 'empty' => [$this, 'translateEmpty'], ]; } public function translateRoot(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('not(parent::*)'); } public function translateFirstChild(XPathExpr $xpath): XPathExpr { return $xpath ->addStarPrefix() ->addNameTest() ->addCondition('position() = 1'); } public function translateLastChild(XPathExpr $xpath): XPathExpr { return $xpath ->addStarPrefix() ->addNameTest() ->addCondition('position() = last()'); } /** * @throws ExpressionErrorException */ public function translateFirstOfType(XPathExpr $xpath): XPathExpr { if ('*' === $xpath->getElement()) { throw new ExpressionErrorException('"*:first-of-type" is not implemented.'); } return $xpath ->addStarPrefix() ->addCondition('position() = 1'); } /** * @throws ExpressionErrorException */ public function translateLastOfType(XPathExpr $xpath): XPathExpr { if ('*' === $xpath->getElement()) { throw new ExpressionErrorException('"*:last-of-type" is not implemented.'); } return $xpath ->addStarPrefix() ->addCondition('position() = last()'); } public function translateOnlyChild(XPathExpr $xpath): XPathExpr { return $xpath ->addStarPrefix() ->addNameTest() ->addCondition('last() = 1'); } public function translateOnlyOfType(XPathExpr $xpath): XPathExpr { $element = $xpath->getElement(); return $xpath->addCondition(sprintf('count(preceding-sibling::%s)=0 and count(following-sibling::%s)=0', $element, $element)); } public function translateEmpty(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('not(*) and not(string-length())'); } /** * {@inheritdoc} */ public function getName(): string { return 'pseudo-class'; } } vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/Extension/ExtensionInterface.php 0000777 00000003056 15252010675 0031102 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Extension; /** * XPath expression translator extension interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface ExtensionInterface { /** * Returns node translators. * * These callables will receive the node as first argument and the translator as second argument. * * @return callable[] */ public function getNodeTranslators(): array; /** * Returns combination translators. * * @return callable[] */ public function getCombinationTranslators(): array; /** * Returns function translators. * * @return callable[] */ public function getFunctionTranslators(): array; /** * Returns pseudo-class translators. * * @return callable[] */ public function getPseudoClassTranslators(): array; /** * Returns attribute operation translators. * * @return callable[] */ public function getAttributeMatchingTranslators(): array; /** * Returns extension name. */ public function getName(): string; } vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/Extension/HtmlExtension.php 0000777 00000013743 15252010675 0030112 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\ExpressionErrorException; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\FunctionNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Translator; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator HTML extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class HtmlExtension extends AbstractExtension { public function __construct(Translator $translator) { $translator ->getExtension('node') ->setFlag(NodeExtension::ELEMENT_NAME_IN_LOWER_CASE, true) ->setFlag(NodeExtension::ATTRIBUTE_NAME_IN_LOWER_CASE, true); } /** * {@inheritdoc} */ public function getPseudoClassTranslators(): array { return [ 'checked' => [$this, 'translateChecked'], 'link' => [$this, 'translateLink'], 'disabled' => [$this, 'translateDisabled'], 'enabled' => [$this, 'translateEnabled'], 'selected' => [$this, 'translateSelected'], 'invalid' => [$this, 'translateInvalid'], 'hover' => [$this, 'translateHover'], 'visited' => [$this, 'translateVisited'], ]; } /** * {@inheritdoc} */ public function getFunctionTranslators(): array { return [ 'lang' => [$this, 'translateLang'], ]; } public function translateChecked(XPathExpr $xpath): XPathExpr { return $xpath->addCondition( '(@checked ' ."and (name(.) = 'input' or name(.) = 'command')" ."and (@type = 'checkbox' or @type = 'radio'))" ); } public function translateLink(XPathExpr $xpath): XPathExpr { return $xpath->addCondition("@href and (name(.) = 'a' or name(.) = 'link' or name(.) = 'area')"); } public function translateDisabled(XPathExpr $xpath): XPathExpr { return $xpath->addCondition( '(' .'@disabled and' .'(' ."(name(.) = 'input' and @type != 'hidden')" ." or name(.) = 'button'" ." or name(.) = 'select'" ." or name(.) = 'textarea'" ." or name(.) = 'command'" ." or name(.) = 'fieldset'" ." or name(.) = 'optgroup'" ." or name(.) = 'option'" .')' .') or (' ."(name(.) = 'input' and @type != 'hidden')" ." or name(.) = 'button'" ." or name(.) = 'select'" ." or name(.) = 'textarea'" .')' .' and ancestor::fieldset[@disabled]' ); // todo: in the second half, add "and is not a descendant of that fieldset element's first legend element child, if any." } public function translateEnabled(XPathExpr $xpath): XPathExpr { return $xpath->addCondition( '(' .'@href and (' ."name(.) = 'a'" ." or name(.) = 'link'" ." or name(.) = 'area'" .')' .') or (' .'(' ."name(.) = 'command'" ." or name(.) = 'fieldset'" ." or name(.) = 'optgroup'" .')' .' and not(@disabled)' .') or (' .'(' ."(name(.) = 'input' and @type != 'hidden')" ." or name(.) = 'button'" ." or name(.) = 'select'" ." or name(.) = 'textarea'" ." or name(.) = 'keygen'" .')' .' and not (@disabled or ancestor::fieldset[@disabled])' .') or (' ."name(.) = 'option' and not(" .'@disabled or ancestor::optgroup[@disabled]' .')' .')' ); } /** * @throws ExpressionErrorException */ public function translateLang(XPathExpr $xpath, FunctionNode $function): XPathExpr { $arguments = $function->getArguments(); foreach ($arguments as $token) { if (!($token->isString() || $token->isIdentifier())) { throw new ExpressionErrorException('Expected a single string or identifier for :lang(), got '.implode(', ', $arguments)); } } return $xpath->addCondition(sprintf( 'ancestor-or-self::*[@lang][1][starts-with(concat(' ."translate(@%s, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'), '-')" .', %s)]', 'lang', Translator::getXpathLiteral(strtolower($arguments[0]->getValue()).'-') )); } public function translateSelected(XPathExpr $xpath): XPathExpr { return $xpath->addCondition("(@selected and name(.) = 'option')"); } public function translateInvalid(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('0'); } public function translateHover(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('0'); } public function translateVisited(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('0'); } /** * {@inheritdoc} */ public function getName(): string { return 'html'; } } vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/Extension/NodeExtension.php 0000777 00000013661 15252010675 0030072 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Translator; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator node extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class NodeExtension extends AbstractExtension { public const ELEMENT_NAME_IN_LOWER_CASE = 1; public const ATTRIBUTE_NAME_IN_LOWER_CASE = 2; public const ATTRIBUTE_VALUE_IN_LOWER_CASE = 4; private $flags; public function __construct(int $flags = 0) { $this->flags = $flags; } /** * @return $this */ public function setFlag(int $flag, bool $on): self { if ($on && !$this->hasFlag($flag)) { $this->flags += $flag; } if (!$on && $this->hasFlag($flag)) { $this->flags -= $flag; } return $this; } public function hasFlag(int $flag): bool { return (bool) ($this->flags & $flag); } /** * {@inheritdoc} */ public function getNodeTranslators(): array { return [ 'Selector' => [$this, 'translateSelector'], 'CombinedSelector' => [$this, 'translateCombinedSelector'], 'Negation' => [$this, 'translateNegation'], 'Function' => [$this, 'translateFunction'], 'Pseudo' => [$this, 'translatePseudo'], 'EmailEditorVendor_Attribute' => [$this, 'translateAttribute'], 'Class' => [$this, 'translateClass'], 'Hash' => [$this, 'translateHash'], 'Element' => [$this, 'translateElement'], ]; } public function translateSelector(Node\SelectorNode $node, Translator $translator): XPathExpr { return $translator->nodeToXPath($node->getTree()); } public function translateCombinedSelector(Node\CombinedSelectorNode $node, Translator $translator): XPathExpr { return $translator->addCombination($node->getCombinator(), $node->getSelector(), $node->getSubSelector()); } public function translateNegation(Node\NegationNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); $subXpath = $translator->nodeToXPath($node->getSubSelector()); $subXpath->addNameTest(); if ($subXpath->getCondition()) { return $xpath->addCondition(sprintf('not(%s)', $subXpath->getCondition())); } return $xpath->addCondition('0'); } public function translateFunction(Node\FunctionNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); return $translator->addFunction($xpath, $node); } public function translatePseudo(Node\PseudoNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); return $translator->addPseudoClass($xpath, $node->getIdentifier()); } public function translateAttribute(Node\AttributeNode $node, Translator $translator): XPathExpr { $name = $node->getAttribute(); $safe = $this->isSafeName($name); if ($this->hasFlag(self::ATTRIBUTE_NAME_IN_LOWER_CASE)) { $name = strtolower($name); } if ($node->getNamespace()) { $name = sprintf('%s:%s', $node->getNamespace(), $name); $safe = $safe && $this->isSafeName($node->getNamespace()); } $attribute = $safe ? '@'.$name : sprintf('attribute::*[name() = %s]', Translator::getXpathLiteral($name)); $value = $node->getValue(); $xpath = $translator->nodeToXPath($node->getSelector()); if ($this->hasFlag(self::ATTRIBUTE_VALUE_IN_LOWER_CASE)) { $value = strtolower($value); } return $translator->addAttributeMatching($xpath, $node->getOperator(), $attribute, $value); } public function translateClass(Node\ClassNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); return $translator->addAttributeMatching($xpath, '~=', '@class', $node->getName()); } public function translateHash(Node\HashNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); return $translator->addAttributeMatching($xpath, '=', '@id', $node->getId()); } public function translateElement(Node\ElementNode $node): XPathExpr { $element = $node->getElement(); if ($element && $this->hasFlag(self::ELEMENT_NAME_IN_LOWER_CASE)) { $element = strtolower($element); } if ($element) { $safe = $this->isSafeName($element); } else { $element = '*'; $safe = true; } if ($node->getNamespace()) { $element = sprintf('%s:%s', $node->getNamespace(), $element); $safe = $safe && $this->isSafeName($node->getNamespace()); } $xpath = new XPathExpr('', $element); if (!$safe) { $xpath->addNameTest(); } return $xpath; } /** * {@inheritdoc} */ public function getName(): string { return 'node'; } private function isSafeName(string $name): bool { return 0 < preg_match('~^[a-zA-Z_][a-zA-Z0-9_.-]*$~', $name); } } vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/Extension/FunctionExtension.php 0000777 00000012613 15252010675 0030766 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\ExpressionErrorException; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\SyntaxErrorException; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\FunctionNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Parser; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Translator; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator function extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class FunctionExtension extends AbstractExtension { /** * {@inheritdoc} */ public function getFunctionTranslators(): array { return [ 'nth-child' => [$this, 'translateNthChild'], 'nth-last-child' => [$this, 'translateNthLastChild'], 'nth-of-type' => [$this, 'translateNthOfType'], 'nth-last-of-type' => [$this, 'translateNthLastOfType'], 'contains' => [$this, 'translateContains'], 'lang' => [$this, 'translateLang'], ]; } /** * @throws ExpressionErrorException */ public function translateNthChild(XPathExpr $xpath, FunctionNode $function, bool $last = false, bool $addNameTest = true): XPathExpr { try { [$a, $b] = Parser::parseSeries($function->getArguments()); } catch (SyntaxErrorException $e) { throw new ExpressionErrorException(sprintf('Invalid series: "%s".', implode('", "', $function->getArguments())), 0, $e); } $xpath->addStarPrefix(); if ($addNameTest) { $xpath->addNameTest(); } if (0 === $a) { return $xpath->addCondition('position() = '.($last ? 'last() - '.($b - 1) : $b)); } if ($a < 0) { if ($b < 1) { return $xpath->addCondition('false()'); } $sign = '<='; } else { $sign = '>='; } $expr = 'position()'; if ($last) { $expr = 'last() - '.$expr; --$b; } if (0 !== $b) { $expr .= ' - '.$b; } $conditions = [sprintf('%s %s 0', $expr, $sign)]; if (1 !== $a && -1 !== $a) { $conditions[] = sprintf('(%s) mod %d = 0', $expr, $a); } return $xpath->addCondition(implode(' and ', $conditions)); // todo: handle an+b, odd, even // an+b means every-a, plus b, e.g., 2n+1 means odd // 0n+b means b // n+0 means a=1, i.e., all elements // an means every a elements, i.e., 2n means even // -n means -1n // -1n+6 means elements 6 and previous } public function translateNthLastChild(XPathExpr $xpath, FunctionNode $function): XPathExpr { return $this->translateNthChild($xpath, $function, true); } public function translateNthOfType(XPathExpr $xpath, FunctionNode $function): XPathExpr { return $this->translateNthChild($xpath, $function, false, false); } /** * @throws ExpressionErrorException */ public function translateNthLastOfType(XPathExpr $xpath, FunctionNode $function): XPathExpr { if ('*' === $xpath->getElement()) { throw new ExpressionErrorException('"*:nth-of-type()" is not implemented.'); } return $this->translateNthChild($xpath, $function, true, false); } /** * @throws ExpressionErrorException */ public function translateContains(XPathExpr $xpath, FunctionNode $function): XPathExpr { $arguments = $function->getArguments(); foreach ($arguments as $token) { if (!($token->isString() || $token->isIdentifier())) { throw new ExpressionErrorException('Expected a single string or identifier for :contains(), got '.implode(', ', $arguments)); } } return $xpath->addCondition(sprintf( 'contains(string(.), %s)', Translator::getXpathLiteral($arguments[0]->getValue()) )); } /** * @throws ExpressionErrorException */ public function translateLang(XPathExpr $xpath, FunctionNode $function): XPathExpr { $arguments = $function->getArguments(); foreach ($arguments as $token) { if (!($token->isString() || $token->isIdentifier())) { throw new ExpressionErrorException('Expected a single string or identifier for :lang(), got '.implode(', ', $arguments)); } } return $xpath->addCondition(sprintf( 'lang(%s)', Translator::getXpathLiteral($arguments[0]->getValue()) )); } /** * {@inheritdoc} */ public function getName(): string { return 'function'; } } vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/Extension/AbstractExtension.php 0000777 00000002436 15252010675 0030746 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Extension; /** * XPath expression translator abstract extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ abstract class AbstractExtension implements ExtensionInterface { /** * {@inheritdoc} */ public function getNodeTranslators(): array { return []; } /** * {@inheritdoc} */ public function getCombinationTranslators(): array { return []; } /** * {@inheritdoc} */ public function getFunctionTranslators(): array { return []; } /** * {@inheritdoc} */ public function getPseudoClassTranslators(): array { return []; } /** * {@inheritdoc} */ public function getAttributeMatchingTranslators(): array { return []; } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/Translator.php 0000777 00000016721 15252010675 0025544 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\ExpressionErrorException; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\FunctionNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\NodeInterface; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Parser; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * XPath expression translator interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Translator implements TranslatorInterface { private $mainParser; /** * @var ParserInterface[] */ private $shortcutParsers = []; /** * @var Extension\ExtensionInterface[] */ private $extensions = []; private $nodeTranslators = []; private $combinationTranslators = []; private $functionTranslators = []; private $pseudoClassTranslators = []; private $attributeMatchingTranslators = []; public function __construct(?ParserInterface $parser = null) { $this->mainParser = $parser ?? new Parser(); $this ->registerExtension(new Extension\NodeExtension()) ->registerExtension(new Extension\CombinationExtension()) ->registerExtension(new Extension\FunctionExtension()) ->registerExtension(new Extension\PseudoClassExtension()) ->registerExtension(new Extension\AttributeMatchingExtension()) ; } public static function getXpathLiteral(string $element): string { if (!str_contains($element, "'")) { return "'".$element."'"; } if (!str_contains($element, '"')) { return '"'.$element.'"'; } $string = $element; $parts = []; while (true) { if (false !== $pos = strpos($string, "'")) { $parts[] = sprintf("'%s'", substr($string, 0, $pos)); $parts[] = "\"'\""; $string = substr($string, $pos + 1); } else { $parts[] = "'$string'"; break; } } return sprintf('concat(%s)', implode(', ', $parts)); } /** * {@inheritdoc} */ public function cssToXPath(string $cssExpr, string $prefix = 'descendant-or-self::'): string { $selectors = $this->parseSelectors($cssExpr); /** @var SelectorNode $selector */ foreach ($selectors as $index => $selector) { if (null !== $selector->getPseudoElement()) { throw new ExpressionErrorException('Pseudo-elements are not supported.'); } $selectors[$index] = $this->selectorToXPath($selector, $prefix); } return implode(' | ', $selectors); } /** * {@inheritdoc} */ public function selectorToXPath(SelectorNode $selector, string $prefix = 'descendant-or-self::'): string { return ($prefix ?: '').$this->nodeToXPath($selector); } /** * @return $this */ public function registerExtension(Extension\ExtensionInterface $extension): self { $this->extensions[$extension->getName()] = $extension; $this->nodeTranslators = array_merge($this->nodeTranslators, $extension->getNodeTranslators()); $this->combinationTranslators = array_merge($this->combinationTranslators, $extension->getCombinationTranslators()); $this->functionTranslators = array_merge($this->functionTranslators, $extension->getFunctionTranslators()); $this->pseudoClassTranslators = array_merge($this->pseudoClassTranslators, $extension->getPseudoClassTranslators()); $this->attributeMatchingTranslators = array_merge($this->attributeMatchingTranslators, $extension->getAttributeMatchingTranslators()); return $this; } /** * @throws ExpressionErrorException */ public function getExtension(string $name): Extension\ExtensionInterface { if (!isset($this->extensions[$name])) { throw new ExpressionErrorException(sprintf('Extension "%s" not registered.', $name)); } return $this->extensions[$name]; } /** * @return $this */ public function registerParserShortcut(ParserInterface $shortcut): self { $this->shortcutParsers[] = $shortcut; return $this; } /** * @throws ExpressionErrorException */ public function nodeToXPath(NodeInterface $node): XPathExpr { if (!isset($this->nodeTranslators[$node->getNodeName()])) { throw new ExpressionErrorException(sprintf('Node "%s" not supported.', $node->getNodeName())); } return $this->nodeTranslators[$node->getNodeName()]($node, $this); } /** * @throws ExpressionErrorException */ public function addCombination(string $combiner, NodeInterface $xpath, NodeInterface $combinedXpath): XPathExpr { if (!isset($this->combinationTranslators[$combiner])) { throw new ExpressionErrorException(sprintf('Combiner "%s" not supported.', $combiner)); } return $this->combinationTranslators[$combiner]($this->nodeToXPath($xpath), $this->nodeToXPath($combinedXpath)); } /** * @throws ExpressionErrorException */ public function addFunction(XPathExpr $xpath, FunctionNode $function): XPathExpr { if (!isset($this->functionTranslators[$function->getName()])) { throw new ExpressionErrorException(sprintf('Function "%s" not supported.', $function->getName())); } return $this->functionTranslators[$function->getName()]($xpath, $function); } /** * @throws ExpressionErrorException */ public function addPseudoClass(XPathExpr $xpath, string $pseudoClass): XPathExpr { if (!isset($this->pseudoClassTranslators[$pseudoClass])) { throw new ExpressionErrorException(sprintf('Pseudo-class "%s" not supported.', $pseudoClass)); } return $this->pseudoClassTranslators[$pseudoClass]($xpath); } /** * @throws ExpressionErrorException */ public function addAttributeMatching(XPathExpr $xpath, string $operator, string $attribute, ?string $value): XPathExpr { if (!isset($this->attributeMatchingTranslators[$operator])) { throw new ExpressionErrorException(sprintf('EmailEditorVendor_Attribute matcher operator "%s" not supported.', $operator)); } return $this->attributeMatchingTranslators[$operator]($xpath, $attribute, $value); } /** * @return SelectorNode[] */ private function parseSelectors(string $css): array { foreach ($this->shortcutParsers as $shortcut) { $tokens = $shortcut->parse($css); if (!empty($tokens)) { return $tokens; } } return $this->mainParser->parse($css); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/XPath/TranslatorInterface.php 0000777 00000002115 15252010675 0027355 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node\SelectorNode; /** * XPath expression translator interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface TranslatorInterface { /** * Translates a CSS selector to an XPath expression. */ public function cssToXPath(string $cssExpr, string $prefix = 'descendant-or-self::'): string; /** * Translates a parsed selector node to an XPath expression. */ public function selectorToXPath(SelectorNode $selector, string $prefix = 'descendant-or-self::'): string; } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/HashNode.php 0000777 00000002452 15252010675 0024741 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>#<id>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class HashNode extends AbstractNode { private $selector; private $id; public function __construct(NodeInterface $selector, string $id) { $this->selector = $selector; $this->id = $id; } public function getSelector(): NodeInterface { return $this->selector; } public function getId(): string { return $this->id; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(1, 0, 0)); } public function __toString(): string { return sprintf('%s[%s#%s]', $this->getNodeName(), $this->selector, $this->id); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/SelectorNode.php 0000777 00000002723 15252010675 0025637 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>(::|:)<pseudoElement>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class SelectorNode extends AbstractNode { private $tree; private $pseudoElement; public function __construct(NodeInterface $tree, ?string $pseudoElement = null) { $this->tree = $tree; $this->pseudoElement = $pseudoElement ? strtolower($pseudoElement) : null; } public function getTree(): NodeInterface { return $this->tree; } public function getPseudoElement(): ?string { return $this->pseudoElement; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->tree->getSpecificity()->plus(new Specificity(0, 0, $this->pseudoElement ? 1 : 0)); } public function __toString(): string { return sprintf('%s[%s%s]', $this->getNodeName(), $this->tree, $this->pseudoElement ? '::'.$this->pseudoElement : ''); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/ElementNode.php 0000777 00000002620 15252010675 0025444 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Represents a "<namespace>|<element>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class ElementNode extends AbstractNode { private $namespace; private $element; public function __construct(?string $namespace = null, ?string $element = null) { $this->namespace = $namespace; $this->element = $element; } public function getNamespace(): ?string { return $this->namespace; } public function getElement(): ?string { return $this->element; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return new Specificity(0, 0, $this->element ? 1 : 0); } public function __toString(): string { $element = $this->element ?: '*'; return sprintf('%s[%s]', $this->getNodeName(), $this->namespace ? $this->namespace.'|'.$element : $element); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/AbstractNode.php 0000777 00000001654 15252010675 0025624 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Abstract base node class. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ abstract class AbstractNode implements NodeInterface { /** * @var string */ private $nodeName; public function getNodeName(): string { if (null === $this->nodeName) { $this->nodeName = preg_replace('~.*\\\\([^\\\\]+)Node$~', '$1', static::class); } return $this->nodeName; } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/PseudoNode.php 0000777 00000002570 15252010675 0025316 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>:<identifier>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class PseudoNode extends AbstractNode { private $selector; private $identifier; public function __construct(NodeInterface $selector, string $identifier) { $this->selector = $selector; $this->identifier = strtolower($identifier); } public function getSelector(): NodeInterface { return $this->selector; } public function getIdentifier(): string { return $this->identifier; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0)); } public function __toString(): string { return sprintf('%s[%s:%s]', $this->getNodeName(), $this->selector, $this->identifier); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/Specificity.php 0000777 00000003465 15252010675 0025530 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Represents a node specificity. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @see http://www.w3.org/TR/selectors/#specificity * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Specificity { public const A_FACTOR = 100; public const B_FACTOR = 10; public const C_FACTOR = 1; private $a; private $b; private $c; public function __construct(int $a, int $b, int $c) { $this->a = $a; $this->b = $b; $this->c = $c; } public function plus(self $specificity): self { return new self($this->a + $specificity->a, $this->b + $specificity->b, $this->c + $specificity->c); } public function getValue(): int { return $this->a * self::A_FACTOR + $this->b * self::B_FACTOR + $this->c * self::C_FACTOR; } /** * Returns -1 if the object specificity is lower than the argument, * 0 if they are equal, and 1 if the argument is lower. */ public function compareTo(self $specificity): int { if ($this->a !== $specificity->a) { return $this->a > $specificity->a ? 1 : -1; } if ($this->b !== $specificity->b) { return $this->b > $specificity->b ? 1 : -1; } if ($this->c !== $specificity->c) { return $this->c > $specificity->c ? 1 : -1; } return 0; } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/NodeInterface.php 0000777 00000001364 15252010675 0025757 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Interface for nodes. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface NodeInterface { public function getNodeName(): string; public function getSpecificity(): Specificity; public function __toString(): string; } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/NegationNode.php 0000777 00000002631 15252010675 0025621 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>:not(<identifier>)" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class NegationNode extends AbstractNode { private $selector; private $subSelector; public function __construct(NodeInterface $selector, NodeInterface $subSelector) { $this->selector = $selector; $this->subSelector = $subSelector; } public function getSelector(): NodeInterface { return $this->selector; } public function getSubSelector(): NodeInterface { return $this->subSelector; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity()); } public function __toString(): string { return sprintf('%s[%s:not(%s)]', $this->getNodeName(), $this->selector, $this->subSelector); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/AttributeNode.php 0000777 00000004165 15252010675 0026024 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>[<namespace>|<attribute> <operator> <value>]" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class AttributeNode extends AbstractNode { private $selector; private $namespace; private $attribute; private $operator; private $value; public function __construct(NodeInterface $selector, ?string $namespace, string $attribute, string $operator, ?string $value) { $this->selector = $selector; $this->namespace = $namespace; $this->attribute = $attribute; $this->operator = $operator; $this->value = $value; } public function getSelector(): NodeInterface { return $this->selector; } public function getNamespace(): ?string { return $this->namespace; } public function getAttribute(): string { return $this->attribute; } public function getOperator(): string { return $this->operator; } public function getValue(): ?string { return $this->value; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0)); } public function __toString(): string { $attribute = $this->namespace ? $this->namespace.'|'.$this->attribute : $this->attribute; return 'exists' === $this->operator ? sprintf('%s[%s[%s]]', $this->getNodeName(), $this->selector, $attribute) : sprintf("%s[%s[%s %s '%s']]", $this->getNodeName(), $this->selector, $attribute, $this->operator, $this->value); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/FunctionNode.php 0000777 00000003567 15252010675 0025653 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Token; /** * Represents a "<selector>:<name>(<arguments>)" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class FunctionNode extends AbstractNode { private $selector; private $name; private $arguments; /** * @param Token[] $arguments */ public function __construct(NodeInterface $selector, string $name, array $arguments = []) { $this->selector = $selector; $this->name = strtolower($name); $this->arguments = $arguments; } public function getSelector(): NodeInterface { return $this->selector; } public function getName(): string { return $this->name; } /** * @return Token[] */ public function getArguments(): array { return $this->arguments; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0)); } public function __toString(): string { $arguments = implode(', ', array_map(function (Token $token) { return "'".$token->getValue()."'"; }, $this->arguments)); return sprintf('%s[%s:%s(%s)]', $this->getNodeName(), $this->selector, $this->name, $arguments ? '['.$arguments.']' : ''); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/CombinedSelectorNode.php 0000777 00000003234 15252010675 0027276 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Represents a combined node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class CombinedSelectorNode extends AbstractNode { private $selector; private $combinator; private $subSelector; public function __construct(NodeInterface $selector, string $combinator, NodeInterface $subSelector) { $this->selector = $selector; $this->combinator = $combinator; $this->subSelector = $subSelector; } public function getSelector(): NodeInterface { return $this->selector; } public function getCombinator(): string { return $this->combinator; } public function getSubSelector(): NodeInterface { return $this->subSelector; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity()); } public function __toString(): string { $combinator = ' ' === $this->combinator ? '<followed>' : $this->combinator; return sprintf('%s[%s %s %s]', $this->getNodeName(), $this->selector, $combinator, $this->subSelector); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Node/ClassNode.php 0000777 00000002473 15252010675 0025126 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>.<name>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class ClassNode extends AbstractNode { private $selector; private $name; public function __construct(NodeInterface $selector, string $name) { $this->selector = $selector; $this->name = $name; } public function getSelector(): NodeInterface { return $this->selector; } public function getName(): string { return $this->name; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0)); } public function __toString(): string { return sprintf('%s[%s.%s]', $this->getNodeName(), $this->selector, $this->name); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/CssSelectorConverter.php 0000777 00000004610 15252010675 0026502 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Shortcut\ClassParser; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Shortcut\ElementParser; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Shortcut\EmptyStringParser; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Shortcut\HashParser; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Extension\HtmlExtension; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\XPath\Translator; /** * CssSelectorConverter is the main entry point of the component and can convert CSS * selectors to XPath expressions. * * @author Christophe Coevoet <stof@notk.org> */ class CssSelectorConverter { private $translator; private $cache; private static $xmlCache = []; private static $htmlCache = []; /** * @param bool $html Whether HTML support should be enabled. Disable it for XML documents */ public function __construct(bool $html = true) { $this->translator = new Translator(); if ($html) { $this->translator->registerExtension(new HtmlExtension($this->translator)); $this->cache = &self::$htmlCache; } else { $this->cache = &self::$xmlCache; } $this->translator ->registerParserShortcut(new EmptyStringParser()) ->registerParserShortcut(new ElementParser()) ->registerParserShortcut(new ClassParser()) ->registerParserShortcut(new HashParser()) ; } /** * Translates a CSS expression to its XPath equivalent. * * Optionally, a prefix can be added to the resulting XPath * expression with the $prefix parameter. * * @return string */ public function toXPath(string $cssExpr, string $prefix = 'descendant-or-self::') { return $this->cache[$prefix][$cssExpr] ?? $this->cache[$prefix][$cssExpr] = $this->translator->cssToXPath($cssExpr, $prefix); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/composer.json 0000777 00000001530 15252010675 0024370 0 ustar 00 { "name": "symfony/css-selector", "type": "library", "description": "Converts CSS selectors to XPath expressions", "keywords": [], "homepage": "https://symfony.com", "license": "MIT", "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Jean-François Simon", "email": "jeanfrancois.simon@sensiolabs.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "require": { "php": ">=7.2.5", "symfony/polyfill-php80": "^1.16" }, "autoload": { "psr-4": { "Symfony\\Component\\CssSelector\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "minimum-stability": "dev" } vendor-prefixed/packages/Symfony/Component/CssSelector/Exception/SyntaxErrorException.php 0000777 00000003326 15252010675 0030422 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Parser\Token; /** * ParseException is thrown when a CSS selector syntax is not valid. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> */ class SyntaxErrorException extends ParseException { /** * @return self */ public static function unexpectedToken(string $expectedValue, Token $foundToken) { return new self(sprintf('Expected %s, but %s found.', $expectedValue, $foundToken)); } /** * @return self */ public static function pseudoElementFound(string $pseudoElement, string $unexpectedLocation) { return new self(sprintf('Unexpected pseudo-element "::%s" found %s.', $pseudoElement, $unexpectedLocation)); } /** * @return self */ public static function unclosedString(int $position) { return new self(sprintf('Unclosed/invalid string at %s.', $position)); } /** * @return self */ public static function nestedNot() { return new self('Got nested ::not().'); } /** * @return self */ public static function stringAsFunctionArgument() { return new self('String not allowed as function argument.'); } } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Exception/ParseException.php 0000777 00000001247 15252010675 0027253 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception; /** * ParseException is thrown when a CSS selector syntax is not valid. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Fabien Potencier <fabien@symfony.com> */ class ParseException extends \Exception implements ExceptionInterface { } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/Exception/ExceptionInterface.php0000777 00000001174 15252010675 0030100 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception; /** * Interface for exceptions. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> */ interface ExceptionInterface extends \Throwable { } vendor-prefixed/packages/Symfony/Component/CssSelector/Exception/ExpressionErrorException.php 0000777 00000001252 15252010675 0031267 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception; /** * ParseException is thrown when a CSS selector syntax is not valid. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> */ class ExpressionErrorException extends ParseException { } vendor-prefixed/packages/Symfony/Component/CssSelector/Exception/InternalErrorException.php 0000777 00000001250 15252010675 0030702 0 ustar 00 email-editor <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception; /** * ParseException is thrown when a CSS selector syntax is not valid. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> */ class InternalErrorException extends ParseException { } email-editor/vendor-prefixed/packages/Symfony/Component/CssSelector/LICENSE 0000777 00000002054 15252010675 0022655 0 ustar 00 Copyright (c) 2004-present Fabien Potencier Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. email-editor/vendor-prefixed/packages/Pelago/Emogrifier/Css/CssDocument.php 0000777 00000017566 15252010675 0023016 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Css; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\Preg; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList\AtRuleBlockList as CssAtRuleBlockList; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList\Document as SabberwormCssDocument; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parser as CssParser; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\AtRule as CssAtRule; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\Charset as CssCharset; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\Import as CssImport; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Renderable as CssRenderable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\DeclarationBlock as CssDeclarationBlock; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\RuleSet as CssRuleSet; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Settings as ParserSettings; /** * Parses and stores a CSS document from a string of CSS, and provides methods to obtain the CSS in parts or as data * structures. * * @internal */ final class CssDocument { /** * @var SabberwormCssDocument */ private $sabberwormCssDocument; /** * `@import` rules must precede all other types of rules, except `@charset` rules. This property is used while * rendering at-rules to enforce that. * * @var bool */ private $isImportRuleAllowed = true; /** * @param string $css * @param bool $debug * If this is `true`, an exception will be thrown if invalid CSS is encountered. * Otherwise the parser will try to do the best it can. */ public function __construct(string $css, bool $debug) { // CSS Parser currently throws exception with nested at-rules (like `@media`) in strict parsing mode $parserSettings = ParserSettings::create()->withLenientParsing(!$debug || $this->hasNestedAtRule($css)); // CSS Parser currently throws exception with non-empty whitespace-only CSS in strict parsing mode, so `trim()` // @see https://github.com/sabberworm/PHP-CSS-Parser/issues/349 $this->sabberwormCssDocument = (new CssParser(\trim($css), $parserSettings))->parse(); } /** * Tests if a string of CSS appears to contain an at-rule with nested rules * (`@media`, `@supports`, `@keyframes`, `@document`, * the latter two additionally with vendor prefixes that may commonly be used). * * @see https://github.com/sabberworm/PHP-CSS-Parser/issues/127 */ private function hasNestedAtRule(string $css): bool { return (new Preg()) ->match('/@(?:media|supports|(?:-webkit-|-moz-|-ms-|-o-)?+(keyframes|document))\\b/', $css) !== 0; } /** * Collates the media query, selectors and declarations for individual rules from the parsed CSS, in order. * * @param array<array-key, string> $allowedMediaTypes * * @return list<StyleRule> */ public function getStyleRulesData(array $allowedMediaTypes): array { $ruleMatches = []; /** @var CssRenderable $rule */ foreach ($this->sabberwormCssDocument->getContents() as $rule) { if ($rule instanceof CssAtRuleBlockList) { $containingAtRule = $this->getFilteredAtIdentifierAndRule($rule, $allowedMediaTypes); if (\is_string($containingAtRule)) { /** @var CssRenderable $nestedRule */ foreach ($rule->getContents() as $nestedRule) { if ($nestedRule instanceof CssDeclarationBlock) { $ruleMatches[] = new StyleRule($nestedRule, $containingAtRule); } } } } elseif ($rule instanceof CssDeclarationBlock) { $ruleMatches[] = new StyleRule($rule); } } return $ruleMatches; } /** * Renders at-rules from the parsed CSS that are valid and not conditional group rules (i.e. not rules such as * `@media` which contain style rules whose data is returned by {@see getStyleRulesData}). Also does not render * `@charset` rules; these are discarded (only UTF-8 is supported). * * @return string */ public function renderNonConditionalAtRules(): string { $this->isImportRuleAllowed = true; $cssContents = $this->sabberwormCssDocument->getContents(); $atRules = \array_filter($cssContents, [$this, 'isValidAtRuleToRender']); if ($atRules === []) { return ''; } $atRulesDocument = new SabberwormCssDocument(); $atRulesDocument->setContents($atRules); return $atRulesDocument->render(); } /** * @param CssAtRuleBlockList $rule * @param array<array-key, string> $allowedMediaTypes * * @return ?string * If the nested at-rule is supported, it's opening declaration (e.g. "@media (max-width: 768px)") is * returned; otherwise the return value is null. */ private function getFilteredAtIdentifierAndRule(CssAtRuleBlockList $rule, array $allowedMediaTypes): ?string { $result = null; if ($rule->atRuleName() === 'media') { $mediaQueryList = $rule->atRuleArgs(); [$mediaType] = \explode('(', $mediaQueryList, 2); if (\trim($mediaType) !== '') { $escapedAllowedMediaTypes = \array_map( static function (string $allowedMediaType): string { return \preg_quote($allowedMediaType, '/'); }, $allowedMediaTypes ); $mediaTypesMatcher = \implode('|', $escapedAllowedMediaTypes); $isAllowed = (new Preg())->match('/^\\s*+(?:only\\s++)?+(?:' . $mediaTypesMatcher . ')/i', $mediaType) !== 0; } else { $isAllowed = true; } if ($isAllowed) { $result = '@media ' . $mediaQueryList; } } return $result; } /** * Tests if a CSS rule is an at-rule that should be passed though and copied to a `<style>` element unmodified: * - `@charset` rules are discarded - only UTF-8 is supported - `false` is returned; * - `@import` rules are passed through only if they satisfy the specification ("user agents must ignore any * '@import' rule that occurs inside a block or after any non-ignored statement other than an '@charset' or an * '@import' rule"); * - `@media` rules are processed separately to see if their nested rules apply - `false` is returned; * - `@font-face` rules are checked for validity - they must contain both a `src` and `font-family` property; * - other at-rules are assumed to be valid and treated as a black box - `true` is returned. * * @param CssRenderable $rule * * @return bool */ private function isValidAtRuleToRender(CssRenderable $rule): bool { if ($rule instanceof CssCharset) { return false; } if ($rule instanceof CssImport) { return $this->isImportRuleAllowed; } $this->isImportRuleAllowed = false; if (!$rule instanceof CssAtRule) { return false; } switch ($rule->atRuleName()) { case 'media': $result = false; break; case 'font-face': $result = $rule instanceof CssRuleSet && $rule->getRules('font-family') !== [] && $rule->getRules('src') !== []; break; default: $result = true; } return $result; } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/Css/StyleRule.php 0000777 00000004376 15252010675 0022512 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Css; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\DeclarationBlock; /** * This class represents a CSS style rule, including selectors, a declaration block, and an optional containing at-rule. * * @internal */ final class StyleRule { /** * @var DeclarationBlock */ private $declarationBlock; /** * @var string */ private $containingAtRule; /** * @param DeclarationBlock $declarationBlock * @param string $containingAtRule e.g. `@media screen and (max-width: 480px)` */ public function __construct(DeclarationBlock $declarationBlock, string $containingAtRule = '') { $this->declarationBlock = $declarationBlock; $this->containingAtRule = \trim($containingAtRule); } /** * @return array<int, string> the selectors, e.g. `["h1", "p"]` */ public function getSelectors(): array { /** @var array<int, Selector> $selectors */ $selectors = $this->declarationBlock->getSelectors(); return \array_map( static function (Selector $selector): string { return (string) $selector; }, $selectors ); } /** * @return string the CSS declarations, separated and followed by a semicolon, e.g., `color: red; height: 4px;` */ public function getDeclarationAsText(): string { return \implode(' ', $this->declarationBlock->getRules()); } /** * Checks whether the declaration block has at least one declaration. */ public function hasAtLeastOneDeclaration(): bool { return $this->declarationBlock->getRules() !== []; } /** * @returns string e.g. `@media screen and (max-width: 480px)`, or an empty string */ public function getContainingAtRule(): string { return $this->containingAtRule; } /** * Checks whether the containing at-rule is non-empty and has any non-whitespace characters. */ public function hasContainingAtRule(): bool { return $this->getContainingAtRule() !== ''; } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/Caching/SimpleStringCache.php 0000777 00000004110 15252010675 0024714 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Caching; /** * This cache caches string values with string keys. It is not PSR-6-compliant. * * Usage: * * ```php * $cache = new SimpleStringCache(); * $cache->set($key, $value); * … * if ($cache->has($key) { * $cachedValue = $cache->get($value); * } * ``` * * @internal */ final class SimpleStringCache { /** * @var array<string, string> */ private $values = []; /** * Checks whether there is an entry stored for the given key. * * @param string $key the key to check; must not be empty * * @throws \InvalidArgumentException */ public function has(string $key): bool { $this->assertNotEmptyKey($key); return isset($this->values[$key]); } /** * Returns the entry stored for the given key, and throws an exception if the value does not exist * (which helps keep the return type simple). * * @param string $key the key to of the item to retrieve; must not be empty * * @return string the retrieved value; may be empty * * @throws \BadMethodCallException */ public function get(string $key): string { if (!$this->has($key)) { throw new \BadMethodCallException('You can only call `get` with a key for an existing value.', 1625996246); } return $this->values[$key]; } /** * Sets or overwrites an entry. * * @param string $key the key to of the item to set; must not be empty * @param string $value the value to set; can be empty * * @throws \BadMethodCallException */ public function set(string $key, string $value): void { $this->assertNotEmptyKey($key); $this->values[$key] = $value; } /** * @throws \InvalidArgumentException */ private function assertNotEmptyKey(string $key): void { if ($key === '') { throw new \InvalidArgumentException('Please provide a non-empty key.', 1625995840); } } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/CssInliner.php 0000777 00000127065 15252010675 0022104 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Css\CssDocument; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\HtmlProcessor\AbstractHtmlProcessor; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\CssConcatenator; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\DeclarationBlockParser; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\Preg; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\CssSelectorConverter; use Automattic\WooCommerce\EmailEditorVendor\Symfony\Component\CssSelector\Exception\ParseException; /** * This class provides functions for converting CSS styles into inline style attributes in your HTML code. */ final class CssInliner extends AbstractHtmlProcessor { /** * @var int */ private const CACHE_KEY_SELECTOR = 0; /** * @var int */ private const CACHE_KEY_COMBINED_STYLES = 1; /** * Regular expression component matching a static pseudo class in a selector, without the preceding ":", * for which the applicable elements can be determined (by converting the selector to an XPath expression). * (Contains alternation without a group and is intended to be placed within a capturing, non-capturing or lookahead * group, as appropriate for the usage context.) * * @var string */ private const PSEUDO_CLASS_MATCHER = 'empty|(?:first|last|nth(?:-last)?+|only)-(?:child|of-type)|not\\([[:ascii:]]*\\)|root'; /** * This regular expression componenet matches an `...of-type` pseudo class name, without the preceding ":". These * pseudo-classes can currently online be inlined if they have an associated type in the selector expression. * * @var string */ private const OF_TYPE_PSEUDO_CLASS_MATCHER = '(?:first|last|nth(?:-last)?+|only)-of-type'; /** * regular expression component to match a selector combinator * * @var string */ private const COMBINATOR_MATCHER = '(?:\\s++|\\s*+[>+~]\\s*+)(?=[[:alpha:]_\\-.#*:\\[])'; /** * options array key for `querySelectorAll` * * @var string */ private const QSA_ALWAYS_THROW_PARSE_EXCEPTION = 'alwaysThrowParseException'; /** * @var array<string, bool> */ private $excludedSelectors = []; /** * @var array<non-empty-string, bool> */ private $excludedCssSelectors = []; /** * @var array<string, bool> */ private $allowedMediaTypes = ['all' => true, 'screen' => true, 'print' => true]; /** * @var array{ * 0: array<string, int>, * 1: array<string, string> * } */ private $caches = [ self::CACHE_KEY_SELECTOR => [], self::CACHE_KEY_COMBINED_STYLES => [], ]; /** * @var ?CssSelectorConverter */ private $cssSelectorConverter = null; /** * the visited nodes with the XPath paths as array keys * * @var array<string, \DOMElement> */ private $visitedNodes = []; /** * the styles to apply to the nodes with the XPath paths as array keys for the outer array * and the attribute names/values as key/value pairs for the inner array * * @var array<string, array<string, string>> */ private $styleAttributesForNodes = []; /** * Determines whether the "style" attributes of tags in the the HTML passed to this class should be preserved. * If set to false, the value of the style attributes will be discarded. * * @var bool */ private $isInlineStyleAttributesParsingEnabled = true; /** * Determines whether the `<style>` blocks in the HTML passed to this class should be parsed. * * If set to true, the `<style>` blocks will be removed from the HTML and their contents will be applied to the HTML * via inline styles. * * If set to false, the `<style>` blocks will be left as they are in the HTML. * * @var bool */ private $isStyleBlocksParsingEnabled = true; /** * For calculating selector precedence order. * Keys are a regular expression part to match before a CSS name. * Values are a multiplier factor per match to weight specificity. * * @var array<string, int> */ private $selectorPrecedenceMatchers = [ // IDs: worth 10000 '\\#' => 10000, // classes, attributes, pseudo-classes (not pseudo-elements) except `:not`: worth 100 '(?:\\.|\\[|(?<!:):(?!not\\())' => 100, // elements (not attribute values or `:not`), pseudo-elements: worth 1 '(?:(?<![="\':\\w\\-])|::)' => 1, ]; /** * array of data describing CSS rules which apply to the document but cannot be inlined, in the format returned by * {@see collateCssRules} * * @var array<array-key, array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * }>|null */ private $matchingUninlinableCssRules = null; /** * Emogrifier will throw Exceptions when it encounters an error instead of silently ignoring them. * * @var bool */ private $debug = false; /** * Inlines the given CSS into the existing HTML. * * @param string $css the CSS to inline, must be UTF-8-encoded * * @return $this * * @throws ParseException in debug mode, if an invalid selector is encountered * @throws \RuntimeException * in debug mode, if an internal PCRE error occurs * or `CssSelectorConverter::toXPath` returns an invalid XPath expression * @throws \UnexpectedValueException * if a selector query result includes a node which is not a `DOMElement` */ public function inlineCss(string $css = ''): self { $this->clearAllCaches(); $this->purgeVisitedNodes(); $this->normalizeStyleAttributesOfAllNodes(); $combinedCss = $css; // grab any existing style blocks from the HTML and append them to the existing CSS // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) if ($this->isStyleBlocksParsingEnabled) { $combinedCss .= $this->getCssFromAllStyleNodes(); } $parsedCss = new CssDocument($combinedCss, $this->debug); $excludedNodes = $this->getNodesToExclude(); $cssRules = $this->collateCssRules($parsedCss); foreach ($cssRules['inlinable'] as $cssRule) { foreach ($this->querySelectorAll($cssRule['selector']) as $node) { if (\in_array($node, $excludedNodes, true)) { continue; } $this->copyInlinableCssToStyleAttribute($this->ensureNodeIsElement($node), $cssRule); } } if ($this->isInlineStyleAttributesParsingEnabled) { $this->fillStyleAttributesWithMergedStyles(); } $this->removeImportantAnnotationFromAllInlineStyles(); $this->determineMatchingUninlinableCssRules($cssRules['uninlinable']); $this->copyUninlinableCssToStyleNode($parsedCss); return $this; } /** * Disables the parsing of inline styles. * * @return $this */ public function disableInlineStyleAttributesParsing(): self { $this->isInlineStyleAttributesParsingEnabled = false; return $this; } /** * Disables the parsing of `<style>` blocks. * * @return $this */ public function disableStyleBlocksParsing(): self { $this->isStyleBlocksParsingEnabled = false; return $this; } /** * Marks a media query type to keep. * * @param string $mediaName the media type name, e.g., "braille" * * @return $this */ public function addAllowedMediaType(string $mediaName): self { $this->allowedMediaTypes[$mediaName] = true; return $this; } /** * Drops a media query type from the allowed list. * * @param string $mediaName the tag name, e.g., "braille" * * @return $this */ public function removeAllowedMediaType(string $mediaName): self { if (isset($this->allowedMediaTypes[$mediaName])) { unset($this->allowedMediaTypes[$mediaName]); } return $this; } /** * Adds a selector to exclude nodes from emogrification. * * Any nodes that match the selector will not have their style altered. * * @param string $selector the selector to exclude, e.g., ".editor" * * @return $this */ public function addExcludedSelector(string $selector): self { $this->excludedSelectors[$selector] = true; return $this; } /** * No longer excludes the nodes matching this selector from emogrification. * * @param string $selector the selector to no longer exclude, e.g., ".editor" * * @return $this */ public function removeExcludedSelector(string $selector): self { if (isset($this->excludedSelectors[$selector])) { unset($this->excludedSelectors[$selector]); } return $this; } /** * Adds a selector to exclude CSS selector from emogrification. * * @param non-empty-string $selector the selector to exclude, e.g., `.editor` * * @return $this */ public function addExcludedCssSelector(string $selector): self { $this->excludedCssSelectors[$selector] = true; return $this; } /** * No longer excludes the CSS selector from emogrification. * * @param non-empty-string $selector the selector to no longer exclude, e.g., `.editor` * * @return $this */ public function removeExcludedCssSelector(string $selector): self { if (isset($this->excludedCssSelectors[$selector])) { unset($this->excludedCssSelectors[$selector]); } return $this; } /** * Sets the debug mode. * * @param bool $debug set to true to enable debug mode * * @return $this */ public function setDebug(bool $debug): self { $this->debug = $debug; return $this; } /** * Gets the array of selectors present in the CSS provided to `inlineCss()` for which the declarations could not be * applied as inline styles, but which may affect elements in the HTML. The relevant CSS will have been placed in a * `<style>` element. The selectors may include those used within `@media` rules or those involving dynamic * pseudo-classes (such as `:hover`) or pseudo-elements (such as `::after`). * * @return array<array-key, string> * * @throws \BadMethodCallException if `inlineCss` has not been called first */ public function getMatchingUninlinableSelectors(): array { return \array_column($this->getMatchingUninlinableCssRules(), 'selector'); } /** * @return array<array-key, array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * }> * * @throws \BadMethodCallException if `inlineCss` has not been called first */ private function getMatchingUninlinableCssRules(): array { if (!\is_array($this->matchingUninlinableCssRules)) { throw new \BadMethodCallException('inlineCss must be called first', 1568385221); } return $this->matchingUninlinableCssRules; } /** * Clears all caches. */ private function clearAllCaches(): void { $this->caches = [ self::CACHE_KEY_SELECTOR => [], self::CACHE_KEY_COMBINED_STYLES => [], ]; } /** * Purges the visited nodes. */ private function purgeVisitedNodes(): void { $this->visitedNodes = []; $this->styleAttributesForNodes = []; } /** * Parses the document and normalizes all existing CSS attributes. * This changes 'DISPLAY: none' to 'display: none'. * We wouldn't have to do this if DOMXPath supported XPath 2.0. * Also stores a reference of nodes with existing inline styles so we don't overwrite them. */ private function normalizeStyleAttributesOfAllNodes(): void { /** @var \DOMElement $node */ foreach ($this->getAllNodesWithStyleAttribute() as $node) { if ($this->isInlineStyleAttributesParsingEnabled) { $this->normalizeStyleAttributes($node); } // Remove style attribute in every case, so we can add them back (if inline style attributes // parsing is enabled) to the end of the style list, thus keeping the right priority of CSS rules; // else original inline style rules may remain at the beginning of the final inline style definition // of a node, which may give not the desired results $node->removeAttribute('style'); } } /** * Returns a list with all DOM nodes that have a style attribute. * * @return \DOMNodeList * * @throws \RuntimeException */ private function getAllNodesWithStyleAttribute(): \DOMNodeList { $query = '//*[@style]'; $matches = $this->getXPath()->query($query); if (!$matches instanceof \DOMNodeList) { throw new \RuntimeException('XPatch query failed: ' . $query, 1618577797); } return $matches; } /** * Normalizes the value of the "style" attribute and saves it. * * @param \DOMElement $node */ private function normalizeStyleAttributes(\DOMElement $node): void { $declarationBlockParser = new DeclarationBlockParser(); $normalizedOriginalStyle = (new Preg())->throwExceptions($this->debug)->replaceCallback( '/-{0,2}+[_a-zA-Z][\\w\\-]*+(?=:)/S', /** @param array<array-key, string> $propertyNameMatches */ static function (array $propertyNameMatches) use ($declarationBlockParser): string { return $declarationBlockParser->normalizePropertyName($propertyNameMatches[0]); }, $node->getAttribute('style') ); // In order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles. $nodePath = $node->getNodePath(); if (\is_string($nodePath) && !isset($this->styleAttributesForNodes[$nodePath])) { $this->styleAttributesForNodes[$nodePath] = $declarationBlockParser->parse($normalizedOriginalStyle); $this->visitedNodes[$nodePath] = $node; } $node->setAttribute('style', $normalizedOriginalStyle); } /** * Returns CSS content. * * @return string */ private function getCssFromAllStyleNodes(): string { $styleNodes = $this->getXPath()->query('//style'); if ($styleNodes === false) { return ''; } $css = ''; foreach ($styleNodes as $styleNode) { if (\is_string($styleNode->nodeValue)) { $css .= "\n\n" . $styleNode->nodeValue; } $parentNode = $styleNode->parentNode; if ($parentNode instanceof \DOMNode) { $parentNode->removeChild($styleNode); } } return $css; } /** * Find the nodes that are not to be emogrified. * * @return list<\DOMElement> * * @throws ParseException in debug mode, if an invalid selector is encountered * @throws \RuntimeException in debug mode, if `CssSelectorConverter::toXPath` returns an invalid XPath expression * @throws \UnexpectedValueException if the selector query result includes a node which is not a `DOMElement` */ private function getNodesToExclude(): array { $excludedNodes = []; foreach (\array_keys($this->excludedSelectors) as $selectorToExclude) { foreach ($this->querySelectorAll($selectorToExclude) as $node) { $excludedNodes[] = $this->ensureNodeIsElement($node); } } return $excludedNodes; } /** * @param array{}|array{alwaysThrowParseException: bool} $options * This is an array of option values to control behaviour: * - `QSA_ALWAYS_THROW_PARSE_EXCEPTION` - `bool` - throw any `ParseException` regardless of debug setting. * * @return \DOMNodeList<\DOMNode> the HTML elements that match the provided CSS `$selectors` * * @throws ParseException * in debug mode (or with `QSA_ALWAYS_THROW_PARSE_EXCEPTION` option), if an invalid selector is encountered * @throws \RuntimeException in debug mode, if `CssSelectorConverter::toXPath` returns an invalid XPath expression */ private function querySelectorAll(string $selectors, array $options = []): \DOMNodeList { try { $result = $this->getXPath()->query($this->getCssSelectorConverter()->toXPath($selectors)); if ($result === false) { throw new \RuntimeException('query failed with selector \'' . $selectors . '\'', 1726533051); } return $result; } catch (ParseException $exception) { $alwaysThrowParseException = $options[self::QSA_ALWAYS_THROW_PARSE_EXCEPTION] ?? false; if ($this->debug || $alwaysThrowParseException) { throw $exception; } return new \DOMNodeList(); } catch (\RuntimeException $exception) { if ( $this->debug ) { throw $exception; } // `RuntimeException` indicates a bug in CssSelector so pass the message to the error handler. \trigger_error($exception->getMessage()); return new \DOMNodeList(); } } /** * @throws \UnexpectedValueException if `$node` is not a `DOMElement` */ private function ensureNodeIsElement(\DOMNode $node): \DOMElement { if (!$node instanceof \DOMElement) { $path = $node->getNodePath() ?? '$node'; throw new \UnexpectedValueException($path . ' is not a DOMElement.', 1617975914); } return $node; } /** * @return CssSelectorConverter */ private function getCssSelectorConverter(): CssSelectorConverter { if (!$this->cssSelectorConverter instanceof CssSelectorConverter) { $this->cssSelectorConverter = new CssSelectorConverter(); } return $this->cssSelectorConverter; } /** * Collates the individual rules from a `CssDocument` object. * * @param CssDocument $parsedCss * * @return array<string, array<array-key, array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * }>> * This 2-entry array has the key "inlinable" containing rules which can be inlined as `style` attributes * and the key "uninlinable" containing rules which cannot. Each value is an array of sub-arrays with the * following keys: * - "media" (the media query string, e.g. "@media screen and (max-width: 480px)", * or an empty string if not from a `@media` rule); * - "selector" (the CSS selector, e.g., "*" or "header h1"); * - "hasUnmatchablePseudo" (`true` if that selector contains pseudo-elements or dynamic pseudo-classes such * that the declarations cannot be applied inline); * - "declarationsBlock" (the semicolon-separated CSS declarations for that selector, * e.g., `color: red; height: 4px;`); * - "line" (the line number, e.g. 42). */ private function collateCssRules(CssDocument $parsedCss): array { $matches = $parsedCss->getStyleRulesData(\array_keys($this->allowedMediaTypes)); $preg = (new Preg())->throwExceptions($this->debug); $cssRules = [ 'inlinable' => [], 'uninlinable' => [], ]; foreach ($matches as $key => $cssRule) { if (!$cssRule->hasAtLeastOneDeclaration()) { continue; } $mediaQuery = $cssRule->getContainingAtRule(); $declarationsBlock = $cssRule->getDeclarationAsText(); $selectors = $cssRule->getSelectors(); // Maybe exclude CSS selectors if (\count($this->excludedCssSelectors) > 0) { // Normalize spaces, line breaks & tabs $selectorsNormalized = \array_map(static function (string $selector) use ($preg): string { return $preg->replace('@\\s++@u', ' ', $selector); }, $selectors); $selectors = \array_filter($selectorsNormalized, function (string $selector): bool { return !isset($this->excludedCssSelectors[$selector]); }); } foreach ($selectors as $selector) { // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; // only allow structural pseudo-classes $hasPseudoElement = \strpos($selector, '::') !== false; $hasUnmatchablePseudo = $hasPseudoElement || $this->hasUnsupportedPseudoClass($selector); $parsedCssRule = [ 'media' => $mediaQuery, 'selector' => $selector, 'hasUnmatchablePseudo' => $hasUnmatchablePseudo, 'declarationsBlock' => $declarationsBlock, // keep track of where it appears in the file, since order is important 'line' => $key, ]; $ruleType = (!$cssRule->hasContainingAtRule() && !$hasUnmatchablePseudo) ? 'inlinable' : 'uninlinable'; $cssRules[$ruleType][] = $parsedCssRule; } } \usort( $cssRules['inlinable'], /** * @param array{selector: string, line: int, ...} $first * @param array{selector: string, line: int, ...} $second */ function (array $first, array $second): int { return $this->sortBySelectorPrecedence($first, $second); } ); return $cssRules; } /** * Tests if a selector contains a pseudo-class which would mean it cannot be converted to an XPath expression for * inlining CSS declarations. * * Any pseudo class that does not match {@see PSEUDO_CLASS_MATCHER} cannot be converted. Additionally, `...of-type` * pseudo-classes cannot be converted if they are not associated with a type selector. * * @param string $selector * * @return bool */ private function hasUnsupportedPseudoClass(string $selector): bool { $preg = (new Preg())->throwExceptions($this->debug); if ($preg->match('/:(?!' . self::PSEUDO_CLASS_MATCHER . ')[\\w\\-]/i', $selector) !== 0) { return true; } if ($preg->match('/:(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')/i', $selector) === 0) { return false; } foreach ($preg->split('/' . self::COMBINATOR_MATCHER . '/', $selector) as $selectorPart) { if ($this->selectorPartHasUnsupportedOfTypePseudoClass($selectorPart)) { return true; } } return false; } /** * Tests if part of a selector contains an `...of-type` pseudo-class such that it cannot be converted to an XPath * expression. * * @param string $selectorPart part of a selector which has been split up at combinators * * @return bool `true` if the selector part does not have a type but does have an `...of-type` pseudo-class */ private function selectorPartHasUnsupportedOfTypePseudoClass(string $selectorPart): bool { $preg = (new Preg())->throwExceptions($this->debug); if ($preg->match('/^[\\w\\-]/', $selectorPart) !== 0) { return false; } return $preg->match('/:(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')/i', $selectorPart) !== 0; } /** * @param array{selector: string, line: int, ...} $first * @param array{selector: string, line: int, ...} $second * * @return int */ private function sortBySelectorPrecedence(array $first, array $second): int { $precedenceOfFirst = $this->getCssSelectorPrecedence($first['selector']); $precedenceOfSecond = $this->getCssSelectorPrecedence($second['selector']); // We want these sorted in ascending order so selectors with lesser precedence get processed first and // selectors with greater precedence get sorted last. $precedenceForEquals = $first['line'] < $second['line'] ? -1 : 1; $precedenceForNotEquals = $precedenceOfFirst < $precedenceOfSecond ? -1 : 1; return ($precedenceOfFirst === $precedenceOfSecond) ? $precedenceForEquals : $precedenceForNotEquals; } /** * @param string $selector * * @return int */ private function getCssSelectorPrecedence(string $selector): int { $selectorKey = $selector; if (isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; } $preg = (new Preg())->throwExceptions($this->debug); $precedence = 0; foreach ($this->selectorPrecedenceMatchers as $matcher => $value) { if (\trim($selector) === '') { break; } $count = 0; $selector = $preg->replace('/' . $matcher . '\\w+/', '', $selector, -1, $count); $precedence += ($value * $count); } $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; return $precedence; } /** * Copies $cssRule into the style attribute of $node. * * Note: This method does not check whether $cssRule matches $node. * * @param \DOMElement $node * @param array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * } $cssRule */ private function copyInlinableCssToStyleAttribute(\DOMElement $node, array $cssRule): void { $declarationsBlock = $cssRule['declarationsBlock']; $declarationBlockParser = new DeclarationBlockParser(); $newStyleDeclarations = $declarationBlockParser->parse($declarationsBlock); if ($newStyleDeclarations === []) { return; } // if it has a style attribute, get it, process it, and append (overwrite) new stuff if ($node->hasAttribute('style')) { // break it up into an associative array $oldStyleDeclarations = $declarationBlockParser->parse($node->getAttribute('style')); } else { $oldStyleDeclarations = []; } $node->setAttribute( 'style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations) ); } /** * This method merges old or existing name/value array with new name/value array * and then generates a string of the combined style suitable for placing inline. * This becomes the single point for CSS string generation allowing for consistent * CSS output no matter where the CSS originally came from. * * @param array<string, string> $oldStyles * @param array<string, string> $newStyles * * @return string * * @throws \UnexpectedValueException if an empty property name is encountered (which should not happen) */ private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles): string { $cacheKey = \serialize([$oldStyles, $newStyles]); if (isset($this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey])) { return $this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey]; } // Unset the overridden styles to preserve order, important if shorthand and individual properties are mixed foreach ($oldStyles as $attributeName => $attributeValue) { if (!isset($newStyles[$attributeName])) { continue; } $newAttributeValue = $newStyles[$attributeName]; if ( $this->attributeValueIsImportant($attributeValue) && !$this->attributeValueIsImportant($newAttributeValue) ) { unset($newStyles[$attributeName]); } else { unset($oldStyles[$attributeName]); } } $combinedStyles = \array_merge($oldStyles, $newStyles); $declarationBlockParser = new DeclarationBlockParser(); $style = ''; foreach ($combinedStyles as $attributeName => $attributeValue) { $trimmedAttributeName = \trim($attributeName); if ($trimmedAttributeName === '') { throw new \UnexpectedValueException('An empty property name was encountered.', 1727046078); } $propertyName = $declarationBlockParser->normalizePropertyName($trimmedAttributeName); $propertyValue = \trim($attributeValue); $style .= $propertyName . ': ' . $propertyValue . '; '; } $trimmedStyle = \rtrim($style); $this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey] = $trimmedStyle; return $trimmedStyle; } /** * Checks whether $attributeValue is marked as !important. * * @param string $attributeValue * * @return bool */ private function attributeValueIsImportant(string $attributeValue): bool { return (new Preg())->throwExceptions($this->debug)->match('/!\\s*+important$/i', $attributeValue) !== 0; } /** * Merges styles from styles attributes and style nodes and applies them to the attribute nodes */ private function fillStyleAttributesWithMergedStyles(): void { $declarationBlockParser = new DeclarationBlockParser(); foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { $node = $this->visitedNodes[$nodePath]; $currentStyleAttributes = $declarationBlockParser->parse($node->getAttribute('style')); $node->setAttribute( 'style', $this->generateStyleStringFromDeclarationsArrays( $currentStyleAttributes, $styleAttributesForNode ) ); } } /** * Searches for all nodes with a style attribute and removes the "!important" annotations out of * the inline style declarations, eventually by rearranging declarations. * * @throws \RuntimeException */ private function removeImportantAnnotationFromAllInlineStyles(): void { /** @var \DOMElement $node */ foreach ($this->getAllNodesWithStyleAttribute() as $node) { $this->removeImportantAnnotationFromNodeInlineStyle($node); } } /** * Removes the "!important" annotations out of the inline style declarations, * eventually by rearranging declarations. * Rearranging needed when !important shorthand properties are followed by some of their * not !important expanded-version properties. * For example "font: 12px serif !important; font-size: 13px;" must be reordered * to "font-size: 13px; font: 12px serif;" in order to remain correct. * * @param \DOMElement $node * * @throws \RuntimeException */ private function removeImportantAnnotationFromNodeInlineStyle(\DOMElement $node): void { $style = $node->getAttribute('style'); $inlineStyleDeclarations = (new DeclarationBlockParser())->parse((bool) $style ? $style : ''); /** @var array<string, string> $regularStyleDeclarations */ $regularStyleDeclarations = []; /** @var array<string, string> $importantStyleDeclarations */ $importantStyleDeclarations = []; foreach ($inlineStyleDeclarations as $property => $value) { if ($this->attributeValueIsImportant($value)) { $importantStyleDeclarations[$property] = (new Preg())->throwExceptions($this->debug)->replace('/\\s*+!\\s*+important$/i', '', $value); } else { $regularStyleDeclarations[$property] = $value; } } $inlineStyleDeclarationsInNewOrder = \array_merge($regularStyleDeclarations, $importantStyleDeclarations); $node->setAttribute( 'style', $this->generateStyleStringFromSingleDeclarationsArray($inlineStyleDeclarationsInNewOrder) ); } /** * Generates a CSS style string suitable to be used inline from the $styleDeclarations property => value array. * * @param array<string, string> $styleDeclarations * * @return string */ private function generateStyleStringFromSingleDeclarationsArray(array $styleDeclarations): string { return $this->generateStyleStringFromDeclarationsArrays([], $styleDeclarations); } /** * Determines which of `$cssRules` actually apply to `$this->domDocument`, and sets them in * `$this->matchingUninlinableCssRules`. * * @param array<array-key, array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * }> $cssRules * the "uninlinable" array of CSS rules returned by `collateCssRules` */ private function determineMatchingUninlinableCssRules(array $cssRules): void { $this->matchingUninlinableCssRules = \array_filter( $cssRules, function (array $cssRule): bool { return $this->existsMatchForSelectorInCssRule($cssRule); } ); } /** * Checks whether there is at least one matching element for the CSS selector contained in the `selector` element * of the provided CSS rule. * * Any dynamic pseudo-classes will be assumed to apply. If the selector matches a pseudo-element, * it will test for a match with its originating element. * * @param array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * } $cssRule * * @return bool * * @throws ParseException */ private function existsMatchForSelectorInCssRule(array $cssRule): bool { $selector = $cssRule['selector']; if ($cssRule['hasUnmatchablePseudo']) { $selector = $this->removeUnmatchablePseudoComponents($selector); } return $this->existsMatchForCssSelector($selector); } /** * Checks whether there is at least one matching element for $cssSelector. * When not in debug mode, it returns true also for invalid selectors (because they may be valid, * just not implemented/recognized yet by Emogrifier). * * @param string $cssSelector * * @return bool * * @throws ParseException in debug mode, if an invalid selector is encountered * @throws \RuntimeException in debug mode, if `CssSelectorConverter::toXPath` returns an invalid XPath expression */ private function existsMatchForCssSelector(string $cssSelector): bool { try { $nodesMatchingSelector = $this->querySelectorAll($cssSelector, [self::QSA_ALWAYS_THROW_PARSE_EXCEPTION => true]); } catch (ParseException $e) { if ($this->debug) { throw $e; } return true; } return $nodesMatchingSelector->length !== 0; } /** * Removes pseudo-elements and dynamic pseudo-classes from a CSS selector, replacing them with "*" if necessary. * If such a pseudo-component is within the argument of `:not`, the entire `:not` component is removed or replaced. * * @param string $selector * * @return string * selector which will match the relevant DOM elements if the pseudo-classes are assumed to apply, or in the * case of pseudo-elements will match their originating element */ private function removeUnmatchablePseudoComponents(string $selector): string { $preg = (new Preg())->throwExceptions($this->debug); // The regex allows nested brackets via `(?2)`. // A space is temporarily prepended because the callback can't determine if the match was at the very start. $selectorWithoutNots = \ltrim((new Preg())->throwExceptions($this->debug)->replaceCallback( '/([\\s>+~]?+):not(\\([^()]*+(?:(?2)[^()]*+)*+\\))/i', /** @param array<array-key, string> $matches */ function (array $matches): string { return $this->replaceUnmatchableNotComponent($matches); }, ' ' . $selector )); $selectorWithoutUnmatchablePseudoComponents = $this->removeSelectorComponents( ':(?!' . self::PSEUDO_CLASS_MATCHER . '):?+[\\w\\-]++(?:\\([^\\)]*+\\))?+', $selectorWithoutNots ); if ( $preg->match( '/:(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')/i', $selectorWithoutUnmatchablePseudoComponents ) === 0 ) { return $selectorWithoutUnmatchablePseudoComponents; } return \implode('', \array_map( function (string $selectorPart): string { return $this->removeUnsupportedOfTypePseudoClasses($selectorPart); }, $preg->split( '/(' . self::COMBINATOR_MATCHER . ')/', $selectorWithoutUnmatchablePseudoComponents, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY ) )); } /** * Helps `removeUnmatchablePseudoComponents()` replace or remove a selector `:not(...)` component if its argument * contains pseudo-elements or dynamic pseudo-classes. * * @param array<array-key, string> $matches array of elements matched by the regular expression * * @return string * the full match if there were no unmatchable pseudo components within; otherwise, any preceding combinator * followed by "*", or an empty string if there was no preceding combinator */ private function replaceUnmatchableNotComponent(array $matches): string { [$notComponentWithAnyPrecedingCombinator, $anyPrecedingCombinator, $notArgumentInBrackets] = $matches; if ($this->hasUnsupportedPseudoClass($notArgumentInBrackets)) { return $anyPrecedingCombinator !== '' ? $anyPrecedingCombinator . '*' : ''; } return $notComponentWithAnyPrecedingCombinator; } /** * Removes components from a CSS selector, replacing them with "*" if necessary. * * @param string $matcher regular expression part to match the components to remove * @param string $selector * * @return string * selector which will match the relevant DOM elements if the removed components are assumed to apply (or in * the case of pseudo-elements will match their originating element) */ private function removeSelectorComponents(string $matcher, string $selector): string { return (new Preg())->throwExceptions($this->debug)->replace( ['/([\\s>+~]|^)' . $matcher . '/i', '/' . $matcher . '/i'], ['$1*', ''], $selector ); } /** * Removes any `...-of-type` pseudo-classes from part of a CSS selector, if it does not have a type, replacing them * with "*" if necessary. * * @param string $selectorPart part of a selector which has been split up at combinators * * @return string * selector part which will match the relevant DOM elements if the pseudo-classes are assumed to apply */ private function removeUnsupportedOfTypePseudoClasses(string $selectorPart): string { if (!$this->selectorPartHasUnsupportedOfTypePseudoClass($selectorPart)) { return $selectorPart; } return $this->removeSelectorComponents( ':(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')(?:\\([^\\)]*+\\))?+', $selectorPart ); } /** * Applies `$this->matchingUninlinableCssRules` to `$this->domDocument` by placing them as CSS in a `<style>` * element. * If there are no uninlinable CSS rules to copy there, a `<style>` element will be created containing only the * applicable at-rules from `$parsedCss`. * If there are none of either, an empty `<style>` element will not be created. * * @param CssDocument $parsedCss * This may contain various at-rules whose content `CssInliner` does not currently attempt to inline or * process in any other way, such as `@import`, `@font-face`, `@keyframes`, etc., and which should precede * the processed but found-to-be-uninlinable CSS placed in the `<style>` element. * Note that `CssInliner` processes `@media` rules so that they can be ordered correctly with respect to * other uninlinable rules; these will not be duplicated from `$parsedCss`. */ private function copyUninlinableCssToStyleNode(CssDocument $parsedCss): void { $css = $parsedCss->renderNonConditionalAtRules(); // avoid including unneeded class dependency if there are no rules if ($this->getMatchingUninlinableCssRules() !== []) { $cssConcatenator = new CssConcatenator(); foreach ($this->getMatchingUninlinableCssRules() as $cssRule) { $cssConcatenator->append([$cssRule['selector']], $cssRule['declarationsBlock'], $cssRule['media']); } $css .= $cssConcatenator->getCss(); } // avoid adding empty style element if ($css !== '') { $this->addStyleElementToDocument($css); } } /** * Adds a style element with $css to $this->domDocument. * * This method is protected to allow overriding. * * @see https://github.com/MyIntervals/emogrifier/issues/103 * * @param string $css */ protected function addStyleElementToDocument(string $css): void { $domDocument = $this->getDomDocument(); $styleElement = $domDocument->createElement('style', $css); $styleAttribute = $domDocument->createAttribute('type'); $styleAttribute->value = 'text/css'; $styleElement->appendChild($styleAttribute); $headElement = $this->getHeadElement(); $headElement->appendChild($styleElement); } /** * Returns the HEAD element. * * This method assumes that there always is a HEAD element. * * @return \DOMElement * * @throws \UnexpectedValueException */ private function getHeadElement(): \DOMElement { $node = $this->getDomDocument()->getElementsByTagName('head')->item(0); if (!$node instanceof \DOMElement) { throw new \UnexpectedValueException('There is no HEAD element. This should never happen.', 1617923227); } return $node; } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/Utilities/ArrayIntersector.php 0000777 00000003637 15252010675 0025304 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities; /** * When computing many array intersections using the same array, it is more efficient to use `array_flip()` first and * then `array_intersect_key()`, than `array_intersect()`. See the discussion at * {@link https://stackoverflow.com/questions/6329211/php-array-intersect-efficiency Stack Overflow} for more * information. * * Of course, this is only possible if the arrays contain integer or string values, and either don't contain duplicates, * or that fact that duplicates will be removed does not matter. * * This class takes care of the detail. * * @internal */ final class ArrayIntersector { /** * the array with which the object was constructed, with all its keys exchanged with their associated values * * @var array<array-key, array-key> */ private $invertedArray; /** * Constructs the object with the array that will be reused for many intersection computations. * * @param array<array-key, array-key> $array */ public function __construct(array $array) { $this->invertedArray = \array_flip($array); } /** * Computes the intersection of `$array` and the array with which this object was constructed. * * @param array<array-key, array-key> $array * * @return array<array-key, array-key> * Returns an array containing all of the values in `$array` whose values exist in the array * with which this object was constructed. Note that keys are preserved, order is maintained, but * duplicates are removed. */ public function intersectWith(array $array): array { $invertedArray = \array_flip($array); $invertedIntersection = \array_intersect_key($invertedArray, $this->invertedArray); return \array_flip($invertedIntersection); } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/Utilities/CssConcatenator.php 0000777 00000015177 15252010675 0025077 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities; /** * Facilitates building a CSS string by appending rule blocks one at a time, checking whether the media query, * selectors, or declarations block are the same as those from the preceding block and combining blocks in such cases. * * Example: * $concatenator = new CssConcatenator(); * $concatenator->append(['body'], 'color: blue;'); * $concatenator->append(['body'], 'font-size: 16px;'); * $concatenator->append(['p'], 'margin: 1em 0;'); * $concatenator->append(['ul', 'ol'], 'margin: 1em 0;'); * $concatenator->append(['body'], 'font-size: 14px;', '@media screen and (max-width: 400px)'); * $concatenator->append(['ul', 'ol'], 'margin: 0.75em 0;', '@media screen and (max-width: 400px)'); * $css = $concatenator->getCss(); * * `$css` (if unminified) would contain the following CSS: * ` body { * ` color: blue; * ` font-size: 16px; * ` } * ` p, ul, ol { * ` margin: 1em 0; * ` } * ` @media screen and (max-width: 400px) { * ` body { * ` font-size: 14px; * ` } * ` ul, ol { * ` margin: 0.75em 0; * ` } * ` } * * @internal */ final class CssConcatenator { /** * Array of media rules in order. Each element is an object with the following properties: * - string `media` - The media query string, e.g. "@media screen and (max-width:639px)", or an empty string for * rules not within a media query block; * - object[] `ruleBlocks` - Array of rule blocks in order, where each element is an object with the following * properties: * - mixed[] `selectorsAsKeys` - Array whose keys are selectors for the rule block (values are of no * significance); * - string `declarationsBlock` - The property declarations, e.g. "margin-top: 0.5em; padding: 0". * * @var array<int, object{ * media: string, * ruleBlocks: array<int, object{ * selectorsAsKeys: array<string, array-key>, * declarationsBlock: string * }> * }> */ private $mediaRules = []; /** * Appends a declaration block to the CSS. * * @param array<array-key, string> $selectors * array of selectors for the rule, e.g. ["ul", "ol", "p:first-child"] * @param string $declarationsBlock * the property declarations, e.g. "margin-top: 0.5em; padding: 0" * @param string $media * the media query for the rule, e.g. "@media screen and (max-width:639px)", or an empty string if none */ public function append(array $selectors, string $declarationsBlock, string $media = ''): void { $selectorsAsKeys = \array_flip($selectors); $mediaRule = $this->getOrCreateMediaRuleToAppendTo($media); $ruleBlocks = $mediaRule->ruleBlocks; $lastRuleBlock = \end($ruleBlocks); $hasSameDeclarationsAsLastRule = \is_object($lastRuleBlock) && $declarationsBlock === $lastRuleBlock->declarationsBlock; if ($hasSameDeclarationsAsLastRule) { $lastRuleBlock->selectorsAsKeys += $selectorsAsKeys; } else { $lastRuleBlockSelectors = \is_object($lastRuleBlock) ? $lastRuleBlock->selectorsAsKeys : []; $hasSameSelectorsAsLastRule = \is_object($lastRuleBlock) && self::hasEquivalentSelectors($selectorsAsKeys, $lastRuleBlockSelectors); if ($hasSameSelectorsAsLastRule) { $lastDeclarationsBlockWithoutSemicolon = \rtrim(\rtrim($lastRuleBlock->declarationsBlock), ';'); $lastRuleBlock->declarationsBlock = $lastDeclarationsBlockWithoutSemicolon . ';' . $declarationsBlock; } else { $mediaRule->ruleBlocks[] = (object) \compact('selectorsAsKeys', 'declarationsBlock'); } } } /** * @return string */ public function getCss(): string { return \implode('', \array_map([self::class, 'getMediaRuleCss'], $this->mediaRules)); } /** * @param string $media The media query for rules to be appended, e.g. "@media screen and (max-width:639px)", * or an empty string if none. * * @return object{ * media: string, * ruleBlocks: array<int, object{ * selectorsAsKeys: array<string, array-key>, * declarationsBlock: string * }> * } */ private function getOrCreateMediaRuleToAppendTo(string $media): object { $lastMediaRule = \end($this->mediaRules); if (\is_object($lastMediaRule) && $media === $lastMediaRule->media) { return $lastMediaRule; } $newMediaRule = (object) [ 'media' => $media, 'ruleBlocks' => [], ]; $this->mediaRules[] = $newMediaRule; return $newMediaRule; } /** * Tests if two sets of selectors are equivalent (i.e. the same selectors, possibly in a different order). * * @param array<string, array-key> $selectorsAsKeys1 * array in which the selectors are the keys, and the values are of no significance * @param array<string, array-key> $selectorsAsKeys2 another such array * * @return bool */ private static function hasEquivalentSelectors(array $selectorsAsKeys1, array $selectorsAsKeys2): bool { return \count($selectorsAsKeys1) === \count($selectorsAsKeys2) && \count($selectorsAsKeys1) === \count($selectorsAsKeys1 + $selectorsAsKeys2); } /** * @param object{ * media: string, * ruleBlocks: array<int, object{ * selectorsAsKeys: array<string, array-key>, * declarationsBlock: string * }> * } $mediaRule * * @return string CSS for the media rule. */ private static function getMediaRuleCss(object $mediaRule): string { $ruleBlocks = $mediaRule->ruleBlocks; $css = \implode('', \array_map([self::class, 'getRuleBlockCss'], $ruleBlocks)); $media = $mediaRule->media; if ($media !== '') { $css = $media . '{' . $css . '}'; } return $css; } /** * @param object{selectorsAsKeys: array<string, array-key>, declarationsBlock: string} $ruleBlock * * @return string CSS for the rule block. */ private static function getRuleBlockCss(object $ruleBlock): string { $selectorsAsKeys = $ruleBlock->selectorsAsKeys; $selectors = \array_keys($selectorsAsKeys); $declarationsBlock = $ruleBlock->declarationsBlock; return \implode(',', $selectors) . '{' . $declarationsBlock . '}'; } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/Utilities/Preg.php 0000777 00000015570 15252010675 0022700 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities; /** * PHP's `preg_*` functions can return `false` on failure. * Failure is rare but may occur with a complex pattern applied to a long subject. * Catastrophic backtracking may occur ({@see https://www.regular-expressions.info/catastrophic.html}). * Failure may also occur due to programmer error, if an invalid pattern is provided. * * Catering for failure in each case clutters up the code with error handling. * This class provides wrappers for some `preg_*` functions, with errors handled either * - by throwing an exception, or * - by triggering a user error and providing fallback logic (e.g. returning the subject string unmodified). * * @internal */ final class Preg { /** * whether to throw exceptions on errors (or call `trigger_error` and implement fallback) * * @var bool */ private $throwExceptions = false; /** * Sets whether exceptions should be thrown if an error occurs. */ public function throwExceptions(bool $throw): self { $this->throwExceptions = $throw; return $this; } /** * Wraps `preg_replace`, though does not support `$subject` being an array. * If an error occurs, and exceptions are not being thrown, the original `$subject` is returned. * * @param non-empty-string|non-empty-array<non-empty-string> $pattern * @param string|non-empty-array<string> $replacement * * @throws \RuntimeException */ public function replace($pattern, $replacement, string $subject, int $limit = -1, ?int &$count = null): string { $result = \preg_replace($pattern, $replacement, $subject, $limit, $count); if ($result === null) { $this->logOrThrowPregLastError(); $result = $subject; } return $result; } /** * Wraps `preg_replace_callback`, though does not support `$subject` being an array. * If an error occurs, and exceptions are not being thrown, the original `$subject` is returned. * * Note that (unlike when calling `preg_replace_callback`), `$callback` cannot be a non-public method * represented by an array comprising an object or class name and the method name. * To circumvent that, use `\Closure::fromCallable([$objectOrClassName, 'method'])`. * * @param non-empty-string|non-empty-array<non-empty-string> $pattern * * @throws \RuntimeException */ public function replaceCallback( $pattern, callable $callback, string $subject, int $limit = -1, ?int &$count = null ): string { $result = \preg_replace_callback($pattern, $callback, $subject, $limit, $count); if ($result === null) { $this->logOrThrowPregLastError(); $result = $subject; } return $result; } /** * Wraps `preg_split`. * If an error occurs, and exceptions are not being thrown, * a single-element array containing the original `$subject` is returned. * This method does not support the `PREG_SPLIT_OFFSET_CAPTURE` flag and will throw an exception if it is specified. * * @param non-empty-string $pattern * * @return array<int, string> * * @throws \RuntimeException */ public function split(string $pattern, string $subject, int $limit = -1, int $flags = 0): array { if (($flags & PREG_SPLIT_OFFSET_CAPTURE) !== 0) { throw new \RuntimeException('PREG_SPLIT_OFFSET_CAPTURE is not supported by Preg::split', 1726506348); } $result = \preg_split($pattern, $subject, $limit, $flags); if ($result === false) { $this->logOrThrowPregLastError(); $result = [$subject]; } return $result; } /** * Wraps `preg_match`. * If an error occurs, and exceptions are not being thrown, * zero (`0`) is returned, and if the `$matches` parameter is provided, it is set to an empty array. * This method does not currently support the `$flags` or `$offset` parameters. * * @param non-empty-string $pattern * @param array<int, string> $matches * * @return 0|1 * * @throws \RuntimeException */ public function match(string $pattern, string $subject, ?array &$matches = null): int { $result = \preg_match($pattern, $subject, $matches); if ($result === false) { $this->logOrThrowPregLastError(); $result = 0; $matches = []; } return $result; } /** * Wraps `preg_match_all`. * * If an error occurs, and exceptions are not being thrown, zero (`0`) is returned. * * In the error case, if the `$matches` parameter is provided, it is set to an array containing empty arrays for the * full pattern match and any possible subpattern match that might be expected. * The algorithm to determine the length of this array simply counts the number of opening parentheses in the * `$pattern`, which may result in a longer array than expected, but guarantees that it is at least as long as * expected. * * This method does not currently support the `$flags` or `$offset` parameters. * * @param non-empty-string $pattern * @param array<int, array<int, string>> $matches * * @throws \RuntimeException */ public function matchAll(string $pattern, string $subject, ?array &$matches = null): int { $result = \preg_match_all($pattern, $subject, $matches); if ($result === false) { $this->logOrThrowPregLastError(); $result = 0; $matches = \array_fill(0, \substr_count($pattern, '(') + 1, []); } return $result; } /** * Obtains the name of the error constant for `preg_last_error` * (based on code posted at {@see https://www.php.net/manual/en/function.preg-last-error.php#124124}) * and puts it into an error message which is either passed to `trigger_error` * or used in the exception which is thrown (depending on the `$throwExceptions` property). * * @throws \RuntimeException */ private function logOrThrowPregLastError(): void { $pcreConstants = \get_defined_constants(true)['pcre']; $pcreErrorConstantNames = \array_flip(\array_filter( $pcreConstants, static function (string $key): bool { return \substr($key, -6) === '_ERROR'; }, ARRAY_FILTER_USE_KEY )); $pregLastError = \preg_last_error(); $message = 'PCRE regex execution error `' . (string) ($pcreErrorConstantNames[$pregLastError] ?? $pregLastError) . '`'; if ($this->throwExceptions) { throw new \RuntimeException($message, 1592870147); } \trigger_error($message); } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/Utilities/DeclarationBlockParser.php 0000777 00000005502 15252010675 0026352 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities; /** * Provides a common method for parsing CSS declaration blocks. * These might be from actual CSS, or from the `style` attribute of an HTML DOM element. * * Caches results globally. * * @internal */ final class DeclarationBlockParser { /** * @var array<string, array<non-empty-string, string>> */ private static $cache = []; /** * CSS custom properties (variables) have case-sensitive names, so their case must be preserved. * Standard CSS properties have case-insensitive names, which are converted to lowercase. * * @param non-empty-string $name * * @return non-empty-string */ public function normalizePropertyName(string $name): string { if (\substr($name, 0, 2) === '--') { return $name; } else { return \strtolower($name); } } /** * Parses a CSS declaration block into property name/value pairs. * * Example: * * The declaration block * * "color: #000; font-weight: bold;" * * will be parsed into the following array: * * "color" => "#000" * "font-weight" => "bold" * * @param string $declarationBlock the CSS declarations block without the curly braces, may be empty * * @return array<non-empty-string, string> * the CSS declarations with the property names as array keys and the property values as array values * * @throws \UnexpectedValueException if an empty property name is encountered (which cannot happen) */ public function parse(string $declarationBlock): array { if (isset(self::$cache[$declarationBlock])) { return self::$cache[$declarationBlock]; } $preg = new Preg(); $declarations = $preg->split('/;(?!base64|charset)/', $declarationBlock); $properties = []; foreach ($declarations as $declaration) { $matches = []; if ( $preg->match( '/^([A-Za-z\\-]+)\\s*:\\s*(.+)$/s', \trim($declaration), $matches ) === 0 ) { continue; } $propertyName = $matches[1]; if ($propertyName === '') { // This cannot happen since the regular epression matches one or more characters. throw new \UnexpectedValueException('An empty property name was encountered.', 1727046409); } $propertyValue = $matches[2]; $properties[$this->normalizePropertyName($propertyName)] = $propertyValue; } self::$cache[$declarationBlock] = $properties; return $properties; } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/HtmlProcessor/AbstractHtmlProcessor.php 0000777 00000035737 15252010675 0027133 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\HtmlProcessor; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\Preg; /** * Base class for HTML processor that e.g., can remove, add or modify nodes or attributes. * * The "vanilla" subclass is the HtmlNormalizer. */ abstract class AbstractHtmlProcessor { /** * @var string */ protected const DEFAULT_DOCUMENT_TYPE = '<!DOCTYPE html>'; /** * @var string */ protected const CONTENT_TYPE_META_TAG = '<meta http-equiv="Content-Type" content="text/html; charset=utf-8">'; /** * @var string Regular expression part to match tag names that PHP's DOMDocument implementation is not aware are * self-closing. These are mostly HTML5 elements, but for completeness <command> (obsolete) and <keygen> * (deprecated) are also included. * * @see https://bugs.php.net/bug.php?id=73175 */ protected const PHP_UNRECOGNIZED_VOID_TAGNAME_MATCHER = '(?:command|embed|keygen|source|track|wbr)'; /** * Regular expression part to match tag names that may appear before the start of the `<body>` element. A start tag * for any other element would implicitly start the `<body>` element due to tag omission rules. * * @var string */ protected const TAGNAME_ALLOWED_BEFORE_BODY_MATCHER = '(?:html|head|base|command|link|meta|noscript|script|style|template|title)'; /** * regular expression pattern to match an HTML comment, including delimiters and modifiers * * @var string */ protected const HTML_COMMENT_PATTERN = '/<!--[^-]*+(?:-(?!->)[^-]*+)*+(?:-->|$)/'; /** * regular expression pattern to match an HTML `<template>` element, including delimiters and modifiers * * @var string */ protected const HTML_TEMPLATE_ELEMENT_PATTERN = '%<template[\\s>][^<]*+(?:<(?!/template>)[^<]*+)*+(?:</template>|$)%i'; /** * @var ?\DOMDocument */ protected $domDocument = null; /** * @var ?\DOMXPath */ private $xPath = null; /** * The constructor. * * Please use `::fromHtml` or `::fromDomDocument` instead. */ private function __construct() {} /** * Builds a new instance from the given HTML. * * @param string $unprocessedHtml raw HTML, must be UTF-encoded, must not be empty * * @return static * * @throws \InvalidArgumentException if $unprocessedHtml is anything other than a non-empty string */ public static function fromHtml(string $unprocessedHtml): self { if ($unprocessedHtml === '') { throw new \InvalidArgumentException('The provided HTML must not be empty.', 1515763647); } $instance = new static(); $instance->setHtml($unprocessedHtml); return $instance; } /** * Builds a new instance from the given DOM document. * * @param \DOMDocument $document a DOM document returned by getDomDocument() of another instance * * @return static */ public static function fromDomDocument(\DOMDocument $document): self { $instance = new static(); $instance->setDomDocument($document); return $instance; } /** * Sets the HTML to process. * * @param string $html the HTML to process, must be UTF-8-encoded */ private function setHtml(string $html): void { $this->createUnifiedDomDocument($html); } /** * Provides access to the internal DOMDocument representation of the HTML in its current state. * * @return \DOMDocument * * @throws \UnexpectedValueException */ public function getDomDocument(): \DOMDocument { if (!$this->domDocument instanceof \DOMDocument) { $message = self::class . '::setDomDocument() has not yet been called on ' . static::class; throw new \UnexpectedValueException($message, 1570472239); } return $this->domDocument; } /** * @param \DOMDocument $domDocument */ private function setDomDocument(\DOMDocument $domDocument): void { $this->domDocument = $domDocument; $this->xPath = new \DOMXPath($this->domDocument); } /** * @return \DOMXPath * * @throws \UnexpectedValueException */ protected function getXPath(): \DOMXPath { if (!$this->xPath instanceof \DOMXPath) { $message = self::class . '::setDomDocument() has not yet been called on ' . static::class; throw new \UnexpectedValueException($message, 1617819086); } return $this->xPath; } /** * Renders the normalized and processed HTML. * * @return string */ public function render(): string { $htmlWithPossibleErroneousClosingTags = $this->getDomDocument()->saveHTML(); return $this->removeSelfClosingTagsClosingTags($htmlWithPossibleErroneousClosingTags); } /** * Renders the content of the BODY element of the normalized and processed HTML. * * @return string */ public function renderBodyContent(): string { $htmlWithPossibleErroneousClosingTags = $this->getDomDocument()->saveHTML($this->getBodyElement()); $bodyNodeHtml = $this->removeSelfClosingTagsClosingTags($htmlWithPossibleErroneousClosingTags); return (new Preg())->replace('%</?+body(?:\\s[^>]*+)?+>%', '', $bodyNodeHtml); } /** * Eliminates any invalid closing tags for void elements from the given HTML. * * @param string $html * * @return string */ private function removeSelfClosingTagsClosingTags(string $html): string { return (new Preg())->replace('%</' . self::PHP_UNRECOGNIZED_VOID_TAGNAME_MATCHER . '>%', '', $html); } /** * Returns the HTML element. * * This method assumes that there always is an HTML element, throwing an exception otherwise. * * @throws \UnexpectedValueException */ protected function getHtmlElement(): \DOMElement { $htmlElement = $this->getDomDocument()->getElementsByTagName('html')->item(0); if (!$htmlElement instanceof \DOMElement) { throw new \UnexpectedValueException('There is no HTML element although there should be one.', 1569930853); } return $htmlElement; } /** * Returns the BODY element. * * This method assumes that there always is a BODY element. * * @return \DOMElement * * @throws \RuntimeException */ private function getBodyElement(): \DOMElement { $node = $this->getDomDocument()->getElementsByTagName('body')->item(0); if (!$node instanceof \DOMElement) { throw new \RuntimeException('There is no body element.', 1617922607); } return $node; } /** * Creates a DOM document from the given HTML and stores it in $this->domDocument. * * The DOM document will always have a BODY element and a document type. * * @param string $html */ private function createUnifiedDomDocument(string $html): void { $this->createRawDomDocument($html); $this->ensureExistenceOfBodyElement(); } /** * Creates a DOMDocument instance from the given HTML and stores it in $this->domDocument. * * @param string $html */ private function createRawDomDocument(string $html): void { $domDocument = new \DOMDocument(); $domDocument->strictErrorChecking = false; $domDocument->formatOutput = false; $libXmlState = \libxml_use_internal_errors(true); $domDocument->loadHTML($this->prepareHtmlForDomConversion($html)); \libxml_clear_errors(); \libxml_use_internal_errors($libXmlState); $this->setDomDocument($domDocument); } /** * Returns the HTML with added document type, Content-Type meta tag, and self-closing slashes, if needed, * ensuring that the HTML will be good for creating a DOM document from it. * * @param string $html * * @return string the unified HTML */ private function prepareHtmlForDomConversion(string $html): string { $htmlWithSelfClosingSlashes = $this->ensurePhpUnrecognizedSelfClosingTagsAreXml($html); $htmlWithDocumentType = $this->ensureDocumentType($htmlWithSelfClosingSlashes); return $this->addContentTypeMetaTag($htmlWithDocumentType); } /** * Makes sure that the passed HTML has a document type, with lowercase "html". * * @param string $html * * @return string HTML with document type */ private function ensureDocumentType(string $html): string { $hasDocumentType = \stripos($html, '<!DOCTYPE') !== false; if ($hasDocumentType) { return $this->normalizeDocumentType($html); } return self::DEFAULT_DOCUMENT_TYPE . $html; } /** * Makes sure the document type in the passed HTML has lowercase "html". * * @param string $html * * @return string HTML with normalized document type */ private function normalizeDocumentType(string $html): string { // Limit to replacing the first occurrence: as an optimization; and in case an example exists as unescaped text. return (new Preg())->replace( '/<!DOCTYPE\\s++html(?=[\\s>])/i', '<!DOCTYPE html', $html, 1 ); } /** * Adds a Content-Type meta tag for the charset. * * This method also ensures that there is a HEAD element. * * @param string $html * * @return string the HTML with the meta tag added */ private function addContentTypeMetaTag(string $html): string { if ($this->hasContentTypeMetaTagInHead($html)) { return $html; } // We are trying to insert the meta tag to the right spot in the DOM. // If we just prepended it to the HTML, we would lose attributes set to the HTML tag. $hasHeadTag = (new Preg())->match('/<head[\\s>]/i', $html) !== 0; $hasHtmlTag = \stripos($html, '<html') !== false; if ($hasHeadTag) { $reworkedHtml = (new Preg())->replace( '/<head(?=[\\s>])([^>]*+)>/i', '<head$1>' . self::CONTENT_TYPE_META_TAG, $html ); } elseif ($hasHtmlTag) { $reworkedHtml = (new Preg())->replace( '/<html(.*?)>/is', '<html$1><head>' . self::CONTENT_TYPE_META_TAG . '</head>', $html ); } else { $reworkedHtml = self::CONTENT_TYPE_META_TAG . $html; } return $reworkedHtml; } /** * Tests whether the given HTML has a valid `Content-Type` metadata element within the `<head>` element. Due to tag * omission rules, HTML parsers are expected to end the `<head>` element and start the `<body>` element upon * encountering a start tag for any element which is permitted only within the `<body>`. * * @param string $html * * @return bool */ private function hasContentTypeMetaTagInHead(string $html): bool { (new Preg())->match( '%^.*?(?=<meta(?=\\s)[^>]*\\shttp-equiv=(["\']?+)Content-Type\\g{-1}[\\s/>])%is', $html, $matches ); if (isset($matches[0])) { $htmlBefore = $matches[0]; try { $hasContentTypeMetaTagInHead = !$this->hasEndOfHeadElement($htmlBefore); } catch (\RuntimeException $exception) { // If something unexpected occurs, assume the `Content-Type` that was found is valid. \trigger_error($exception->getMessage()); $hasContentTypeMetaTagInHead = true; } } else { $hasContentTypeMetaTagInHead = false; } return $hasContentTypeMetaTagInHead; } /** * Tests whether the `<head>` element ends within the given HTML. Due to tag omission rules, HTML parsers are * expected to end the `<head>` element and start the `<body>` element upon encountering a start tag for any element * which is permitted only within the `<body>`. * * @param string $html * * @return bool * * @throws \RuntimeException */ private function hasEndOfHeadElement(string $html): bool { if ( (new Preg())->match('%<(?!' . self::TAGNAME_ALLOWED_BEFORE_BODY_MATCHER . '[\\s/>])\\w|</head>%i', $html) !== 0 ) { // An exception to the implicit end of the `<head>` is any content within a `<template>` element, as well in // comments. As an optimization, this is only checked for if a potential `<head>` end tag is found. $htmlWithoutCommentsOrTemplates = $this->removeHtmlTemplateElements($this->removeHtmlComments($html)); $hasEndOfHeadElement = $htmlWithoutCommentsOrTemplates === $html || $this->hasEndOfHeadElement($htmlWithoutCommentsOrTemplates); } else { $hasEndOfHeadElement = false; } return $hasEndOfHeadElement; } /** * Removes comments from the given HTML, including any which are unterminated, for which the remainder of the string * is removed. * * @param string $html * * @return string * * @throws \RuntimeException */ private function removeHtmlComments(string $html): string { return (new Preg())->throwExceptions(true)->replace(self::HTML_COMMENT_PATTERN, '', $html); } /** * Removes `<template>` elements from the given HTML, including any without an end tag, for which the remainder of * the string is removed. * * @param string $html * * @return string * * @throws \RuntimeException */ private function removeHtmlTemplateElements(string $html): string { return (new Preg())->throwExceptions(true)->replace(self::HTML_TEMPLATE_ELEMENT_PATTERN, '', $html); } /** * Makes sure that any self-closing tags not recognized as such by PHP's DOMDocument implementation have a * self-closing slash. * * @param string $html * * @return string HTML with problematic tags converted. */ private function ensurePhpUnrecognizedSelfClosingTagsAreXml(string $html): string { return (new Preg())->replace( '%<' . self::PHP_UNRECOGNIZED_VOID_TAGNAME_MATCHER . '\\b[^>]*+(?<!/)(?=>)%', '$0/', $html ); } /** * Checks that $this->domDocument has a BODY element and adds it if it is missing. * * @throws \UnexpectedValueException */ private function ensureExistenceOfBodyElement(): void { if ($this->getDomDocument()->getElementsByTagName('body')->item(0) instanceof \DOMElement) { return; } $this->getHtmlElement()->appendChild($this->getDomDocument()->createElement('body')); } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/HtmlProcessor/HtmlPruner.php 0000777 00000012342 15252010675 0024726 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\HtmlProcessor; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\CssInliner; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\ArrayIntersector; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\Preg; /** * This class can remove things from HTML. */ final class HtmlPruner extends AbstractHtmlProcessor { /** * We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only * supports XPath 1.0, lower-case() isn't available to us. We've thus far only set attributes to lowercase, * not attribute values. Consequently, we need to translate() the letters that would be in 'NONE' ("NOE") * to lowercase. * * @var string */ private const DISPLAY_NONE_MATCHER = '//*[@style and contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")' . ' and not(@class and contains(concat(" ", normalize-space(@class), " "), " -emogrifier-keep "))]'; /** * Removes elements that have a "display: none;" style. * * @return $this */ public function removeElementsWithDisplayNone(): self { $elementsWithStyleDisplayNone = $this->getXPath()->query(self::DISPLAY_NONE_MATCHER); if ($elementsWithStyleDisplayNone->length === 0) { return $this; } foreach ($elementsWithStyleDisplayNone as $element) { $parentNode = $element->parentNode; if ($parentNode !== null) { $parentNode->removeChild($element); } } return $this; } /** * Removes classes that are no longer required (e.g. because there are no longer any CSS rules that reference them) * from `class` attributes. * * Note that this does not inspect the CSS, but expects to be provided with a list of classes that are still in use. * * This method also has the (presumably beneficial) side-effect of minifying (removing superfluous whitespace from) * `class` attributes. * * @param array<array-key, string> $classesToKeep names of classes that should not be removed * * @return $this */ public function removeRedundantClasses(array $classesToKeep = []): self { $elementsWithClassAttribute = $this->getXPath()->query('//*[@class]'); if ($classesToKeep !== []) { $this->removeClassesFromElements($elementsWithClassAttribute, $classesToKeep); } else { // Avoid unnecessary processing if there are no classes to keep. $this->removeClassAttributeFromElements($elementsWithClassAttribute); } return $this; } /** * Removes classes from the `class` attribute of each element in `$elements`, except any in `$classesToKeep`, * removing the `class` attribute itself if the resultant list is empty. * * @param \DOMNodeList $elements * @param array<array-key, string> $classesToKeep */ private function removeClassesFromElements(\DOMNodeList $elements, array $classesToKeep): void { $classesToKeepIntersector = new ArrayIntersector($classesToKeep); $preg = new Preg(); /** @var \DOMElement $element */ foreach ($elements as $element) { $elementClasses = $preg->split('/\\s++/', \trim($element->getAttribute('class'))); $elementClassesToKeep = $classesToKeepIntersector->intersectWith($elementClasses); if ($elementClassesToKeep !== []) { $element->setAttribute('class', \implode(' ', $elementClassesToKeep)); } else { $element->removeAttribute('class'); } } } /** * Removes the `class` attribute from each element in `$elements`. * * @param \DOMNodeList $elements */ private function removeClassAttributeFromElements(\DOMNodeList $elements): void { /** @var \DOMElement $element */ foreach ($elements as $element) { $element->removeAttribute('class'); } } /** * After CSS has been inlined, there will likely be some classes in `class` attributes that are no longer referenced * by any remaining (uninlinable) CSS. This method removes such classes. * * Note that it does not inspect the remaining CSS, but uses information readily available from the `CssInliner` * instance about the CSS rules that could not be inlined. * * @param CssInliner $cssInliner object instance that performed the CSS inlining * * @return $this * * @throws \BadMethodCallException if `inlineCss` has not first been called on `$cssInliner` */ public function removeRedundantClassesAfterCssInlined(CssInliner $cssInliner): self { $preg = new Preg(); $classesToKeepAsKeys = []; foreach ($cssInliner->getMatchingUninlinableSelectors() as $selector) { $preg->matchAll('/\\.(-?+[_a-zA-Z][\\w\\-]*+)/', $selector, $matches); $classesToKeepAsKeys += \array_fill_keys($matches[1], true); } $this->removeRedundantClasses(\array_keys($classesToKeepAsKeys)); return $this; } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/HtmlProcessor/CssToAttributeConverter.php 0000777 00000021512 15252010675 0027434 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\HtmlProcessor; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\DeclarationBlockParser; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\Preg; /** * This HtmlProcessor can convert style HTML attributes to the corresponding other visual HTML attributes, * e.g. it converts style="width: 100px" to width="100". * * It will only add attributes, but leaves the style attribute untouched. * * To trigger the conversion, call the convertCssToVisualAttributes method. */ final class CssToAttributeConverter extends AbstractHtmlProcessor { /** * This multi-level array contains simple mappings of CSS properties to * HTML attributes. If a mapping only applies to certain HTML nodes or * only for certain values, the mapping is an object with an allowlist * of nodes and values. * * @var array<string, array{attribute: string, nodes?: array<int, string>, values?: array<int, string>}> */ private $cssToHtmlMap = [ 'background-color' => [ 'attribute' => 'bgcolor', ], 'text-align' => [ 'attribute' => 'align', 'nodes' => ['p', 'div', 'td', 'th'], 'values' => ['left', 'right', 'center', 'justify'], ], 'float' => [ 'attribute' => 'align', 'nodes' => ['table', 'img'], 'values' => ['left', 'right'], ], 'border-spacing' => [ 'attribute' => 'cellspacing', 'nodes' => ['table'], ], ]; /** * Maps the CSS from the style nodes to visual HTML attributes. * * @return $this */ public function convertCssToVisualAttributes(): self { $declarationBlockParser = new DeclarationBlockParser(); /** @var \DOMElement $node */ foreach ($this->getAllNodesWithStyleAttribute() as $node) { $inlineStyleDeclarations = $declarationBlockParser->parse($node->getAttribute('style')); $this->mapCssToHtmlAttributes($inlineStyleDeclarations, $node); } return $this; } /** * Returns a list with all DOM nodes that have a style attribute. * * @return \DOMNodeList */ private function getAllNodesWithStyleAttribute(): \DOMNodeList { return $this->getXPath()->query('//*[@style]'); } /** * Applies $styles to $node. * * This method maps CSS styles to HTML attributes and adds those to the * node. * * @param array<string, string> $styles the new CSS styles taken from the global styles to be applied to this node * @param \DOMElement $node node to apply styles to */ private function mapCssToHtmlAttributes(array $styles, \DOMElement $node): void { foreach ($styles as $property => $value) { // Strip !important indicator $value = \trim(\str_replace('!important', '', $value)); $this->mapCssToHtmlAttribute($property, $value, $node); } } /** * Tries to apply the CSS style to $node as an attribute. * * This method maps a CSS rule to HTML attributes and adds those to the node. * * @param string $property the name of the CSS property to map * @param string $value the value of the style rule to map * @param \DOMElement $node node to apply styles to */ private function mapCssToHtmlAttribute(string $property, string $value, \DOMElement $node): void { if (!$this->mapSimpleCssProperty($property, $value, $node)) { $this->mapComplexCssProperty($property, $value, $node); } } /** * Looks up the CSS property in the mapping table and maps it if it matches the conditions. * * @param string $property the name of the CSS property to map * @param string $value the value of the style rule to map * @param \DOMElement $node node to apply styles to * * @return bool true if the property can be mapped using the simple mapping table */ private function mapSimpleCssProperty(string $property, string $value, \DOMElement $node): bool { if (!isset($this->cssToHtmlMap[$property])) { return false; } $mapping = $this->cssToHtmlMap[$property]; $nodesMatch = !isset($mapping['nodes']) || \in_array($node->nodeName, $mapping['nodes'], true); $valuesMatch = !isset($mapping['values']) || \in_array($value, $mapping['values'], true); $canBeMapped = $nodesMatch && $valuesMatch; if ($canBeMapped) { $node->setAttribute($mapping['attribute'], $value); } return $canBeMapped; } /** * Maps CSS properties that need special transformation to an HTML attribute. * * @param string $property the name of the CSS property to map * @param string $value the value of the style rule to map * @param \DOMElement $node node to apply styles to */ private function mapComplexCssProperty(string $property, string $value, \DOMElement $node): void { switch ($property) { case 'background': $this->mapBackgroundProperty($node, $value); break; case 'width': // intentional fall-through case 'height': $this->mapWidthOrHeightProperty($node, $value, $property); break; case 'margin': $this->mapMarginProperty($node, $value); break; case 'border': $this->mapBorderProperty($node, $value); break; default: } } /** * @param \DOMElement $node node to apply styles to * @param string $value the value of the style rule to map */ private function mapBackgroundProperty(\DOMElement $node, string $value): void { // parse out the color, if any /** @var array<int, string> $styles */ $styles = \explode(' ', $value, 2); $first = $styles[0]; if (\is_numeric($first[0]) || \strncmp($first, 'url', 3) === 0) { return; } // as this is not a position or image, assume it's a color $node->setAttribute('bgcolor', $first); } /** * @param \DOMElement $node node to apply styles to * @param string $value the value of the style rule to map * @param string $property the name of the CSS property to map */ private function mapWidthOrHeightProperty(\DOMElement $node, string $value, string $property): void { $preg = new Preg(); // only parse values in px and %, but not values like "auto" if ($preg->match('/^(\\d+)(\\.(\\d+))?(px|%)$/', $value) === 0) { return; } $number = $preg->replace('/[^0-9.%]/', '', $value); $node->setAttribute($property, $number); } /** * @param \DOMElement $node node to apply styles to * @param string $value the value of the style rule to map */ private function mapMarginProperty(\DOMElement $node, string $value): void { if (!$this->isTableOrImageNode($node)) { return; } $margins = $this->parseCssShorthandValue($value); if ($margins['left'] === 'auto' && $margins['right'] === 'auto') { $node->setAttribute('align', 'center'); } } /** * @param \DOMElement $node node to apply styles to * @param string $value the value of the style rule to map */ private function mapBorderProperty(\DOMElement $node, string $value): void { if (!$this->isTableOrImageNode($node)) { return; } if ($value === 'none' || $value === '0') { $node->setAttribute('border', '0'); } } /** * @param \DOMElement $node * * @return bool */ private function isTableOrImageNode(\DOMElement $node): bool { return $node->nodeName === 'table' || $node->nodeName === 'img'; } /** * Parses a shorthand CSS value and splits it into individual values. For example: `padding: 0 auto;` - `0 auto` is * split into top: 0, left: auto, bottom: 0, right: auto. * * @param string $value a CSS property value with 1, 2, 3 or 4 sizes * * @return array<string, string> * an array of values for top, right, bottom and left (using these as associative array keys) */ private function parseCssShorthandValue(string $value): array { $values = (new Preg())->split('/\\s+/', $value); $css = []; $css['top'] = $values[0]; $css['right'] = (\count($values) > 1) ? $values[1] : $css['top']; $css['bottom'] = (\count($values) > 2) ? $values[2] : $css['top']; $css['left'] = (\count($values) > 3) ? $values[3] : $css['right']; return $css; } } email-editor/vendor-prefixed/packages/Pelago/Emogrifier/HtmlProcessor/HtmlNormalizer.php 0000777 00000000560 15252010675 0025574 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\HtmlProcessor; /** * Normalizes HTML: * - add a document type (HTML5) if missing * - disentangle incorrectly nested tags * - add HEAD and BODY elements (if they are missing) * - reformat the HTML */ final class HtmlNormalizer extends AbstractHtmlProcessor {} email-editor/vendor-prefixed/packages/Pelago/Emogrifier/HtmlProcessor/CssVariableEvaluator.php 0000777 00000016324 15252010675 0026713 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\HtmlProcessor; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\DeclarationBlockParser; use Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\Utilities\Preg; /** * This class can evaluate CSS custom properties that are defined and used in inline style attributes. */ final class CssVariableEvaluator extends AbstractHtmlProcessor { /** * temporary collection used by {@see replaceVariablesInDeclarations} and callee methods * * @var array<non-empty-string, string> */ private $currentVariableDefinitions = []; /** * Replaces all CSS custom property references in inline style attributes with their corresponding values where * defined in inline style attributes (either from the element itself or the nearest ancestor). * * @return $this * * @throws \UnexpectedValueException */ public function evaluateVariables(): self { return $this->evaluateVariablesInElementAndDescendants($this->getHtmlElement(), []); } /** * @param array<non-empty-string, string> $declarations * * @return array<non-empty-string, string> */ private function getVariableDefinitionsFromDeclarations(array $declarations): array { return \array_filter( $declarations, static function (string $key): bool { return \substr($key, 0, 2) === '--'; }, ARRAY_FILTER_USE_KEY ); } /** * Callback function for {@see replaceVariablesInPropertyValue} performing regular expression replacement. * * @param array<int, string> $matches */ private function getPropertyValueReplacement(array $matches): string { $variableName = $matches[1]; if (isset($this->currentVariableDefinitions[$variableName])) { $variableValue = $this->currentVariableDefinitions[$variableName]; } else { $fallbackValueSeparator = $matches[2] ?? ''; if ($fallbackValueSeparator !== '') { $fallbackValue = $matches[3]; // The fallback value may use other CSS variables, so recurse $variableValue = $this->replaceVariablesInPropertyValue($fallbackValue); } else { $variableValue = $matches[0]; } } return $variableValue; } /** * Regular expression based on {@see https://stackoverflow.com/a/54143883/2511031 a StackOverflow answer}. */ private function replaceVariablesInPropertyValue(string $propertyValue): string { return (new Preg())->replaceCallback( '/ var\\( \\s*+ # capture variable name including `--` prefix ( --[^\\s\\),]++ ) \\s*+ # capture optional fallback value (?: # capture separator to confirm there is a fallback value (,)\\s* # begin capture with named group that can be used recursively (?<recursable> # begin named group to match sequence without parentheses, except in strings (?<noparentheses> # repeated zero or more times: (?: # sequence without parentheses or quotes [^\\(\\)\'"]++ | # string in double quotes "(?>[^"\\\\]++|\\\\.)*" | # string in single quotes \'(?>[^\'\\\\]++|\\\\.)*\' )*+ ) # repeated zero or more times: (?: # sequence in parentheses \\( # using the named recursable pattern (?&recursable) \\) # sequence without parentheses, except in strings (?&noparentheses) )*+ ) )?+ \\) /x', \Closure::fromCallable([$this, 'getPropertyValueReplacement']), $propertyValue ); } /** * @param array<non-empty-string, string> $declarations * * @return ?array<non-empty-string, string> `null` is returned if no substitutions were made. */ private function replaceVariablesInDeclarations(array $declarations): ?array { $substitutionsMade = false; $result = \array_map( function (string $propertyValue) use (&$substitutionsMade): string { $newPropertyValue = $this->replaceVariablesInPropertyValue($propertyValue); if ($newPropertyValue !== $propertyValue) { $substitutionsMade = true; } return $newPropertyValue; }, $declarations ); return $substitutionsMade ? $result : null; } /** * @param array<non-empty-string, string> $declarations */ private function getDeclarationsAsString(array $declarations): string { $declarationStrings = \array_map( static function (string $key, string $value): string { return $key . ': ' . $value; }, \array_keys($declarations), \array_values($declarations) ); return \implode('; ', $declarationStrings) . ';'; } /** * @param array<non-empty-string, string> $ancestorVariableDefinitions * * @return $this */ private function evaluateVariablesInElementAndDescendants( \DOMElement $element, array $ancestorVariableDefinitions ): self { $style = $element->getAttribute('style'); // Avoid parsing declarations if none use or define a variable if ((new Preg())->match('/(?<![\\w\\-])--[\\w\\-]/', $style) !== 0) { $declarations = (new DeclarationBlockParser())->parse($style); $variableDefinitions = $this->currentVariableDefinitions = $this->getVariableDefinitionsFromDeclarations($declarations) + $ancestorVariableDefinitions; $newDeclarations = $this->replaceVariablesInDeclarations($declarations); if ($newDeclarations !== null) { $element->setAttribute('style', $this->getDeclarationsAsString($newDeclarations)); } } else { $variableDefinitions = $ancestorVariableDefinitions; } foreach ($element->childNodes as $child) { if ($child instanceof \DOMElement) { $this->evaluateVariablesInElementAndDescendants($child, $variableDefinitions); } } return $this; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Parser.php 0000777 00000003724 15252010675 0020516 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList\Document; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\SourceException; /** * This class parses CSS from text into a data structure. */ class Parser { /** * @var ParserState */ private $oParserState; /** * @param string $sText the complete CSS as text (i.e., usually the contents of a CSS file) * @param Settings|null $oParserSettings * @param int $iLineNo the line number (starting from 1, not from 0) */ public function __construct($sText, $oParserSettings = null, $iLineNo = 1) { if ($oParserSettings === null) { $oParserSettings = Settings::create(); } $this->oParserState = new ParserState($sText, $oParserSettings, $iLineNo); } /** * Sets the charset to be used if the CSS does not contain an `@charset` declaration. * * @param string $sCharset * * @return void * * @deprecated since 8.7.0, will be removed in version 9.0.0 with #687 */ public function setCharset($sCharset) { $this->oParserState->setCharset($sCharset); } /** * Returns the charset that is used if the CSS does not contain an `@charset` declaration. * * @return void * * @deprecated since 8.7.0, will be removed in version 9.0.0 with #687 */ public function getCharset() { // Note: The `return` statement is missing here. This is a bug that needs to be fixed. $this->oParserState->getCharset(); } /** * Parses the CSS provided to the constructor and creates a `Document` from it. * * @return Document * * @throws SourceException */ public function parse() { return Document::parse($this->oParserState); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Comment/Comment.php 0000777 00000002711 15252010675 0022261 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Renderable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Positionable; class Comment implements Positionable, Renderable { use Position; /** * @var string * * @internal since 8.8.0 */ protected $sComment; /** * @param string $sComment * @param int $iLineNo */ public function __construct($sComment = '', $iLineNo = 0) { $this->sComment = $sComment; $this->setPosition($iLineNo); } /** * @return string */ public function getComment() { return $this->sComment; } /** * @param string $sComment * * @return void */ public function setComment($sComment) { $this->sComment = $sComment; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return '/*' . $this->sComment . '*/'; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Comment/Commentable.php 0000777 00000000755 15252010675 0023113 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment; interface Commentable { /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments); /** * @return array<array-key, Comment> */ public function getComments(); /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments); } email-editor/vendor-prefixed/packages/Sabberworm/CSS/CSSList/CSSBlockList.php 0000777 00000017156 15252010675 0023011 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Rule\Rule; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\DeclarationBlock; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\RuleSet; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\CSSFunction; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\ValueList; /** * A `CSSBlockList` is a `CSSList` whose `DeclarationBlock`s are guaranteed to contain valid declaration blocks or * at-rules. * * Most `CSSList`s conform to this category but some at-rules (such as `@keyframes`) do not. */ abstract class CSSBlockList extends CSSList { /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); } /** * @param array<int, DeclarationBlock> $aResult * * @return void */ protected function allDeclarationBlocks(array &$aResult) { foreach ($this->aContents as $mContent) { if ($mContent instanceof DeclarationBlock) { $aResult[] = $mContent; } elseif ($mContent instanceof CSSBlockList) { $mContent->allDeclarationBlocks($aResult); } } } /** * @param array<int, RuleSet> $aResult * * @return void */ protected function allRuleSets(array &$aResult) { foreach ($this->aContents as $mContent) { if ($mContent instanceof RuleSet) { $aResult[] = $mContent; } elseif ($mContent instanceof CSSBlockList) { $mContent->allRuleSets($aResult); } } } /** * Returns all `Value` objects found recursively in `Rule`s in the tree. * * @param CSSElement|string|null $element * This is the `CSSList` or `RuleSet` to start the search from (defaults to the whole document). * If a string is given, it is used as a rule name filter. * Passing a string for this parameter is deprecated in version 8.9.0, and will not work from v9.0; * use the following parameter to pass a rule name filter instead. * @param string|bool|null $ruleSearchPatternOrSearchInFunctionArguments * This allows filtering rules by property name * (e.g. if "color" is passed, only `Value`s from `color` properties will be returned, * or if "font-" is provided, `Value`s from all font rules, like `font-size`, and including `font` itself, * will be returned). * If a Boolean is provided, it is treated as the `$searchInFunctionArguments` argument. * Passing a Boolean for this parameter is deprecated in version 8.9.0, and will not work from v9.0; * use the `$searchInFunctionArguments` parameter instead. * @param bool $searchInFunctionArguments whether to also return Value objects used as Function arguments. * * @return array<int, Value> * * @see RuleSet->getRules() */ public function getAllValues( $element = null, $ruleSearchPatternOrSearchInFunctionArguments = null, $searchInFunctionArguments = false ) { if (\is_bool($ruleSearchPatternOrSearchInFunctionArguments)) { $searchInFunctionArguments = $ruleSearchPatternOrSearchInFunctionArguments; $searchString = null; } else { $searchString = $ruleSearchPatternOrSearchInFunctionArguments; } if ($element === null) { $element = $this; } elseif (\is_string($element)) { $searchString = $element; $element = $this; } $result = []; $this->allValues($element, $result, $searchString, $searchInFunctionArguments); return $result; } /** * @param CSSElement|string $oElement * @param array<int, Value> $aResult * @param string|null $sSearchString * @param bool $bSearchInFunctionArguments * * @return void */ protected function allValues($oElement, array &$aResult, $sSearchString = null, $bSearchInFunctionArguments = false) { if ($oElement instanceof CSSBlockList) { foreach ($oElement->getContents() as $oContent) { $this->allValues($oContent, $aResult, $sSearchString, $bSearchInFunctionArguments); } } elseif ($oElement instanceof RuleSet) { foreach ($oElement->getRules($sSearchString) as $oRule) { $this->allValues($oRule, $aResult, $sSearchString, $bSearchInFunctionArguments); } } elseif ($oElement instanceof Rule) { $this->allValues($oElement->getValue(), $aResult, $sSearchString, $bSearchInFunctionArguments); } elseif ($oElement instanceof ValueList) { if ($bSearchInFunctionArguments || !($oElement instanceof CSSFunction)) { foreach ($oElement->getListComponents() as $mComponent) { $this->allValues($mComponent, $aResult, $sSearchString, $bSearchInFunctionArguments); } } } else { // Non-List `Value` or `CSSString` (CSS identifier) $aResult[] = $oElement; } } /** * @param array<int, Selector> $aResult * @param string|null $sSpecificitySearch * * @return void */ protected function allSelectors(array &$aResult, $sSpecificitySearch = null) { /** @var array<int, DeclarationBlock> $aDeclarationBlocks */ $aDeclarationBlocks = []; $this->allDeclarationBlocks($aDeclarationBlocks); foreach ($aDeclarationBlocks as $oBlock) { foreach ($oBlock->getSelectors() as $oSelector) { if ($sSpecificitySearch === null) { $aResult[] = $oSelector; } else { $sComparator = '==='; $aSpecificitySearch = explode(' ', $sSpecificitySearch); $iTargetSpecificity = $aSpecificitySearch[0]; if (count($aSpecificitySearch) > 1) { $sComparator = $aSpecificitySearch[0]; $iTargetSpecificity = $aSpecificitySearch[1]; } $iTargetSpecificity = (int)$iTargetSpecificity; $iSelectorSpecificity = $oSelector->getSpecificity(); $bMatches = false; switch ($sComparator) { case '<=': $bMatches = $iSelectorSpecificity <= $iTargetSpecificity; break; case '<': $bMatches = $iSelectorSpecificity < $iTargetSpecificity; break; case '>=': $bMatches = $iSelectorSpecificity >= $iTargetSpecificity; break; case '>': $bMatches = $iSelectorSpecificity > $iTargetSpecificity; break; default: $bMatches = $iSelectorSpecificity === $iTargetSpecificity; break; } if ($bMatches) { $aResult[] = $oSelector; } } } } } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/CSSList/Document.php 0000777 00000010571 15252010675 0022322 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\DeclarationBlock; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\RuleSet; /** * This class represents the root of a parsed CSS file. It contains all top-level CSS contents: mostly declaration * blocks, but also any at-rules encountered (`Import` and `Charset`). */ class Document extends CSSBlockList { /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); } /** * @return Document * * @throws SourceException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState) { $oDocument = new Document($oParserState->currentLine()); CSSList::parseList($oParserState, $oDocument); return $oDocument; } /** * Gets all `DeclarationBlock` objects recursively, no matter how deeply nested the selectors are. * Aliased as `getAllSelectors()`. * * @return array<int, DeclarationBlock> */ public function getAllDeclarationBlocks() { /** @var array<int, DeclarationBlock> $aResult */ $aResult = []; $this->allDeclarationBlocks($aResult); return $aResult; } /** * Gets all `DeclarationBlock` objects recursively. * * @return array<int, DeclarationBlock> * * @deprecated will be removed in version 9.0; use `getAllDeclarationBlocks()` instead */ public function getAllSelectors() { return $this->getAllDeclarationBlocks(); } /** * Returns all `RuleSet` objects recursively found in the tree, no matter how deeply nested the rule sets are. * * @return array<int, RuleSet> */ public function getAllRuleSets() { /** @var array<int, RuleSet> $aResult */ $aResult = []; $this->allRuleSets($aResult); return $aResult; } /** * Returns all `Selector` objects with the requested specificity found recursively in the tree. * * Note that this does not yield the full `DeclarationBlock` that the selector belongs to * (and, currently, there is no way to get to that). * * @param string|null $sSpecificitySearch * An optional filter by specificity. * May contain a comparison operator and a number or just a number (defaults to "=="). * * @return array<int, Selector> * @example `getSelectorsBySpecificity('>= 100')` * */ public function getSelectorsBySpecificity($sSpecificitySearch = null) { /** @var array<int, Selector> $aResult */ $aResult = []; $this->allSelectors($aResult, $sSpecificitySearch); return $aResult; } /** * Expands all shorthand properties to their long value. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandShorthands() { foreach ($this->getAllDeclarationBlocks() as $oDeclaration) { $oDeclaration->expandShorthands(); } } /** * Create shorthands properties whenever possible. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createShorthands() { foreach ($this->getAllDeclarationBlocks() as $oDeclaration) { $oDeclaration->createShorthands(); } } /** * Overrides `render()` to make format argument optional. * * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat = null) { if ($oOutputFormat === null) { $oOutputFormat = new OutputFormat(); } return $oOutputFormat->comments($this) . $this->renderListContents($oOutputFormat); } /** * @return bool */ public function isRootList() { return true; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/CSSList/AtRuleBlockList.php 0000777 00000003664 15252010675 0023554 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\AtRule; /** * A `BlockList` constructed by an unknown at-rule. `@media` rules are rendered into `AtRuleBlockList` objects. */ class AtRuleBlockList extends CSSBlockList implements AtRule { /** * @var string */ private $sType; /** * @var string */ private $sArgs; /** * @param string $sType * @param string $sArgs * @param int $iLineNo */ public function __construct($sType, $sArgs = '', $iLineNo = 0) { parent::__construct($iLineNo); $this->sType = $sType; $this->sArgs = $sArgs; } /** * @return string */ public function atRuleName() { return $this->sType; } /** * @return string */ public function atRuleArgs() { return $this->sArgs; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sResult = $oOutputFormat->comments($this); $sResult .= $oOutputFormat->sBeforeAtRuleBlock; $sArgs = $this->sArgs; if ($sArgs) { $sArgs = ' ' . $sArgs; } $sResult .= "@{$this->sType}$sArgs{$oOutputFormat->spaceBeforeOpeningBrace()}{"; $sResult .= $this->renderListContents($oOutputFormat); $sResult .= '}'; $sResult .= $oOutputFormat->sAfterAtRuleBlock; return $sResult; } /** * @return bool */ public function isRootList() { return false; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/CSSList/CSSList.php 0000777 00000041563 15252010675 0022035 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\AtRule; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\Charset; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\CSSNamespace; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\Import; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Renderable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\AtRuleSet; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\DeclarationBlock; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet\RuleSet; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Settings; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\CSSString; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\URL; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\Value; /** * This is the most generic container available. It can contain `DeclarationBlock`s (rule sets with a selector), * `RuleSet`s as well as other `CSSList` objects. * * It can also contain `Import` and `Charset` objects stemming from at-rules. */ abstract class CSSList implements Commentable, CSSElement, Positionable { use Position; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @var array<int, RuleSet|CSSList|Import|Charset> * * @internal since 8.8.0 */ protected $aContents; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { $this->aComments = []; $this->aContents = []; $this->setPosition($iLineNo); } /** * @return void * * @throws UnexpectedTokenException * @throws SourceException * * @internal since V8.8.0 */ public static function parseList(ParserState $oParserState, CSSList $oList) { $bIsRoot = $oList instanceof Document; if (is_string($oParserState)) { $oParserState = new ParserState($oParserState, Settings::create()); } $bLenientParsing = $oParserState->getSettings()->bLenientParsing; $aComments = []; while (!$oParserState->isEnd()) { $aComments = array_merge($aComments, $oParserState->consumeWhiteSpace()); $oListItem = null; if ($bLenientParsing) { try { $oListItem = self::parseListItem($oParserState, $oList); } catch (UnexpectedTokenException $e) { $oListItem = false; } } else { $oListItem = self::parseListItem($oParserState, $oList); } if ($oListItem === null) { // List parsing finished return; } if ($oListItem) { $oListItem->addComments($aComments); $oList->append($oListItem); } $aComments = $oParserState->consumeWhiteSpace(); } $oList->addComments($aComments); if (!$bIsRoot && !$bLenientParsing) { throw new SourceException("Unexpected end of document", $oParserState->currentLine()); } } /** * @return AtRuleBlockList|KeyFrame|Charset|CSSNamespace|Import|AtRuleSet|DeclarationBlock|null|false * * @throws SourceException * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ private static function parseListItem(ParserState $oParserState, CSSList $oList) { $bIsRoot = $oList instanceof Document; if ($oParserState->comes('@')) { $oAtRule = self::parseAtRule($oParserState); if ($oAtRule instanceof Charset) { if (!$bIsRoot) { throw new UnexpectedTokenException( '@charset may only occur in root document', '', 'custom', $oParserState->currentLine() ); } if (count($oList->getContents()) > 0) { throw new UnexpectedTokenException( '@charset must be the first parseable token in a document', '', 'custom', $oParserState->currentLine() ); } $oParserState->setCharset($oAtRule->getCharset()); } return $oAtRule; } elseif ($oParserState->comes('}')) { if ($bIsRoot) { if ($oParserState->getSettings()->bLenientParsing) { return DeclarationBlock::parse($oParserState); } else { throw new SourceException("Unopened {", $oParserState->currentLine()); } } else { // End of list return null; } } else { return DeclarationBlock::parse($oParserState, $oList); } } /** * @param ParserState $oParserState * * @return AtRuleBlockList|KeyFrame|Charset|CSSNamespace|Import|AtRuleSet|null * * @throws SourceException * @throws UnexpectedTokenException * @throws UnexpectedEOFException */ private static function parseAtRule(ParserState $oParserState) { $oParserState->consume('@'); $sIdentifier = $oParserState->parseIdentifier(); $iIdentifierLineNum = $oParserState->currentLine(); $oParserState->consumeWhiteSpace(); if ($sIdentifier === 'import') { $oLocation = URL::parse($oParserState); $oParserState->consumeWhiteSpace(); $sMediaQuery = null; if (!$oParserState->comes(';')) { $sMediaQuery = trim($oParserState->consumeUntil([';', ParserState::EOF])); } $oParserState->consumeUntil([';', ParserState::EOF], true, true); return new Import($oLocation, $sMediaQuery ?: null, $iIdentifierLineNum); } elseif ($sIdentifier === 'charset') { $oCharsetString = CSSString::parse($oParserState); $oParserState->consumeWhiteSpace(); $oParserState->consumeUntil([';', ParserState::EOF], true, true); return new Charset($oCharsetString, $iIdentifierLineNum); } elseif (self::identifierIs($sIdentifier, 'keyframes')) { $oResult = new KeyFrame($iIdentifierLineNum); $oResult->setVendorKeyFrame($sIdentifier); $oResult->setAnimationName(trim($oParserState->consumeUntil('{', false, true))); CSSList::parseList($oParserState, $oResult); if ($oParserState->comes('}')) { $oParserState->consume('}'); } return $oResult; } elseif ($sIdentifier === 'namespace') { $sPrefix = null; $mUrl = Value::parsePrimitiveValue($oParserState); if (!$oParserState->comes(';')) { $sPrefix = $mUrl; $mUrl = Value::parsePrimitiveValue($oParserState); } $oParserState->consumeUntil([';', ParserState::EOF], true, true); if ($sPrefix !== null && !is_string($sPrefix)) { throw new UnexpectedTokenException('Wrong namespace prefix', $sPrefix, 'custom', $iIdentifierLineNum); } if (!($mUrl instanceof CSSString || $mUrl instanceof URL)) { throw new UnexpectedTokenException( 'Wrong namespace url of invalid type', $mUrl, 'custom', $iIdentifierLineNum ); } return new CSSNamespace($mUrl, $sPrefix, $iIdentifierLineNum); } else { // Unknown other at rule (font-face or such) $sArgs = trim($oParserState->consumeUntil('{', false, true)); if (substr_count($sArgs, "(") != substr_count($sArgs, ")")) { if ($oParserState->getSettings()->bLenientParsing) { return null; } else { throw new SourceException("Unmatched brace count in media query", $oParserState->currentLine()); } } $bUseRuleSet = true; foreach (explode('/', AtRule::BLOCK_RULES) as $sBlockRuleName) { if (self::identifierIs($sIdentifier, $sBlockRuleName)) { $bUseRuleSet = false; break; } } if ($bUseRuleSet) { $oAtRule = new AtRuleSet($sIdentifier, $sArgs, $iIdentifierLineNum); RuleSet::parseRuleSet($oParserState, $oAtRule); } else { $oAtRule = new AtRuleBlockList($sIdentifier, $sArgs, $iIdentifierLineNum); CSSList::parseList($oParserState, $oAtRule); if ($oParserState->comes('}')) { $oParserState->consume('}'); } } return $oAtRule; } } /** * Tests an identifier for a given value. Since identifiers are all keywords, they can be vendor-prefixed. * We need to check for these versions too. * * @param string $sIdentifier * @param string $sMatch * * @return bool */ private static function identifierIs($sIdentifier, $sMatch) { return (strcasecmp($sIdentifier, $sMatch) === 0) ?: preg_match("/^(-\\w+-)?$sMatch$/i", $sIdentifier) === 1; } /** * Prepends an item to the list of contents. * * @param RuleSet|CSSList|Import|Charset $oItem * * @return void */ public function prepend($oItem) { array_unshift($this->aContents, $oItem); } /** * Appends an item to the list of contents. * * @param RuleSet|CSSList|Import|Charset $oItem * * @return void */ public function append($oItem) { $this->aContents[] = $oItem; } /** * Splices the list of contents. * * @param int $iOffset * @param int $iLength * @param array<int, RuleSet|CSSList|Import|Charset> $mReplacement * * @return void */ public function splice($iOffset, $iLength = null, $mReplacement = null) { array_splice($this->aContents, $iOffset, $iLength, $mReplacement); } /** * Inserts an item in the CSS list before its sibling. If the desired sibling cannot be found, * the item is appended at the end. * * @param RuleSet|CSSList|Import|Charset $item * @param RuleSet|CSSList|Import|Charset $sibling */ public function insertBefore($item, $sibling) { if (in_array($sibling, $this->aContents, true)) { $this->replace($sibling, [$item, $sibling]); } else { $this->append($item); } } /** * Removes an item from the CSS list. * * @param RuleSet|Import|Charset|CSSList $oItemToRemove * May be a RuleSet (most likely a DeclarationBlock), a Import, * a Charset or another CSSList (most likely a MediaQuery) * * @return bool whether the item was removed */ public function remove($oItemToRemove) { $iKey = array_search($oItemToRemove, $this->aContents, true); if ($iKey !== false) { unset($this->aContents[$iKey]); return true; } return false; } /** * Replaces an item from the CSS list. * * @param RuleSet|Import|Charset|CSSList $oOldItem * May be a `RuleSet` (most likely a `DeclarationBlock`), an `Import`, a `Charset` * or another `CSSList` (most likely a `MediaQuery`) * * @return bool */ public function replace($oOldItem, $mNewItem) { $iKey = array_search($oOldItem, $this->aContents, true); if ($iKey !== false) { if (is_array($mNewItem)) { array_splice($this->aContents, $iKey, 1, $mNewItem); } else { array_splice($this->aContents, $iKey, 1, [$mNewItem]); } return true; } return false; } /** * @param array<int, RuleSet|Import|Charset|CSSList> $aContents */ public function setContents(array $aContents) { $this->aContents = []; foreach ($aContents as $content) { $this->append($content); } } /** * Removes a declaration block from the CSS list if it matches all given selectors. * * @param DeclarationBlock|array<array-key, Selector>|string $mSelector the selectors to match * @param bool $bRemoveAll whether to stop at the first declaration block found or remove all blocks * * @return void */ public function removeDeclarationBlockBySelector($mSelector, $bRemoveAll = false) { if ($mSelector instanceof DeclarationBlock) { $mSelector = $mSelector->getSelectors(); } if (!is_array($mSelector)) { $mSelector = explode(',', $mSelector); } foreach ($mSelector as $iKey => &$mSel) { if (!($mSel instanceof Selector)) { if (!Selector::isValid($mSel)) { throw new UnexpectedTokenException( "Selector did not match '" . Selector::SELECTOR_VALIDATION_RX . "'.", $mSel, "custom" ); } $mSel = new Selector($mSel); } } foreach ($this->aContents as $iKey => $mItem) { if (!($mItem instanceof DeclarationBlock)) { continue; } if ($mItem->getSelectors() == $mSelector) { unset($this->aContents[$iKey]); if (!$bRemoveAll) { return; } } } } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @return string */ protected function renderListContents(OutputFormat $oOutputFormat) { $sResult = ''; $bIsFirst = true; $oNextLevel = $oOutputFormat; if (!$this->isRootList()) { $oNextLevel = $oOutputFormat->nextLevel(); } foreach ($this->aContents as $oContent) { $sRendered = $oOutputFormat->safely(function () use ($oNextLevel, $oContent) { return $oContent->render($oNextLevel); }); if ($sRendered === null) { continue; } if ($bIsFirst) { $bIsFirst = false; $sResult .= $oNextLevel->spaceBeforeBlocks(); } else { $sResult .= $oNextLevel->spaceBetweenBlocks(); } $sResult .= $sRendered; } if (!$bIsFirst) { // Had some output $sResult .= $oOutputFormat->spaceAfterBlocks(); } return $sResult; } /** * Return true if the list can not be further outdented. Only important when rendering. * * @return bool */ abstract public function isRootList(); /** * Returns the stored items. * * @return array<int, RuleSet|Import|Charset|CSSList> */ public function getContents() { return $this->aContents; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/CSSList/KeyFrame.php 0000777 00000004310 15252010675 0022241 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\AtRule; class KeyFrame extends CSSList implements AtRule { /** * @var string|null */ private $vendorKeyFrame; /** * @var string|null */ private $animationName; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); $this->vendorKeyFrame = null; $this->animationName = null; } /** * @param string $vendorKeyFrame */ public function setVendorKeyFrame($vendorKeyFrame) { $this->vendorKeyFrame = $vendorKeyFrame; } /** * @return string|null */ public function getVendorKeyFrame() { return $this->vendorKeyFrame; } /** * @param string $animationName */ public function setAnimationName($animationName) { $this->animationName = $animationName; } /** * @return string|null */ public function getAnimationName() { return $this->animationName; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sResult = $oOutputFormat->comments($this); $sResult .= "@{$this->vendorKeyFrame} {$this->animationName}{$oOutputFormat->spaceBeforeOpeningBrace()}{"; $sResult .= $this->renderListContents($oOutputFormat); $sResult .= '}'; return $sResult; } /** * @return bool */ public function isRootList() { return false; } /** * @return string|null */ public function atRuleName() { return $this->vendorKeyFrame; } /** * @return string|null */ public function atRuleArgs() { return $this->animationName; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/RuleSet/RuleSet.php 0000777 00000030514 15252010675 0022225 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Renderable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Rule\Rule; /** * This class is a container for individual 'Rule's. * * The most common form of a rule set is one constrained by a selector, i.e., a `DeclarationBlock`. * However, unknown `AtRule`s (like `@font-face`) are rule sets as well. * * If you want to manipulate a `RuleSet`, use the methods `addRule(Rule $rule)`, `getRules()` and `removeRule($rule)` * (which accepts either a `Rule` or a rule name; optionally suffixed by a dash to remove all related rules). */ abstract class RuleSet implements CSSElement, Commentable, Positionable { use Position; /** * the rules in this rule set, using the property name as the key, * with potentially multiple rules per property name. * * @var array<string, array<int<0, max>, Rule>> */ private $aRules; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { $this->aRules = []; $this->setPosition($iLineNo); $this->aComments = []; } /** * @return void * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parseRuleSet(ParserState $oParserState, RuleSet $oRuleSet) { while ($oParserState->comes(';')) { $oParserState->consume(';'); } while (true) { $commentsBeforeRule = $oParserState->consumeWhiteSpace(); if ($oParserState->comes('}')) { break; } $oRule = null; if ($oParserState->getSettings()->bLenientParsing) { try { $oRule = Rule::parse($oParserState, $commentsBeforeRule); } catch (UnexpectedTokenException $e) { try { $sConsume = $oParserState->consumeUntil(["\n", ";", '}'], true); // We need to “unfind” the matches to the end of the ruleSet as this will be matched later if ($oParserState->streql(substr($sConsume, -1), '}')) { $oParserState->backtrack(1); } else { while ($oParserState->comes(';')) { $oParserState->consume(';'); } } } catch (UnexpectedTokenException $e) { // We’ve reached the end of the document. Just close the RuleSet. return; } } } else { $oRule = Rule::parse($oParserState, $commentsBeforeRule); } if ($oRule) { $oRuleSet->addRule($oRule); } } $oParserState->consume('}'); } /** * @param Rule|null $oSibling * * @return void */ public function addRule(Rule $oRule, $oSibling = null) { $sRule = $oRule->getRule(); if (!isset($this->aRules[$sRule])) { $this->aRules[$sRule] = []; } $iPosition = count($this->aRules[$sRule]); if ($oSibling !== null) { $iSiblingPos = array_search($oSibling, $this->aRules[$sRule], true); if ($iSiblingPos !== false) { $iPosition = $iSiblingPos; $oRule->setPosition($oSibling->getLineNo(), $oSibling->getColNo() - 1); } } if ($oRule->getLineNumber() === null) { //this node is added manually, give it the next best line $columnNumber = $oRule->getColNo(); $rules = $this->getRules(); $pos = count($rules); if ($pos > 0) { $last = $rules[$pos - 1]; $oRule->setPosition($last->getLineNo() + 1, $columnNumber); } else { $oRule->setPosition(1, $columnNumber); } } elseif ($oRule->getColumnNumber() === null) { $oRule->setPosition($oRule->getLineNumber(), 0); } array_splice($this->aRules[$sRule], $iPosition, 0, [$oRule]); } /** * Returns all rules matching the given rule name * * @example $oRuleSet->getRules('font') // returns array(0 => $oRule, …) or array(). * * @example $oRuleSet->getRules('font-') * //returns an array of all rules either beginning with font- or matching font. * * @param Rule|string|null $mRule * Pattern to search for. If null, returns all rules. * If the pattern ends with a dash, all rules starting with the pattern are returned * as well as one matching the pattern with the dash excluded. * Passing a `Rule` for this parameter is deprecated in version 8.9.0, and will not work from v9.0. * Call `getRules($rule->getRule())` instead. * * @return array<int, Rule> */ public function getRules($mRule = null) { if ($mRule instanceof Rule) { $mRule = $mRule->getRule(); } /** @var array<int, Rule> $aResult */ $aResult = []; foreach ($this->aRules as $sName => $aRules) { // Either no search rule is given or the search rule matches the found rule exactly // or the search rule ends in “-” and the found rule starts with the search rule. if ( !$mRule || $sName === $mRule || ( strrpos($mRule, '-') === strlen($mRule) - strlen('-') && (strpos($sName, $mRule) === 0 || $sName === substr($mRule, 0, -1)) ) ) { $aResult = array_merge($aResult, $aRules); } } usort($aResult, function (Rule $first, Rule $second) { if ($first->getLineNo() === $second->getLineNo()) { return $first->getColNo() - $second->getColNo(); } return $first->getLineNo() - $second->getLineNo(); }); return $aResult; } /** * Overrides all the rules of this set. * * @param array<array-key, Rule> $aRules The rules to override with. * * @return void */ public function setRules(array $aRules) { $this->aRules = []; foreach ($aRules as $rule) { $this->addRule($rule); } } /** * Returns all rules matching the given pattern and returns them in an associative array with the rule’s name * as keys. This method exists mainly for backwards-compatibility and is really only partially useful. * * Note: This method loses some information: Calling this (with an argument of `background-`) on a declaration block * like `{ background-color: green; background-color; rgba(0, 127, 0, 0.7); }` will only yield an associative array * containing the rgba-valued rule while `getRules()` would yield an indexed array containing both. * * @param Rule|string|null $mRule $mRule * Pattern to search for. If null, returns all rules. If the pattern ends with a dash, * all rules starting with the pattern are returned as well as one matching the pattern with the dash * excluded. * Passing a `Rule` for this parameter is deprecated in version 8.9.0, and will not work from v9.0. * Call `getRulesAssoc($rule->getRule())` instead. * * @return array<string, Rule> */ public function getRulesAssoc($mRule = null) { /** @var array<string, Rule> $aResult */ $aResult = []; foreach ($this->getRules($mRule) as $oRule) { $aResult[$oRule->getRule()] = $oRule; } return $aResult; } /** * Removes a `Rule` from this `RuleSet` by identity. * * @param Rule|string|null $mRule * `Rule` to remove. * Passing a `string` or `null` is deprecated in version 8.9.0, and will no longer work from v9.0. * Use `removeMatchingRules()` or `removeAllRules()` instead. */ public function removeRule($mRule) { if ($mRule instanceof Rule) { $sRule = $mRule->getRule(); if (!isset($this->aRules[$sRule])) { return; } foreach ($this->aRules[$sRule] as $iKey => $oRule) { if ($oRule === $mRule) { unset($this->aRules[$sRule][$iKey]); } } } elseif ($mRule !== null) { $this->removeMatchingRules($mRule); } else { $this->removeAllRules(); } } /** * Removes rules by property name or search pattern. * * @param string $searchPattern * pattern to remove. * If the pattern ends in a dash, * all rules starting with the pattern are removed as well as one matching the pattern with the dash * excluded. */ public function removeMatchingRules($searchPattern) { foreach ($this->aRules as $propertyName => $rules) { // Either the search rule matches the found rule exactly // or the search rule ends in “-” and the found rule starts with the search rule or equals it // (without the trailing dash). if ( $propertyName === $searchPattern || (\strrpos($searchPattern, '-') === \strlen($searchPattern) - \strlen('-') && (\strpos($propertyName, $searchPattern) === 0 || $propertyName === \substr($searchPattern, 0, -1))) ) { unset($this->aRules[$propertyName]); } } } public function removeAllRules() { $this->aRules = []; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @return string */ protected function renderRules(OutputFormat $oOutputFormat) { $sResult = ''; $bIsFirst = true; $oNextLevel = $oOutputFormat->nextLevel(); foreach ($this->getRules() as $oRule) { $sRendered = $oNextLevel->safely(function () use ($oRule, $oNextLevel) { return $oRule->render($oNextLevel); }); if ($sRendered === null) { continue; } if ($bIsFirst) { $bIsFirst = false; $sResult .= $oNextLevel->spaceBeforeRules(); } else { $sResult .= $oNextLevel->spaceBetweenRules(); } $sResult .= $sRendered; } if (!$bIsFirst) { // Had some output $sResult .= $oOutputFormat->spaceAfterRules(); } return $oOutputFormat->removeLastSemicolon($sResult); } /** * @param array<string, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<string, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<string, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/RuleSet/DeclarationBlock.php 0000777 00000076321 15252010675 0024050 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList\CSSList; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSList\KeyFrame; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\OutputException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\KeyframeSelector; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Rule\Rule; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\Color; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\RuleValueList; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\Size; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\URL; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\Value; /** * This class represents a `RuleSet` constrained by a `Selector`. * * It contains an array of selector objects (comma-separated in the CSS) as well as the rules to be applied to the * matching elements. * * Declaration blocks usually appear directly inside a `Document` or another `CSSList` (mostly a `MediaQuery`). */ class DeclarationBlock extends RuleSet { /** * @var array<int, Selector|string> */ private $aSelectors; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); $this->aSelectors = []; } /** * @param CSSList|null $oList * * @return DeclarationBlock|false * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $oList = null) { $aComments = []; $oResult = new DeclarationBlock($oParserState->currentLine()); try { $aSelectorParts = []; $sStringWrapperChar = false; do { $aSelectorParts[] = $oParserState->consume(1) . $oParserState->consumeUntil(['{', '}', '\'', '"'], false, false, $aComments); if (in_array($oParserState->peek(), ['\'', '"']) && substr(end($aSelectorParts), -1) != "\\") { if ($sStringWrapperChar === false) { $sStringWrapperChar = $oParserState->peek(); } elseif ($sStringWrapperChar == $oParserState->peek()) { $sStringWrapperChar = false; } } } while (!in_array($oParserState->peek(), ['{', '}']) || $sStringWrapperChar !== false); $oResult->setSelectors(implode('', $aSelectorParts), $oList); if ($oParserState->comes('{')) { $oParserState->consume(1); } } catch (UnexpectedTokenException $e) { if ($oParserState->getSettings()->bLenientParsing) { if (!$oParserState->comes('}')) { $oParserState->consumeUntil('}', false, true); } return false; } else { throw $e; } } $oResult->setComments($aComments); RuleSet::parseRuleSet($oParserState, $oResult); return $oResult; } /** * @param array<int, Selector|string>|string $mSelector * @param CSSList|null $oList * * @throws UnexpectedTokenException */ public function setSelectors($mSelector, $oList = null) { if (is_array($mSelector)) { $this->aSelectors = $mSelector; } else { $this->aSelectors = explode(',', $mSelector); } foreach ($this->aSelectors as $iKey => $mSelector) { if (!($mSelector instanceof Selector)) { if ($oList === null || !($oList instanceof KeyFrame)) { if (!Selector::isValid($mSelector)) { throw new UnexpectedTokenException( "Selector did not match '" . Selector::SELECTOR_VALIDATION_RX . "'.", $mSelector, "custom" ); } $this->aSelectors[$iKey] = new Selector($mSelector); } else { if (!KeyframeSelector::isValid($mSelector)) { throw new UnexpectedTokenException( "Selector did not match '" . KeyframeSelector::SELECTOR_VALIDATION_RX . "'.", $mSelector, "custom" ); } $this->aSelectors[$iKey] = new KeyframeSelector($mSelector); } } } } /** * Remove one of the selectors of the block. * * @param Selector|string $mSelector * * @return bool */ public function removeSelector($mSelector) { if ($mSelector instanceof Selector) { $mSelector = $mSelector->getSelector(); } foreach ($this->aSelectors as $iKey => $oSelector) { if ($oSelector->getSelector() === $mSelector) { unset($this->aSelectors[$iKey]); return true; } } return false; } /** * @return array<int, Selector|string> * * @deprecated will be removed in version 9.0; use `getSelectors()` instead */ public function getSelector() { return $this->getSelectors(); } /** * @param Selector|string $mSelector * @param CSSList|null $oList * * @return void * * @deprecated will be removed in version 9.0; use `setSelectors()` instead */ public function setSelector($mSelector, $oList = null) { $this->setSelectors($mSelector, $oList); } /** * @return array<int, Selector|string> */ public function getSelectors() { return $this->aSelectors; } /** * Splits shorthand declarations (e.g. `margin` or `font`) into their constituent parts. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandShorthands() { // border must be expanded before dimensions $this->expandBorderShorthand(); $this->expandDimensionsShorthand(); $this->expandFontShorthand(); $this->expandBackgroundShorthand(); $this->expandListStyleShorthand(); } /** * Creates shorthand declarations (e.g. `margin` or `font`) whenever possible. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createShorthands() { $this->createBackgroundShorthand(); $this->createDimensionsShorthand(); // border must be shortened after dimensions $this->createBorderShorthand(); $this->createFontShorthand(); $this->createListStyleShorthand(); } /** * Splits shorthand border declarations (e.g. `border: 1px red;`). * * Additional splitting happens in expandDimensionsShorthand. * * Multiple borders are not yet supported as of 3. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandBorderShorthand() { $aBorderRules = [ 'border', 'border-left', 'border-right', 'border-top', 'border-bottom', ]; $aBorderSizes = [ 'thin', 'medium', 'thick', ]; $aRules = $this->getRulesAssoc(); foreach ($aBorderRules as $sBorderRule) { if (!isset($aRules[$sBorderRule])) { continue; } $oRule = $aRules[$sBorderRule]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } foreach ($aValues as $mValue) { if ($mValue instanceof Value) { $mNewValue = clone $mValue; } else { $mNewValue = $mValue; } if ($mValue instanceof Size) { $sNewRuleName = $sBorderRule . "-width"; } elseif ($mValue instanceof Color) { $sNewRuleName = $sBorderRule . "-color"; } else { if (in_array($mValue, $aBorderSizes)) { $sNewRuleName = $sBorderRule . "-width"; } else { $sNewRuleName = $sBorderRule . "-style"; } } $oNewRule = new Rule($sNewRuleName, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->setIsImportant($oRule->getIsImportant()); $oNewRule->addValue([$mNewValue]); $this->addRule($oNewRule); } $this->removeRule($sBorderRule); } } /** * Splits shorthand dimensional declarations (e.g. `margin: 0px auto;`) * into their constituent parts. * * Handles `margin`, `padding`, `border-color`, `border-style` and `border-width`. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandDimensionsShorthand() { $aExpansions = [ 'margin' => 'margin-%s', 'padding' => 'padding-%s', 'border-color' => 'border-%s-color', 'border-style' => 'border-%s-style', 'border-width' => 'border-%s-width', ]; $aRules = $this->getRulesAssoc(); foreach ($aExpansions as $sProperty => $sExpanded) { if (!isset($aRules[$sProperty])) { continue; } $oRule = $aRules[$sProperty]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } $top = $right = $bottom = $left = null; switch (count($aValues)) { case 1: $top = $right = $bottom = $left = $aValues[0]; break; case 2: $top = $bottom = $aValues[0]; $left = $right = $aValues[1]; break; case 3: $top = $aValues[0]; $left = $right = $aValues[1]; $bottom = $aValues[2]; break; case 4: $top = $aValues[0]; $right = $aValues[1]; $bottom = $aValues[2]; $left = $aValues[3]; break; } foreach (['top', 'right', 'bottom', 'left'] as $sPosition) { $oNewRule = new Rule(sprintf($sExpanded, $sPosition), $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->setIsImportant($oRule->getIsImportant()); $oNewRule->addValue(${$sPosition}); $this->addRule($oNewRule); } $this->removeRule($sProperty); } } /** * Converts shorthand font declarations * (e.g. `font: 300 italic 11px/14px verdana, helvetica, sans-serif;`) * into their constituent parts. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandFontShorthand() { $aRules = $this->getRulesAssoc(); if (!isset($aRules['font'])) { return; } $oRule = $aRules['font']; // reset properties to 'normal' per http://www.w3.org/TR/21/fonts.html#font-shorthand $aFontProperties = [ 'font-style' => 'normal', 'font-variant' => 'normal', 'font-weight' => 'normal', 'font-size' => 'normal', 'line-height' => 'normal', ]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } foreach ($aValues as $mValue) { if (!$mValue instanceof Value) { $mValue = mb_strtolower($mValue); } if (in_array($mValue, ['normal', 'inherit'])) { foreach (['font-style', 'font-weight', 'font-variant'] as $sProperty) { if (!isset($aFontProperties[$sProperty])) { $aFontProperties[$sProperty] = $mValue; } } } elseif (in_array($mValue, ['italic', 'oblique'])) { $aFontProperties['font-style'] = $mValue; } elseif ($mValue == 'small-caps') { $aFontProperties['font-variant'] = $mValue; } elseif ( in_array($mValue, ['bold', 'bolder', 'lighter']) || ($mValue instanceof Size && in_array($mValue->getSize(), range(100, 900, 100))) ) { $aFontProperties['font-weight'] = $mValue; } elseif ($mValue instanceof RuleValueList && $mValue->getListSeparator() == '/') { list($oSize, $oHeight) = $mValue->getListComponents(); $aFontProperties['font-size'] = $oSize; $aFontProperties['line-height'] = $oHeight; } elseif ($mValue instanceof Size && $mValue->getUnit() !== null) { $aFontProperties['font-size'] = $mValue; } else { $aFontProperties['font-family'] = $mValue; } } foreach ($aFontProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->addValue($mValue); $oNewRule->setIsImportant($oRule->getIsImportant()); $this->addRule($oNewRule); } $this->removeRule('font'); } /** * Converts shorthand background declarations * (e.g. `background: url("chess.png") gray 50% repeat fixed;`) * into their constituent parts. * * @see http://www.w3.org/TR/21/colors.html#propdef-background * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandBackgroundShorthand() { $aRules = $this->getRulesAssoc(); if (!isset($aRules['background'])) { return; } $oRule = $aRules['background']; $aBgProperties = [ 'background-color' => ['transparent'], 'background-image' => ['none'], 'background-repeat' => ['repeat'], 'background-attachment' => ['scroll'], 'background-position' => [ new Size(0, '%', false, $this->getLineNo()), new Size(0, '%', false, $this->getLineNo()), ], ]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } if (count($aValues) == 1 && $aValues[0] == 'inherit') { foreach ($aBgProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->addValue('inherit'); $oNewRule->setIsImportant($oRule->getIsImportant()); $this->addRule($oNewRule); } $this->removeRule('background'); return; } $iNumBgPos = 0; foreach ($aValues as $mValue) { if (!$mValue instanceof Value) { $mValue = mb_strtolower($mValue); } if ($mValue instanceof URL) { $aBgProperties['background-image'] = $mValue; } elseif ($mValue instanceof Color) { $aBgProperties['background-color'] = $mValue; } elseif (in_array($mValue, ['scroll', 'fixed'])) { $aBgProperties['background-attachment'] = $mValue; } elseif (in_array($mValue, ['repeat', 'no-repeat', 'repeat-x', 'repeat-y'])) { $aBgProperties['background-repeat'] = $mValue; } elseif ( in_array($mValue, ['left', 'center', 'right', 'top', 'bottom']) || $mValue instanceof Size ) { if ($iNumBgPos == 0) { $aBgProperties['background-position'][0] = $mValue; $aBgProperties['background-position'][1] = 'center'; } else { $aBgProperties['background-position'][$iNumBgPos] = $mValue; } $iNumBgPos++; } } foreach ($aBgProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->setIsImportant($oRule->getIsImportant()); $oNewRule->addValue($mValue); $this->addRule($oNewRule); } $this->removeRule('background'); } /** * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandListStyleShorthand() { $aListProperties = [ 'list-style-type' => 'disc', 'list-style-position' => 'outside', 'list-style-image' => 'none', ]; $aListStyleTypes = [ 'none', 'disc', 'circle', 'square', 'decimal-leading-zero', 'decimal', 'lower-roman', 'upper-roman', 'lower-greek', 'lower-alpha', 'lower-latin', 'upper-alpha', 'upper-latin', 'hebrew', 'armenian', 'georgian', 'cjk-ideographic', 'hiragana', 'hira-gana-iroha', 'katakana-iroha', 'katakana', ]; $aListStylePositions = [ 'inside', 'outside', ]; $aRules = $this->getRulesAssoc(); if (!isset($aRules['list-style'])) { return; } $oRule = $aRules['list-style']; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } if (count($aValues) == 1 && $aValues[0] == 'inherit') { foreach ($aListProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->addValue('inherit'); $oNewRule->setIsImportant($oRule->getIsImportant()); $this->addRule($oNewRule); } $this->removeRule('list-style'); return; } foreach ($aValues as $mValue) { if (!$mValue instanceof Value) { $mValue = mb_strtolower($mValue); } if ($mValue instanceof Url) { $aListProperties['list-style-image'] = $mValue; } elseif (in_array($mValue, $aListStyleTypes)) { $aListProperties['list-style-types'] = $mValue; } elseif (in_array($mValue, $aListStylePositions)) { $aListProperties['list-style-position'] = $mValue; } } foreach ($aListProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->setIsImportant($oRule->getIsImportant()); $oNewRule->addValue($mValue); $this->addRule($oNewRule); } $this->removeRule('list-style'); } /** * @param array<array-key, string> $aProperties * @param string $sShorthand * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createShorthandProperties(array $aProperties, $sShorthand) { $aRules = $this->getRulesAssoc(); $oRule = null; $aNewValues = []; foreach ($aProperties as $sProperty) { if (!isset($aRules[$sProperty])) { continue; } $oRule = $aRules[$sProperty]; if (!$oRule->getIsImportant()) { $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } foreach ($aValues as $mValue) { $aNewValues[] = $mValue; } $this->removeRule($sProperty); } } if ($aNewValues !== [] && $oRule instanceof Rule) { $oNewRule = new Rule($sShorthand, $oRule->getLineNo(), $oRule->getColNo()); foreach ($aNewValues as $mValue) { $oNewRule->addValue($mValue); } $this->addRule($oNewRule); } } /** * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createBackgroundShorthand() { $aProperties = [ 'background-color', 'background-image', 'background-repeat', 'background-position', 'background-attachment', ]; $this->createShorthandProperties($aProperties, 'background'); } /** * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createListStyleShorthand() { $aProperties = [ 'list-style-type', 'list-style-position', 'list-style-image', ]; $this->createShorthandProperties($aProperties, 'list-style'); } /** * Combines `border-color`, `border-style` and `border-width` into `border`. * * Should be run after `create_dimensions_shorthand`! * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createBorderShorthand() { $aProperties = [ 'border-width', 'border-style', 'border-color', ]; $this->createShorthandProperties($aProperties, 'border'); } /** * Looks for long format CSS dimensional properties * (margin, padding, border-color, border-style and border-width) * and converts them into shorthand CSS properties. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createDimensionsShorthand() { $aPositions = ['top', 'right', 'bottom', 'left']; $aExpansions = [ 'margin' => 'margin-%s', 'padding' => 'padding-%s', 'border-color' => 'border-%s-color', 'border-style' => 'border-%s-style', 'border-width' => 'border-%s-width', ]; $aRules = $this->getRulesAssoc(); foreach ($aExpansions as $sProperty => $sExpanded) { $aFoldable = []; foreach ($aRules as $sRuleName => $oRule) { foreach ($aPositions as $sPosition) { if ($sRuleName == sprintf($sExpanded, $sPosition)) { $aFoldable[$sRuleName] = $oRule; } } } // All four dimensions must be present if (count($aFoldable) == 4) { $aValues = []; foreach ($aPositions as $sPosition) { $oRule = $aRules[sprintf($sExpanded, $sPosition)]; $mRuleValue = $oRule->getValue(); $aRuleValues = []; if (!$mRuleValue instanceof RuleValueList) { $aRuleValues[] = $mRuleValue; } else { $aRuleValues = $mRuleValue->getListComponents(); } $aValues[$sPosition] = $aRuleValues; } $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); if ((string)$aValues['left'][0] == (string)$aValues['right'][0]) { if ((string)$aValues['top'][0] == (string)$aValues['bottom'][0]) { if ((string)$aValues['top'][0] == (string)$aValues['left'][0]) { // All 4 sides are equal $oNewRule->addValue($aValues['top']); } else { // Top and bottom are equal, left and right are equal $oNewRule->addValue($aValues['top']); $oNewRule->addValue($aValues['left']); } } else { // Only left and right are equal $oNewRule->addValue($aValues['top']); $oNewRule->addValue($aValues['left']); $oNewRule->addValue($aValues['bottom']); } } else { // No sides are equal $oNewRule->addValue($aValues['top']); $oNewRule->addValue($aValues['left']); $oNewRule->addValue($aValues['bottom']); $oNewRule->addValue($aValues['right']); } $this->addRule($oNewRule); foreach ($aPositions as $sPosition) { $this->removeRule(sprintf($sExpanded, $sPosition)); } } } } /** * Looks for long format CSS font properties (e.g. `font-weight`) and * tries to convert them into a shorthand CSS `font` property. * * At least `font-size` AND `font-family` must be present in order to create a shorthand declaration. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createFontShorthand() { $aFontProperties = [ 'font-style', 'font-variant', 'font-weight', 'font-size', 'line-height', 'font-family', ]; $aRules = $this->getRulesAssoc(); if (!isset($aRules['font-size']) || !isset($aRules['font-family'])) { return; } $oOldRule = isset($aRules['font-size']) ? $aRules['font-size'] : $aRules['font-family']; $oNewRule = new Rule('font', $oOldRule->getLineNo(), $oOldRule->getColNo()); unset($oOldRule); foreach (['font-style', 'font-variant', 'font-weight'] as $sProperty) { if (isset($aRules[$sProperty])) { $oRule = $aRules[$sProperty]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } if ($aValues[0] !== 'normal') { $oNewRule->addValue($aValues[0]); } } } // Get the font-size value $oRule = $aRules['font-size']; $mRuleValue = $oRule->getValue(); $aFSValues = []; if (!$mRuleValue instanceof RuleValueList) { $aFSValues[] = $mRuleValue; } else { $aFSValues = $mRuleValue->getListComponents(); } // But wait to know if we have line-height to add it if (isset($aRules['line-height'])) { $oRule = $aRules['line-height']; $mRuleValue = $oRule->getValue(); $aLHValues = []; if (!$mRuleValue instanceof RuleValueList) { $aLHValues[] = $mRuleValue; } else { $aLHValues = $mRuleValue->getListComponents(); } if ($aLHValues[0] !== 'normal') { $val = new RuleValueList('/', $this->getLineNo()); $val->addListComponent($aFSValues[0]); $val->addListComponent($aLHValues[0]); $oNewRule->addValue($val); } } else { $oNewRule->addValue($aFSValues[0]); } $oRule = $aRules['font-family']; $mRuleValue = $oRule->getValue(); $aFFValues = []; if (!$mRuleValue instanceof RuleValueList) { $aFFValues[] = $mRuleValue; } else { $aFFValues = $mRuleValue->getListComponents(); } $oFFValue = new RuleValueList(',', $this->getLineNo()); $oFFValue->setListComponents($aFFValues); $oNewRule->addValue($oFFValue); $this->addRule($oNewRule); foreach ($aFontProperties as $sProperty) { $this->removeRule($sProperty); } } /** * @return string * * @throws OutputException * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string * * @throws OutputException */ public function render($oOutputFormat) { $sResult = $oOutputFormat->comments($this); if (count($this->aSelectors) === 0) { // If all the selectors have been removed, this declaration block becomes invalid throw new OutputException( 'Attempt to print declaration block with missing selector', $this->getLineNumber() ); } $sResult .= $oOutputFormat->sBeforeDeclarationBlock; $sResult .= $oOutputFormat->implode( $oOutputFormat->spaceBeforeSelectorSeparator() . ',' . $oOutputFormat->spaceAfterSelectorSeparator(), $this->aSelectors ); $sResult .= $oOutputFormat->sAfterDeclarationBlockSelectors; $sResult .= $oOutputFormat->spaceBeforeOpeningBrace() . '{'; $sResult .= $this->renderRules($oOutputFormat); $sResult .= '}'; $sResult .= $oOutputFormat->sAfterDeclarationBlock; return $sResult; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/RuleSet/AtRuleSet.php 0000777 00000003437 15252010675 0022516 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\RuleSet; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property\AtRule; /** * This class represents rule sets for generic at-rules which are not covered by specific classes, i.e., not * `@import`, `@charset` or `@media`. * * A common example for this is `@font-face`. */ class AtRuleSet extends RuleSet implements AtRule { /** * @var string */ private $sType; /** * @var string */ private $sArgs; /** * @param string $sType * @param string $sArgs * @param int $iLineNo */ public function __construct($sType, $sArgs = '', $iLineNo = 0) { parent::__construct($iLineNo); $this->sType = $sType; $this->sArgs = $sArgs; } /** * @return string */ public function atRuleName() { return $this->sType; } /** * @return string */ public function atRuleArgs() { return $this->sArgs; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sResult = $oOutputFormat->comments($this); $sArgs = $this->sArgs; if ($sArgs) { $sArgs = ' ' . $sArgs; } $sResult .= "@{$this->sType}$sArgs{$oOutputFormat->spaceBeforeOpeningBrace()}{"; $sResult .= $this->renderRules($oOutputFormat); $sResult .= '}'; return $sResult; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Rule/Rule.php 0000777 00000025531 15252010675 0021100 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Rule; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\RuleValueList; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\Value; /** * `Rule`s just have a string key (the rule) and a 'Value'. * * In CSS, `Rule`s are expressed as follows: “key: value[0][0] value[0][1], value[1][0] value[1][1];” */ class Rule implements Commentable, CSSElement, Positionable { use Position; /** * @var string */ private $sRule; /** * @var RuleValueList|string|null */ private $mValue; /** * @var bool */ private $bIsImportant; /** * @var array<int, int> */ private $aIeHack; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param string $sRule * @param int $iLineNo * @param int $iColNo */ public function __construct($sRule, $iLineNo = 0, $iColNo = 0) { $this->sRule = $sRule; $this->mValue = null; $this->bIsImportant = false; $this->aIeHack = []; $this->setPosition($iLineNo, $iColNo); $this->aComments = []; } /** * @param array<int, Comment> $commentsBeforeRule * * @return Rule * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $commentsBeforeRule = []) { $aComments = \array_merge($commentsBeforeRule, $oParserState->consumeWhiteSpace()); $oRule = new Rule( $oParserState->parseIdentifier(!$oParserState->comes("--")), $oParserState->currentLine(), $oParserState->currentColumn() ); $oRule->setComments($aComments); $oRule->addComments($oParserState->consumeWhiteSpace()); $oParserState->consume(':'); $oValue = Value::parseValue($oParserState, self::listDelimiterForRule($oRule->getRule())); $oRule->setValue($oValue); if ($oParserState->getSettings()->bLenientParsing) { while ($oParserState->comes('\\')) { $oParserState->consume('\\'); $oRule->addIeHack($oParserState->consume()); $oParserState->consumeWhiteSpace(); } } $oParserState->consumeWhiteSpace(); if ($oParserState->comes('!')) { $oParserState->consume('!'); $oParserState->consumeWhiteSpace(); $oParserState->consume('important'); $oRule->setIsImportant(true); } $oParserState->consumeWhiteSpace(); while ($oParserState->comes(';')) { $oParserState->consume(';'); } return $oRule; } /** * Returns a list of delimiters (or separators). * The first item is the innermost separator (or, put another way, the highest-precedence operator). * The sequence continues to the outermost separator (or lowest-precedence operator). * * @param string $sRule * * @return list<non-empty-string> */ private static function listDelimiterForRule($sRule) { if (preg_match('/^font($|-)/', $sRule)) { return [',', '/', ' ']; } switch ($sRule) { case 'src': return [' ', ',']; default: return [',', ' ', '/']; } } /** * @param string $sRule * * @return void */ public function setRule($sRule) { $this->sRule = $sRule; } /** * @return string */ public function getRule() { return $this->sRule; } /** * @return RuleValueList|string|null */ public function getValue() { return $this->mValue; } /** * @param RuleValueList|string|null $mValue * * @return void */ public function setValue($mValue) { $this->mValue = $mValue; } /** * @param array<array-key, array<array-key, RuleValueList>> $aSpaceSeparatedValues * * @return RuleValueList * * @deprecated will be removed in version 9.0 * Old-Style 2-dimensional array given. Retained for (some) backwards-compatibility. * Use `setValue()` instead and wrap the value inside a RuleValueList if necessary. */ public function setValues(array $aSpaceSeparatedValues) { $oSpaceSeparatedList = null; if (count($aSpaceSeparatedValues) > 1) { $oSpaceSeparatedList = new RuleValueList(' ', $this->iLineNo); } foreach ($aSpaceSeparatedValues as $aCommaSeparatedValues) { $oCommaSeparatedList = null; if (count($aCommaSeparatedValues) > 1) { $oCommaSeparatedList = new RuleValueList(',', $this->iLineNo); } foreach ($aCommaSeparatedValues as $mValue) { if (!$oSpaceSeparatedList && !$oCommaSeparatedList) { $this->mValue = $mValue; return $mValue; } if ($oCommaSeparatedList) { $oCommaSeparatedList->addListComponent($mValue); } else { $oSpaceSeparatedList->addListComponent($mValue); } } if (!$oSpaceSeparatedList) { $this->mValue = $oCommaSeparatedList; return $oCommaSeparatedList; } else { $oSpaceSeparatedList->addListComponent($oCommaSeparatedList); } } $this->mValue = $oSpaceSeparatedList; return $oSpaceSeparatedList; } /** * @return array<int, array<int, RuleValueList>> * * @deprecated will be removed in version 9.0 * Old-Style 2-dimensional array returned. Retained for (some) backwards-compatibility. * Use `getValue()` instead and check for the existence of a (nested set of) ValueList object(s). */ public function getValues() { if (!$this->mValue instanceof RuleValueList) { return [[$this->mValue]]; } if ($this->mValue->getListSeparator() === ',') { return [$this->mValue->getListComponents()]; } $aResult = []; foreach ($this->mValue->getListComponents() as $mValue) { if (!$mValue instanceof RuleValueList || $mValue->getListSeparator() !== ',') { $aResult[] = [$mValue]; continue; } if ($this->mValue->getListSeparator() === ' ' || count($aResult) === 0) { $aResult[] = []; } foreach ($mValue->getListComponents() as $mValue) { $aResult[count($aResult) - 1][] = $mValue; } } return $aResult; } /** * Adds a value to the existing value. Value will be appended if a `RuleValueList` exists of the given type. * Otherwise, the existing value will be wrapped by one. * * @param RuleValueList|array<int, RuleValueList> $mValue * @param string $sType * * @return void */ public function addValue($mValue, $sType = ' ') { if (!is_array($mValue)) { $mValue = [$mValue]; } if (!$this->mValue instanceof RuleValueList || $this->mValue->getListSeparator() !== $sType) { $mCurrentValue = $this->mValue; $this->mValue = new RuleValueList($sType, $this->getLineNumber()); if ($mCurrentValue) { $this->mValue->addListComponent($mCurrentValue); } } foreach ($mValue as $mValueItem) { $this->mValue->addListComponent($mValueItem); } } /** * @param int $iModifier * * @return void * * @deprecated since V8.8.0, will be removed in V9.0 */ public function addIeHack($iModifier) { $this->aIeHack[] = $iModifier; } /** * @param array<int, int> $aModifiers * * @return void * * @deprecated since V8.8.0, will be removed in V9.0 */ public function setIeHack(array $aModifiers) { $this->aIeHack = $aModifiers; } /** * @return array<int, int> * * @deprecated since V8.8.0, will be removed in V9.0 */ public function getIeHack() { return $this->aIeHack; } /** * @param bool $bIsImportant * * @return void */ public function setIsImportant($bIsImportant) { $this->bIsImportant = $bIsImportant; } /** * @return bool */ public function getIsImportant() { return $this->bIsImportant; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sResult = "{$oOutputFormat->comments($this)}{$this->sRule}:{$oOutputFormat->spaceAfterRuleName()}"; if ($this->mValue instanceof Value) { // Can also be a ValueList $sResult .= $this->mValue->render($oOutputFormat); } else { $sResult .= $this->mValue; } if (!empty($this->aIeHack)) { $sResult .= ' \\' . implode('\\', $this->aIeHack); } if ($this->bIsImportant) { $sResult .= ' !important'; } $sResult .= ';'; return $sResult; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Settings.php 0000777 00000005172 15252010675 0021061 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS; /** * Parser settings class. * * Configure parser behaviour here. */ class Settings { /** * Multi-byte string support. * * If `true` (`mbstring` extension must be enabled), will use (slower) `mb_strlen`, `mb_convert_case`, `mb_substr` * and `mb_strpos` functions. Otherwise, the normal (ASCII-Only) functions will be used. * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bMultibyteSupport; /** * The default charset for the CSS if no `@charset` declaration is found. Defaults to utf-8. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sDefaultCharset = 'utf-8'; /** * Whether the parser silently ignore invalid rules instead of choking on them. * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bLenientParsing = true; private function __construct() { $this->bMultibyteSupport = extension_loaded('mbstring'); } /** * @return self new instance */ public static function create() { return new Settings(); } /** * Enables/disables multi-byte string support. * * If `true` (`mbstring` extension must be enabled), will use (slower) `mb_strlen`, `mb_convert_case`, `mb_substr` * and `mb_strpos` functions. Otherwise, the normal (ASCII-Only) functions will be used. * * @param bool $bMultibyteSupport * * @return self fluent interface */ public function withMultibyteSupport($bMultibyteSupport = true) { $this->bMultibyteSupport = $bMultibyteSupport; return $this; } /** * Sets the charset to be used if the CSS does not contain an `@charset` declaration. * * @param string $sDefaultCharset * * @return self fluent interface */ public function withDefaultCharset($sDefaultCharset) { $this->sDefaultCharset = $sDefaultCharset; return $this; } /** * Configures whether the parser should silently ignore invalid rules. * * @param bool $bLenientParsing * * @return self fluent interface */ public function withLenientParsing($bLenientParsing = true) { $this->bLenientParsing = $bLenientParsing; return $this; } /** * Configures the parser to choke on invalid rules. * * @return self fluent interface */ public function beStrict() { return $this->withLenientParsing(false); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/Value.php 0000777 00000020330 15252010675 0021402 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Positionable; /** * Abstract base class for specific classes of CSS values: `Size`, `Color`, `CSSString` and `URL`, and another * abstract subclass `ValueList`. */ abstract class Value implements CSSElement, Positionable { use Position; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { $this->setPosition($iLineNo); } /** * @param array<array-key, string> $aListDelimiters * * @return RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parseValue(ParserState $oParserState, array $aListDelimiters = []) { /** @var array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aStack */ $aStack = []; $oParserState->consumeWhiteSpace(); //Build a list of delimiters and parsed values while ( !($oParserState->comes('}') || $oParserState->comes(';') || $oParserState->comes('!') || $oParserState->comes(')') || $oParserState->comes('\\') || $oParserState->isEnd()) ) { if (count($aStack) > 0) { $bFoundDelimiter = false; foreach ($aListDelimiters as $sDelimiter) { if ($oParserState->comes($sDelimiter)) { array_push($aStack, $oParserState->consume($sDelimiter)); $oParserState->consumeWhiteSpace(); $bFoundDelimiter = true; break; } } if (!$bFoundDelimiter) { //Whitespace was the list delimiter array_push($aStack, ' '); } } array_push($aStack, self::parsePrimitiveValue($oParserState)); $oParserState->consumeWhiteSpace(); } // Convert the list to list objects foreach ($aListDelimiters as $sDelimiter) { $iStackLength = count($aStack); if ($iStackLength === 1) { return $aStack[0]; } $aNewStack = []; for ($iStartPosition = 0; $iStartPosition < $iStackLength; ++$iStartPosition) { if ($iStartPosition === ($iStackLength - 1) || $sDelimiter !== $aStack[$iStartPosition + 1]) { $aNewStack[] = $aStack[$iStartPosition]; continue; } $iLength = 2; //Number of elements to be joined for ($i = $iStartPosition + 3; $i < $iStackLength; $i += 2, ++$iLength) { if ($sDelimiter !== $aStack[$i]) { break; } } $oList = new RuleValueList($sDelimiter, $oParserState->currentLine()); for ($i = $iStartPosition; $i - $iStartPosition < $iLength * 2; $i += 2) { $oList->addListComponent($aStack[$i]); } $aNewStack[] = $oList; $iStartPosition += $iLength * 2 - 2; } $aStack = $aNewStack; } if (!isset($aStack[0])) { throw new UnexpectedTokenException( " {$oParserState->peek()} ", $oParserState->peek(1, -1) . $oParserState->peek(2), 'literal', $oParserState->currentLine() ); } return $aStack[0]; } /** * @param bool $bIgnoreCase * * @return CSSFunction|string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parseIdentifierOrFunction(ParserState $oParserState, $bIgnoreCase = false) { $oAnchor = $oParserState->anchor(); $mResult = $oParserState->parseIdentifier($bIgnoreCase); if ($oParserState->comes('(')) { $oAnchor->backtrack(); if ($oParserState->streql('url', $mResult)) { $mResult = URL::parse($oParserState); } elseif ( $oParserState->streql('calc', $mResult) || $oParserState->streql('-webkit-calc', $mResult) || $oParserState->streql('-moz-calc', $mResult) ) { $mResult = CalcFunction::parse($oParserState); } else { $mResult = CSSFunction::parse($oParserState, $bIgnoreCase); } } return $mResult; } /** * @return CSSFunction|CSSString|LineName|Size|URL|string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * @throws SourceException * * @internal since V8.8.0 */ public static function parsePrimitiveValue(ParserState $oParserState) { $oValue = null; $oParserState->consumeWhiteSpace(); if ( is_numeric($oParserState->peek()) || ($oParserState->comes('-.') && is_numeric($oParserState->peek(1, 2))) || (($oParserState->comes('-') || $oParserState->comes('.')) && is_numeric($oParserState->peek(1, 1))) ) { $oValue = Size::parse($oParserState); } elseif ($oParserState->comes('#') || $oParserState->comes('rgb', true) || $oParserState->comes('hsl', true)) { $oValue = Color::parse($oParserState); } elseif ($oParserState->comes("'") || $oParserState->comes('"')) { $oValue = CSSString::parse($oParserState); } elseif ($oParserState->comes("progid:") && $oParserState->getSettings()->bLenientParsing) { $oValue = self::parseMicrosoftFilter($oParserState); } elseif ($oParserState->comes("[")) { $oValue = LineName::parse($oParserState); } elseif ($oParserState->comes("U+")) { $oValue = self::parseUnicodeRangeValue($oParserState); } else { $sNextChar = $oParserState->peek(1); try { $oValue = self::parseIdentifierOrFunction($oParserState); } catch (UnexpectedTokenException $e) { if (\in_array($sNextChar, ['+', '-', '*', '/'], true)) { $oValue = $oParserState->consume(1); } else { throw $e; } } } $oParserState->consumeWhiteSpace(); return $oValue; } /** * @return CSSFunction * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ private static function parseMicrosoftFilter(ParserState $oParserState) { $sFunction = $oParserState->consumeUntil('(', false, true); $aArguments = Value::parseValue($oParserState, [',', '=']); return new CSSFunction($sFunction, $aArguments, ',', $oParserState->currentLine()); } /** * @return string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ private static function parseUnicodeRangeValue(ParserState $oParserState) { $iCodepointMaxLength = 6; // Code points outside BMP can use up to six digits $sRange = ""; $oParserState->consume("U+"); do { if ($oParserState->comes('-')) { $iCodepointMaxLength = 13; // Max length is 2 six digit code points + the dash(-) between them } $sRange .= $oParserState->consume(1); } while (strlen($sRange) < $iCodepointMaxLength && preg_match("/[A-Fa-f0-9\?-]/", $oParserState->peek())); return "U+{$sRange}"; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/CSSString.php 0000777 00000006317 15252010675 0022156 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * This class is a wrapper for quoted strings to distinguish them from keywords. * * `CSSString`s always output with double quotes. */ class CSSString extends PrimitiveValue { /** * @var string */ private $sString; /** * @param string $sString * @param int $iLineNo */ public function __construct($sString, $iLineNo = 0) { $this->sString = $sString; parent::__construct($iLineNo); } /** * @return CSSString * * @throws SourceException * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState) { $sBegin = $oParserState->peek(); $sQuote = null; if ($sBegin === "'") { $sQuote = "'"; } elseif ($sBegin === '"') { $sQuote = '"'; } if ($sQuote !== null) { $oParserState->consume($sQuote); } $sResult = ""; $sContent = null; if ($sQuote === null) { // Unquoted strings end in whitespace or with braces, brackets, parentheses while (!preg_match('/[\\s{}()<>\\[\\]]/isu', $oParserState->peek())) { $sResult .= $oParserState->parseCharacter(false); } } else { while (!$oParserState->comes($sQuote)) { $sContent = $oParserState->parseCharacter(false); if ($sContent === null) { throw new SourceException( "Non-well-formed quoted string {$oParserState->peek(3)}", $oParserState->currentLine() ); } $sResult .= $sContent; } $oParserState->consume($sQuote); } return new CSSString($sResult, $oParserState->currentLine()); } /** * @param string $sString * * @return void */ public function setString($sString) { $this->sString = $sString; } /** * @return string */ public function getString() { return $this->sString; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sString = addslashes($this->sString); $sString = str_replace("\n", '\A', $sString); return $oOutputFormat->getStringQuotingType() . $sString . $oOutputFormat->getStringQuotingType(); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/CSSFunction.php 0000777 00000006120 15252010675 0022465 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * A `CSSFunction` represents a special kind of value that also contains a function name and where the values are the * function’s arguments. It also handles equals-sign-separated argument lists like `filter: alpha(opacity=90);`. */ class CSSFunction extends ValueList { /** * @var string * * @internal since 8.8.0 */ protected $sName; /** * @param string $sName * @param RuleValueList|array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aArguments * @param string $sSeparator * @param int $iLineNo */ public function __construct($sName, $aArguments, $sSeparator = ',', $iLineNo = 0) { if ($aArguments instanceof RuleValueList) { $sSeparator = $aArguments->getListSeparator(); $aArguments = $aArguments->getListComponents(); } $this->sName = $sName; $this->setPosition($iLineNo); // TODO: redundant? parent::__construct($aArguments, $sSeparator, $iLineNo); } /** * @param ParserState $oParserState * @param bool $bIgnoreCase * * @return CSSFunction * * @throws SourceException * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $bIgnoreCase = false) { $mResult = $oParserState->parseIdentifier($bIgnoreCase); $oParserState->consume('('); $aArguments = Value::parseValue($oParserState, ['=', ' ', ',']); $mResult = new CSSFunction($mResult, $aArguments, ',', $oParserState->currentLine()); $oParserState->consume(')'); return $mResult; } /** * @return string */ public function getName() { return $this->sName; } /** * @param string $sName * * @return void */ public function setName($sName) { $this->sName = $sName; } /** * @return array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> */ public function getArguments() { return $this->aComponents; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $aArguments = parent::render($oOutputFormat); return "{$this->sName}({$aArguments})"; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/LineName.php 0000777 00000004172 15252010675 0022024 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; class LineName extends ValueList { /** * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aComponents * @param int $iLineNo */ public function __construct(array $aComponents = [], $iLineNo = 0) { parent::__construct($aComponents, ' ', $iLineNo); } /** * @return LineName * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState) { $oParserState->consume('['); $oParserState->consumeWhiteSpace(); $aNames = []; do { if ($oParserState->getSettings()->bLenientParsing) { try { $aNames[] = $oParserState->parseIdentifier(); } catch (UnexpectedTokenException $e) { if (!$oParserState->comes(']')) { throw $e; } } } else { $aNames[] = $oParserState->parseIdentifier(); } $oParserState->consumeWhiteSpace(); } while (!$oParserState->comes(']')); $oParserState->consume(']'); return new LineName($aNames, $oParserState->currentLine()); } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return '[' . parent::render(OutputFormat::createCompact()) . ']'; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/Size.php 0000777 00000014501 15252010675 0021243 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * A `Size` consists of a numeric `size` value and a unit. */ class Size extends PrimitiveValue { /** * vh/vw/vm(ax)/vmin/rem are absolute insofar as they don’t scale to the immediate parent (only the viewport) * * @var array<int, string> * * @internal */ const ABSOLUTE_SIZE_UNITS = [ 'px', 'pt', 'pc', 'cm', 'mm', 'mozmm', 'in', 'vh', 'dvh', 'svh', 'lvh', 'vw', 'vmin', 'vmax', 'rem', ]; /** * @var array<int, string> * * @internal */ const RELATIVE_SIZE_UNITS = ['%', 'em', 'ex', 'ch', 'fr']; /** * @var array<int, string> * * @internal */ const NON_SIZE_UNITS = ['deg', 'grad', 'rad', 's', 'ms', 'turn', 'Hz', 'kHz']; /** * @var array<int, array<string, string>>|null */ private static $SIZE_UNITS = null; /** * @var float */ private $fSize; /** * @var string|null */ private $sUnit; /** * @var bool */ private $bIsColorComponent; /** * @param float|int|string $fSize * @param string|null $sUnit * @param bool $bIsColorComponent * @param int $iLineNo */ public function __construct($fSize, $sUnit = null, $bIsColorComponent = false, $iLineNo = 0) { parent::__construct($iLineNo); $this->fSize = (float)$fSize; $this->sUnit = $sUnit; $this->bIsColorComponent = $bIsColorComponent; } /** * @param bool $bIsColorComponent * * @return Size * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $bIsColorComponent = false) { $sSize = ''; if ($oParserState->comes('-')) { $sSize .= $oParserState->consume('-'); } while (is_numeric($oParserState->peek()) || $oParserState->comes('.') || $oParserState->comes('e', true)) { if ($oParserState->comes('.')) { $sSize .= $oParserState->consume('.'); } elseif ($oParserState->comes('e', true)) { $sLookahead = $oParserState->peek(1, 1); if (is_numeric($sLookahead) || $sLookahead === '+' || $sLookahead === '-') { $sSize .= $oParserState->consume(2); } else { break; // Reached the unit part of the number like "em" or "ex" } } else { $sSize .= $oParserState->consume(1); } } $sUnit = null; $aSizeUnits = self::getSizeUnits(); foreach ($aSizeUnits as $iLength => &$aValues) { $sKey = strtolower($oParserState->peek($iLength)); if (array_key_exists($sKey, $aValues)) { if (($sUnit = $aValues[$sKey]) !== null) { $oParserState->consume($iLength); break; } } } return new Size((float)$sSize, $sUnit, $bIsColorComponent, $oParserState->currentLine()); } /** * @return array<int, array<string, string>> */ private static function getSizeUnits() { if (!is_array(self::$SIZE_UNITS)) { self::$SIZE_UNITS = []; foreach (array_merge(self::ABSOLUTE_SIZE_UNITS, self::RELATIVE_SIZE_UNITS, self::NON_SIZE_UNITS) as $val) { $iSize = strlen($val); if (!isset(self::$SIZE_UNITS[$iSize])) { self::$SIZE_UNITS[$iSize] = []; } self::$SIZE_UNITS[$iSize][strtolower($val)] = $val; } krsort(self::$SIZE_UNITS, SORT_NUMERIC); } return self::$SIZE_UNITS; } /** * @param string $sUnit * * @return void */ public function setUnit($sUnit) { $this->sUnit = $sUnit; } /** * @return string|null */ public function getUnit() { return $this->sUnit; } /** * @param float|int|string $fSize */ public function setSize($fSize) { $this->fSize = (float)$fSize; } /** * @return float */ public function getSize() { return $this->fSize; } /** * @return bool */ public function isColorComponent() { return $this->bIsColorComponent; } /** * Returns whether the number stored in this Size really represents a size (as in a length of something on screen). * * @return false if the unit an angle, a duration, a frequency or the number is a component in a Color object. */ public function isSize() { if (in_array($this->sUnit, self::NON_SIZE_UNITS, true)) { return false; } return !$this->isColorComponent(); } /** * @return bool */ public function isRelative() { if (in_array($this->sUnit, self::RELATIVE_SIZE_UNITS, true)) { return true; } if ($this->sUnit === null && $this->fSize != 0) { return true; } return false; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $l = localeconv(); $sPoint = preg_quote($l['decimal_point'], '/'); $sSize = preg_match("/[\d\.]+e[+-]?\d+/i", (string)$this->fSize) ? preg_replace("/$sPoint?0+$/", "", sprintf("%f", $this->fSize)) : (string)$this->fSize; return preg_replace(["/$sPoint/", "/^(-?)0\./"], ['.', '$1.'], $sSize) . ($this->sUnit === null ? '' : $this->sUnit); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/URL.php 0000777 00000005057 15252010675 0021001 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * This class represents URLs in CSS. `URL`s always output in `URL("")` notation. */ class URL extends PrimitiveValue { /** * @var CSSString */ private $oURL; /** * @param int $iLineNo */ public function __construct(CSSString $oURL, $iLineNo = 0) { parent::__construct($iLineNo); $this->oURL = $oURL; } /** * @return URL * * @throws SourceException * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState) { $oAnchor = $oParserState->anchor(); $sIdentifier = ''; for ($i = 0; $i < 3; $i++) { $sChar = $oParserState->parseCharacter(true); if ($sChar === null) { break; } $sIdentifier .= $sChar; } $bUseUrl = $oParserState->streql($sIdentifier, 'url'); if ($bUseUrl) { $oParserState->consumeWhiteSpace(); $oParserState->consume('('); } else { $oAnchor->backtrack(); } $oParserState->consumeWhiteSpace(); $oResult = new URL(CSSString::parse($oParserState), $oParserState->currentLine()); if ($bUseUrl) { $oParserState->consumeWhiteSpace(); $oParserState->consume(')'); } return $oResult; } /** * @return void */ public function setURL(CSSString $oURL) { $this->oURL = $oURL; } /** * @return CSSString */ public function getURL() { return $this->oURL; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return "url({$this->oURL->render($oOutputFormat)})"; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/Color.php 0000777 00000015130 15252010675 0021406 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * `Color's can be input in the form #rrggbb, #rgb or schema(val1, val2, …) but are always stored as an array of * ('s' => val1, 'c' => val2, 'h' => val3, …) and output in the second form. */ class Color extends CSSFunction { /** * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aColor * @param int $iLineNo */ public function __construct(array $aColor, $iLineNo = 0) { parent::__construct(implode('', array_keys($aColor)), $aColor, ',', $iLineNo); } /** * @param ParserState $oParserState * @param bool $bIgnoreCase * * @return Color|CSSFunction * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $bIgnoreCase = false) { $aColor = []; if ($oParserState->comes('#')) { $oParserState->consume('#'); $sValue = $oParserState->parseIdentifier(false); if ($oParserState->strlen($sValue) === 3) { $sValue = $sValue[0] . $sValue[0] . $sValue[1] . $sValue[1] . $sValue[2] . $sValue[2]; } elseif ($oParserState->strlen($sValue) === 4) { $sValue = $sValue[0] . $sValue[0] . $sValue[1] . $sValue[1] . $sValue[2] . $sValue[2] . $sValue[3] . $sValue[3]; } if ($oParserState->strlen($sValue) === 8) { $aColor = [ 'r' => new Size(intval($sValue[0] . $sValue[1], 16), null, true, $oParserState->currentLine()), 'g' => new Size(intval($sValue[2] . $sValue[3], 16), null, true, $oParserState->currentLine()), 'b' => new Size(intval($sValue[4] . $sValue[5], 16), null, true, $oParserState->currentLine()), 'a' => new Size( round(self::mapRange(intval($sValue[6] . $sValue[7], 16), 0, 255, 0, 1), 2), null, true, $oParserState->currentLine() ), ]; } elseif ($oParserState->strlen($sValue) === 6) { $aColor = [ 'r' => new Size(intval($sValue[0] . $sValue[1], 16), null, true, $oParserState->currentLine()), 'g' => new Size(intval($sValue[2] . $sValue[3], 16), null, true, $oParserState->currentLine()), 'b' => new Size(intval($sValue[4] . $sValue[5], 16), null, true, $oParserState->currentLine()), ]; } else { throw new UnexpectedTokenException( 'Invalid hex color value', $sValue, 'custom', $oParserState->currentLine() ); } } else { $sColorMode = $oParserState->parseIdentifier(true); $oParserState->consumeWhiteSpace(); $oParserState->consume('('); $bContainsVar = false; $iLength = $oParserState->strlen($sColorMode); for ($i = 0; $i < $iLength; ++$i) { $oParserState->consumeWhiteSpace(); if ($oParserState->comes('var')) { $aColor[$sColorMode[$i]] = CSSFunction::parseIdentifierOrFunction($oParserState); $bContainsVar = true; } else { $aColor[$sColorMode[$i]] = Size::parse($oParserState, true); } if ($bContainsVar && $oParserState->comes(')')) { // With a var argument the function can have fewer arguments break; } $oParserState->consumeWhiteSpace(); if ($i < ($iLength - 1)) { $oParserState->consume(','); } } $oParserState->consume(')'); if ($bContainsVar) { return new CSSFunction($sColorMode, array_values($aColor), ',', $oParserState->currentLine()); } } return new Color($aColor, $oParserState->currentLine()); } /** * @param float $fVal * @param float $fFromMin * @param float $fFromMax * @param float $fToMin * @param float $fToMax * * @return float */ private static function mapRange($fVal, $fFromMin, $fFromMax, $fToMin, $fToMax) { $fFromRange = $fFromMax - $fFromMin; $fToRange = $fToMax - $fToMin; $fMultiplier = $fToRange / $fFromRange; $fNewVal = $fVal - $fFromMin; $fNewVal *= $fMultiplier; return $fNewVal + $fToMin; } /** * @return array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> */ public function getColor() { return $this->aComponents; } /** * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aColor * * @return void */ public function setColor(array $aColor) { $this->setName(implode('', array_keys($aColor))); $this->aComponents = $aColor; } /** * @return string */ public function getColorDescription() { return $this->getName(); } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { // Shorthand RGB color values if ($oOutputFormat->getRGBHashNotation() && implode('', array_keys($this->aComponents)) === 'rgb') { $sResult = sprintf( '%02x%02x%02x', $this->aComponents['r']->getSize(), $this->aComponents['g']->getSize(), $this->aComponents['b']->getSize() ); return '#' . (($sResult[0] == $sResult[1]) && ($sResult[2] == $sResult[3]) && ($sResult[4] == $sResult[5]) ? "$sResult[0]$sResult[2]$sResult[4]" : $sResult); } return parent::render($oOutputFormat); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/ValueList.php 0000777 00000005511 15252010675 0022242 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; /** * A `ValueList` represents a lists of `Value`s, separated by some separation character * (mostly `,`, whitespace, or `/`). * * There are two types of `ValueList`s: `RuleValueList` and `CSSFunction` */ abstract class ValueList extends Value { /** * @var array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> * * @internal since 8.8.0 */ protected $aComponents; /** * @var string * * @internal since 8.8.0 */ protected $sSeparator; /** * phpcs:ignore Generic.Files.LineLength * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string>|RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string $aComponents * @param string $sSeparator * @param int $iLineNo */ public function __construct($aComponents = [], $sSeparator = ',', $iLineNo = 0) { parent::__construct($iLineNo); if (!is_array($aComponents)) { $aComponents = [$aComponents]; } $this->aComponents = $aComponents; $this->sSeparator = $sSeparator; } /** * @param RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string $mComponent * * @return void */ public function addListComponent($mComponent) { $this->aComponents[] = $mComponent; } /** * @return array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> */ public function getListComponents() { return $this->aComponents; } /** * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aComponents * * @return void */ public function setListComponents(array $aComponents) { $this->aComponents = $aComponents; } /** * @return string */ public function getListSeparator() { return $this->sSeparator; } /** * @param string $sSeparator * * @return void */ public function setListSeparator($sSeparator) { $this->sSeparator = $sSeparator; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return $oOutputFormat->implode( $oOutputFormat->spaceBeforeListArgumentSeparator($this->sSeparator) . $this->sSeparator . $oOutputFormat->spaceAfterListArgumentSeparator($this->sSeparator), $this->aComponents ); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/CalcRuleValueList.php 0000777 00000001064 15252010675 0023654 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; class CalcRuleValueList extends RuleValueList { /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct(',', $iLineNo); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return $oOutputFormat->implode(' ', $this->aComponents); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/RuleValueList.php 0000777 00000001125 15252010675 0023067 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; /** * This class is used to represent all multivalued rules like `font: bold 12px/3 Helvetica, Verdana, sans-serif;` * (where the value would be a whitespace-separated list of the primitive value `bold`, a slash-separated list * and a comma-separated list). */ class RuleValueList extends ValueList { /** * @param string $sSeparator * @param int $iLineNo */ public function __construct($sSeparator = ',', $iLineNo = 0) { parent::__construct([], $sSeparator, $iLineNo); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/CalcFunction.php 0000777 00000010723 15252010675 0022703 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * Support for `-webkit-calc` and `-moz-calc` is deprecated in version 8.8.0, and will be removed in version 9.0.0. */ class CalcFunction extends CSSFunction { /** * @var int * * @internal */ const T_OPERAND = 1; /** * @var int * * @internal */ const T_OPERATOR = 2; /** * @param ParserState $oParserState * @param bool $bIgnoreCase * * @return CalcFunction * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $bIgnoreCase = false) { $aOperators = ['+', '-', '*', '/']; $sFunction = $oParserState->parseIdentifier(); if ($oParserState->peek() != '(') { // Found ; or end of line before an opening bracket throw new UnexpectedTokenException('(', $oParserState->peek(), 'literal', $oParserState->currentLine()); } elseif (!in_array($sFunction, ['calc', '-moz-calc', '-webkit-calc'])) { // Found invalid calc definition. Example calc (... throw new UnexpectedTokenException('calc', $sFunction, 'literal', $oParserState->currentLine()); } $oParserState->consume('('); $oCalcList = new CalcRuleValueList($oParserState->currentLine()); $oList = new RuleValueList(',', $oParserState->currentLine()); $iNestingLevel = 0; $iLastComponentType = null; while (!$oParserState->comes(')') || $iNestingLevel > 0) { if ($oParserState->isEnd() && $iNestingLevel === 0) { break; } $oParserState->consumeWhiteSpace(); if ($oParserState->comes('(')) { $iNestingLevel++; $oCalcList->addListComponent($oParserState->consume(1)); $oParserState->consumeWhiteSpace(); continue; } elseif ($oParserState->comes(')')) { $iNestingLevel--; $oCalcList->addListComponent($oParserState->consume(1)); $oParserState->consumeWhiteSpace(); continue; } if ($iLastComponentType != CalcFunction::T_OPERAND) { $oVal = Value::parsePrimitiveValue($oParserState); $oCalcList->addListComponent($oVal); $iLastComponentType = CalcFunction::T_OPERAND; } else { if (in_array($oParserState->peek(), $aOperators)) { if (($oParserState->comes('-') || $oParserState->comes('+'))) { if ( $oParserState->peek(1, -1) != ' ' || !($oParserState->comes('- ') || $oParserState->comes('+ ')) ) { throw new UnexpectedTokenException( " {$oParserState->peek()} ", $oParserState->peek(1, -1) . $oParserState->peek(2), 'literal', $oParserState->currentLine() ); } } $oCalcList->addListComponent($oParserState->consume(1)); $iLastComponentType = CalcFunction::T_OPERATOR; } else { throw new UnexpectedTokenException( sprintf( 'Next token was expected to be an operand of type %s. Instead "%s" was found.', implode(', ', $aOperators), $oParserState->peek() ), '', 'custom', $oParserState->currentLine() ); } } $oParserState->consumeWhiteSpace(); } $oList->addListComponent($oCalcList); if (!$oParserState->isEnd()) { $oParserState->consume(')'); } return new CalcFunction($sFunction, $oList, ',', $oParserState->currentLine()); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Value/PrimitiveValue.php 0000777 00000000415 15252010675 0023275 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value; abstract class PrimitiveValue extends Value { /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Renderable.php 0000777 00000000720 15252010675 0021316 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS; interface Renderable { /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString(); /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat); /** * @return int */ public function getLineNo(); } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Position/Positionable.php 0000777 00000002325 15252010675 0023512 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position; /** * Represents a CSS item that may have a position in the source CSS document (line number and possibly column number). * * A standard implementation of this interface is available in the `Position` trait. */ interface Positionable { /** * @return int<1, max>|null */ public function getLineNumber(); /** * @return int<0, max> * * @deprecated in version 8.9.0, will be removed in v9.0. Use `getLineNumber()` instead. */ public function getLineNo(); /** * @return int<0, max>|null */ public function getColumnNumber(); /** * @return int<0, max> * * @deprecated in version 8.9.0, will be removed in v9.0. Use `getColumnNumber()` instead. */ public function getColNo(); /** * @param int<0, max>|null $lineNumber * Providing zero for this parameter is deprecated in version 8.9.0, and will not be supported from v9.0. * Use `null` instead when no line number is available. * @param int<0, max>|null $columnNumber */ public function setPosition($lineNumber, $columnNumber = null); } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Position/Position.php 0000777 00000002676 15252010675 0022677 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position; /** * Provides a standard reusable implementation of `Positionable`. * * @internal * * @phpstan-require-implements Positionable */ trait Position { /** * @var int<1, max>|null */ protected $lineNumber; /** * @var int<0, max>|null */ protected $columnNumber; /** * @return int<1, max>|null */ public function getLineNumber() { return $this->lineNumber; } /** * @return int<0, max> */ public function getLineNo() { $lineNumber = $this->getLineNumber(); return $lineNumber !== null ? $lineNumber : 0; } /** * @return int<0, max>|null */ public function getColumnNumber() { return $this->columnNumber; } /** * @return int<0, max> */ public function getColNo() { $columnNumber = $this->getColumnNumber(); return $columnNumber !== null ? $columnNumber : 0; } /** * @param int<0, max>|null $lineNumber * @param int<0, max>|null $columnNumber */ public function setPosition($lineNumber, $columnNumber = null) { // The conditional is for backwards compatibility (backcompat); `0` will not be allowed in future. $this->lineNumber = $lineNumber !== 0 ? $lineNumber : null; $this->columnNumber = $columnNumber; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Parsing/SourceException.php 0000777 00000001206 15252010675 0023775 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Positionable; class SourceException extends \Exception implements Positionable { use Position; /** * @param string $sMessage * @param int $iLineNo */ public function __construct($sMessage, $iLineNo = 0) { $this->setPosition($iLineNo); if (!empty($iLineNo)) { $sMessage .= " [line no: $iLineNo]"; } parent::__construct($sMessage); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Parsing/ParserState.php 0000777 00000034415 15252010675 0023123 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Settings; /** * @internal since 8.7.0 */ class ParserState { /** * @var null * * @internal since 8.5.2 */ const EOF = null; /** * @var Settings */ private $oParserSettings; /** * @var string */ private $sText; /** * @var array<int, string> */ private $aText; /** * @var int */ private $iCurrentPosition; /** * will only be used if the CSS does not contain an `@charset` declaration * * @var string */ private $sCharset; /** * @var int */ private $iLength; /** * @var int */ private $iLineNo; /** * @param string $sText the complete CSS as text (i.e., usually the contents of a CSS file) * @param int $iLineNo */ public function __construct($sText, Settings $oParserSettings, $iLineNo = 1) { $this->oParserSettings = $oParserSettings; $this->sText = $sText; $this->iCurrentPosition = 0; $this->iLineNo = $iLineNo; $this->setCharset($this->oParserSettings->sDefaultCharset); } /** * Sets the charset to be used if the CSS does not contain an `@charset` declaration. * * @param string $sCharset * * @return void */ public function setCharset($sCharset) { $this->sCharset = $sCharset; $this->aText = $this->strsplit($this->sText); if (is_array($this->aText)) { $this->iLength = count($this->aText); } } /** * Returns the charset that is used if the CSS does not contain an `@charset` declaration. * * @return string */ public function getCharset() { return $this->sCharset; } /** * @return int */ public function currentLine() { return $this->iLineNo; } /** * @return int */ public function currentColumn() { return $this->iCurrentPosition; } /** * @return Settings */ public function getSettings() { return $this->oParserSettings; } /** * @return \Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\Anchor */ public function anchor() { return new Anchor($this->iCurrentPosition, $this); } /** * @param int $iPosition * * @return void */ public function setPosition($iPosition) { $this->iCurrentPosition = $iPosition; } /** * @param bool $bIgnoreCase * * @return string * * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public function parseIdentifier($bIgnoreCase = true) { if ($this->isEnd()) { throw new UnexpectedEOFException('', '', 'identifier', $this->iLineNo); } $sResult = $this->parseCharacter(true); if ($sResult === null) { throw new UnexpectedTokenException($sResult, $this->peek(5), 'identifier', $this->iLineNo); } $sCharacter = null; while (!$this->isEnd() && ($sCharacter = $this->parseCharacter(true)) !== null) { if (preg_match('/[a-zA-Z0-9\x{00A0}-\x{FFFF}_-]/Sux', $sCharacter)) { $sResult .= $sCharacter; } else { $sResult .= '\\' . $sCharacter; } } if ($bIgnoreCase) { $sResult = $this->strtolower($sResult); } return $sResult; } /** * @param bool $bIsForIdentifier * * @return string|null * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public function parseCharacter($bIsForIdentifier) { if ($this->peek() === '\\') { if ( $bIsForIdentifier && $this->oParserSettings->bLenientParsing && ($this->comes('\0') || $this->comes('\9')) ) { // Non-strings can contain \0 or \9 which is an IE hack supported in lenient parsing. return null; } $this->consume('\\'); if ($this->comes('\n') || $this->comes('\r')) { return ''; } if (preg_match('/[0-9a-fA-F]/Su', $this->peek()) === 0) { return $this->consume(1); } $sUnicode = $this->consumeExpression('/^[0-9a-fA-F]{1,6}/u', 6); if ($this->strlen($sUnicode) < 6) { // Consume whitespace after incomplete unicode escape if (preg_match('/\\s/isSu', $this->peek())) { if ($this->comes('\r\n')) { $this->consume(2); } else { $this->consume(1); } } } $iUnicode = intval($sUnicode, 16); $sUtf32 = ""; for ($i = 0; $i < 4; ++$i) { $sUtf32 .= chr($iUnicode & 0xff); $iUnicode = $iUnicode >> 8; } return iconv('utf-32le', $this->sCharset, $sUtf32); } if ($bIsForIdentifier) { $peek = ord($this->peek()); // Ranges: a-z A-Z 0-9 - _ if ( ($peek >= 97 && $peek <= 122) || ($peek >= 65 && $peek <= 90) || ($peek >= 48 && $peek <= 57) || ($peek === 45) || ($peek === 95) || ($peek > 0xa1) ) { return $this->consume(1); } } else { return $this->consume(1); } return null; } /** * @return array<int, Comment>|void * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ public function consumeWhiteSpace() { $aComments = []; do { while (preg_match('/\\s/isSu', $this->peek()) === 1) { $this->consume(1); } if ($this->oParserSettings->bLenientParsing) { try { $oComment = $this->consumeComment(); } catch (UnexpectedEOFException $e) { $this->iCurrentPosition = $this->iLength; return $aComments; } } else { $oComment = $this->consumeComment(); } if ($oComment !== false) { $aComments[] = $oComment; } } while ($oComment !== false); return $aComments; } /** * @param string $sString * @param bool $bCaseInsensitive * * @return bool */ public function comes($sString, $bCaseInsensitive = false) { $sPeek = $this->peek(strlen($sString)); return ($sPeek == '') ? false : $this->streql($sPeek, $sString, $bCaseInsensitive); } /** * @param int $iLength * @param int $iOffset * * @return string */ public function peek($iLength = 1, $iOffset = 0) { $iOffset += $this->iCurrentPosition; if ($iOffset >= $this->iLength) { return ''; } return $this->substr($iOffset, $iLength); } /** * @param int $mValue * * @return string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ public function consume($mValue = 1) { if (is_string($mValue)) { $iLineCount = substr_count($mValue, "\n"); $iLength = $this->strlen($mValue); if (!$this->streql($this->substr($this->iCurrentPosition, $iLength), $mValue)) { throw new UnexpectedTokenException($mValue, $this->peek(max($iLength, 5)), $this->iLineNo); } $this->iLineNo += $iLineCount; $this->iCurrentPosition += $this->strlen($mValue); return $mValue; } else { if ($this->iCurrentPosition + $mValue > $this->iLength) { throw new UnexpectedEOFException($mValue, $this->peek(5), 'count', $this->iLineNo); } $sResult = $this->substr($this->iCurrentPosition, $mValue); $iLineCount = substr_count($sResult, "\n"); $this->iLineNo += $iLineCount; $this->iCurrentPosition += $mValue; return $sResult; } } /** * @param string $mExpression * @param int|null $iMaxLength * * @return string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ public function consumeExpression($mExpression, $iMaxLength = null) { $aMatches = null; $sInput = $iMaxLength !== null ? $this->peek($iMaxLength) : $this->inputLeft(); if (preg_match($mExpression, $sInput, $aMatches, PREG_OFFSET_CAPTURE) === 1) { return $this->consume($aMatches[0][0]); } throw new UnexpectedTokenException($mExpression, $this->peek(5), 'expression', $this->iLineNo); } /** * @return Comment|false */ public function consumeComment() { $mComment = false; if ($this->comes('/*')) { $iLineNo = $this->iLineNo; $this->consume(1); $mComment = ''; while (($char = $this->consume(1)) !== '') { $mComment .= $char; if ($this->comes('*/')) { $this->consume(2); break; } } } if ($mComment !== false) { // We skip the * which was included in the comment. return new Comment(substr($mComment, 1), $iLineNo); } return $mComment; } /** * @return bool */ public function isEnd() { return $this->iCurrentPosition >= $this->iLength; } /** * @param array<array-key, string>|string $aEnd * @param string $bIncludeEnd * @param string $consumeEnd * @param array<int, Comment> $comments * * @return string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ public function consumeUntil($aEnd, $bIncludeEnd = false, $consumeEnd = false, array &$comments = []) { $aEnd = is_array($aEnd) ? $aEnd : [$aEnd]; $out = ''; $start = $this->iCurrentPosition; while (!$this->isEnd()) { $char = $this->consume(1); if (in_array($char, $aEnd)) { if ($bIncludeEnd) { $out .= $char; } elseif (!$consumeEnd) { $this->iCurrentPosition -= $this->strlen($char); } return $out; } $out .= $char; if ($comment = $this->consumeComment()) { $comments[] = $comment; } } if (in_array(self::EOF, $aEnd)) { return $out; } $this->iCurrentPosition = $start; throw new UnexpectedEOFException( 'One of ("' . implode('","', $aEnd) . '")', $this->peek(5), 'search', $this->iLineNo ); } /** * @return string */ private function inputLeft() { return $this->substr($this->iCurrentPosition, -1); } /** * @param string $sString1 * @param string $sString2 * @param bool $bCaseInsensitive * * @return bool */ public function streql($sString1, $sString2, $bCaseInsensitive = true) { if ($bCaseInsensitive) { return $this->strtolower($sString1) === $this->strtolower($sString2); } else { return $sString1 === $sString2; } } /** * @param int $iAmount * * @return void */ public function backtrack($iAmount) { $this->iCurrentPosition -= $iAmount; } /** * @param string $sString * * @return int */ public function strlen($sString) { if ($this->oParserSettings->bMultibyteSupport) { return mb_strlen($sString, $this->sCharset); } else { return strlen($sString); } } /** * @param int $iStart * @param int $iLength * * @return string */ private function substr($iStart, $iLength) { if ($iLength < 0) { $iLength = $this->iLength - $iStart + $iLength; } if ($iStart + $iLength > $this->iLength) { $iLength = $this->iLength - $iStart; } $sResult = ''; while ($iLength > 0) { $sResult .= $this->aText[$iStart]; $iStart++; $iLength--; } return $sResult; } /** * @param string $sString * * @return string */ private function strtolower($sString) { if ($this->oParserSettings->bMultibyteSupport) { return mb_strtolower($sString, $this->sCharset); } else { return strtolower($sString); } } /** * @param string $sString * * @return array<int, string> */ private function strsplit($sString) { if ($this->oParserSettings->bMultibyteSupport) { if ($this->streql($this->sCharset, 'utf-8')) { return preg_split('//u', $sString, -1, PREG_SPLIT_NO_EMPTY); } else { $iLength = mb_strlen($sString, $this->sCharset); $aResult = []; for ($i = 0; $i < $iLength; ++$i) { $aResult[] = mb_substr($sString, $i, 1, $this->sCharset); } return $aResult; } } else { if ($sString === '') { return []; } else { return str_split($sString); } } } /** * @param string $sString * @param string $sNeedle * @param int $iOffset * * @return int|false */ private function strpos($sString, $sNeedle, $iOffset) { if ($this->oParserSettings->bMultibyteSupport) { return mb_strpos($sString, $sNeedle, $iOffset, $this->sCharset); } else { return strpos($sString, $sNeedle, $iOffset); } } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Parsing/UnexpectedTokenException.php 0000777 00000002755 15252010675 0025654 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing; /** * Thrown if the CSS parser encounters a token it did not expect. */ class UnexpectedTokenException extends SourceException { /** * @var string */ private $sExpected; /** * @var string */ private $sFound; /** * Possible values: literal, identifier, count, expression, search * * @var string */ private $sMatchType; /** * @param string $sExpected * @param string $sFound * @param string $sMatchType * @param int $iLineNo */ public function __construct($sExpected, $sFound, $sMatchType = 'literal', $iLineNo = 0) { $this->sExpected = $sExpected; $this->sFound = $sFound; $this->sMatchType = $sMatchType; $sMessage = "Token “{$sExpected}” ({$sMatchType}) not found. Got “{$sFound}”."; if ($this->sMatchType === 'search') { $sMessage = "Search for “{$sExpected}” returned no results. Context: “{$sFound}”."; } elseif ($this->sMatchType === 'count') { $sMessage = "Next token was expected to have {$sExpected} chars. Context: “{$sFound}”."; } elseif ($this->sMatchType === 'identifier') { $sMessage = "Identifier expected. Got “{$sFound}”"; } elseif ($this->sMatchType === 'custom') { $sMessage = trim("$sExpected $sFound"); } parent::__construct($sMessage, $iLineNo); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Parsing/OutputException.php 0000777 00000000617 15252010675 0024042 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing; /** * Thrown if the CSS parser attempts to print something invalid. */ class OutputException extends SourceException { /** * @param string $sMessage * @param int $iLineNo */ public function __construct($sMessage, $iLineNo = 0) { parent::__construct($sMessage, $iLineNo); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Parsing/Anchor.php 0000777 00000001415 15252010675 0022072 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing; /** * @internal since 8.7.0 */ class Anchor { /** * @var int */ private $iPosition; /** * @var \Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState */ private $oParserState; /** * @param int $iPosition * @param \Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\ParserState $oParserState */ public function __construct($iPosition, ParserState $oParserState) { $this->iPosition = $iPosition; $this->oParserState = $oParserState; } /** * @return void */ public function backtrack() { $this->oParserState->setPosition($this->iPosition); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Parsing/UnexpectedEOFException.php 0000777 00000000472 15252010675 0025177 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing; /** * Thrown if the CSS parser encounters end of file it did not expect. * * Extends `UnexpectedTokenException` in order to preserve backwards compatibility. */ class UnexpectedEOFException extends UnexpectedTokenException { } email-editor/vendor-prefixed/packages/Sabberworm/CSS/CSSElement.php 0000777 00000001063 15252010675 0021216 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS; /** * Represents any entity in the CSS that is encapsulated by a class. * * Its primary purpose is to provide a type for use with `Document::getAllValues()` * when a subset of values from a particular part of the document is required. * * Thus, elements which don't contain `Value`s (such as statement at-rules) don't need to implement this. * * It extends `Renderable` because every element is renderable. */ interface CSSElement extends Renderable {} email-editor/vendor-prefixed/packages/Sabberworm/CSS/Property/KeyframeSelector.php 0000777 00000001406 15252010675 0024345 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property; class KeyframeSelector extends Selector { /** * regexp for specificity calculations * * @var string * * @internal since 8.5.2 */ const SELECTOR_VALIDATION_RX = '/ ^( (?: [a-zA-Z0-9\x{00A0}-\x{FFFF}_^$|*="\'~\[\]()\-\s\.:#+>]* # any sequence of valid unescaped characters (?:\\\\.)? # a single escaped character (?:([\'"]).*?(?<!\\\\)\2)? # a quoted text like [id="example"] )* )| (\d+%) # keyframe animation progress percentage (e.g. 50%) $ /ux'; } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Property/CSSNamespace.php 0000777 00000006034 15252010675 0023350 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Positionable; /** * `CSSNamespace` represents an `@namespace` rule. */ class CSSNamespace implements AtRule, Positionable { use Position; /** * @var string */ private $mUrl; /** * @var string */ private $sPrefix; /** * @var int */ private $iLineNo; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param string $mUrl * @param string|null $sPrefix * @param int $iLineNo */ public function __construct($mUrl, $sPrefix = null, $iLineNo = 0) { $this->mUrl = $mUrl; $this->sPrefix = $sPrefix; $this->setPosition($iLineNo); $this->aComments = []; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return '@namespace ' . ($this->sPrefix === null ? '' : $this->sPrefix . ' ') . $this->mUrl->render($oOutputFormat) . ';'; } /** * @return string */ public function getUrl() { return $this->mUrl; } /** * @return string|null */ public function getPrefix() { return $this->sPrefix; } /** * @param string $mUrl * * @return void */ public function setUrl($mUrl) { $this->mUrl = $mUrl; } /** * @param string $sPrefix * * @return void */ public function setPrefix($sPrefix) { $this->sPrefix = $sPrefix; } /** * @return string */ public function atRuleName() { return 'namespace'; } /** * @return array<int, string> */ public function atRuleArgs() { $aResult = [$this->mUrl]; if ($this->sPrefix) { array_unshift($aResult, $this->sPrefix); } return $aResult; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Property/Import.php 0000777 00000005761 15252010675 0022363 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\URL; /** * Class representing an `@import` rule. */ class Import implements AtRule, Positionable { use Position; /** * @var URL */ private $oLocation; /** * @var string */ private $sMediaQuery; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param URL $oLocation * @param string $sMediaQuery * @param int $iLineNo */ public function __construct(URL $oLocation, $sMediaQuery, $iLineNo = 0) { $this->oLocation = $oLocation; $this->sMediaQuery = $sMediaQuery; $this->setPosition($iLineNo); $this->aComments = []; } /** * @param URL $oLocation * * @return void */ public function setLocation($oLocation) { $this->oLocation = $oLocation; } /** * @return URL */ public function getLocation() { return $this->oLocation; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return $oOutputFormat->comments($this) . "@import " . $this->oLocation->render($oOutputFormat) . ($this->sMediaQuery === null ? '' : ' ' . $this->sMediaQuery) . ';'; } /** * @return string */ public function atRuleName() { return 'import'; } /** * @return array<int, URL|string> */ public function atRuleArgs() { $aResult = [$this->oLocation]; if ($this->sMediaQuery) { array_push($aResult, $this->sMediaQuery); } return $aResult; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } /** * @return string */ public function getMediaQuery() { return $this->sMediaQuery; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Property/Selector.php 0000777 00000007227 15252010675 0022670 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property; /** * Class representing a single CSS selector. Selectors have to be split by the comma prior to being passed into this * class. */ class Selector { /** * regexp for specificity calculations * * @var string * * @internal */ const NON_ID_ATTRIBUTES_AND_PSEUDO_CLASSES_RX = '/ (\.[\w]+) # classes | \[(\w+) # attributes | (\:( # pseudo classes link|visited|active |hover|focus |lang |target |enabled|disabled|checked|indeterminate |root |nth-child|nth-last-child|nth-of-type|nth-last-of-type |first-child|last-child|first-of-type|last-of-type |only-child|only-of-type |empty|contains )) /ix'; /** * regexp for specificity calculations * * @var string * * @internal */ const ELEMENTS_AND_PSEUDO_ELEMENTS_RX = '/ ((^|[\s\+\>\~]+)[\w]+ # elements | \:{1,2}( # pseudo-elements after|before|first-letter|first-line|selection )) /ix'; /** * regexp for specificity calculations * * @var string * * @internal since 8.5.2 */ const SELECTOR_VALIDATION_RX = '/ ^( (?: [a-zA-Z0-9\x{00A0}-\x{FFFF}_^$|*="\'~\[\]()\-\s\.:#+>]* # any sequence of valid unescaped characters (?:\\\\.)? # a single escaped character (?:([\'"]).*?(?<!\\\\)\2)? # a quoted text like [id="example"] )* )$ /ux'; /** * @var string */ private $sSelector; /** * @var int|null */ private $iSpecificity; /** * @param string $sSelector * * @return bool * * @internal since V8.8.0 */ public static function isValid($sSelector) { return preg_match(static::SELECTOR_VALIDATION_RX, $sSelector); } /** * @param string $sSelector * @param bool $bCalculateSpecificity @deprecated since V8.8.0, will be removed in V9.0.0 */ public function __construct($sSelector, $bCalculateSpecificity = false) { $this->setSelector($sSelector); if ($bCalculateSpecificity) { $this->getSpecificity(); } } /** * @return string */ public function getSelector() { return $this->sSelector; } /** * @param string $sSelector * * @return void */ public function setSelector($sSelector) { $this->sSelector = trim($sSelector); $this->iSpecificity = null; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->getSelector(); } /** * @return int */ public function getSpecificity() { if ($this->iSpecificity === null) { $a = 0; /// @todo should exclude \# as well as "#" $aMatches = null; $b = substr_count($this->sSelector, '#'); $c = preg_match_all(self::NON_ID_ATTRIBUTES_AND_PSEUDO_CLASSES_RX, $this->sSelector, $aMatches); $d = preg_match_all(self::ELEMENTS_AND_PSEUDO_ELEMENTS_RX, $this->sSelector, $aMatches); $this->iSpecificity = ($a * 1000) + ($b * 100) + ($c * 10) + $d; } return $this->iSpecificity; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Property/AtRule.php 0000777 00000001744 15252010675 0022302 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Renderable; interface AtRule extends Renderable, Commentable { /** * Since there are more set rules than block rules, * we’re whitelisting the block rules and have anything else be treated as a set rule. * * @var string * * @internal since 8.5.2 */ const BLOCK_RULES = 'media/document/supports/region-style/font-feature-values'; /** * … and more font-specific ones (to be used inside font-feature-values) * * @var string * * @internal since 8.5.2 */ const SET_RULES = 'font-face/counter-style/page/swash/styleset/annotation'; /** * @return string|null */ public function atRuleName(); /** * @return string|null */ public function atRuleArgs(); } email-editor/vendor-prefixed/packages/Sabberworm/CSS/Property/Charset.php 0000777 00000005651 15252010675 0022500 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Property; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Value\CSSString; /** * Class representing an `@charset` rule. * * The following restrictions apply: * - May not be found in any CSSList other than the Document. * - May only appear at the very top of a Document’s contents. * - Must not appear more than once. */ class Charset implements AtRule, Positionable { use Position; /** * @var CSSString */ private $oCharset; /** * @var int * * @internal since 8.8.0 */ protected $iLineNo; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param CSSString $oCharset * @param int $iLineNo */ public function __construct(CSSString $oCharset, $iLineNo = 0) { $this->oCharset = $oCharset; $this->setPosition($iLineNo); $this->aComments = []; } /** * @param string|CSSString $oCharset * * @return void */ public function setCharset($sCharset) { $sCharset = $sCharset instanceof CSSString ? $sCharset : new CSSString($sCharset); $this->oCharset = $sCharset; } /** * @return string */ public function getCharset() { return $this->oCharset->getString(); } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return "{$oOutputFormat->comments($this)}@charset {$this->oCharset->render($oOutputFormat)};"; } /** * @return string */ public function atRuleName() { return 'charset'; } /** * @return string */ public function atRuleArgs() { return $this->oCharset; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/OutputFormatter.php 0000777 00000014666 15252010675 0022455 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS\Parsing\OutputException; /** * @internal since 8.8.0 */ class OutputFormatter { /** * @var OutputFormat */ private $oFormat; public function __construct(OutputFormat $oFormat) { $this->oFormat = $oFormat; } /** * @param string $sName * @param string|null $sType * * @return string */ public function space($sName, $sType = null) { $sSpaceString = $this->oFormat->get("Space$sName"); // If $sSpaceString is an array, we have multiple values configured // depending on the type of object the space applies to if (is_array($sSpaceString)) { if ($sType !== null && isset($sSpaceString[$sType])) { $sSpaceString = $sSpaceString[$sType]; } else { $sSpaceString = reset($sSpaceString); } } return $this->prepareSpace($sSpaceString); } /** * @return string */ public function spaceAfterRuleName() { return $this->space('AfterRuleName'); } /** * @return string */ public function spaceBeforeRules() { return $this->space('BeforeRules'); } /** * @return string */ public function spaceAfterRules() { return $this->space('AfterRules'); } /** * @return string */ public function spaceBetweenRules() { return $this->space('BetweenRules'); } /** * @return string */ public function spaceBeforeBlocks() { return $this->space('BeforeBlocks'); } /** * @return string */ public function spaceAfterBlocks() { return $this->space('AfterBlocks'); } /** * @return string */ public function spaceBetweenBlocks() { return $this->space('BetweenBlocks'); } /** * @return string */ public function spaceBeforeSelectorSeparator() { return $this->space('BeforeSelectorSeparator'); } /** * @return string */ public function spaceAfterSelectorSeparator() { return $this->space('AfterSelectorSeparator'); } /** * @param string $sSeparator * * @return string */ public function spaceBeforeListArgumentSeparator($sSeparator) { $spaceForSeparator = $this->oFormat->getSpaceBeforeListArgumentSeparators(); if (isset($spaceForSeparator[$sSeparator])) { return $spaceForSeparator[$sSeparator]; } return $this->space('BeforeListArgumentSeparator', $sSeparator); } /** * @param string $sSeparator * * @return string */ public function spaceAfterListArgumentSeparator($sSeparator) { $spaceForSeparator = $this->oFormat->getSpaceAfterListArgumentSeparators(); if (isset($spaceForSeparator[$sSeparator])) { return $spaceForSeparator[$sSeparator]; } return $this->space('AfterListArgumentSeparator', $sSeparator); } /** * @return string */ public function spaceBeforeOpeningBrace() { return $this->space('BeforeOpeningBrace'); } /** * Runs the given code, either swallowing or passing exceptions, depending on the `bIgnoreExceptions` setting. * * @param string $cCode the name of the function to call * * @return string|null */ public function safely($cCode) { if ($this->oFormat->get('IgnoreExceptions')) { // If output exceptions are ignored, run the code with exception guards try { return $cCode(); } catch (OutputException $e) { return null; } // Do nothing } else { // Run the code as-is return $cCode(); } } /** * Clone of the `implode` function, but calls `render` with the current output format instead of `__toString()`. * * @param string $sSeparator * @param array<array-key, Renderable|string> $aValues * @param bool $bIncreaseLevel * * @return string */ public function implode($sSeparator, array $aValues, $bIncreaseLevel = false) { $sResult = ''; $oFormat = $this->oFormat; if ($bIncreaseLevel) { $oFormat = $oFormat->nextLevel(); } $bIsFirst = true; foreach ($aValues as $mValue) { if ($bIsFirst) { $bIsFirst = false; } else { $sResult .= $sSeparator; } if ($mValue instanceof Renderable) { $sResult .= $mValue->render($oFormat); } else { $sResult .= $mValue; } } return $sResult; } /** * @param string $sString * * @return string */ public function removeLastSemicolon($sString) { if ($this->oFormat->get('SemicolonAfterLastRule')) { return $sString; } $sString = explode(';', $sString); if (count($sString) < 2) { return $sString[0]; } $sLast = array_pop($sString); $sNextToLast = array_pop($sString); array_push($sString, $sNextToLast . $sLast); return implode(';', $sString); } /** * * @param array<Commentable> $aComments * * @return string */ public function comments(Commentable $oCommentable) { if (!$this->oFormat->bRenderComments) { return ''; } $sResult = ''; $aComments = $oCommentable->getComments(); $iLastCommentIndex = count($aComments) - 1; foreach ($aComments as $i => $oComment) { $sResult .= $oComment->render($this->oFormat); $sResult .= $i === $iLastCommentIndex ? $this->spaceAfterBlocks() : $this->spaceBetweenBlocks(); } return $sResult; } /** * @param string $sSpaceString * * @return string */ private function prepareSpace($sSpaceString) { return str_replace("\n", "\n" . $this->indent(), $sSpaceString); } /** * @return string */ private function indent() { return str_repeat($this->oFormat->sIndentation, $this->oFormat->getIndentationLevel()); } } email-editor/vendor-prefixed/packages/Sabberworm/CSS/OutputFormat.php 0000777 00000026425 15252010675 0021736 0 ustar 00 <?php namespace Automattic\WooCommerce\EmailEditorVendor\Sabberworm\CSS; /** * Extending this class is deprecated in version 8.8.0; it will be made `final` in version 9.0.0. * * @method OutputFormat setSemicolonAfterLastRule(bool $bSemicolonAfterLastRule) Set whether semicolons are added after * last rule. */ class OutputFormat { /** * Value format: `"` means double-quote, `'` means single-quote * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sStringQuotingType = '"'; /** * Output RGB colors in hash notation if possible * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bRGBHashNotation = true; /** * Declaration format * * Semicolon after the last rule of a declaration block can be omitted. To do that, set this false. * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bSemicolonAfterLastRule = true; /** * Spacing * Note that these strings are not sanity-checked: the value should only consist of whitespace * Any newline character will be indented according to the current level. * The triples (After, Before, Between) can be set using a wildcard (e.g. `$oFormat->set('Space*Rules', "\n");`) * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterRuleName = ' '; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeRules = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterRules = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBetweenRules = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeBlocks = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterBlocks = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBetweenBlocks = "\n"; /** * Content injected in and around at-rule blocks. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sBeforeAtRuleBlock = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sAfterAtRuleBlock = ''; /** * This is what’s printed before and after the comma if a declaration block contains multiple selectors. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeSelectorSeparator = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterSelectorSeparator = ' '; /** * This is what’s inserted before the separator in value lists, by default. * * `array` is deprecated in version 8.8.0, and will be removed in version 9.0.0. * To set the spacing for specific separators, use {@see $aSpaceBeforeListArgumentSeparators} instead. * * @var string|array<non-empty-string, string> * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeListArgumentSeparator = ''; /** * Keys are separators (e.g. `,`). Values are the space sequence to insert, or an empty string. * * @var array<non-empty-string, string> * * @internal since 8.8.0, will be made private in 9.0.0 */ public $aSpaceBeforeListArgumentSeparators = []; /** * This is what’s inserted after the separator in value lists, by default. * * `array` is deprecated in version 8.8.0, and will be removed in version 9.0.0. * To set the spacing for specific separators, use {@see $aSpaceAfterListArgumentSeparators} instead. * * @var string|array<non-empty-string, string> * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterListArgumentSeparator = ''; /** * Keys are separators (e.g. `,`). Values are the space sequence to insert, or an empty string. * * @var array<non-empty-string, string> * * @internal since 8.8.0, will be made private in 9.0.0 */ public $aSpaceAfterListArgumentSeparators = []; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeOpeningBrace = ' '; /** * Content injected in and around declaration blocks. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sBeforeDeclarationBlock = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sAfterDeclarationBlockSelectors = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sAfterDeclarationBlock = ''; /** * Indentation character(s) per level. Only applicable if newlines are used in any of the spacing settings. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sIndentation = "\t"; /** * Output exceptions. * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bIgnoreExceptions = false; /** * Render comments for lists and RuleSets * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bRenderComments = false; /** * @var OutputFormatter|null */ private $oFormatter = null; /** * @var OutputFormat|null */ private $oNextLevelFormat = null; /** * @var int */ private $iIndentationLevel = 0; /** * @internal since V8.8.0. Use the factory methods `create()`, `createCompact()`, or `createPretty()` instead. */ public function __construct() { } /** * @param string $sName * * @return string|null * * @deprecated since 8.8.0, will be removed in 9.0.0. Use specific getters instead. */ public function get($sName) { $aVarPrefixes = ['a', 's', 'm', 'b', 'f', 'o', 'c', 'i']; foreach ($aVarPrefixes as $sPrefix) { $sFieldName = $sPrefix . ucfirst($sName); if (isset($this->$sFieldName)) { return $this->$sFieldName; } } return null; } /** * @param array<array-key, string>|string $aNames * @param mixed $mValue * * @return self|false * * @deprecated since 8.8.0, will be removed in 9.0.0. Use specific setters instead. */ public function set($aNames, $mValue) { $aVarPrefixes = ['a', 's', 'm', 'b', 'f', 'o', 'c', 'i']; if (is_string($aNames) && strpos($aNames, '*') !== false) { $aNames = [ str_replace('*', 'Before', $aNames), str_replace('*', 'Between', $aNames), str_replace('*', 'After', $aNames), ]; } elseif (!is_array($aNames)) { $aNames = [$aNames]; } foreach ($aVarPrefixes as $sPrefix) { $bDidReplace = false; foreach ($aNames as $sName) { $sFieldName = $sPrefix . ucfirst($sName); if (isset($this->$sFieldName)) { $this->$sFieldName = $mValue; $bDidReplace = true; } } if ($bDidReplace) { return $this; } } // Break the chain so the user knows this option is invalid return false; } /** * @param string $sMethodName * @param array<array-key, mixed> $aArguments * * @return mixed * * @throws \Exception */ public function __call($sMethodName, array $aArguments) { if (strpos($sMethodName, 'set') === 0) { return $this->set(substr($sMethodName, 3), $aArguments[0]); } elseif (strpos($sMethodName, 'get') === 0) { return $this->get(substr($sMethodName, 3)); } elseif (method_exists(OutputFormatter::class, $sMethodName)) { // @deprecated since 8.8.0, will be removed in 9.0.0. Call the method on the formatter directly instead. return call_user_func_array([$this->getFormatter(), $sMethodName], $aArguments); } else { throw new \Exception('Unknown OutputFormat method called: ' . $sMethodName); } } /** * @param int $iNumber * * @return self */ public function indentWithTabs($iNumber = 1) { return $this->setIndentation(str_repeat("\t", $iNumber)); } /** * @param int $iNumber * * @return self */ public function indentWithSpaces($iNumber = 2) { return $this->setIndentation(str_repeat(" ", $iNumber)); } /** * @return OutputFormat * * @internal since V8.8.0 */ public function nextLevel() { if ($this->oNextLevelFormat === null) { $this->oNextLevelFormat = clone $this; $this->oNextLevelFormat->iIndentationLevel++; $this->oNextLevelFormat->oFormatter = null; } return $this->oNextLevelFormat; } /** * @return void */ public function beLenient() { $this->bIgnoreExceptions = true; } /** * @return OutputFormatter * * @internal since 8.8.0 */ public function getFormatter() { if ($this->oFormatter === null) { $this->oFormatter = new OutputFormatter($this); } return $this->oFormatter; } /** * @return int * * @deprecated #869 since version V8.8.0, will be removed in V9.0.0. Use `getIndentationLevel()` instead. */ public function level() { return $this->iIndentationLevel; } /** * Creates an instance of this class without any particular formatting settings. * * @return self */ public static function create() { return new OutputFormat(); } /** * Creates an instance of this class with a preset for compact formatting. * * @return self */ public static function createCompact() { $format = self::create(); $format->set('Space*Rules', "") ->set('Space*Blocks', "") ->setSpaceAfterRuleName('') ->setSpaceBeforeOpeningBrace('') ->setSpaceAfterSelectorSeparator('') ->setRenderComments(false); return $format; } /** * Creates an instance of this class with a preset for pretty formatting. * * @return self */ public static function createPretty() { $format = self::create(); $format->set('Space*Rules', "\n") ->set('Space*Blocks', "\n") ->setSpaceBetweenBlocks("\n\n") ->set('SpaceAfterListArgumentSeparators', [',' => ' ']) ->setRenderComments(true); return $format; } } email-editor/vendor-prefixed/composer.json 0000777 00000001736 15252010675 0014763 0 ustar 00 { "name": "woocommerce/email-editor-lib", "description": "A package for hiding re-namespaced dependencies and executing them", "prefer-stable": true, "minimum-stability": "dev", "require": { "php": ">=7.4" }, "require-dev": { "pelago/emogrifier": "7.3.0" }, "config": { "platform": { "php": "7.4" } }, "scripts": { "post-install-cmd": [ "\"../../../../plugins/woocommerce/vendor/bin/mozart\" compose" ], "post-update-cmd": [ "\"../../../../plugins/woocommerce/vendor/bin/mozart\" compose" ] }, "extra": { "mozart": { "dep_namespace": "Automattic\\WooCommerce\\EmailEditorVendor\\", "dep_directory": "/packages/", "packages": [ "pelago/emogrifier" ], "excluded_packages": [ ], "override_autoload": { "thecodingmachine/safe": { "psr-4": { "Safe\\": "" } } }, "classmap_directory": "/classes/", "classmap_prefix": "EmailEditorVendor_", "delete_vendor_directories": true } } } email-editor/src/class-package.php 0000777 00000001334 15252010675 0013130 0 ustar 00 <?php /** * Email Editor Container class file. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor; defined( 'ABSPATH' ) || exit; /** * Main package class. */ class Package { /** * Version. * * @var string */ const VERSION = '0.1.0'; /** * Init the package. * * @return void */ public static function init() { Email_Editor_Container::init(); } /** * Return the version of the package. * * @return string */ public static function get_version() { return self::VERSION; } /** * Return the path to the package. * * @return string */ public static function get_path() { return dirname( __DIR__ ); } } email-editor/src/class-container.php 0000777 00000004474 15252010675 0013527 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor; /** * Class Container is a simple dependency injection container. * * @package Automattic\WooCommerce\EmailEditor */ class Container { /** * A list of registered services * * @var array<string, callable> $services */ protected array $services = array(); /** * A list of created instances * * @var array<string, object> $instances */ protected array $instances = array(); /** * Prevents deserialization of this class to avoid callback replacement attacks. * * @param array $data The serialized data. * @return void * @throws \Exception Always throws an exception to prevent deserialization. */ public function __unserialize( array $data ): void { throw new \Exception( 'Deserialization of Container is not allowed for security reasons.' ); } /** * The method for registering a new service. * * @param string $name The name of the service. * @param callable $callback The callable that will be used to create the service. * @return void * @phpstan-template T of object * @phpstan-param class-string<T> $name */ public function set( string $name, callable $callback ): void { $this->services[ $name ] = $callback; } /** * Method for getting a registered service. * * @param string $name The name of the service. * @return object The service instance. * @throws \Exception If the service is not found. * @phpstan-template T of object * @phpstan-param class-string<T> $name * @phpstan-return T */ public function get( string $name ): object { // Check if the service is already instantiated. if ( isset( $this->instances[ $name ] ) ) { /** * Instance. * * @var T $instance Instance of requested service. */ $instance = $this->instances[ $name ]; return $instance; } // Check if the service is registered. if ( ! isset( $this->services[ $name ] ) ) { throw new \Exception( esc_html( "Service not found: $name" ) ); } /** * Instance. * * @var T $instance Instance of requested service. */ $instance = $this->services[ $name ]( $this ); $this->instances[ $name ] = $instance; return $instance; } } email-editor/src/exceptions.php 0000777 00000005477 15252010675 0012627 0 ustar 00 <?php declare(strict_types = 1); // phpcs:ignoreFile PSR1.Classes.ClassDeclaration namespace Automattic\WooCommerce\EmailEditor; /** * Provides information for converting exceptions to HTTP responses. */ interface HttpAwareException { public function getHttpStatusCode(): int; } /** * Frames all exceptions ("$e instanceof Automattic\WooCommerce\EmailEditor\Exception"). */ abstract class Exception extends \Exception { /** @var string[] */ private $errors = []; final public function __construct(string $message = '', int $code = 0, ?\Throwable $previous = null) { parent::__construct($message, $code, $previous); } /** @return static */ public static function create(?\Throwable $previous = null) { return new static('', 0, $previous); } /** @return static */ public function withMessage(string $message) { $this->message = $message; return $this; } /** @return static */ public function withCode(int $code) { $this->code = $code; return $this; } /** * @param string[] $errors * @return static */ public function withErrors(array $errors) { $this->errors = $errors; return $this; } /** @return static */ public function withError(string $id, string $error) { $this->errors[$id] = $error; return $this; } /** * @return string[] */ public function getErrors(): array { return $this->errors; } } /** * USE: Generic runtime error. When possible, use a more specific exception instead. * API: 500 Server Error (not HTTP-aware) */ class RuntimeException extends Exception {} /** * USE: When wrong data VALUE is received. * API: 400 Bad Request */ class UnexpectedValueException extends RuntimeException implements HttpAwareException { public function getHttpStatusCode(): int { return 400; } } /** * USE: When an action is forbidden for given actor (although generally valid). * API: 403 Forbidden */ class AccessDeniedException extends UnexpectedValueException implements HttpAwareException { public function getHttpStatusCode(): int { return 403; } } /** * USE: When the main resource we're interested in doesn't exist. * API: 404 Not Found */ class NotFoundException extends UnexpectedValueException implements HttpAwareException { public function getHttpStatusCode(): int { return 404; } } /** * USE: When the main action produces conflict (i.e. duplicate key). * API: 409 Conflict */ class ConflictException extends UnexpectedValueException implements HttpAwareException { public function getHttpStatusCode(): int { return 409; } } /** * USE: An application state that should not occur. Can be subclassed for feature-specific exceptions. * API: 500 Server Error (not HTTP-aware) */ class InvalidStateException extends RuntimeException {} class NewsletterProcessingException extends Exception {} email-editor/src/Integrations/WooCommerce/Renderer/Blocks/class-product-price.php 0000777 00000015365 15252010675 0024176 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * Renders a WooCommerce product price block for email. */ class Product_Price extends Abstract_Product_Block_Renderer { /** * Render the product price block content for email. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $product = $this->get_product_from_context( $parsed_block ); if ( ! $product ) { return ''; } $attributes = $parsed_block['attrs'] ?? array(); $price_content = $this->generate_price_html( $product, $attributes, $rendering_context ); return $this->apply_email_wrapper( $price_content, $parsed_block ); } /** * Generate clean price HTML from product data. * * @param \WC_Product $product Product object. * @param array $attributes Block attributes. * @param Rendering_Context $rendering_context Rendering context. * @return string */ private function generate_price_html( \WC_Product $product, array $attributes, Rendering_Context $rendering_context ): string { $price_html = $this->build_price_from_scratch( $product ); if ( empty( $price_html ) ) { return ''; } $price_styles = array( 'display' => 'block', 'margin' => '0', 'padding' => '0', 'font-family' => 'inherit', 'color' => 'inherit', 'text-decoration' => 'none', ); $custom_styles = Styles_Helper::get_block_styles( $attributes, $rendering_context, array( 'border', 'background-color', 'color', 'typography', 'spacing' ) ); $price_styles = array_merge( $price_styles, $custom_styles['declarations'] ); $style_attr = \WP_Style_Engine::compile_css( $price_styles, '' ); return sprintf( '<div class="wc-block-components-product-price" style="%s">%s</div>', esc_attr( $style_attr ), $price_html ); } /** * Build price HTML completely from scratch based on product type. * * @param \WC_Product $product Product object. * @return string */ private function build_price_from_scratch( \WC_Product $product ): string { $product_type = $product->get_type(); switch ( $product_type ) { case 'simple': case 'external': return $this->build_simple_product_price( $product ); case 'variable': // When the product does not have a correct type, the default will be used. if ( $product instanceof \WC_Product_Variable ) { return $this->build_variable_product_price( $product ); } return $this->build_simple_product_price( $product ); case 'grouped': // When the product does not have a correct type, the default will be used. if ( $product instanceof \WC_Product_Grouped ) { return $this->build_grouped_product_price( $product ); } return $this->build_simple_product_price( $product ); default: return $this->build_simple_product_price( $product ); } } /** * Build price HTML for simple products. * * @param \WC_Product $product Product object. * @return string */ private function build_simple_product_price( \WC_Product $product ): string { $regular_price = wc_get_price_to_display( $product, array( 'price' => (float) $product->get_regular_price() ) ); $sale_price = $product->get_sale_price() !== '' ? wc_get_price_to_display( $product, array( 'price' => (float) $product->get_sale_price() ) ) : ''; if ( empty( $regular_price ) ) { return ''; } if ( $product->is_on_sale() && '' !== $sale_price ) { return sprintf( '<del style="text-decoration: line-through; font-size: 0.9em; margin-right: 0.5em;">%s</del><span>%s</span>', wc_price( $regular_price, array( 'in_span' => false ) ), wc_price( $sale_price, array( 'in_span' => false ) ) ); } else { return sprintf( '<span>%s</span>', wc_price( $regular_price, array( 'in_span' => false ) ) ); } } /** * Build price HTML for variable products. * Uses the same logic as the editor: get_variation_price() methods. * * @param \WC_Product_Variable $product Variable product object. * @return string */ private function build_variable_product_price( \WC_Product_Variable $product ): string { $min_price = $product->get_variation_price( 'min', true ); $max_price = $product->get_variation_price( 'max', true ); return sprintf( '<span>%s — %s</span>', wc_price( (float) $min_price, array( 'in_span' => false ) ), wc_price( (float) $max_price, array( 'in_span' => false ) ) ); } /** * Build price HTML for grouped products. * * @param \WC_Product_Grouped $product Grouped product object. * @return string */ private function build_grouped_product_price( \WC_Product_Grouped $product ): string { $children = $product->get_children(); if ( empty( $children ) ) { return ''; } $prices = array(); foreach ( $children as $child_id ) { $child = wc_get_product( $child_id ); if ( $child && $child->get_price() !== '' ) { $prices[] = wc_get_price_to_display( $child, array( 'price' => (float) $child->get_price() ) ); } } if ( empty( $prices ) ) { return ''; } $min_price = min( $prices ); $max_price = max( $prices ); return sprintf( '<span>%s — %s</span>', wc_price( (float) $min_price, array( 'in_span' => false ) ), wc_price( (float) $max_price, array( 'in_span' => false ) ) ); } /** * Apply email-compatible table wrapper. * * @param string $price_html Price HTML. * @param array $parsed_block Parsed block. * @return string */ private function apply_email_wrapper( string $price_html, array $parsed_block ): string { $align = $parsed_block['attrs']['textAlign'] ?? 'left'; $wrapper_styles = array( 'border-collapse' => 'collapse', 'width' => '100%', ); $cell_styles = array( 'padding' => '5px 0', 'text-align' => $align, 'font-family' => 'inherit', ); $table_attrs = array( 'style' => \WP_Style_Engine::compile_css( $wrapper_styles, '' ), 'width' => '100%', ); $cell_attrs = array( 'class' => 'email-product-price-cell', 'style' => \WP_Style_Engine::compile_css( $cell_styles, '' ), 'align' => $align, ); return Table_Wrapper_Helper::render_table_wrapper( $price_html, $table_attrs, $cell_attrs ); } } email-editor/src/Integrations/WooCommerce/Renderer/Blocks/class-product-button.php 0000777 00000011224 15252010675 0024375 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * Renders a WooCommerce product button block for email. */ class Product_Button extends Abstract_Product_Block_Renderer { /** * Get styles for the wrapper element. * * @param array $block_attributes Block attributes. * @param Rendering_Context $rendering_context Rendering context. * @return array */ private function get_wrapper_styles( array $block_attributes, Rendering_Context $rendering_context ): array { $block_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'border', 'background-color', 'color', 'typography', 'spacing' ) ); return Styles_Helper::extend_block_styles( $block_styles, array( 'word-break' => 'break-word', 'display' => 'block', ) ); } /** * Get styles for the button link element. * * @param array $block_attributes Block attributes. * @param Rendering_Context $rendering_context Rendering context. * @return array */ private function get_button_styles( array $block_attributes, Rendering_Context $rendering_context ): array { $block_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'color', 'typography' ) ); return Styles_Helper::extend_block_styles( $block_styles, array( 'display' => 'block', 'text-decoration' => 'none', 'width' => '100%', ) ); } /** * Render the product button block content for email. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $product = $this->get_product_from_context( $parsed_block ); if ( ! $product ) { return ''; } // Check if this is a cart-contents collection to customize button text and link. $collection = $parsed_block['context']['collection'] ?? ''; $is_cart_contents = 'woocommerce/product-collection/cart-contents' === $collection; if ( $is_cart_contents ) { // For cart contents, link to cart page instead of product page. $button_text = __( 'Finish checkout', 'woocommerce' ); $button_url = wc_get_cart_url(); } else { $button_text = $product->add_to_cart_text() ? $product->add_to_cart_text() : __( 'Add to cart', 'woocommerce' ); if ( $product->is_type( 'external' ) && $product instanceof \WC_Product_External ) { $external_url = $product->get_product_url(); $button_url = $external_url ? $external_url : $product->get_permalink(); } else { $button_url = $product->get_permalink(); } } $block_attributes = array_replace_recursive( array( 'textColor' => '#ffffff', 'backgroundColor' => '#000000', 'textAlign' => 'left', 'width' => '', 'style' => array( 'typography' => array( 'fontSize' => '16px', 'fontWeight' => 'bold', ), 'border' => array( 'radius' => '0', ), 'spacing' => array( 'padding' => '12px 24px', ), ), ), $parsed_block['attrs'] ?? array() ); $wrapper_styles = $this->get_wrapper_styles( $block_attributes, $rendering_context ); $button_styles = $this->get_button_styles( $block_attributes, $rendering_context ); $table_attrs = array( 'style' => 'width:' . ( $block_attributes['width'] ? '100%' : 'auto' ) . ';', 'align' => $block_attributes['textAlign'], ); $cell_attrs = array( 'class' => $wrapper_styles['classnames'], 'style' => $wrapper_styles['css'], 'align' => $block_attributes['textAlign'], 'valign' => 'middle', 'role' => 'presentation', ); $button_content = sprintf( '<a class="product-button-link %1$s" style="%2$s" href="%3$s" target="_blank">%4$s</a>', esc_attr( $button_styles['classnames'] ), esc_attr( $button_styles['css'] ), esc_url( $button_url ), esc_html( $button_text ) ); $button_html = Table_Wrapper_Helper::render_table_wrapper( $button_content, $table_attrs, $cell_attrs ); return Table_Wrapper_Helper::render_table_wrapper( $button_html, array( 'style' => 'width: 100%' ) ); } } email-editor/src/Integrations/WooCommerce/Renderer/Blocks/class-product-image.php 0000777 00000034773 15252010675 0024162 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * Renders a WooCommerce product image block for email. */ class Product_Image extends Abstract_Product_Block_Renderer { /** * Render the product image block content for email. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $product = $this->get_product_from_context( $parsed_block ); if ( ! $product ) { return ''; } $attributes = $this->parse_attributes( $parsed_block['attrs'] ?? array() ); $image_data = $this->get_product_image_data( $product, $attributes ); if ( ! $image_data ) { return ''; } $parsed_block = $this->add_image_size_when_missing( $parsed_block, $rendering_context ); $attributes = $this->parse_attributes( $parsed_block['attrs'] ?? array() ); $image_html = $this->build_image_html( $image_data, $attributes, $rendering_context ); $inner_blocks = $this->process_inner_blocks( $parsed_block, $product, $rendering_context ); $combined_content = $this->create_overlay_structure( $image_html, $inner_blocks['badges'], $inner_blocks['other_content'], $inner_blocks['badge_alignment'], $product, $attributes['showProductLink'] ); return $this->apply_email_wrapper( $combined_content, $parsed_block, $rendering_context ); } /** * Process inner blocks (like sale badges) from block content. * Handles special positioning for email compatibility. * * @param array $parsed_block Parsed block. * @param \WC_Product $product Product object. * @param Rendering_Context $rendering_context Rendering context. * @return array Array with 'badges' and 'other_content' keys */ private function process_inner_blocks( array $parsed_block, \WC_Product $product, Rendering_Context $rendering_context ): array { $badges = ''; $other_content = ''; $badge_alignment = 'left'; if ( ! empty( $parsed_block['innerBlocks'] ) ) { foreach ( $parsed_block['innerBlocks'] as $inner_block ) { $inner_block['context'] = $inner_block['context'] ?? array(); $inner_block['context']['postId'] = $product->get_id(); if ( 'woocommerce/product-sale-badge' === $inner_block['blockName'] ) { $badges .= $this->render_overlay_badge( $inner_block, $product, $rendering_context ); $badge_alignment = $inner_block['attrs']['align'] ?? 'left'; } else { $other_content .= render_block( $inner_block ); } } } return array( 'badges' => $badges, 'other_content' => $other_content, 'badge_alignment' => $badge_alignment, ); } /** * Render a sale badge with email-compatible overlay positioning. * * @param array $badge_block Badge block data. * @param \WC_Product $product Product object. * @param Rendering_Context $rendering_context Rendering context. * @return string */ private function render_overlay_badge( array $badge_block, \WC_Product $product, Rendering_Context $rendering_context ): string { if ( ! $product->is_on_sale() ) { return ''; } $sale_text = apply_filters( 'woocommerce_sale_badge_text', __( 'Sale', 'woocommerce' ), $product ); $badge_attributes = array_replace_recursive( array( 'textColor' => '#43454b', 'backgroundColor' => '#fff', 'style' => array( 'border' => array( 'width' => '1px', 'radius' => '4px', 'color' => '#43454b', ), 'spacing' => array( 'padding' => '4px 12px', ), 'typography' => array( 'fontSize' => '14px', 'fontWeight' => '600', 'textTransform' => 'uppercase', 'lineHeight' => '1.5', ), ), ), wp_parse_args( $badge_block['attrs'] ?? array() ) ); $block_styles = Styles_Helper::get_block_styles( $badge_attributes, $rendering_context, array( 'border', 'background-color', 'color', 'typography', 'spacing' ) ); $additional_styles = array( 'display' => 'inline-block', 'width' => 'fit-content', 'box-sizing' => 'border-box', ); $final_styles = Styles_Helper::extend_block_styles( $block_styles, $additional_styles ); return sprintf( '<span class="wc-block-components-product-sale-badge__text" style="%s">%s</span>', esc_attr( $final_styles['css'] ), esc_html( $sale_text ) ); } /** * Create overlay structure for email compatibility. * Uses Faux Absolute Position with badge-below fallback for better cross-client support. * * @param string $image_html Image HTML. * @param string $badges_html Badges HTML. * @param string $other_content Other inner content. * @param string $badge_alignment Badge alignment. * @param \WC_Product|null $product Product object for link. * @param bool $show_product_link Whether to show product link. * @return string */ private function create_overlay_structure( string $image_html, string $badges_html, string $other_content, string $badge_alignment, ?\WC_Product $product = null, bool $show_product_link = false ): string { if ( empty( $badges_html ) ) { $linked_image_html = $image_html; if ( $show_product_link && $product ) { $linked_image_html = $this->wrap_with_link( $image_html, $product ); } return $linked_image_html . $other_content; } $image_width = $this->extract_image_width( $image_html ); $image_height = $this->extract_image_height( $image_html ); $linked_image_html = $image_html; if ( $show_product_link && $product ) { $linked_image_html = $this->wrap_with_link( $image_html, $product ); } $vml_side = ( 'left' === $badge_alignment ) ? 'left' : 'right'; $overlay_html = sprintf( '<table cellpadding="0" cellspacing="0" border="0" style="width: %dpx; height: %dpx; table-layout: fixed;"> <tr> <td style="font-size: 0; line-height: 0; padding: 0; height: %dpx; width: %dpx;"> <div style="max-height:0; position:relative; opacity:0.999;"> <!--[if mso]> <v:rect xmlns:v="urn:schemas-microsoft-com:vml" stroked="false" filled="false" style="mso-width-percent: 1000; position:absolute; top:16px; ' . esc_attr( $vml_side ) . ':16px;"> <v:textbox inset="0,0,0,0"> <![endif]--> <div style="padding: 12px; box-sizing: border-box; display: inline-block; width: 100%%; text-align: %s;"> %s </div> <!--[if mso]> </v:textbox> </v:rect> <![endif]--> </div> %s </td> </tr> </table>%s', $image_width, $image_height, $image_height, $image_width, $badge_alignment, $badges_html, $linked_image_html, $other_content ); return $overlay_html; } /** * Extract image width from HTML for positioning calculations. * * @param string $image_html Image HTML. * @return float Image width in pixels. */ private function extract_image_width( string $image_html ): float { $width = ( new Dom_Document_Helper( $image_html ) )->get_attribute_value_by_tag_name( 'img', 'width' ) ?? ''; if ( $width ) { return Styles_Helper::parse_value( $width ); } return 300; } /** * Extract image height from HTML for positioning calculations. * * @param string $image_html Image HTML. * @return float Image height in pixels. */ private function extract_image_height( string $image_html ): float { $height = ( new Dom_Document_Helper( $image_html ) )->get_attribute_value_by_tag_name( 'img', 'height' ) ?? ''; if ( $height ) { return Styles_Helper::parse_value( $height ); } return 300; } /** * When the width is not set, it's important to get it for the image to be displayed correctly. * Based on the email Image renderer logic. * * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return array */ private function add_image_size_when_missing( array $parsed_block, Rendering_Context $rendering_context ): array { if ( isset( $parsed_block['attrs']['width'] ) ) { return $parsed_block; } if ( ! isset( $parsed_block['email_attrs']['width'] ) ) { $parsed_block['attrs']['width'] = '100%'; return $parsed_block; } $parsed_block['attrs']['width'] = $rendering_context->get_layout_width_without_padding(); return $parsed_block; } /** * Parse block attributes with defaults. * * @param array $attributes Block attributes. * @return array */ private function parse_attributes( array $attributes ): array { return wp_parse_args( $attributes, array( 'showProductLink' => true, 'imageSizing' => 'single', 'scale' => 'cover', 'showSaleBadge' => false, 'saleBadgeAlign' => 'right', ) ); } /** * Get product image data. * * @param \WC_Product $product Product object. * @param array $attributes Parsed attributes. * @return array|null */ private function get_product_image_data( \WC_Product $product, array $attributes ): ?array { $image_size = 'single' === $attributes['imageSizing'] ? 'woocommerce_single' : 'woocommerce_thumbnail'; $image_id = (int) $product->get_image_id(); if ( ! $image_id ) { $placeholder = wc_placeholder_img_src( $image_size ); return array( 'url' => $placeholder, 'alt' => $product->get_name(), 'width' => 300, 'height' => 300, ); } $image_url = wp_get_attachment_image_url( $image_id, $image_size ); if ( ! $image_url ) { return null; } $alt_text = get_post_meta( $image_id, '_wp_attachment_image_alt', true ); $image_meta = wp_get_attachment_metadata( $image_id ); return array( 'url' => $image_url, 'alt' => $alt_text ? $alt_text : $product->get_name(), 'width' => $image_meta['width'] ?? 300, 'height' => $image_meta['height'] ?? 300, ); } /** * Build email-compatible image HTML. * * @param array $image_data Image data. * @param array $attributes Block attributes. * @param Rendering_Context $rendering_context Rendering context. * @return string */ private function build_image_html( array $image_data, array $attributes, Rendering_Context $rendering_context ): string { $style_parts = array( 'max-width' => '100%', 'height' => 'auto', 'display' => 'block', ); if ( ! empty( $attributes['scale'] ) ) { $style_parts['object-fit'] = $attributes['scale']; } if ( ! empty( $attributes['width'] ) ) { $style_parts['width'] = $attributes['width']; } if ( ! empty( $attributes['height'] ) ) { $style_parts['height'] = $attributes['height']; } if ( ! empty( $attributes['aspectRatio'] ) ) { $style_parts['aspect-ratio'] = $attributes['aspectRatio']; } $width = ! empty( $attributes['width'] ) ? Styles_Helper::parse_value( $attributes['width'] ) : $image_data['width']; $layout_width = Styles_Helper::parse_value( $rendering_context->get_layout_width_without_padding() ); if ( $width > $layout_width ) { $width = $layout_width; $aspect_ratio = $image_data['height'] / $image_data['width']; $attributes['height'] = round( $width * $aspect_ratio ) . 'px'; } $height = $image_data['height']; if ( ! empty( $attributes['height'] ) ) { $height = Styles_Helper::parse_value( $attributes['height'] ); } elseif ( ! empty( $attributes['width'] ) && $image_data['width'] > 0 ) { $aspect_ratio = $image_data['height'] / $image_data['width']; $height = round( $width * $aspect_ratio ); } return sprintf( '<img class="email-editor-product-image skip-lazy" data-skip-lazy="1" loading="eager" decoding="auto" src="%s" alt="%s" style="%s" width="%d" height="%d" />', esc_url( $image_data['url'] ), esc_attr( $image_data['alt'] ), esc_attr( \WP_Style_Engine::compile_css( $style_parts, '' ) ), $width, $height ); } /** * Wrap image with product link. * * @param string $image_html Image HTML. * @param \WC_Product $product Product object. * @return string */ private function wrap_with_link( string $image_html, \WC_Product $product ): string { $product_url = $product->get_permalink(); return sprintf( '<a href="%s" style="display: block; text-decoration: none;">%s</a>', esc_url( $product_url ), $image_html ); } /** * Apply email-compatible table wrapper (similar to Image renderer). * * @param string $image_html Image HTML. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ private function apply_email_wrapper( string $image_html, array $parsed_block, Rendering_Context $rendering_context ): string { $width = $parsed_block['attrs']['width'] ?? ''; $wrapper_width = ( $width && '100%' !== $width ) ? $width : 'auto'; $image_height = $this->extract_image_height( $image_html ) . 'px'; $wrapper_styles = array( 'border-collapse' => 'separate', 'width' => $wrapper_width, ); $cell_styles = array( 'overflow' => 'hidden', 'vertical-align' => 'top', ); $align = $parsed_block['attrs']['align'] ?? 'left'; $cell_styles['text-align'] = $align; $outer_table_attrs = array( 'style' => \WP_Style_Engine::compile_css( array( 'border-collapse' => 'collapse', 'border-spacing' => '0px', 'width' => '100%', 'height' => $image_height, ), '' ), 'width' => '100%', ); $outer_cell_attrs = array( 'align' => $align, ); $inner_table_attrs = array( 'style' => \WP_Style_Engine::compile_css( $wrapper_styles, '' ), 'width' => $wrapper_width, 'height' => $image_height, ); $inner_cell_attrs = array( 'style' => \WP_Style_Engine::compile_css( $cell_styles, '' ), ); $inner_content = Table_Wrapper_Helper::render_table_wrapper( $image_html, $inner_table_attrs, $inner_cell_attrs ); return Table_Wrapper_Helper::render_table_wrapper( $inner_content, $outer_table_attrs, $outer_cell_attrs ); } } email-editor/src/Integrations/WooCommerce/Renderer/Blocks/class-product-sale-badge.php 0000777 00000011306 15252010675 0025047 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * Renders a WooCommerce product sale badge block for email. */ class Product_Sale_Badge extends Abstract_Product_Block_Renderer { /** * Render the product sale badge block content for email. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $product = $this->get_product_from_context( $parsed_block ); if ( ! $product ) { return ''; } if ( ! $product->is_on_sale() ) { return ''; } $attributes = $parsed_block['attrs'] ?? array(); /** * Filters the product sale badge text. * * @hook woocommerce_sale_badge_text * @since 10.0.0 * * @param string $sale_text The sale badge text. * @param \WC_Product $product The product object. * @return string The filtered sale badge text. */ $sale_text = apply_filters( 'woocommerce_sale_badge_text', __( 'Sale', 'woocommerce' ), $product ); $badge_html = $this->build_badge_html( $sale_text, $attributes, $rendering_context ); return $this->apply_email_wrapper( $badge_html, $parsed_block ); } /** * Build email-compatible badge HTML. * * @param string $sale_text Sale badge text. * @param array $attributes Block attributes. * @param Rendering_Context $rendering_context Rendering context. * @return string */ private function build_badge_html( string $sale_text, array $attributes, Rendering_Context $rendering_context ): string { $align = $attributes['align'] ?? 'left'; $position_style = $this->get_position_style( $align ); $badge_styles = array_merge( array( 'font-size' => '0.875em', 'padding' => '0.25em 0.75em', 'display' => 'inline-block', 'width' => 'fit-content', 'border' => '1px solid #43454b', 'border-radius' => '4px', 'box-sizing' => 'border-box', 'color' => '#43454b', 'background' => '#fff', 'text-align' => 'center', 'text-transform' => 'uppercase', 'font-weight' => '600', 'z-index' => '9', 'position' => 'static', ), $position_style ); $custom_styles = Styles_Helper::get_block_styles( $attributes, $rendering_context, array( 'border', 'background-color', 'color', 'typography', 'spacing' ) ); $style_attr = \WP_Style_Engine::compile_css( array_merge( $badge_styles, $custom_styles['declarations'] ?? array() ), '' ); return sprintf( '<span class="wc-block-components-product-sale-badge__text" style="%s">%s</span>', esc_attr( $style_attr ), esc_html( $sale_text ) ); } /** * Get positioning styles based on alignment. * * @param string $align Alignment value. * @return array */ private function get_position_style( string $align ): array { switch ( $align ) { case 'left': return array( 'text-align' => 'left', 'margin-right' => 'auto', ); case 'center': return array( 'text-align' => 'center', 'margin-left' => 'auto', 'margin-right' => 'auto', ); case 'right': return array( 'text-align' => 'right', 'margin-left' => 'auto', ); default: return array( 'text-align' => 'left', ); } } /** * Apply email-compatible table wrapper. * * @param string $badge_html Badge HTML. * @param array $parsed_block Parsed block. * @return string */ private function apply_email_wrapper( string $badge_html, array $parsed_block ): string { $align = $parsed_block['attrs']['align'] ?? 'left'; $wrapper_styles = array( 'border-collapse' => 'collapse', 'width' => '100%', ); $cell_styles = array( 'padding' => '5px 0', 'text-align' => $align, ); $table_attrs = array( 'style' => \WP_Style_Engine::compile_css( $wrapper_styles, '' ), 'width' => '100%', ); $cell_attrs = array( 'class' => 'email-product-sale-badge-cell', 'style' => \WP_Style_Engine::compile_css( $cell_styles, '' ), 'align' => $align, ); return Table_Wrapper_Helper::render_table_wrapper( $badge_html, $table_attrs, $cell_attrs ); } } email-editor/src/Integrations/WooCommerce/Renderer/Blocks/class-product-collection.php 0000777 00000047412 15252010675 0025225 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use WP_Query; /** * Renders a product collection block for email. */ class Product_Collection extends Abstract_Product_Block_Renderer { /** * Render the product collection block content for email. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // Create a query for the Product Collection block. $query = $this->prepare_and_execute_query( $parsed_block, $rendering_context ); // Get collection type to pass to child blocks. $collection_type = $parsed_block['attrs']['collection'] ?? ''; $content = ''; foreach ( $parsed_block['innerBlocks'] as $inner_block ) { switch ( $inner_block['blockName'] ) { case 'woocommerce/product-template': $content .= $this->render_product_template( $inner_block, $query, $collection_type ); break; default: $content .= render_block( $inner_block ); break; } } wp_reset_postdata(); return $content; } /** * Render the product template block. * * @param array $inner_block Inner block data. * @param \WP_Query $query WP_Query object. * @param string $collection_type Collection type identifier. * @return string */ private function render_product_template( array $inner_block, \WP_Query $query, string $collection_type ): string { if ( ! $query->have_posts() ) { return $this->render_no_results_message(); } $posts = $query->get_posts(); $total_count = count( $posts ); if ( 0 === $total_count ) { return $this->render_no_results_message(); } $products = array_filter( array_map( function ( $post ) { return $post instanceof \WP_Post ? wc_get_product( $post->ID ) : null; }, $posts ) ); return $this->render_product_grid( $products, $inner_block, $collection_type ); } /** * Render product grid using HTML table structure for email compatibility. * * @param array $products Array of WC_Product objects. * @param array $inner_block Inner block data. * @param string $collection_type Collection type identifier. * @return string */ private function render_product_grid( array $products, array $inner_block, string $collection_type ): string { // We start with supporting 1 product per row. $content = ''; foreach ( $products as $product ) { $content .= $this->add_spacer( $this->render_product_content( $product, $inner_block, $collection_type ), $inner_block['email_attrs'] ?? array() ); } return $content; } /** * Render default product content when no inner blocks are present. * * @param \WC_Product|null $product Product object. * @param array $template_block Inner block data. * @param string $collection_type Collection type identifier. * @return string */ private function render_product_content( ?\WC_Product $product, array $template_block, string $collection_type ): string { $content = ''; if ( ! $product ) { return $content; } foreach ( $template_block['innerBlocks'] as $inner_block ) { switch ( $inner_block['blockName'] ) { case 'woocommerce/product-price': case 'woocommerce/product-button': case 'woocommerce/product-sale-badge': case 'woocommerce/product-image': $inner_block['context'] = $inner_block['context'] ?? array(); $inner_block['context']['postId'] = $product->get_id(); $inner_block['context']['collection'] = $collection_type; $content .= render_block( $inner_block ); break; case 'core/post-title': global $post; $original_post = $post; $original_global_product = $GLOBALS['product'] ?? null; $product_post = get_post( $product->get_id() ); $post = $product_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited $GLOBALS['product'] = $product; $inner_block['context'] = $inner_block['context'] ?? array(); $inner_block['context']['postId'] = $product->get_id(); $content .= render_block( $inner_block ); $post = $original_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited $GLOBALS['product'] = $original_global_product; break; default: break; } } return $content; } /** * Prepare and execute a query for the Product Collection block using the original QueryBuilder. * * @param array $parsed_block Parsed block data. * @param Rendering_Context $rendering_context Rendering context. * @return WP_Query */ private function prepare_and_execute_query( array $parsed_block, Rendering_Context $rendering_context ): WP_Query { $collection = $parsed_block['attrs']['collection'] ?? ''; $query_attrs = $parsed_block['attrs']['query'] ?? array(); // Build a direct WP_Query for email rendering (not using ProductCollection QueryBuilder). // The QueryBuilder is designed for REST/frontend context, not email rendering. $query_args = array( 'post_type' => 'product', 'post_status' => 'publish', 'posts_per_page' => (int) ( $query_attrs['perPage'] ?? 9 ), 'orderby' => sanitize_key( $query_attrs['orderBy'] ?? 'menu_order' ), 'order' => sanitize_key( $query_attrs['order'] ?? 'asc' ), 'meta_query' => array(), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query 'tax_query' => array(), // phpcs:ignore WordPress.DB.SlowDBQuery ); // Handle search. if ( ! empty( $query_attrs['search'] ) ) { $query_args['s'] = sanitize_text_field( (string) $query_attrs['search'] ); } // Handle offset. if ( isset( $query_attrs['offset'] ) ) { $query_args['offset'] = (int) $query_attrs['offset']; } // Handle exclusions. if ( isset( $query_attrs['exclude'] ) && is_array( $query_attrs['exclude'] ) ) { $query_args['post__not_in'] = array_map( static function ( $id ) { return is_numeric( $id ) ? (int) $id : 0; }, $query_attrs['exclude'] ); } // Handle handpicked products. if ( ! empty( $query_attrs['woocommerceHandPickedProducts'] ) ) { $query_args['post__in'] = array_map( static function ( $id ) { return is_numeric( $id ) ? (int) $id : 0; }, $query_attrs['woocommerceHandPickedProducts'] ); $query_args['orderby'] = 'post__in'; } // Handle featured products - use the WooCommerce way. $is_featured = $query_attrs['featured'] ?? false; if ( 'woocommerce/product-collection/featured' === $collection || $is_featured ) { // Use WooCommerce's built-in function to get featured products query. $featured_query = wc_get_product_visibility_term_ids(); if ( isset( $featured_query['featured'] ) ) { $query_args['tax_query'][] = array( 'taxonomy' => 'product_visibility', 'field' => 'term_taxonomy_id', 'terms' => array( (int) $featured_query['featured'] ), 'operator' => 'IN', ); } } // Handle on-sale products. $is_on_sale = $query_attrs['woocommerceOnSale'] ?? false; if ( 'woocommerce/product-collection/on-sale' === $collection || $is_on_sale ) { $query_args['meta_query'][] = array( 'relation' => 'OR', array( 'key' => '_sale_price', 'value' => '', 'compare' => '!=', ), ); } // Handle stock status (only if not all statuses are selected). $stock_status = $query_attrs['woocommerceStockStatus'] ?? array(); if ( ! empty( $stock_status ) && ! $this->is_all_stock_statuses( $stock_status ) ) { $query_args['meta_query'][] = array( 'key' => '_stock_status', 'value' => $stock_status, 'compare' => 'IN', ); } // Handle taxonomies (categories, tags, etc.). if ( ! empty( $query_attrs['taxQuery'] ) ) { $tax_queries = $this->build_tax_query( $query_attrs['taxQuery'] ); $query_args['tax_query'] = array_merge( $query_args['tax_query'], $tax_queries ); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query } // Handle product attributes. if ( ! empty( $query_attrs['woocommerceAttributes'] ) ) { $attribute_queries = $this->build_attribute_query( $query_attrs['woocommerceAttributes'] ); $query_args['tax_query'] = array_merge( $query_args['tax_query'], $attribute_queries ); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query } // Handle special collections: upsells, cross-sells, related, cart-contents. $product_ids_to_include = $this->get_collection_specific_product_ids( $collection, $parsed_block, $rendering_context ); if ( ! empty( $product_ids_to_include ) ) { $query_args['post__in'] = $product_ids_to_include; } // Set tax_query relation if multiple tax queries. if ( count( $query_args['tax_query'] ) > 1 ) { $query_args['tax_query']['relation'] = 'AND'; } $wp_query = new WP_Query( $query_args ); return $wp_query; } /** * Check if all stock statuses are selected (meaning no filtering needed). * * @param array $stock_status Stock status values from block attributes. * @return bool */ private function is_all_stock_statuses( array $stock_status ): bool { if ( empty( $stock_status ) ) { return true; // Empty means all statuses. } $all_stock_statuses = array_keys( wc_get_product_stock_status_options() ); return count( $stock_status ) === count( $all_stock_statuses ) && count( array_diff( $stock_status, $all_stock_statuses ) ) === 0 && count( array_diff( $all_stock_statuses, $stock_status ) ) === 0; } /** * Build tax query from taxQuery block attributes. * * @param array $tax_query_input Tax query input from block attributes. * @return array */ private function build_tax_query( array $tax_query_input ): array { $tax_queries = array(); if ( empty( $tax_query_input ) ) { return $tax_queries; } $first_key = array_key_first( $tax_query_input ); // If not a numeric array of clauses, assume object map: { taxonomy => [termIds] }. if ( ! is_int( $first_key ) ) { foreach ( $tax_query_input as $taxonomy => $terms ) { if ( ! empty( $terms ) ) { $tax_queries[] = array( 'taxonomy' => $taxonomy, 'field' => 'term_id', 'terms' => array_map( static function ( $id ) { return is_numeric( $id ) ? (int) $id : 0; }, (array) $terms ), ); } } } else { $tax_queries = $tax_query_input; } return $tax_queries; } /** * Build attribute query from woocommerceAttributes block attributes. * * @param array $attributes Attribute filters from block attributes. * @return array */ private function build_attribute_query( array $attributes ): array { $attribute_queries = array(); foreach ( $attributes as $attribute ) { if ( ! empty( $attribute['taxonomy'] ) && ! empty( $attribute['termId'] ) ) { $attribute_queries[] = array( 'taxonomy' => $attribute['taxonomy'], 'field' => 'term_id', 'terms' => array( (int) $attribute['termId'] ), ); } } return $attribute_queries; } /** * Get specific product IDs for collection types that need them (upsell, cross-sell, related, cart-contents). * * @param string $collection Collection type. * @param array $parsed_block Parsed block data. * @param Rendering_Context $rendering_context Rendering context. * @return array Array of product IDs or empty array. */ private function get_collection_specific_product_ids( string $collection, array $parsed_block, Rendering_Context $rendering_context ): array { switch ( $collection ) { case 'woocommerce/product-collection/upsells': return $this->get_upsell_product_ids( $parsed_block ); case 'woocommerce/product-collection/cross-sells': return $this->get_cross_sell_product_ids( $parsed_block ); case 'woocommerce/product-collection/related': return $this->get_related_product_ids( $parsed_block ); case 'woocommerce/product-collection/cart-contents': return $this->get_cart_contents_product_ids( $parsed_block, $rendering_context ); default: return array(); } } /** * Get upsell product IDs. * * @param array $parsed_block Parsed block data. * @return array Array of upsell product IDs. */ private function get_upsell_product_ids( array $parsed_block ): array { $product_references = $this->get_product_references_for_collection( $parsed_block ); if ( empty( $product_references ) ) { return array( -1 ); // Return -1 to ensure no products are found. } $products = array_filter( array_map( 'wc_get_product', $product_references ) ); if ( empty( $products ) ) { return array( -1 ); } $all_upsells = array(); foreach ( $products as $product ) { $all_upsells = array_merge( $all_upsells, $product->get_upsell_ids() ); } // Remove duplicates and product references (don't show what's already in context). $unique_upsells = array_unique( $all_upsells ); $upsells = array_diff( $unique_upsells, $product_references ); return ! empty( $upsells ) ? $upsells : array( -1 ); } /** * Get cross-sell product IDs. * * @param array $parsed_block Parsed block data. * @return array Array of cross-sell product IDs. */ private function get_cross_sell_product_ids( array $parsed_block ): array { $product_references = $this->get_product_references_for_collection( $parsed_block ); if ( empty( $product_references ) ) { return array( -1 ); // Return -1 to ensure no products are found. } $products = array_filter( array_map( 'wc_get_product', $product_references ) ); if ( empty( $products ) ) { return array( -1 ); } $product_ids = array_map( function ( $product ) { return $product->get_id(); }, $products ); $all_cross_sells = array(); foreach ( $products as $product ) { $all_cross_sells = array_merge( $all_cross_sells, $product->get_cross_sell_ids() ); } // Remove duplicates and product references (don't show what's already in context). $unique_cross_sells = array_unique( $all_cross_sells ); $cross_sells = array_diff( $unique_cross_sells, $product_ids ); return ! empty( $cross_sells ) ? $cross_sells : array( -1 ); } /** * Get related product IDs. * * @param array $parsed_block Parsed block data. * @return array Array of related product IDs. */ private function get_related_product_ids( array $parsed_block ): array { $product_references = $this->get_product_references_for_collection( $parsed_block ); if ( empty( $product_references ) ) { return array( -1 ); // Return -1 to ensure no products are found. } // For related products, we only use the first product reference. $product_reference = $product_references[0]; if ( empty( $product_reference ) ) { return array( -1 ); } // Get related products using WooCommerce's built-in function. $related_ids = wc_get_related_products( $product_reference, 100 ); return ! empty( $related_ids ) ? $related_ids : array( -1 ); } /** * Get product references for collections (handles different contexts). * * @param array $parsed_block Parsed block data. * @return array Array of product IDs or empty array. */ private function get_product_references_for_collection( array $parsed_block ): array { $query_attrs = $parsed_block['attrs']['query'] ?? array(); $product_references = array(); // First try to get from productReference in query attributes. if ( ! empty( $query_attrs['productReference'] ) ) { $product_references = array( (int) $query_attrs['productReference'] ); } // If no product reference found, try to get from global context. if ( empty( $product_references ) ) { global $product; if ( $product && is_a( $product, 'WC_Product' ) ) { $product_references = array( $product->get_id() ); } } // In email context, we might need additional context sources. // This could be extended based on email type (order confirmation, etc.). return $product_references; } /** * Get cart contents product IDs for email rendering. * * @param array $parsed_block Parsed block data. * @param Rendering_Context $rendering_context Rendering context. * @return array Array of cart product IDs or sample products for preview. */ private function get_cart_contents_product_ids( array $parsed_block, Rendering_Context $rendering_context ): array { // Try to get cart product IDs from the user's cart using user ID or email. $cart_product_ids = $this->get_user_cart_product_ids_from_context( $rendering_context ); if ( ! empty( $cart_product_ids ) ) { return $cart_product_ids; } // For preview emails, show sample products so users can see what the email will look like. if ( $rendering_context->get( 'is_user_preview', false ) ) { return $this->get_sample_product_ids_for_preview(); } // For real emails with empty cart, return -1 to ensure no products are shown. return array( -1 ); } /** * Get cart product IDs from rendering context using user ID or email. * * @param Rendering_Context $rendering_context Rendering context. * @return array Array of product IDs from the user's cart. */ private function get_user_cart_product_ids_from_context( Rendering_Context $rendering_context ): array { $user_id = $rendering_context->get_user_id(); $email = $rendering_context->get_recipient_email(); // Use shared utility if available (WooCommerce 10.4+). if ( class_exists( '\Automattic\WooCommerce\Blocks\Utils\CartCheckoutUtils' ) && method_exists( '\Automattic\WooCommerce\Blocks\Utils\CartCheckoutUtils', 'get_cart_product_ids_for_user' ) ) { // @phpstan-ignore-next-line - Method exists in newer WooCommerce versions. return \Automattic\WooCommerce\Blocks\Utils\CartCheckoutUtils::get_cart_product_ids_for_user( $user_id, $email ); } // Fallback: Get user ID from email if needed, then fetch cart. if ( ! $user_id && $email ) { $user = get_user_by( 'email', $email ); if ( $user ) { $user_id = $user->ID; } } if ( ! $user_id ) { return array(); } // Fallback implementation for older WooCommerce versions. $cart_data = get_user_meta( $user_id, '_woocommerce_persistent_cart_' . get_current_blog_id(), true ); if ( ! is_array( $cart_data ) || empty( $cart_data ) || ! isset( $cart_data['cart'] ) || ! is_array( $cart_data['cart'] ) ) { return array(); } $product_ids = array(); foreach ( $cart_data['cart'] as $cart_item ) { if ( is_array( $cart_item ) && isset( $cart_item['product_id'] ) && is_numeric( $cart_item['product_id'] ) ) { $product_ids[] = (int) $cart_item['product_id']; } } return array_unique( $product_ids ); } /** * Get sample product IDs for preview emails. * This ensures that preview emails show representative content even when the cart is empty. * * @return array Array of sample product IDs. */ private function get_sample_product_ids_for_preview(): array { $query = new WP_Query( array( 'post_type' => 'product', 'post_status' => 'publish', 'posts_per_page' => 3, 'orderby' => 'date', 'order' => 'DESC', 'fields' => 'ids', ) ); if ( ! empty( $query->posts ) && is_array( $query->posts ) ) { return array_map( static function ( $id ) { return is_numeric( $id ) ? (int) $id : 0; }, $query->posts ); } return array( -1 ); } /** * Render a no results message. * * @return string */ private function render_no_results_message(): string { return sprintf( '<div style="text-align: center; padding: 20px; color: #666;">%s</div>', esc_html__( 'No products found.', 'woocommerce' ) ); } } email-editor/src/Integrations/WooCommerce/Renderer/Blocks/class-abstract-product-block-renderer.php 0000777 00000002320 15252010675 0027556 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Block_Renderer; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Abstract_Block_Renderer; /** * Shared functionality for block renderers. */ abstract class Abstract_Product_Block_Renderer extends Abstract_Block_Renderer implements Block_Renderer { /** * Get product from block context. * * @param array $parsed_block Parsed block. * @return \WC_Product|null */ protected function get_product_from_context( array $parsed_block ): ?\WC_Product { $post_id = $parsed_block['context']['postId'] ?? 0; if ( ! $post_id ) { global $product; if ( $product && is_a( $product, 'WC_Product' ) ) { $post_id = $product->get_id(); } } if ( ! $post_id ) { global $post; if ( $post && get_post_type( $post->ID ) === 'product' ) { $post_id = $post->ID; } } $product = $post_id ? wc_get_product( $post_id ) : null; return $product ? $product : null; } } email-editor/src/Integrations/WooCommerce/class-initializer.php 0000777 00000006761 15252010675 0020756 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Abstract_Block_Renderer; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Fallback; use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Button; use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Collection; use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Image; use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Price; use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Renderer\Blocks\Product_Sale_Badge; /** * Initializes the WooCommerce blocks renderers. */ class Initializer { /** * List of supported WooCommerce blocks in the email editor. */ const ALLOWED_BLOCK_TYPES = array( 'woocommerce/product-collection', 'woocommerce/product-image', 'woocommerce/product-price', 'woocommerce/product-button', 'woocommerce/product-sale-badge', 'woocommerce/coupon-code', ); /** * Cache renderers by block name. * * @var array<string, Abstract_Block_Renderer> */ private array $renderers = array(); /** * Set `supports.email = true` and configure render_email_callback for supported blocks. * * @param array $settings Block settings. * @return array */ public function update_block_settings( array $settings ): array { if ( in_array( $settings['name'], self::ALLOWED_BLOCK_TYPES, true ) ) { $settings['supports']['email'] = true; $settings['render_email_callback'] = array( $this, 'render_block' ); } return $settings; } /** * Returns the block content rendered by the block renderer. * * @param string $block_content Block content. * @param array $parsed_block Parsed block settings. * @param Rendering_Context $rendering_context Rendering context. * @return string */ public function render_block( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { if ( isset( $parsed_block['blockName'] ) ) { $block_renderer = $this->get_block_renderer( $parsed_block['blockName'] ); return $block_renderer->render( $block_content, $parsed_block, $rendering_context ); } return $block_content; } /** * Return an instance of Abstract_Block_Renderer by the block name. * * @param string $block_name Block name. * @return Abstract_Block_Renderer */ private function get_block_renderer( string $block_name ): Abstract_Block_Renderer { if ( isset( $this->renderers[ $block_name ] ) ) { return $this->renderers[ $block_name ]; } switch ( $block_name ) { case 'woocommerce/product-image': $renderer = new Product_Image(); break; case 'woocommerce/product-price': $renderer = new Product_Price(); break; case 'woocommerce/product-sale-badge': $renderer = new Product_Sale_Badge(); break; case 'woocommerce/product-collection': $renderer = new Product_Collection(); break; case 'woocommerce/product-button': $renderer = new Product_Button(); break; default: $renderer = new Fallback(); break; } $this->renderers[ $block_name ] = $renderer; return $renderer; } } email-editor/src/Integrations/Core/class-initializer.php 0000777 00000020021 15252010675 0017410 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Layout\Flex_Layout_Renderer; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Abstract_Block_Renderer; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Audio; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Button; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Buttons; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Column; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Columns; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Cover; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Embed; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Fallback; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Gallery; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Group; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Image; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\List_Block; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\List_Item; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Media_Text; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Post_Content; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Quote; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Video; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Social_Link; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Social_Links; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Table; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Text; /** * Initializes the core blocks renderers. */ class Initializer { /** * List of supported WordPress core blocks in the email editor. */ const ALLOWED_BLOCK_TYPES = array( 'core/button', 'core/buttons', 'core/column', 'core/columns', 'core/group', 'core/heading', 'core/image', 'core/list', 'core/list-item', 'core/paragraph', 'core/quote', 'core/spacer', 'core/social-link', 'core/social-links', 'core/site-logo', 'core/site-title', 'core/table', ); /** * List of blocks that only need rendering capabilities (not available in email editor). * * To add a new render-only block: * 1. Add the block name to this array * 2. Optionally create a specific renderer in the Renderer/Blocks directory * 3. Add the renderer case in the get_block_renderer method */ const RENDER_ONLY_BLOCK_TYPES = array( 'core/gallery', 'core/media-text', 'core/audio', 'core/embed', 'core/cover', 'core/video', 'core/post-title', ); /** * Cache renderers by block name. * * @var array<string, Abstract_Block_Renderer> */ private array $renderers = array(); /** * Initializes the core blocks renderers. */ public function initialize(): void { add_filter( 'woocommerce_email_editor_theme_json', array( $this, 'adjust_theme_json' ), 10, 1 ); add_filter( 'safe_style_css', array( $this, 'allow_styles' ) ); } /** * Adjusts the editor's theme to add blocks specific settings for core blocks. * * @param \WP_Theme_JSON $editor_theme_json Editor theme JSON. */ public function adjust_theme_json( \WP_Theme_JSON $editor_theme_json ): \WP_Theme_JSON { $theme_json = (string) file_get_contents( __DIR__ . '/theme.json' ); $theme_json = json_decode( $theme_json, true ); /** * Loaded theme json. * * @var array $theme_json */ $editor_theme_json->merge( new \WP_Theme_JSON( $theme_json, 'default' ) ); return $editor_theme_json; } /** * Allow styles for the email editor. * * @param array|null $allowed_styles Allowed styles. */ public function allow_styles( ?array $allowed_styles ): array { // The styles can be null in some cases. if ( ! is_array( $allowed_styles ) ) { $allowed_styles = array(); } $allowed_styles[] = 'display'; $allowed_styles[] = 'mso-padding-alt'; $allowed_styles[] = 'mso-font-width'; $allowed_styles[] = 'mso-text-raise'; return $allowed_styles; } /** * Configure block settings for email editor support and rendering. * * This method handles three types of blocks: * 1. Editor-available blocks: Set supports.email = true and render_email_callback * 2. Render-only blocks: Only set render_email_callback (not available in editor) * 3. Special blocks: Custom handling (e.g., core/post-content stateless renderer) * * @param array $settings Block settings. * @return array Modified block settings. */ public function update_block_settings( array $settings ): array { // Enable blocks in email editor and set rendering callback. if ( in_array( $settings['name'], self::ALLOWED_BLOCK_TYPES, true ) ) { $settings['supports']['email'] = true; $settings['render_email_callback'] = array( $this, 'render_block' ); } // Set rendering callback for render-only blocks (without enabling in editor). if ( in_array( $settings['name'], self::RENDER_ONLY_BLOCK_TYPES, true ) ) { $settings['render_email_callback'] = array( $this, 'render_block' ); } return $settings; } /** * Returns the block content rendered by the block renderer. * * @param string $block_content Block content. * @param array $parsed_block Parsed block settings. * @param Rendering_Context $rendering_context Rendering context. * @return string */ public function render_block( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { if ( isset( $parsed_block['blockName'] ) ) { $block_renderer = $this->get_block_renderer( $parsed_block['blockName'] ); return $block_renderer->render( $block_content, $parsed_block, $rendering_context ); } return $block_content; } /** * Return an instance of Abstract_Block_Renderer by the block name. * * @param string $block_name Block name. * @return Abstract_Block_Renderer */ private function get_block_renderer( string $block_name ): Abstract_Block_Renderer { if ( isset( $this->renderers[ $block_name ] ) ) { return $this->renderers[ $block_name ]; } switch ( $block_name ) { case 'core/heading': case 'core/paragraph': case 'core/site-title': case 'core/post-title': $renderer = new Text(); break; case 'core/column': $renderer = new Column(); break; case 'core/columns': $renderer = new Columns(); break; case 'core/list': $renderer = new List_Block(); break; case 'core/list-item': $renderer = new List_Item(); break; case 'core/image': $renderer = new Image(); break; case 'core/button': $renderer = new Button(); break; case 'core/buttons': $renderer = new Buttons( new Flex_Layout_Renderer() ); break; case 'core/group': $renderer = new Group(); break; case 'core/quote': $renderer = new Quote(); break; case 'core/social-link': $renderer = new Social_Link(); break; case 'core/social-links': $renderer = new Social_Links(); break; case 'core/table': $renderer = new Table(); break; case 'core/gallery': $renderer = new Gallery(); break; case 'core/media-text': $renderer = new Media_Text(); break; case 'core/audio': $renderer = new Audio(); break; case 'core/embed': $renderer = new Embed(); break; case 'core/cover': $renderer = new Cover(); break; case 'core/video': $renderer = new Video(); break; default: $renderer = new Fallback(); break; } $this->renderers[ $block_name ] = $renderer; return $renderer; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-column.php 0000777 00000011454 15252010675 0021357 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * Renders a column block. */ class Column extends Abstract_Block_Renderer { /** * Override this method to disable spacing (block gap) for columns. * Spacing is applied on wrapping columns block. Columns are rendered side by side so no spacer is needed. * * @param string $content Content. * @param array $email_attrs Email attributes. */ protected function add_spacer( $content, $email_attrs ): string { return $content; } /** * Renders the block content. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { return str_replace( '{column_content}', $this->get_inner_content( $block_content ), $this->get_block_wrapper( $block_content, $parsed_block, $rendering_context ) ); } /** * Based on MJML <mj-column> * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. */ private function get_block_wrapper( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $original_wrapper_classname = ( new Dom_Document_Helper( $block_content ) )->get_attribute_value_by_tag_name( 'div', 'class' ) ?? ''; $block_attributes = wp_parse_args( $parsed_block['attrs'] ?? array(), array( 'verticalAlignment' => 'stretch', 'width' => $rendering_context->get_layout_width_without_padding(), 'style' => array(), ) ); // The default column alignment is `stretch to fill` which means that we need to set the background color to the main cell // to create a feeling of a stretched column. This also needs to apply to CSS classnames which can also apply styles. $is_stretched = empty( $block_attributes['verticalAlignment'] ) || 'stretch' === $block_attributes['verticalAlignment']; $padding_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'padding' ) ); $padding_styles = Styles_Helper::extend_block_styles( $padding_styles, array( 'text-align' => 'left' ) ); $cell_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'border', 'background', 'background-color', 'color' ) ); $cell_styles = Styles_Helper::extend_block_styles( $cell_styles, array_filter( array( 'background-size' => ! empty( $cell_styles['background-image'] ) && empty( $cell_styles['background-size'] ) ? 'cover' : null, ) ) ); $wrapper_classname = 'block wp-block-column email-block-column'; $content_classname = 'email-block-column-content'; $wrapper_styles = Styles_Helper::extend_block_styles( Styles_Helper::$empty_block_styles, array( 'vertical-align' => $is_stretched ? 'top' : $block_attributes['verticalAlignment'] ), ); $content_styles = Styles_Helper::extend_block_styles( Styles_Helper::$empty_block_styles, array( 'vertical-align' => 'top' ) ); if ( $is_stretched ) { $wrapper_classname .= ' ' . $original_wrapper_classname; $wrapper_styles = Styles_Helper::extend_block_styles( $wrapper_styles, $cell_styles['declarations'] ); } else { $content_classname .= ' ' . $original_wrapper_classname; $content_styles = Styles_Helper::extend_block_styles( $content_styles, $cell_styles['declarations'] ); } // Create the inner table using the helper. $inner_table_attrs = array( 'class' => $content_classname, 'style' => $content_styles['css'], 'width' => '100%', ); $inner_cell_attrs = array( 'align' => 'left', 'style' => $padding_styles['css'], ); $inner_table = Table_Wrapper_Helper::render_table_wrapper( '{column_content}', $inner_table_attrs, $inner_cell_attrs ); // Create the outer td element (since this is meant to be used within a columns structure). $wrapper_cell_attrs = array( 'class' => $wrapper_classname, 'style' => $wrapper_styles['css'], 'width' => Styles_Helper::parse_value( $block_attributes['width'] ), ); return Table_Wrapper_Helper::render_table_cell( $inner_table, $wrapper_cell_attrs ); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-video.php 0000777 00000014657 15252010675 0021200 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; /** * Video block renderer. * This renderer handles core/video blocks by reusing the cover block renderer * to show a thumbnail with a play button overlay. */ class Video extends Cover { /** * Renders the video block content by transforming it into a cover block structure. * Shows the video poster/thumbnail with a play button overlay using the parent cover renderer. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $block_attrs = $parsed_block['attrs'] ?? array(); // Extract poster URL from video attributes. $poster_url = $this->extract_poster_url( $block_attrs, $block_content ); // If no poster image, return empty content. if ( empty( $poster_url ) ) { return ''; } // Transform video block into cover block structure and delegate to parent. $cover_block = $this->transform_to_cover_block( $parsed_block, $poster_url ); return parent::render_content( $block_content, $cover_block, $rendering_context ); } /** * Extract poster URL from block attributes. * * @param array $block_attrs Block attributes. * @param string $block_content Original block content (unused, kept for consistency). * @return string Poster URL or empty string. */ private function extract_poster_url( array $block_attrs, string $block_content ): string { // Check for poster attribute. if ( ! empty( $block_attrs['poster'] ) ) { return esc_url( $block_attrs['poster'] ); } return ''; } /** * Extract video URL from block content. * * @param string $block_content Block content HTML. * @return string Video URL or empty string. */ private function extract_video_url( string $block_content ): string { // Use Dom_Document_Helper for robust HTML parsing. $dom_helper = new Dom_Document_Helper( $block_content ); // Find the wp-block-embed__wrapper div. $wrapper_element = $dom_helper->find_element( 'div' ); if ( ! $wrapper_element ) { return ''; } // Check if this div has the correct class. $class_attr = $dom_helper->get_attribute_value( $wrapper_element, 'class' ); if ( strpos( $class_attr, 'wp-block-embed__wrapper' ) === false ) { return ''; } // Get the inner HTML content from the wrapper div. $inner_html = $dom_helper->get_element_inner_html( $wrapper_element ); // Look for HTTP/HTTPS URLs in the inner HTML content. if ( preg_match( '/(?<![a-zA-Z0-9.-])https?:\/\/[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}[a-zA-Z0-9\/?=&%-]*(?![a-zA-Z0-9.-])/', $inner_html, $matches ) ) { $url = $matches[0]; // Decode HTML entities and validate URL. $url = html_entity_decode( $url, ENT_QUOTES | ENT_HTML5, 'UTF-8' ); // Validate the URL. if ( filter_var( $url, FILTER_VALIDATE_URL ) && wp_http_validate_url( $url ) ) { return $url; } } return ''; } /** * Transform a video block into a cover block structure. * * @param array $video_block Original video block. * @param string $poster_url Poster URL to use as background. * @return array Cover block structure. */ private function transform_to_cover_block( array $video_block, string $poster_url ): array { $block_attrs = $video_block['attrs'] ?? array(); $block_content = $video_block['innerHTML'] ?? ''; // Extract video URL from block content, fall back to post URL. // Priority: 1) Video URL (if found), 2) Post permalink (fallback). $video_url = $this->extract_video_url( $block_content ); $link_url = ! empty( $video_url ) ? $video_url : $this->get_current_post_url(); return array( 'blockName' => 'core/cover', 'attrs' => array( 'url' => $poster_url, 'minHeight' => '390px', // Custom attribute for video blocks. ), 'innerBlocks' => array( array( 'blockName' => 'core/html', 'attrs' => array(), 'innerBlocks' => array(), 'innerHTML' => $this->create_play_button_html( $link_url ), 'innerContent' => array( $this->create_play_button_html( $link_url ) ), ), ), 'innerHTML' => $block_content, ); } /** * Create the play button HTML with optional link. * * @param string $link_url Optional URL to link to. * @return string Play button HTML. */ private function create_play_button_html( string $link_url = '' ): string { $play_icon_url = $this->get_play_icon_url(); $play_button = sprintf( '<img src="%s" alt="%s" style="width: 48px; height: 48px; display: inline-block;" />', esc_url( $play_icon_url ), // translators: Alt text for video play button icon. esc_attr( __( 'Play', 'woocommerce' ) ) ); // Wrap the play button in a link if URL is provided. if ( ! empty( $link_url ) ) { $play_button = sprintf( '<a href="%s" target="_blank" rel="noopener noreferrer nofollow" style="display: inline-block; text-decoration: none;">%s</a>', esc_url( $link_url ), $play_button ); } return sprintf( '<p style="text-align: center;">%s</p>', $play_button ); } /** * Get the URL for the play button icon. * * @return string Play button icon URL. */ private function get_play_icon_url(): string { $file_name = '/icons/video/play2x.png'; return plugins_url( $file_name, __FILE__ ); } /** * Get the current post permalink with security validation. * * @return string Post permalink or empty string if invalid. */ private function get_current_post_url(): string { global $post; if ( ! $post instanceof \WP_Post ) { return ''; } $permalink = get_permalink( $post->ID ); if ( empty( $permalink ) ) { return ''; } // Validate URL type and format (following audio block pattern). if ( strpos( $permalink, 'https://' ) !== 0 && strpos( $permalink, 'http://' ) !== 0 ) { // Reject non-HTTP protocols for security. return ''; } // For all HTTP(S) URLs, validate with wp_http_validate_url. if ( ! wp_http_validate_url( $permalink ) ) { return ''; } return $permalink; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-fallback.php 0000777 00000003130 15252010675 0021611 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * Fallback block renderer. * This renderer is used when no specific renderer is found for a block. * * AbstractBlockRenderer applies some adjustments to the block content, like adding spacers. * By using fallback renderer for all blocks we apply there adjustments to all blocks that don't have any renderer. * * We need to find a better abstraction/architecture for this. */ class Fallback extends Abstract_Block_Renderer { /** * Renders the block content * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $block_attrs = $parsed_block['attrs'] ?? array(); $table_attrs = array( 'style' => 'border-collapse: separate;', // Needed because of border radius. 'width' => '100%', ); $align = $block_attrs['textAlign'] ?? $block_attrs['align'] ?? 'left'; $cell_attrs = array( 'align' => $align, ); return Table_Wrapper_Helper::render_table_wrapper( $block_content, $table_attrs, $cell_attrs ); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-media-text.php 0000777 00000015646 15252010675 0022132 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; /** * Media-text block renderer. * This renderer handles core/media-text blocks with proper email-friendly HTML layout. */ class Media_Text extends Abstract_Block_Renderer { /** * Renders the media-text block content using a direct table-based layout. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $block_attrs = $parsed_block['attrs'] ?? array(); $inner_blocks = $parsed_block['innerBlocks'] ?? array(); // Extract media content from innerHTML. $media_content = $this->extract_media_from_html( $parsed_block['innerHTML'] ?? $block_content ); // Render all inner blocks content. $text_content = ''; foreach ( $inner_blocks as $block ) { $text_content .= render_block( $block ); } // If we don't have both media and text content, return empty. if ( empty( $media_content ) || empty( $text_content ) ) { return ''; } // Build the email-friendly layout. return $this->build_email_layout( $media_content, $text_content, $block_attrs, $block_content, $rendering_context ); } /** * Extract media content from the HTML block content. * * @param string $block_content Raw block content. * @return string Media HTML content or empty string if not found. */ private function extract_media_from_html( string $block_content ): string { // Extract inner content from figure element (removing figure wrapper for email compatibility). $media_content = ''; if ( preg_match( '/<figure[^>]*class="[^"]*\bwp-block-media-text__media\b[^"]*"[^>]*>(.*?)<\/figure>/s', $block_content, $matches ) ) { $media_content = trim( $matches[1] ); } return $media_content; } /** * Build the email-friendly layout for media-text blocks. * * @param string $media_content Media HTML content. * @param string $text_content Text content. * @param array $block_attrs Block attributes. * @param string $block_content Original block content. * @param Rendering_Context $rendering_context Rendering context. * @return string Rendered HTML. */ private function build_email_layout( string $media_content, string $text_content, array $block_attrs, string $block_content, Rendering_Context $rendering_context ): string { // Get original wrapper classes from block content. $original_wrapper_classname = ( new Dom_Document_Helper( $block_content ) )->get_attribute_value_by_tag_name( 'div', 'class' ) ?? ''; // Get layout attributes. $media_position = $block_attrs['mediaPosition'] ?? 'left'; $vertical_alignment = $this->get_vertical_alignment_from_attributes( $block_attrs ); $media_width = $this->get_media_width_from_attributes( $block_attrs ); $text_width = 100 - $media_width; // Text takes the remaining width. // Handle image linking for any linkDestination type that has an href. if ( ! empty( $block_attrs['href'] ) ) { $media_content = $this->wrap_media_with_link( $media_content, $block_attrs['href'] ); } // Get block styles using the Styles_Helper. $block_styles = Styles_Helper::get_block_styles( $block_attrs, $rendering_context, array( 'padding', 'border', 'background', 'background-color', 'color' ) ); $block_styles = Styles_Helper::extend_block_styles( $block_styles, array( 'width' => '100%', 'border-collapse' => 'collapse', 'text-align' => 'left', ) ); // Apply class and style attributes to the wrapper table. $table_attrs = array( 'class' => 'email-block-media-text ' . $original_wrapper_classname, 'style' => $block_styles['css'], 'align' => 'left', 'width' => '100%', ); // Build individual table cells. $media_cell_attrs = array( 'style' => sprintf( 'width: %d%%; padding: 10px; vertical-align: %s;', $media_width, $vertical_alignment ), 'valign' => $vertical_alignment, ); $text_cell_attrs = array( 'style' => sprintf( 'width: %d%%; padding: 0 8%%; vertical-align: %s;', $text_width, $vertical_alignment ), 'valign' => $vertical_alignment, ); $media_cell = Table_Wrapper_Helper::render_table_cell( $media_content, $media_cell_attrs ); $text_cell = Table_Wrapper_Helper::render_table_cell( $text_content, $text_cell_attrs ); // Order cells based on media position. if ( 'right' === $media_position ) { // Text first, then media. $cells = $text_cell . $media_cell; } else { // Media first, then text (default left position). $cells = $media_cell . $text_cell; } // Use render_cell = false to avoid wrapping in an extra <td>. return Table_Wrapper_Helper::render_table_wrapper( $cells, $table_attrs, array(), array(), false ); } /** * Get the vertical alignment value from block attributes. * * @param array $block_attrs Block attributes. * @return string CSS vertical-align value. */ private function get_vertical_alignment_from_attributes( array $block_attrs ): string { $vertical_alignment = $block_attrs['verticalAlignment'] ?? 'middle'; // Convert WordPress alignment values to CSS values. switch ( $vertical_alignment ) { case 'top': return 'top'; case 'center': return 'middle'; case 'bottom': return 'bottom'; default: return 'middle'; } } /** * Get the media width value from block attributes. * * @param array $block_attrs Block attributes. * @return int Media width percentage (1-99). */ private function get_media_width_from_attributes( array $block_attrs ): int { $media_width = $block_attrs['mediaWidth'] ?? 50; // Ensure the width is within reasonable bounds. $media_width = max( 1, min( 99, (int) $media_width ) ); return $media_width; } /** * Wrap media content with a link if it's not already wrapped. * * @param string $media_content The media content (inner content from figure element). * @param string $href The URL to link to. * @return string Media content wrapped with link. */ private function wrap_media_with_link( string $media_content, string $href ): string { // If media is already wrapped in a link, return as-is. if ( false !== strpos( $media_content, '<a ' ) ) { return $media_content; } // Wrap the media content with a link. return '<a href="' . esc_url( $href ) . '">' . $media_content . '</a>'; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-table.php 0000777 00000054143 15252010675 0021153 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Html_Processing_Helper; /** * Renders a table block. */ class Table extends Abstract_Block_Renderer { /** * Valid text alignment values. */ private const VALID_TEXT_ALIGNMENTS = array( 'left', 'center', 'right' ); /** * Renders the block content. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // Extract table content and caption from figure wrapper if present. $extracted_data = $this->extract_table_and_caption_from_figure( $block_content ); $table_content = $extracted_data['table']; $caption = $extracted_data['caption']; // Validate that we have actual table content. if ( ! $this->is_valid_table_content( $table_content ) ) { return ''; } // Check for empty table structures - tables with no th or td elements. if ( ! preg_match( '/<(th|td)/i', $table_content ) ) { return ''; } $block_attributes = wp_parse_args( $parsed_block['attrs'] ?? array(), array( 'textAlign' => 'left', 'style' => array(), ) ); $html = new \WP_HTML_Tag_Processor( $table_content ); $classes = 'email-table-block'; if ( $html->next_tag() ) { $block_classes = (string) ( $html->get_attribute( 'class' ) ?? '' ); $classes .= ' ' . $block_classes; // Clean classes for table element. $block_classes = Html_Processing_Helper::clean_css_classes( $block_classes ); $html->set_attribute( 'class', $block_classes ); $table_content = $html->get_updated_html(); } // Clean wrapper classes. $classes = Html_Processing_Helper::clean_css_classes( $classes ); // Get spacing styles for wrapper and table-specific styles separately. $spacing_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'spacing' ) ); $table_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'background-color', 'color', 'typography' ) ); // Ensure background styles are completely removed from spacing styles and force transparent background. $spacing_css = $spacing_styles['css'] ?? ''; $spacing_css = (string) ( preg_replace( '/background[^;]*;?/', '', $spacing_css ) ?? '' ); $spacing_css = (string) ( preg_replace( '/\s*;\s*;/', ';', $spacing_css ) ?? '' ); // Clean up double semicolons. $spacing_css = trim( $spacing_css, '; ' ); // Force transparent background on wrapper to prevent any background leakage. $spacing_styles['css'] = $spacing_css ? $spacing_css . '; background: transparent !important;' : 'background: transparent !important;'; $additional_styles = array( 'min-width' => '100%', // Prevent Gmail App from shrinking the table on mobile devices. ); // Add fallback text color when no custom text color or preset text color is set. if ( empty( $table_styles['declarations']['color'] ) ) { $email_styles = $rendering_context->get_theme_styles(); $color = $parsed_block['email_attrs']['color'] ?? $email_styles['color']['text'] ?? '#000000'; // Sanitize color value to ensure it's a valid hex color. $additional_styles['color'] = Html_Processing_Helper::sanitize_color( $color ); } $additional_styles['text-align'] = 'left'; if ( ! empty( $parsed_block['attrs']['textAlign'] ) ) { // In this case, textAlign needs to be one of 'left', 'center', 'right'. $text_align = $parsed_block['attrs']['textAlign']; if ( in_array( $text_align, self::VALID_TEXT_ALIGNMENTS, true ) ) { $additional_styles['text-align'] = $text_align; } } elseif ( in_array( $parsed_block['attrs']['align'] ?? null, self::VALID_TEXT_ALIGNMENTS, true ) ) { $additional_styles['text-align'] = $parsed_block['attrs']['align']; } $table_styles = Styles_Helper::extend_block_styles( $table_styles, $additional_styles ); // Check if this is a striped table style. $is_striped_table = $this->is_striped_table( $block_content, $parsed_block ); // Process the table content to ensure email compatibility BEFORE wrapping. $table_content = $this->process_table_content( $table_content, $parsed_block, $rendering_context, $is_striped_table ); // Apply table-specific styles (background, color, typography) directly to the table element. $table_content_with_styles = $this->apply_styles_to_table_element( $table_content, $table_styles['css'] ); // Add wp-block-table class to the table element for theme.json CSS rules. if ( false !== strpos( $block_content, 'wp-block-table' ) ) { $table_content_with_styles = $this->add_class_to_table_element( $table_content_with_styles, 'wp-block-table' ); } // Build complete content (table + caption). $complete_content = $table_content_with_styles; if ( ! empty( $caption ) ) { // Use HTML API to safely allow specific tags in caption. $sanitized_caption = Html_Processing_Helper::sanitize_caption_html( $caption ); // Extract typography styles from table styles (not spacing styles) and apply to caption. $caption_styles = $this->extract_typography_styles_for_caption( $table_styles['css'] ); $complete_content .= '<div style="text-align: center; margin-top: 8px; ' . $caption_styles . '">' . $sanitized_caption . '</div>'; } $table_attrs = array( 'style' => 'border-collapse: separate;', // Needed because of border radius. 'width' => '100%', ); // Use spacing styles only for the wrapper. $cell_attrs = array( 'class' => $classes, 'style' => $spacing_styles['css'], 'align' => $additional_styles['text-align'], ); $rendered_table = Table_Wrapper_Helper::render_table_wrapper( $complete_content, $table_attrs, $cell_attrs ); return $rendered_table; } /** * Process table content to ensure email client compatibility. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @param bool $is_striped_table Whether this is a striped table. * @return string */ private function process_table_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context, bool $is_striped_table = false ): string { $html = new \WP_HTML_Tag_Processor( $block_content ); // Extract custom border color and width from block attributes. $custom_border_color = $this->get_custom_border_color( $parsed_block, $rendering_context ); $custom_border_width = $this->get_custom_border_width( $parsed_block ); // Use custom border color if available, otherwise fall back to default. if ( $custom_border_color ) { $border_color = $custom_border_color; } else { // Get theme styles once to avoid repeated calls. $email_styles = $rendering_context->get_theme_styles(); $border_color = Html_Processing_Helper::sanitize_color( $parsed_block['email_attrs']['color'] ?? $email_styles['color']['text'] ?? '#000000' ); } // Track row context for striped styling. $current_section = ''; // Table sections: thead, tbody, tfoot. $row_count = 0; // Process table elements. while ( $html->next_tag() ) { $tag_name = $html->get_tag(); if ( 'TABLE' === $tag_name ) { // Ensure table has proper email attributes. $html->set_attribute( 'border', '1' ); $html->set_attribute( 'cellpadding', '8' ); $html->set_attribute( 'cellspacing', '0' ); $html->set_attribute( 'role', 'presentation' ); $html->set_attribute( 'width', '100%' ); // Get existing style and add email-specific styles. $existing_style = (string) ( $html->get_attribute( 'style' ) ?? '' ); // Check for fixed layout class and apply table-layout: fixed. $class_attr = (string) ( $html->get_attribute( 'class' ) ?? '' ); $table_layout = $this->has_fixed_layout( $class_attr ) ? 'table-layout: fixed; ' : ''; // Use border-collapse: collapse to ensure consistent borders between table and cells. $email_table_styles = "{$table_layout}border-collapse: collapse; width: 100%;"; $existing_style = rtrim( $existing_style, "; \t\n\r\0\x0B" ); $new_style = $existing_style ? $existing_style . '; ' . $email_table_styles : $email_table_styles; $html->set_attribute( 'style', $new_style ); // Remove problematic classes from the table but keep has-fixed-layout and alignment classes for editor UI. $class_attr = Html_Processing_Helper::clean_css_classes( $class_attr ); $html->set_attribute( 'class', $class_attr ); } elseif ( 'THEAD' === $tag_name ) { $current_section = 'thead'; $row_count = 0; } elseif ( 'TBODY' === $tag_name ) { $current_section = 'tbody'; $row_count = 0; } elseif ( 'TFOOT' === $tag_name ) { $current_section = 'tfoot'; $row_count = 0; } elseif ( 'TR' === $tag_name ) { ++$row_count; } elseif ( 'TD' === $tag_name || 'TH' === $tag_name ) { // Ensure table cells have proper email attributes with borders and padding. $html->set_attribute( 'valign', 'top' ); // Get existing style and add email-specific styles with borders and padding. $existing_style = (string) ( $html->get_attribute( 'style' ) ?? '' ); $existing_style = rtrim( $existing_style, "; \t\n\r\0\x0B" ); $border_width = $custom_border_width ? $custom_border_width : '1px'; $border_style = $this->get_custom_border_style( $parsed_block ); // Extract cell-specific text alignment. $cell_text_align = $this->get_cell_text_alignment( $html ); $email_cell_styles = "vertical-align: top; border: {$border_width} {$border_style} {$border_color}; padding: 8px; text-align: {$cell_text_align};"; // Add thicker borders for header and footer cells when no custom border is set. $email_cell_styles = $this->add_header_footer_borders( $html, $email_cell_styles, $border_color, $current_section, $custom_border_width ); // Add striped styling for tbody rows (first row gets background, then alternates). if ( $is_striped_table && 'tbody' === $current_section && 1 === $row_count % 2 ) { $email_cell_styles .= ' background-color: #f8f9fa;'; } $new_cell_style = $existing_style ? $existing_style . '; ' . $email_cell_styles : $email_cell_styles; $html->set_attribute( 'style', $new_cell_style ); } } return $html->get_updated_html(); } /** * Get custom border color from block attributes. * * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string|null Custom border color or null if not set. */ private function get_custom_border_color( array $parsed_block, Rendering_Context $rendering_context ): ?string { $block_attributes = $parsed_block['attrs'] ?? array(); if ( ! empty( $block_attributes['borderColor'] ) ) { $border_color = $rendering_context->translate_slug_to_color( $block_attributes['borderColor'] ); return Html_Processing_Helper::sanitize_color( $border_color ); } return null; } /** * Get custom border width from block attributes. * * @param array $parsed_block Parsed block. * @return string|null Custom border width or null if not set. */ private function get_custom_border_width( array $parsed_block ): ?string { $block_attributes = $parsed_block['attrs'] ?? array(); if ( ! empty( $block_attributes['style']['border']['width'] ) ) { $border_width = $block_attributes['style']['border']['width']; // Sanitize the border width value. $border_width = Html_Processing_Helper::sanitize_css_value( $border_width ); if ( empty( $border_width ) ) { return null; } // Ensure the border width has a unit, default to px if not specified. if ( is_numeric( $border_width ) ) { return $border_width . 'px'; } // Validate that the border width contains only valid CSS units and numbers. if ( preg_match( '/^[0-9]+\.?[0-9]*(px|em|rem|pt|pc|in|cm|mm|ex|ch|vw|vh|vmin|vmax)$/', $border_width ) ) { return $border_width; } // If invalid, return null to use default. return null; } return null; } /** * Get custom border style from block attributes. * * @param array $parsed_block Parsed block. * @return string Custom border style or 'solid' as default. */ private function get_custom_border_style( array $parsed_block ): string { $style = strtolower( (string) ( $parsed_block['attrs']['style']['border']['style'] ?? '' ) ); $allowed = array( 'solid', 'dashed', 'dotted' ); // Email-safe subset. return in_array( $style, $allowed, true ) ? $style : 'solid'; } /** * Add thicker borders for table headers and footers when no custom border is set. * * @param \WP_HTML_Tag_Processor $html HTML tag processor. * @param string $base_styles Base cell styles. * @param string $border_color Border color. * @param string $current_section Current table section (thead, tbody, tfoot). * @param string|null $custom_border_width Custom border width if set. * @return string Updated cell styles. */ private function add_header_footer_borders( \WP_HTML_Tag_Processor $html, string $base_styles, string $border_color, string $current_section = '', ?string $custom_border_width = null ): string { $tag_name = $html->get_tag(); // Only add thicker borders if no custom border width is set. if ( $custom_border_width ) { return $base_styles; } // Add thicker bottom border to all TH elements (headers). if ( 'TH' === $tag_name ) { $base_styles .= " border-bottom: 3px solid {$border_color};"; } // Add thicker top border to footer cells (TD elements in tfoot). if ( 'TD' === $tag_name && 'tfoot' === $current_section ) { $base_styles .= " border-top: 3px solid {$border_color};"; } return $base_styles; } /** * Get text alignment for a table cell. * * @param \WP_HTML_Tag_Processor $html HTML tag processor. * @return string Text alignment value (left, center, right). */ private function get_cell_text_alignment( \WP_HTML_Tag_Processor $html ): string { // Check for data-align attribute first. $data_align = $html->get_attribute( 'data-align' ); if ( $data_align && in_array( $data_align, self::VALID_TEXT_ALIGNMENTS, true ) ) { return $data_align; } // Check for has-text-align-* classes. $class_attr = (string) ( $html->get_attribute( 'class' ) ?? '' ); if ( false !== strpos( $class_attr, 'has-text-align-center' ) ) { return 'center'; } if ( false !== strpos( $class_attr, 'has-text-align-right' ) ) { return 'right'; } if ( false !== strpos( $class_attr, 'has-text-align-left' ) ) { return 'left'; } // Default to left alignment. return 'left'; } /** * Check if table has fixed layout class. * * @param string $class_attr Class attribute string. * @return bool True if has-fixed-layout class is present. */ private function has_fixed_layout( string $class_attr ): bool { return false !== strpos( $class_attr, 'has-fixed-layout' ); } /** * Extract table content and caption from figure wrapper if present. * * @param string $block_content Block content. * @return array Array with 'table' and 'caption' keys. */ private function extract_table_and_caption_from_figure( string $block_content ): array { $dom_helper = new Dom_Document_Helper( $block_content ); // Look for figure element with wp-block-table class. $figure_tag = $dom_helper->find_element( 'figure' ); if ( ! $figure_tag ) { // If no figure wrapper found, return original content as table. return array( 'table' => $block_content, 'caption' => '', ); } $figure_class_attr = $dom_helper->get_attribute_value( $figure_tag, 'class' ); $figure_class = (string) ( $figure_class_attr ? $figure_class_attr : '' ); if ( false === strpos( $figure_class, 'wp-block-table' ) ) { // If figure doesn't have wp-block-table class, return original content as table. return array( 'table' => $block_content, 'caption' => '', ); } // Extract table element from within the matched figure only. $figure_html = $dom_helper->get_outer_html( $figure_tag ); // Use regex to extract table from within the figure to avoid document conflicts. if ( ! preg_match( '/<table[^>]*>.*?<\/table>/is', $figure_html, $table_matches ) ) { return array( 'table' => $block_content, 'caption' => '', ); } $table_html = $table_matches[0]; // Extract figcaption if present (scoped to the figure). $caption = ''; if ( preg_match( '/<figcaption[^>]*>(.*?)<\/figcaption>/is', $figure_html, $figcaption_matches ) ) { $caption = $figcaption_matches[1]; } return array( 'table' => $table_html, 'caption' => $caption, ); } /** * Apply CSS styles directly to the table element. * * @param string $table_content Table HTML content. * @param string $styles CSS styles to apply. * @return string Table content with styles applied. */ private function apply_styles_to_table_element( string $table_content, string $styles ): string { $html = new \WP_HTML_Tag_Processor( $table_content ); if ( $html->next_tag( array( 'tag_name' => 'TABLE' ) ) ) { $existing_style = (string) ( $html->get_attribute( 'style' ) ?? '' ); $existing_style = rtrim( $existing_style, "; \t\n\r\0\x0B" ); // Add default border widths if individual border colors are present but no widths. $border_width_styles = $this->get_default_border_widths( $existing_style ); $new_style = $existing_style; if ( ! empty( $border_width_styles ) ) { $new_style = $new_style ? $new_style . '; ' . $border_width_styles : $border_width_styles; } if ( ! empty( $styles ) ) { $new_style = $new_style ? $new_style . '; ' . $styles : $styles; } $html->set_attribute( 'style', $new_style ); return $html->get_updated_html(); } return $table_content; } /** * Get default border widths for table element when individual border colors are present. * * @param string $existing_style Existing style attribute of the table element. * @return string CSS border width styles or empty string if not needed. */ private function get_default_border_widths( string $existing_style ): string { // Check if individual border colors are present but no corresponding widths. $sides = array( 'top', 'right', 'bottom', 'left' ); $border_width_styles = array(); foreach ( $sides as $side ) { $has_color = strpos( $existing_style, "border-{$side}-color:" ) !== false; $has_width = strpos( $existing_style, "border-{$side}-width:" ) !== false; // If border color is present but no width, add default width. if ( $has_color && ! $has_width ) { $border_width_styles[] = "border-{$side}-width: 1.5px"; } } return implode( '; ', $border_width_styles ); } /** * Add a CSS class to the table element. * * @param string $table_content Table HTML content. * @param string $class_name CSS class to add. * @return string Table content with class added. */ private function add_class_to_table_element( string $table_content, string $class_name ): string { // Validate class name to prevent XSS. if ( ! preg_match( '/^[a-zA-Z0-9\-_]+$/', $class_name ) ) { return $table_content; } $html = new \WP_HTML_Tag_Processor( $table_content ); if ( $html->next_tag( array( 'tag_name' => 'TABLE' ) ) ) { $existing_class = (string) ( $html->get_attribute( 'class' ) ?? '' ); $existing_class = trim( $existing_class ); // Only add if not already present. if ( false === strpos( $existing_class, $class_name ) ) { $new_class = $existing_class ? $existing_class . ' ' . $class_name : $class_name; $html->set_attribute( 'class', $new_class ); } return $html->get_updated_html(); } return $table_content; } /** * Extract typography styles from CSS string for caption. * * @param string $css CSS string to extract typography from. * @return string Typography CSS for caption. */ private function extract_typography_styles_for_caption( string $css ): string { $typography_properties = Html_Processing_Helper::get_caption_css_properties(); $caption_styles = array(); foreach ( $typography_properties as $property ) { // Use regex to extract each typography property. if ( preg_match( '/' . preg_quote( $property, '/' ) . '\s*:\s*([^;]+)/i', $css, $matches ) ) { $value = trim( $matches[1] ); // Sanitize the CSS value to prevent injection. $sanitized_value = Html_Processing_Helper::sanitize_css_value( $value ); if ( ! empty( $sanitized_value ) ) { $caption_styles[] = $property . ': ' . $sanitized_value; } } } return implode( '; ', $caption_styles ); } /** * Check if the table has striped styling. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @return bool True if it's a striped table, false otherwise. */ private function is_striped_table( string $block_content, array $parsed_block ): bool { // Check for is-style-stripes in block attributes. if ( isset( $parsed_block['attrs']['className'] ) && false !== strpos( $parsed_block['attrs']['className'], 'is-style-stripes' ) ) { return true; } // Check for is-style-stripes in figure classes. if ( false !== strpos( $block_content, 'is-style-stripes' ) ) { return true; } return false; } /** * Validate if the content is a valid table HTML. * * @param string $content The content to validate. * @return bool True if it's a valid table, false otherwise. */ private function is_valid_table_content( string $content ): bool { // Only assert that a <table> exists; downstream checks handle emptiness and KSES handles sanitization. return (bool) preg_match( '/<table[^>]*>.*?<\/table>/is', $content ); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-gallery.php 0000777 00000026643 15252010675 0021527 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Html_Processing_Helper; /** * Gallery block renderer. * This renderer handles core/gallery blocks with proper email-friendly HTML layout. */ class Gallery extends Abstract_Block_Renderer { /** * Renders the gallery block content using a table-based layout. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // Extract images directly from the block content (more efficient than re-rendering). $gallery_images = $this->extract_images_from_gallery_content( $block_content, $parsed_block ); // If we don't have any images, return empty. if ( empty( $gallery_images ) ) { return ''; } // Build the email-friendly layout. return $this->build_email_layout( $gallery_images, $parsed_block, $block_content, $rendering_context ); } /** * Extract all images from gallery content with their links and captions. * * @param string $block_content The rendered gallery block HTML. * @param array $parsed_block The parsed block data. * @return array Array of sanitized image HTML strings. */ private function extract_images_from_gallery_content( string $block_content, array $parsed_block ): array { $gallery_images = array(); $inner_blocks = $parsed_block['innerBlocks'] ?? array(); // Extract images from inner blocks data where the actual image HTML is stored. foreach ( $inner_blocks as $block ) { if ( 'core/image' === $block['blockName'] && isset( $block['innerHTML'] ) ) { $extracted_image = $this->extract_image_from_html( $block['innerHTML'] ); if ( ! empty( $extracted_image ) ) { $gallery_images[] = $extracted_image; } } } return $gallery_images; } /** * Extract and sanitize image with optional link and caption from HTML content. * This is the unified method that handles all image extraction scenarios. * * @param string $html_content HTML content containing the image. * @return string Sanitized image HTML with proper link and caption handling. */ private function extract_image_from_html( string $html_content ): string { $result = ''; // First, try to find a linked image (most common case). if ( preg_match( '/<a[^>]*href=(["\'])(.*?)\1[^>]*>(\s*<img[^>]*>)\s*<\/a>/s', $html_content, $link_matches ) ) { // Validate and sanitize the link URL. $sanitized_url = esc_url( $link_matches[2] ); if ( ! empty( $sanitized_url ) ) { $sanitized_img = Html_Processing_Helper::sanitize_image_html( $link_matches[3] ); if ( '' !== $sanitized_img ) { $result .= '<a href="' . $sanitized_url . '">' . $sanitized_img . '</a>'; } } else { // If URL is invalid, extract just the image without link. $sanitized_img = Html_Processing_Helper::sanitize_image_html( $link_matches[3] ); if ( '' !== $sanitized_img ) { $result .= $sanitized_img; } } } elseif ( preg_match( '/<img[^>]*>/', $html_content, $img_matches ) ) { // Image is not linked - just extract the img element with sanitization. $sanitized_img = Html_Processing_Helper::sanitize_image_html( $img_matches[0] ); if ( '' !== $sanitized_img ) { $result .= $sanitized_img; } } // Extract the caption if it exists (handle both figcaption and span formats). // Enhanced security: validate container attributes before extracting content. if ( preg_match( '/(<figcaption[^>]*>)(.*?)(<\/figcaption>)/s', $html_content, $caption_matches ) ) { // Validate the figcaption container attributes for security. if ( Html_Processing_Helper::validate_container_attributes( $caption_matches[1] . $caption_matches[3] ) ) { $sanitized_caption = Html_Processing_Helper::sanitize_caption_html( $caption_matches[2] ); $result .= '<br><div class="wp-element-caption" style="font-size: 13px; line-height: 1.0;">' . $sanitized_caption . '</div>'; } } elseif ( preg_match( '/(<span class="wp-element-caption"[^>]*>)(.*?)(<\/span>)/s', $html_content, $caption_matches ) ) { // Validate the span container attributes for security. if ( Html_Processing_Helper::validate_container_attributes( $caption_matches[1] . $caption_matches[3] ) ) { $sanitized_caption = Html_Processing_Helper::sanitize_caption_html( $caption_matches[2] ); $result .= '<br><div class="wp-element-caption" style="font-size: 13px; line-height: 1.0;">' . $sanitized_caption . '</div>'; } } return $result; } /** * Extract gallery-level caption from the original block content. * * @param string $block_content Original block content. * @return string Gallery caption or empty string if not found. */ private function extract_gallery_caption( string $block_content ): string { // Look for gallery-level caption: <figcaption class="blocks-gallery-caption wp-element-caption">. // Enhanced security: validate container attributes before extracting content. if ( preg_match( '/(<figcaption class="blocks-gallery-caption[^"]*"[^>]*>)(.*?)(<\/figcaption>)/s', $block_content, $matches ) ) { // Validate the figcaption container attributes for security. if ( Html_Processing_Helper::validate_container_attributes( $matches[1] . $matches[3] ) ) { return Html_Processing_Helper::sanitize_caption_html( trim( $matches[2] ) ); } } return ''; } /** * Build the email-friendly layout for gallery blocks. * * @param array $gallery_images Array of image HTML strings. * @param array $parsed_block Full parsed block data. * @param string $block_content Original block content. * @param Rendering_Context $rendering_context Rendering context. * @return string Rendered HTML. */ private function build_email_layout( array $gallery_images, array $parsed_block, string $block_content, Rendering_Context $rendering_context ): string { // Get original wrapper classes from block content. $original_wrapper_classname = ( new Dom_Document_Helper( $block_content ) )->get_attribute_value_by_tag_name( 'figure', 'class' ) ?? ''; // Get gallery attributes. $block_attrs = $parsed_block['attrs'] ?? array(); $columns = $this->get_columns_from_attributes( $block_attrs ); // Extract gallery-level caption from the original block content. $gallery_caption = $this->extract_gallery_caption( $block_content ); // Get block styles using the Styles_Helper. $block_styles = Styles_Helper::get_block_styles( $block_attrs, $rendering_context, array( 'padding', 'border', 'background', 'background-color', 'color' ) ); $block_styles = Styles_Helper::extend_block_styles( $block_styles, array( 'width' => '100%', 'border-collapse' => 'collapse', 'text-align' => 'left', ) ); // Apply class and style attributes to the wrapper table. $table_attrs = array( 'class' => 'email-block-gallery ' . Html_Processing_Helper::clean_css_classes( $original_wrapper_classname ), 'style' => $block_styles['css'], 'align' => 'left', 'width' => '100%', ); // Add email width to cell attributes if available. $cell_attrs = array(); if ( isset( $parsed_block['email_attrs']['width'] ) ) { $cell_attrs['width'] = $parsed_block['email_attrs']['width']; } // Build the gallery rows with proper table structure. $gallery_content = $this->build_gallery_table( $gallery_images, $columns ); // Add gallery caption if it exists. if ( ! empty( $gallery_caption ) ) { $gallery_content .= '<br><div class="blocks-gallery-caption wp-element-caption" style="font-size: 13px; line-height: 1.0; text-align: center;">' . $gallery_caption . '</div>'; } // Use Table_Wrapper_Helper for the main container (following tiled gallery pattern). return Table_Wrapper_Helper::render_table_wrapper( $gallery_content, $table_attrs, $cell_attrs ); } /** * Build the gallery table structure with proper rows and cells. * Uses the tiled gallery pattern: separate tables for each row, then wrap in main table. * * @param array $gallery_images Array of image HTML strings. * @param int $columns Number of columns. * @return string Gallery table HTML. */ private function build_gallery_table( array $gallery_images, int $columns ): string { $content_parts = array(); $image_count = count( $gallery_images ); $cell_padding = 8; // 0.5em equivalent (approximately 8px) // Process images in chunks based on columns to create rows. for ( $i = 0; $i < $image_count; $i += $columns ) { $row_images = array_slice( $gallery_images, $i, $columns ); $content_parts[] = $this->build_gallery_row_table( $row_images, $columns, $cell_padding ); } return implode( '', $content_parts ); } /** * Build a single gallery row as a separate table (following tiled gallery pattern). * * @param array $row_images Images for this row. * @param int $total_columns Total number of columns. * @param int $cell_padding Cell padding. * @return string Row table HTML. */ private function build_gallery_row_table( array $row_images, int $total_columns, int $cell_padding ): string { $images_in_row = count( $row_images ); $row_cells = ''; // If there is exactly one image, span full width; otherwise distribute width evenly across the images in this row. if ( 1 === $images_in_row ) { $cell_attrs = array( 'style' => sprintf( 'width: %s; padding: %dpx; vertical-align: top; text-align: center;', Html_Processing_Helper::sanitize_css_value( '100%' ), $cell_padding ), 'valign' => 'top', 'colspan' => $total_columns, ); $row_cells .= Table_Wrapper_Helper::render_table_cell( $row_images[0], $cell_attrs ); } else { // Evenly distribute available width among the images in this row. $cell_width_percent = 100 / $images_in_row; foreach ( $row_images as $image_html ) { $cell_attrs = array( 'style' => sprintf( 'width: %s; padding: %dpx; vertical-align: top; text-align: center;', Html_Processing_Helper::sanitize_css_value( sprintf( '%.2f%%', $cell_width_percent ) ), $cell_padding ), 'valign' => 'top', ); $row_cells .= Table_Wrapper_Helper::render_table_cell( $image_html, $cell_attrs ); } } // Create a separate table for this row (following tiled gallery pattern). return sprintf( '<table role="presentation" style="width: %s; border-collapse: collapse; table-layout: fixed;"><tr>%s</tr></table>', Html_Processing_Helper::sanitize_css_value( '100%' ), $row_cells ); } /** * Get the columns value from block attributes. * * @param array $block_attrs Block attributes. * @return int Number of columns (1-5). */ private function get_columns_from_attributes( array $block_attrs ): int { $columns = $block_attrs['columns'] ?? 3; // Ensure the columns are within reasonable bounds. $columns = max( 1, min( 5, (int) $columns ) ); return $columns; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-list-item.php 0000777 00000002063 15252010675 0021765 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; /** * Renders a list item block. */ class List_Item extends Abstract_Block_Renderer { /** * Override this method to disable spacing (block gap) for list items. * * @param string $content Content. * @param array $email_attrs Email attributes. */ protected function add_spacer( $content, $email_attrs ): string { return $content; } /** * Renders the block content. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { return $block_content; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-social-links.php 0000777 00000036342 15252010675 0022455 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Social_Links_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * Renders the social links block. */ class Social_Links extends Abstract_Block_Renderer { /** * Cache of the core social link services. * * @var array<string, array> */ private $core_social_link_services_cache = array(); /** * Supported image types. * * @var array<string> */ private $supported_image_types = array( 'white', 'brand' ); /** * Renders the block content. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $attrs = $parsed_block['attrs'] ?? array(); $inner_blocks = $parsed_block['innerBlocks'] ?? array(); $content = ''; foreach ( $inner_blocks as $block ) { $content .= $this->generate_social_link_content( $block, $attrs ); } return str_replace( '{social_links_content}', $content, $this->get_block_wrapper( $block_content, $parsed_block ) ); } /** * Generates the social link content. * * @param array $block The block data. * @param array $parent_block_attrs The parent block attributes. * @return string The generated content. */ private function generate_social_link_content( $block, $parent_block_attrs ) { $service_name = $block['attrs']['service'] ?? ''; $service_url = $block['attrs']['url'] ?? ''; $label = $block['attrs']['label'] ?? ''; if ( empty( $service_name ) || empty( $service_url ) ) { return ''; } /** * Prepend emails with `mailto:` if not set. * The `is_email` returns false for emails with schema. */ if ( is_email( $service_url ) ) { $service_url = 'mailto:' . antispambot( $service_url ); } /** * Prepend URL with https:// if it doesn't appear to contain a scheme * and it's not a relative link or a fragment. */ if ( ! wp_parse_url( $service_url, PHP_URL_SCHEME ) && ! str_starts_with( $service_url, '//' ) && ! str_starts_with( $service_url, '#' ) ) { $service_url = 'https://' . $service_url; } $open_in_new_tab = $parent_block_attrs['openInNewTab'] ?? false; $show_labels = $parent_block_attrs['showLabels'] ?? false; $size = $parent_block_attrs['size'] ?? Social_Links_Helper::get_default_social_link_size(); $service_brand_color = Social_Links_Helper::get_service_brand_color( $service_name ); $icon_color_value = $parent_block_attrs['iconColorValue'] ?? '#ffffff'; // use white as default icon color. $icon_background_color_value = $parent_block_attrs['iconBackgroundColorValue'] ?? ''; $is_logos_only = strpos( $parent_block_attrs['className'] ?? '', 'is-style-logos-only' ) !== false; $is_pill_shape = strpos( $parent_block_attrs['className'] ?? '', 'is-style-pill-shape' ) !== false; if ( ! $is_logos_only && Social_Links_Helper::detect_whiteish_color( $icon_color_value ) && ( Social_Links_Helper::detect_whiteish_color( $icon_background_color_value ) || empty( $icon_background_color_value ) ) ) { // If the icon color is white and the background color is white or empty, use the service brand color for the icon background color. $icon_background_color_value = ! empty( $service_brand_color ) ? $service_brand_color : '#000'; } if ( $is_logos_only ) { // logos only mode does not need background color. We also don't really need the icon color (we can't change png image color anyways). // We set it so that the label text color will reflect the service brand color. $icon_color_value = ! empty( $service_brand_color ) ? $service_brand_color : '#000'; } $icon_size = Social_Links_Helper::get_social_link_size_option_value( $size ); $service_icon_url = $this->get_service_icon_url( $service_name, $is_logos_only ? 'brand' : 'white' ); $service_label = ''; if ( $show_labels ) { $text = ! empty( $label ) ? trim( $label ) : ''; $service_label = $text ? $text : block_core_social_link_get_name( $service_name ); } $main_table_styles = $this->compile_css( array( 'background-color' => $icon_background_color_value, 'border-radius' => '9999px', 'display' => 'inline-table', 'float' => 'none', ) ); // divide the icon value by 2 to get the font size. $font_size_value = (int) rtrim( $icon_size, 'px' ); $font_size = ( $font_size_value / 2 ) + 1; // inline with core styles. $text_font_size = "{$font_size}px"; $anchor_styles = $this->compile_css( array( 'color' => $icon_color_value, 'text-decoration' => 'none', 'text-transform' => 'none', 'font-size' => $text_font_size, ) ); $anchor_html = sprintf( ' style="%s" ', esc_attr( $anchor_styles ) ); if ( $open_in_new_tab ) { $anchor_html .= ' rel="noopener nofollow" target="_blank" '; } $row_container_styles = array( 'display' => 'block', 'padding' => '0.25em', ); if ( $is_pill_shape ) { $row_container_styles['padding-left'] = '17px'; $row_container_styles['padding-right'] = '17px'; } $row_container_styles = $this->compile_css( $row_container_styles ); // Generate the icon content. $icon_content = sprintf( '<a href="%1$s" %2$s class="wp-block-social-link-anchor"> <img height="%3$s" src="%4$s" style="display:block;margin-right:0;" width="%3$s" alt="%5$s"> </a>', esc_url( $service_url ), $anchor_html, esc_attr( $icon_size ), esc_url( $service_icon_url ), // translators: %s is the social service name. sprintf( __( '%s icon', 'woocommerce' ), $service_name ) ); $icon_content = Table_Wrapper_Helper::render_table_wrapper( $icon_content, array(), array( 'style' => 'vertical-align:middle;' ) ); $icon_content = Table_Wrapper_Helper::render_table_cell( $icon_content, array( 'style' => sprintf( 'vertical-align:middle;font-size:%s;', $text_font_size ) ) ); // Generate the label content if needed. $label_content = ''; if ( $service_label ) { $label_content = sprintf( '<a href="%1$s" %2$s class="wp-block-social-link-anchor"> <span style="margin-left:.5em;margin-right:.5em"> %3$s </span> </a>', esc_url( $service_url ), $anchor_html, esc_html( $service_label ) ); $label_cell_style = sprintf( 'vertical-align:middle;padding-left:6px;padding-right:6px;font-size:%s;', $text_font_size ); $label_content = Table_Wrapper_Helper::render_table_cell( $label_content, array( 'style' => $label_cell_style ) ); } // Combine icon and label tables. $social_link_content = $icon_content . $label_content; // Create the main social link table. $main_table_attrs = array( 'align' => 'center', 'style' => $main_table_styles, ); $main_row_attrs = array( 'style' => $row_container_styles, ); $main_table = Table_Wrapper_Helper::render_table_wrapper( $social_link_content, $main_table_attrs, array(), $main_row_attrs, false ); return Table_Wrapper_Helper::render_outlook_table_cell( $main_table ); } /** * Gets the block wrapper. * * @param string $block_content The block content. * @param array $parsed_block The parsed block. * @return string The block wrapper HTML. */ private function get_block_wrapper( $block_content, $parsed_block ) { $content = $this->adjust_block_content( $block_content, $parsed_block ); $table_styles = $content['table_styles']; $classes = $content['classes']; $compiled_styles = $content['compiled_styles']; $align = $content['align']; $table_attrs = array( 'class' => 'wp-block-social-links', 'style' => $table_styles . ' vertical-align:top;', 'width' => '100%', ); $cell_attrs = array( 'class' => $classes, 'style' => $compiled_styles, 'align' => $align, ); $row_attrs = array( 'role' => 'presentation', ); $inner_content = Table_Wrapper_Helper::render_outlook_table_wrapper( '{social_links_content}', array( 'align' => 'center' ), array(), array(), false ); $main_wrapper = Table_Wrapper_Helper::render_table_wrapper( $inner_content, $table_attrs, $cell_attrs, $row_attrs ); return Table_Wrapper_Helper::render_outlook_table_wrapper( $main_wrapper, array( 'align' => 'center' ) ); } /** * Adjusts the block content. * Returns css classes and styles compatible with email clients. * * @param string $block_content The block content. * @param array $parsed_block The parsed block. * @return array The adjusted block content. */ private function adjust_block_content( $block_content, $parsed_block ) { $block_content = $this->adjust_style_attribute( $block_content ); $block_attributes = wp_parse_args( $parsed_block['attrs'] ?? array(), array( 'textAlign' => 'left', 'style' => array(), ) ); $html = new \WP_HTML_Tag_Processor( $block_content ); $classes = 'wp-block-social-links'; if ( $html->next_tag() ) { /** @var string $block_classes */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $block_classes = $html->get_attribute( 'class' ) ?? ''; $classes .= ' ' . $block_classes; // remove has-background to prevent double padding applied for wrapper and inner element. $block_classes = str_replace( 'has-background', '', $block_classes ); // remove border related classes because we handle border on wrapping table cell. $block_classes = preg_replace( '/[a-z-]+-border-[a-z-]+/', '', $block_classes ); /** @var string $block_classes */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $html->set_attribute( 'class', trim( $block_classes ) ); $block_content = $html->get_updated_html(); } $block_styles = $this->get_styles_from_block( array( 'color' => $block_attributes['style']['color'] ?? array(), 'spacing' => $block_attributes['style']['spacing'] ?? array(), 'typography' => $block_attributes['style']['typography'] ?? array(), 'border' => $block_attributes['style']['border'] ?? array(), ) ); $styles = array( 'min-width' => '100%', // prevent Gmail App from shrinking the table on mobile devices. 'vertical-align' => 'middle', 'word-break' => 'break-word', ); $styles['text-align'] = 'left'; if ( ! empty( $parsed_block['attrs']['textAlign'] ) ) { // in this case, textAlign needs to be one of 'left', 'center', 'right'. $styles['text-align'] = $parsed_block['attrs']['textAlign']; } elseif ( in_array( $parsed_block['attrs']['align'] ?? null, array( 'left', 'center', 'right' ), true ) ) { $styles['text-align'] = $parsed_block['attrs']['align']; } $compiled_styles = $this->compile_css( $block_styles['declarations'], $styles ); $table_styles = 'border-collapse: separate;'; // Needed because of border radius. return array( 'table_styles' => $table_styles, 'classes' => $classes, 'compiled_styles' => $compiled_styles, 'align' => $styles['text-align'], 'block_content' => $block_content, ); } /** * 1) We need to remove padding because we render padding on wrapping table cell * 2) We also need to replace font-size to avoid clamp() because clamp() is not supported in many email clients. * The font size values is automatically converted to clamp() when WP site theme is configured to use fluid layouts. * Currently (WP 6.5), there is no way to disable this behavior. * * @param string $block_content Block content. */ private function adjust_style_attribute( string $block_content ): string { $html = new \WP_HTML_Tag_Processor( $block_content ); if ( $html->next_tag() ) { $element_style_value = $html->get_attribute( 'style' ); $element_style = isset( $element_style_value ) ? strval( $element_style_value ) : ''; // Padding may contain value like 10px or variable like var(--spacing-10). $element_style = preg_replace( '/padding[^:]*:.?[0-9a-z-()]+;?/', '', $element_style ); // Remove border styles. We apply border styles on the wrapping table cell. $element_style = preg_replace( '/border[^:]*:.?[0-9a-z-()#]+;?/', '', strval( $element_style ) ); // We define the font-size on the wrapper element, but we need to keep font-size definition here // to prevent CSS Inliner from adding a default value and overriding the value set by user, which is on the wrapper element. // The value provided by WP uses clamp() function which is not supported in many email clients. $element_style = preg_replace( '/font-size:[^;]+;?/', 'font-size: inherit;', strval( $element_style ) ); /** @var string $element_style */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $html->set_attribute( 'style', esc_attr( $element_style ) ); $block_content = $html->get_updated_html(); } return $block_content; } /** * Gets the service icon URL. * * Default image type is 'white'. * * @param string $service The service name. * @param string $image_type The image type. e.g 'white', 'brand'. * @return string The service icon URL. */ public function get_service_icon_url( $service, $image_type = '' ) { $image_type = empty( $image_type ) ? 'white' : $image_type; $service = empty( $service ) ? '' : strtolower( $service ); if ( empty( $this->core_social_link_services_cache ) ) { $services = block_core_social_link_services(); $this->core_social_link_services_cache = is_array( $services ) ? $services : array(); } if ( ! isset( $this->core_social_link_services_cache[ $service ] ) ) { // not in the list of core services. return ''; } if ( ! in_array( $image_type, $this->supported_image_types, true ) ) { return ''; } // Get URL to icons/service.png. $service_icon_url = $this->get_service_png_url( $service, $image_type ); if ( $service_icon_url && ! file_exists( $this->get_service_png_path( $service, $image_type ) ) ) { // The image file does not exist. return ''; } return $service_icon_url; } /** * Gets the service PNG URL. * * @param string $service The service name. * @param string $image_type The image type. e.g 'white', 'brand'. * @return string The service PNG URL. */ public function get_service_png_url( $service, $image_type = 'white' ) { if ( empty( $service ) ) { return ''; } $image_type = empty( $image_type ) ? 'white' : $image_type; $file_name = "/icons/{$service}/{$service}-{$image_type}.png"; return plugins_url( $file_name, __FILE__ ); } /** * Gets the service PNG path. * * @param string $service The service name. * @param string $image_type The image type. e.g 'white', 'brand'. * @return string The service PNG path. */ public function get_service_png_path( $service, $image_type = 'white' ) { if ( empty( $service ) ) { return ''; } $image_type = empty( $image_type ) ? 'white' : $image_type; $file_name = "/icons/{$service}/{$service}-{$image_type}.png"; return __DIR__ . $file_name; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-button.php 0000777 00000010502 15252010675 0021366 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; /** * Renders a button block. * * @see https://www.activecampaign.com/blog/email-buttons * @see https://documentation.mjml.io/#mj-button */ class Button extends Abstract_Block_Renderer { /** * Get styles for the wrapper element. * * @param array $block_attributes Block attributes. * @param Rendering_Context $rendering_context Rendering context. * @return array */ private function get_wrapper_styles( array $block_attributes, Rendering_Context $rendering_context ) { $block_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'border', 'background-color', 'color', 'typography', 'spacing' ) ); return Styles_Helper::extend_block_styles( $block_styles, array( 'word-break' => 'break-word', 'display' => 'block', ) ); } /** * Get styles for the link element. * * @param array $block_attributes Block attributes. * @param Rendering_Context $rendering_context Rendering context. * @return array */ private function get_link_styles( array $block_attributes, Rendering_Context $rendering_context ) { $block_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'color', 'typography' ) ); return Styles_Helper::extend_block_styles( $block_styles, array( 'display' => 'block' ) ); } /** * Renders the block. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ public function render( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { return $this->render_content( $block_content, $parsed_block, $rendering_context ); } /** * Renders the block content. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { if ( empty( $parsed_block['innerHTML'] ) ) { return ''; } $dom_helper = new Dom_Document_Helper( $parsed_block['innerHTML'] ); $block_classname = $dom_helper->get_attribute_value_by_tag_name( 'div', 'class' ) ?? ''; $button_link = $dom_helper->find_element( 'a' ); if ( ! $button_link ) { return ''; } $button_text = $dom_helper->get_element_inner_html( $button_link ) ? $dom_helper->get_element_inner_html( $button_link ) : ''; $button_url = $button_link->getAttribute( 'href' ) ? $button_link->getAttribute( 'href' ) : '#'; $block_attributes = wp_parse_args( $parsed_block['attrs'] ?? array(), array( 'width' => '', 'style' => array(), 'textAlign' => 'center', 'backgroundColor' => '', 'textColor' => '', ) ); $wrapper_styles = $this->get_wrapper_styles( $block_attributes, $rendering_context ); $link_styles = $this->get_link_styles( $block_attributes, $rendering_context ); $table_attrs = array( 'style' => 'width:' . ( $block_attributes['width'] ? '100%' : 'auto' ) . ';', ); $cell_attrs = array( 'class' => $wrapper_styles['classnames'] . ' ' . $block_classname, 'style' => $wrapper_styles['css'], 'align' => $block_attributes['textAlign'], 'valign' => 'middle', 'role' => 'presentation', ); $button_content = sprintf( '<a class="button-link %1$s" style="%2$s" href="%3$s" target="_blank">%4$s</a>', esc_attr( $link_styles['classnames'] ), esc_attr( $link_styles['css'] ), esc_url( $button_url ), $button_text ); return Table_Wrapper_Helper::render_table_wrapper( $button_content, $table_attrs, $cell_attrs ); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-social-link.php 0000777 00000001617 15252010675 0022267 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; /** * Renders a social link block. */ class Social_Link extends Abstract_Block_Renderer { /** * Renders the block content. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // We are not using this because the blocks are rendered in the Social_Links block class. return $block_content; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-image.php 0000777 00000041637 15252010675 0021152 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * Renders an image block. */ class Image extends Abstract_Block_Renderer { /** * Renders the block content * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $parsed_html = $this->parse_block_content( $block_content ); if ( ! $parsed_html ) { return ''; } $image_url = $parsed_html['imageUrl']; $image = $parsed_html['image']; $caption = $parsed_html['caption']; $class = $parsed_html['class']; $anchor_tag_href = $parsed_html['anchor_tag_href']; $parsed_block = $this->add_image_size_when_missing( $parsed_block, $image_url ); $image = $this->add_image_dimensions( $image, $parsed_block ); $image_with_wrapper = str_replace( array( '{image_content}', '{caption_content}' ), array( $image, $caption ), $this->get_block_wrapper( $parsed_block, $rendering_context, $caption, $anchor_tag_href ) ); $image_with_wrapper = $this->apply_rounded_style( $image_with_wrapper, $parsed_block ); $image_with_wrapper = $this->apply_image_border_style( $image_with_wrapper, $parsed_block, $class ); return $image_with_wrapper; } /** * Apply rounded style to the image. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. */ private function apply_rounded_style( string $block_content, array $parsed_block ): string { // Because the isn't an attribute for definition of rounded style, we have to check the class name. if ( isset( $parsed_block['attrs']['className'] ) && strpos( $parsed_block['attrs']['className'], 'is-style-rounded' ) !== false ) { // If the image should be in a circle, we need to set the border-radius to 9999px to make it the same as is in the editor // This style is applied to both wrapper and the image. $block_content = $this->remove_style_attribute_from_element( $block_content, array( 'tag_name' => 'td', 'class_name' => 'email-image-cell', ), 'border-radius' ); $block_content = $this->add_style_to_element( $block_content, array( 'tag_name' => 'td', 'class_name' => 'email-image-cell', ), 'border-radius: 9999px;' ); $block_content = $this->remove_style_attribute_from_element( $block_content, array( 'tag_name' => 'img' ), 'border-radius' ); $block_content = $this->add_style_to_element( $block_content, array( 'tag_name' => 'img' ), 'border-radius: 9999px;' ); } return $block_content; } /** * When the width is not set, it's important to get it for the image to be displayed correctly * * @param array $parsed_block Parsed block. * @param string $image_url Image URL. */ private function add_image_size_when_missing( array $parsed_block, string $image_url ): array { if ( isset( $parsed_block['attrs']['width'] ) ) { return $parsed_block; } // Can't determine any width let's go with 100%. if ( ! isset( $parsed_block['email_attrs']['width'] ) ) { $parsed_block['attrs']['width'] = '100%'; return $parsed_block; } $max_width = Styles_Helper::parse_value( $parsed_block['email_attrs']['width'] ); $image_size = null; if ( $image_url ) { // Try to extract width from URL query parameter if it exists. $parsed_url = wp_parse_url( $image_url ); if ( isset( $parsed_url['query'] ) ) { parse_str( $parsed_url['query'], $query_params ); if ( isset( $query_params['w'] ) && is_numeric( $query_params['w'] ) && $query_params['w'] > 0 ) { $image_size = (int) $query_params['w']; } } // Next we check the attachment data if it has an ID. if ( ! isset( $image_size ) ) { $attachment_id = $parsed_block['attrs']['id'] ?? null; if ( $attachment_id ) { $size_slug = $parsed_block['attrs']['sizeSlug'] ?? 'large'; // Check the metadata first. $metadata = wp_get_attachment_metadata( $attachment_id ); if ( $metadata ) { if ( isset( $metadata['sizes'][ $size_slug ]['width'] ) ) { $image_size = (int) $metadata['sizes'][ $size_slug ]['width']; } elseif ( 'full' === $size_slug && isset( $metadata['width'] ) ) { $image_size = (int) $metadata['width']; } } // Try to get dimensions from wp_get_attachment_image_src if metadata didn't have it. if ( ! isset( $image_size ) ) { $image_src = wp_get_attachment_image_src( $attachment_id, $size_slug ); if ( $image_src && isset( $image_src[1] ) ) { $image_size = (int) $image_src[1]; } } } } // Fallback to wp_getimagesize if we still don't have a size. if ( ! isset( $image_size ) ) { $upload_dir = wp_upload_dir(); $image_path = str_replace( $upload_dir['baseurl'], $upload_dir['basedir'], $image_url ); $result = wp_getimagesize( $image_path ); if ( $result ) { $image_size = (int) $result[0]; } } } // Use the found image size or fall back to max_width. $width = isset( $image_size ) ? min( $image_size, $max_width ) : $max_width; $parsed_block['attrs']['width'] = "{$width}px"; return $parsed_block; } /** * Apply border style to the image. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param string $class_name Class name. */ private function apply_image_border_style( string $block_content, array $parsed_block, string $class_name ): string { // Getting individual border properties. $border_styles = wp_style_engine_get_styles( array( 'border' => $parsed_block['attrs']['style']['border'] ?? array() ) ); $border_styles = $border_styles['declarations'] ?? array(); if ( ! empty( $border_styles ) ) { $border_styles['border-style'] = 'solid'; $border_styles['box-sizing'] = 'border-box'; } $border_element_tag = array( 'tag_name' => 'td', 'class_name' => 'email-image-cell', ); $content_with_border_styles = $this->add_style_to_element( $block_content, $border_element_tag, \WP_Style_Engine::compile_css( $border_styles, '' ) ); // Remove border styles from the image HTML tag. $content_with_border_styles = $this->remove_style_attribute_from_element( $content_with_border_styles, array( 'tag_name' => 'img' ), 'border-style' ); $content_with_border_styles = $this->remove_style_attribute_from_element( $content_with_border_styles, array( 'tag_name' => 'img' ), 'border-width' ); $content_with_border_styles = $this->remove_style_attribute_from_element( $content_with_border_styles, array( 'tag_name' => 'img' ), 'border-color' ); $content_with_border_styles = $this->remove_style_attribute_from_element( $content_with_border_styles, array( 'tag_name' => 'img' ), 'border-radius' ); // Add Border related classes to proper element. This is required for inlined border-color styles when defined via class. $border_classes = array_filter( explode( ' ', $class_name ), function ( $class_name ) { return strpos( $class_name, 'border' ) !== false; } ); $html = new \WP_HTML_Tag_Processor( $content_with_border_styles ); if ( $html->next_tag( $border_element_tag ) ) { $class_name = $html->get_attribute( 'class' ) ?? ''; $border_classes[] = $class_name; $html->set_attribute( 'class', implode( ' ', $border_classes ) ); } return $html->get_updated_html(); } /** * Settings width and height attributes for images is important for MS Outlook. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. */ private function add_image_dimensions( string $block_content, array $parsed_block ): string { $html = new \WP_HTML_Tag_Processor( $block_content ); if ( $html->next_tag( array( 'tag_name' => 'img' ) ) ) { // Getting height from styles and if it's set, we set the height attribute. /** @var string $styles */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $styles = $html->get_attribute( 'style' ) ?? ''; $styles = Styles_Helper::parse_styles_to_array( $styles ); $height = $styles['height'] ?? null; if ( $height && 'auto' !== $height ) { $height = Styles_Helper::parse_value( $height ); /* @phpstan-ignore-next-line Wrong annotation for parameter in WP. */ $html->set_attribute( 'height', esc_attr( $height ) ); } if ( isset( $parsed_block['attrs']['width'] ) ) { $width = Styles_Helper::parse_value( $parsed_block['attrs']['width'] ); /* @phpstan-ignore-next-line Wrong annotation for parameter in WP. */ $html->set_attribute( 'width', esc_attr( $width ) ); } $block_content = $html->get_updated_html(); } return $block_content; } /** * This method configure the font size of the caption because it's set to 0 for the parent element to avoid unexpected white spaces * We try to use font-size passed down from the parent element $parsedBlock['email_attrs']['font-size'], but if it's not set, we use the default font-size from the email theme. * * @param Rendering_Context $rendering_context Rendering context. * @param array $parsed_block Parsed block. */ private function get_caption_styles( Rendering_Context $rendering_context, array $parsed_block ): string { $theme_data = $rendering_context->get_theme_json()->get_data(); $styles = array( 'text-align' => isset( $parsed_block['attrs']['align'] ) ? 'center' : 'left', ); $styles['font-size'] = $parsed_block['email_attrs']['font-size'] ?? $theme_data['styles']['typography']['fontSize']; return \WP_Style_Engine::compile_css( $styles, '' ); } /** * Based on MJML <mj-image> but because MJML doesn't support captions, our solution is a bit different * * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @param string|null $caption Caption. * @param string|null $anchor_tag_href Anchor tag href. */ private function get_block_wrapper( array $parsed_block, Rendering_Context $rendering_context, ?string $caption, ?string $anchor_tag_href ): string { $styles = array( 'border-collapse' => 'collapse', 'border-spacing' => '0px', 'font-size' => '0px', 'vertical-align' => 'top', 'width' => '100%', ); $width = $parsed_block['attrs']['width'] ?? '100%'; $wrapper_width = ( $width && '100%' !== $width ) ? $width : 'auto'; $wrapper_styles = $styles; $wrapper_styles['width'] = $wrapper_width; $wrapper_styles['border-collapse'] = 'separate'; // Needed because of border radius. $caption_html = ''; if ( $caption ) { // When the image is not aligned, the wrapper is set to 100% width due to caption that can be longer than the image. $caption_width = isset( $parsed_block['attrs']['align'] ) ? ( $parsed_block['attrs']['width'] ?? '100%' ) : '100%'; $caption_wrapper_styles = $styles; $caption_wrapper_styles['width'] = $caption_width; $caption_styles = $this->get_caption_styles( $rendering_context, $parsed_block ); $caption_table_attrs = array( 'class' => 'email-table-with-width', 'style' => \WP_Style_Engine::compile_css( $caption_wrapper_styles, '' ), 'width' => $caption_width, ); $caption_cell_attrs = array( 'style' => $caption_styles, ); $caption_html = Table_Wrapper_Helper::render_table_wrapper( '{caption_content}', $caption_table_attrs, $caption_cell_attrs ); } $styles['width'] = '100%'; $align = $parsed_block['attrs']['align'] ?? 'left'; $table_attrs = array( 'style' => \WP_Style_Engine::compile_css( $styles, '' ), 'width' => '100%', ); $cell_attrs = array( 'align' => $align, ); $image_table_attrs = array( 'class' => 'email-table-with-width', 'style' => \WP_Style_Engine::compile_css( $wrapper_styles, '' ), 'width' => $wrapper_width, ); $image_cell_attrs = array( 'class' => 'email-image-cell', 'style' => 'overflow: hidden;', ); $image_content = '{image_content}'; if ( $anchor_tag_href ) { $image_content = sprintf( '<a href="%s" rel="noopener nofollow" target="_blank">%s</a>', esc_url( $anchor_tag_href ), '{image_content}' ); } $image_html = Table_Wrapper_Helper::render_table_wrapper( $image_content, $image_table_attrs, $image_cell_attrs ); $inner_content = $image_html . $caption_html; return Table_Wrapper_Helper::render_table_wrapper( $inner_content, $table_attrs, $cell_attrs ); } /** * Add style to the element. * * @param string $block_content Block content. * @param array{tag_name: string, class_name?: string} $tag Tag to add style to. * @param string $style Style to add. */ private function add_style_to_element( $block_content, array $tag, string $style ): string { $html = new \WP_HTML_Tag_Processor( $block_content ); if ( $html->next_tag( $tag ) ) { /** @var string $element_style */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $element_style = $html->get_attribute( 'style' ) ?? ''; $element_style = ! empty( $element_style ) ? ( rtrim( $element_style, ';' ) . ';' ) : ''; // Adding semicolon if it's missing. $element_style .= $style; $html->set_attribute( 'style', esc_attr( $element_style ) ); $block_content = $html->get_updated_html(); } return $block_content; } /** * Remove style attribute from the element. * * @param string $block_content Block content. * @param array{tag_name: string, class_name?: string} $tag Tag to remove style from. * @param string $style_name Name of the style to remove. */ private function remove_style_attribute_from_element( $block_content, array $tag, string $style_name ): string { $html = new \WP_HTML_Tag_Processor( $block_content ); if ( $html->next_tag( $tag ) ) { /** @var string $element_style */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $element_style = $html->get_attribute( 'style' ) ?? ''; $element_style = preg_replace( '/' . preg_quote( $style_name, '/' ) . '\s*:\s*[^;]+;?/', '', $element_style ); $html->set_attribute( 'style', esc_attr( strval( $element_style ) ) ); $block_content = $html->get_updated_html(); } return $block_content; } /** * Parse block content to get image URL, image HTML and caption HTML. * * @param string $block_content Block content. * @return array{imageUrl: string, image: string, caption: string, class: string, anchor_tag_href: string}|null */ private function parse_block_content( string $block_content ): ?array { // If block's image is not set, we don't need to parse the content. if ( empty( $block_content ) ) { return null; } $dom_helper = new Dom_Document_Helper( $block_content ); $figure_tag = $dom_helper->find_element( 'figure' ); if ( ! $figure_tag ) { return null; } $img_tag = $dom_helper->find_element( 'img' ); if ( ! $img_tag ) { return null; } $image_src = $dom_helper->get_attribute_value( $img_tag, 'src' ); $image_class = $dom_helper->get_attribute_value( $img_tag, 'class' ); $image_html = $dom_helper->get_outer_html( $img_tag ); $figcaption = $dom_helper->find_element( 'figcaption' ); $figcaption_html = $figcaption ? $dom_helper->get_outer_html( $figcaption ) : ''; $figcaption_html = str_replace( array( '<figcaption', '</figcaption>' ), array( '<span', '</span>' ), $figcaption_html ); $anchor_tag = $dom_helper->find_element( 'a' ); $anchor_tag_href = $anchor_tag ? $dom_helper->get_attribute_value( $anchor_tag, 'href' ) : ''; return array( 'imageUrl' => $image_src ? $image_src : '', 'image' => $this->cleanup_image_html( $image_html ), 'caption' => $figcaption_html ? $figcaption_html : '', 'class' => $image_class ? $image_class : '', 'anchor_tag_href' => $anchor_tag_href ? $anchor_tag_href : '', ); } /** * Cleanup image HTML. * * @param string $content_html Content HTML. */ private function cleanup_image_html( string $content_html ): string { $html = new \WP_HTML_Tag_Processor( $content_html ); if ( $html->next_tag( array( 'tag_name' => 'img' ) ) ) { $html->remove_attribute( 'srcset' ); $html->remove_attribute( 'class' ); } return $html->get_updated_html(); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-text.php 0000777 00000014155 15252010675 0021047 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * This renderer covers both core/paragraph, core/heading and core/site-title blocks. */ class Text extends Abstract_Block_Renderer { /** * Renders the block content. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // Do not render empty blocks. if ( empty( trim( wp_strip_all_tags( $block_content ) ) ) ) { return ''; } $block_content = $this->adjustStyleAttribute( $block_content ); $block_attributes = wp_parse_args( $parsed_block['attrs'] ?? array(), array( 'textAlign' => 'left', 'style' => array(), ) ); $html = new \WP_HTML_Tag_Processor( $block_content ); $classes = 'email-text-block'; $alignment_from_class = null; if ( $html->next_tag() ) { /** @var string $block_classes */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $block_classes = $html->get_attribute( 'class' ) ?? ''; $classes .= ' ' . $block_classes; // Extract text alignment from has-text-align-* classes before they're potentially modified. $class_attr = (string) $block_classes; if ( false !== strpos( $class_attr, 'has-text-align-center' ) ) { $alignment_from_class = 'center'; } elseif ( false !== strpos( $class_attr, 'has-text-align-right' ) ) { $alignment_from_class = 'right'; } elseif ( false !== strpos( $class_attr, 'has-text-align-left' ) ) { $alignment_from_class = 'left'; } // remove has-background to prevent double padding applied for wrapper and inner element. $block_classes = str_replace( 'has-background', '', $block_classes ); // remove border related classes because we handle border on wrapping table cell. $block_classes = preg_replace( '/[a-z-]+-border-[a-z-]+/', '', $block_classes ); /** @var string $block_classes */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $html->set_attribute( 'class', trim( $block_classes ) ); $block_content = $html->get_updated_html(); } $block_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'spacing', 'border', 'background-color', 'color', 'typography' ) ); $additional_styles = array( 'min-width' => '100%', // prevent Gmail App from shrinking the table on mobile devices. ); // Add fallback text color when no custom text color or preset text color is set. if ( empty( $block_styles['declarations']['color'] ) ) { $email_styles = $rendering_context->get_theme_styles(); $additional_styles['color'] = $parsed_block['email_attrs']['color'] ?? $email_styles['color']['text'] ?? '#000000'; // Fallback for the text color. } $additional_styles['text-align'] = 'left'; if ( ! empty( $parsed_block['attrs']['textAlign'] ) ) { // in this case, textAlign needs to be one of 'left', 'center', 'right'. $additional_styles['text-align'] = $parsed_block['attrs']['textAlign']; } elseif ( in_array( $parsed_block['attrs']['align'] ?? null, array( 'left', 'center', 'right' ), true ) ) { $additional_styles['text-align'] = $parsed_block['attrs']['align']; } elseif ( null !== $alignment_from_class ) { $additional_styles['text-align'] = $alignment_from_class; } $block_styles = Styles_Helper::extend_block_styles( $block_styles, $additional_styles ); $table_attrs = array( 'style' => 'border-collapse: separate;', // Needed because of border radius. 'width' => '100%', ); $cell_attrs = array( 'class' => $classes, 'style' => $block_styles['css'], 'align' => $additional_styles['text-align'], ); return Table_Wrapper_Helper::render_table_wrapper( $block_content, $table_attrs, $cell_attrs ); } /** * 1) We need to remove padding because we render padding on wrapping table cell * 2) We also need to replace font-size to avoid clamp() because clamp() is not supported in many email clients. * The font size values is automatically converted to clamp() when WP site theme is configured to use fluid layouts. * Currently (WP 6.5), there is no way to disable this behavior. * * @param string $block_content Block content. */ private function adjustStyleAttribute( string $block_content ): string { $html = new \WP_HTML_Tag_Processor( $block_content ); if ( $html->next_tag() ) { $element_style_value = $html->get_attribute( 'style' ); $element_style = isset( $element_style_value ) ? strval( $element_style_value ) : ''; // Padding may contain value like 10px or variable like var(--spacing-10). $element_style = preg_replace( '/padding[^:]*:.?[0-9a-z-()]+;?/', '', $element_style ); // Remove border styles. We apply border styles on the wrapping table cell. $element_style = preg_replace( '/border[^:]*:.?[0-9a-z-()#]+;?/', '', strval( $element_style ) ); // We define the font-size on the wrapper element, but we need to keep font-size definition here // to prevent CSS Inliner from adding a default value and overriding the value set by user, which is on the wrapper element. // The value provided by WP uses clamp() function which is not supported in many email clients. $element_style = preg_replace( '/font-size:[^;]+;?/', 'font-size: inherit;', strval( $element_style ) ); /** @var string $element_style */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $html->set_attribute( 'style', esc_attr( $element_style ) ); $block_content = $html->get_updated_html(); } return $block_content; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-cover.php 0000777 00000022154 15252010675 0021177 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Html_Processing_Helper; /** * Cover block renderer. * This renderer handles core/cover blocks with proper email-friendly HTML layout. */ class Cover extends Abstract_Block_Renderer { /** * Renders the cover block content using a table-based layout for email compatibility. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $block_attrs = $parsed_block['attrs'] ?? array(); $inner_blocks = $parsed_block['innerBlocks'] ?? array(); // Render all inner blocks content. $inner_content = ''; foreach ( $inner_blocks as $block ) { $inner_content .= render_block( $block ); } // If we don't have inner content, return empty. if ( empty( $inner_content ) ) { return ''; } // Build the email-friendly layout. $background_image = $this->extract_background_image( $block_attrs, $parsed_block['innerHTML'] ?? $block_content ); return $this->build_email_layout( $inner_content, $block_attrs, $block_content, $background_image, $rendering_context ); } /** * Build the email-friendly layout for cover blocks. * * @param string $inner_content Inner content. * @param array $block_attrs Block attributes. * @param string $block_content Original block content. * @param string $background_image Background image URL. * @param Rendering_Context $rendering_context Rendering context. * @return string Rendered HTML. */ private function build_email_layout( string $inner_content, array $block_attrs, string $block_content, string $background_image, Rendering_Context $rendering_context ): string { // Get original wrapper classes from block content. $original_wrapper_classname = ( new Dom_Document_Helper( $block_content ) )->get_attribute_value_by_tag_name( 'div', 'class' ) ?? ''; // Get background color information. $background_color = $this->get_background_color( $block_attrs, $rendering_context ); // Get block styles using the Styles_Helper. $block_styles = Styles_Helper::get_block_styles( $block_attrs, $rendering_context, array( 'padding', 'border', 'background-color' ) ); $default_styles = array( 'width' => '100%', 'border-collapse' => 'collapse', 'text-align' => 'center', ); // Add minimum height (use specified value or default). $min_height = $this->get_minimum_height( $block_attrs ); $default_styles['min-height'] = ! empty( $min_height ) ? $min_height : '430px'; $block_styles = Styles_Helper::extend_block_styles( $block_styles, $default_styles ); // Add background image to table styles if present. if ( ! empty( $background_image ) ) { $block_styles = Styles_Helper::extend_block_styles( $block_styles, array( 'background-image' => 'url("' . esc_url( $background_image ) . '")', 'background-size' => 'cover', 'background-position' => 'center', 'background-repeat' => 'no-repeat', ) ); } elseif ( ! empty( $background_color ) ) { // If no background image but there's a background color, use it. $block_styles = Styles_Helper::extend_block_styles( $block_styles, array( 'background-color' => $background_color, ) ); } // Apply class and style attributes to the wrapper table. $table_attrs = array( 'class' => 'email-block-cover ' . esc_attr( $original_wrapper_classname ), 'style' => $block_styles['css'], 'align' => 'center', 'width' => '100%', ); // Build the cover content without background (background is now on the table). $cover_content = $this->build_cover_content( $inner_content ); // Build individual table cell. $cell_attrs = array( 'valign' => 'middle', 'align' => 'center', ); $cell = Table_Wrapper_Helper::render_table_cell( $cover_content, $cell_attrs ); // Use render_cell = false to avoid wrapping in an extra <td>. return Table_Wrapper_Helper::render_table_wrapper( $cell, $table_attrs, array(), array(), false ); } /** * Extract background image from block attributes or HTML content. * * @param array $block_attrs Block attributes. * @param string $block_content Original block content. * @return string Background image URL or empty string. */ private function extract_background_image( array $block_attrs, string $block_content ): string { // First check block attributes for URL. if ( ! empty( $block_attrs['url'] ) ) { return esc_url( $block_attrs['url'] ); } // Fallback: use HTML API to find background image src. $html = new \WP_HTML_Tag_Processor( $block_content ); while ( $html->next_tag( array( 'tag_name' => 'img' ) ) ) { $class_attr = $html->get_attribute( 'class' ); // Check if this img tag has the wp-block-cover__image-background class. if ( is_string( $class_attr ) && false !== strpos( $class_attr, 'wp-block-cover__image-background' ) ) { $src = $html->get_attribute( 'src' ); if ( is_string( $src ) ) { return esc_url( $src ); } } } return ''; } /** * Get minimum height from block attributes. * * @param array $block_attrs Block attributes. * @return string Minimum height value or empty string. */ private function get_minimum_height( array $block_attrs ): string { // Check for minHeight attribute (legacy format). if ( ! empty( $block_attrs['minHeight'] ) ) { return Html_Processing_Helper::sanitize_dimension_value( $block_attrs['minHeight'] ); } // Check for style.dimensions.minHeight (WordPress 6.2+ format). if ( ! empty( $block_attrs['style']['dimensions']['minHeight'] ) ) { return Html_Processing_Helper::sanitize_dimension_value( $block_attrs['style']['dimensions']['minHeight'] ); } return ''; } /** * Get background color from block attributes. * * @param array $block_attrs Block attributes. * @param Rendering_Context $rendering_context Rendering context. * @return string Background color or empty string. */ private function get_background_color( array $block_attrs, Rendering_Context $rendering_context ): string { // Check for custom overlay color first (used as background color when no image). if ( ! empty( $block_attrs['customOverlayColor'] ) ) { $color = $block_attrs['customOverlayColor']; $sanitized_color = $this->validate_and_sanitize_color( $color ); if ( ! empty( $sanitized_color ) ) { return $sanitized_color; } } // Check for overlay color slug (used as background color when no image). if ( ! empty( $block_attrs['overlayColor'] ) ) { $translated_color = $rendering_context->translate_slug_to_color( $block_attrs['overlayColor'] ); $sanitized_color = $this->validate_and_sanitize_color( $translated_color ); if ( ! empty( $sanitized_color ) ) { return $sanitized_color; } } return ''; } /** * Validate and sanitize a color value, returning empty string for invalid colors. * * @param string $color The color value to validate and sanitize. * @return string Sanitized color or empty string if invalid. */ private function validate_and_sanitize_color( string $color ): string { $sanitized_color = Html_Processing_Helper::sanitize_color( $color ); // If sanitize_color returned the default fallback, check if the original was actually valid. if ( '#000000' === $sanitized_color && '#000000' !== $color ) { // The original color was invalid, so return empty string. return ''; } // The color is valid (either it was sanitized to something other than the default, // or it was specifically #000000 which is a valid color). return $sanitized_color; } /** * Build the cover content with background image or color. * * @param string $inner_content Inner content. * @return string Cover content HTML. */ private function build_cover_content( string $inner_content ): string { $cover_style = 'position: relative; display: inline-block; width: 100%; max-width: 100%;'; // Wrap inner content with padding. // Note: $inner_content is already rendered HTML from other blocks via render_block(), // so it should be properly escaped by the individual block renderers. $inner_wrapper_style = 'padding: 20px;'; $inner_wrapper_html = sprintf( '<div class="wp-block-cover__inner-container" style="%s">%s</div>', $inner_wrapper_style, $inner_content ); return sprintf( '<div class="wp-block-cover" style="%s">%s</div>', $cover_style, $inner_wrapper_html ); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-buttons.php 0000777 00000003305 15252010675 0021554 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Layout\Flex_Layout_Renderer; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; /** * Renders a buttons block. */ class Buttons extends Abstract_Block_Renderer { /** * Provides the Flex_Layout_Renderer instance. * * @var Flex_Layout_Renderer */ private $flex_layout_renderer; /** * Buttons constructor. * * @param Flex_Layout_Renderer $flex_layout_renderer Flex layout renderer. */ public function __construct( Flex_Layout_Renderer $flex_layout_renderer ) { $this->flex_layout_renderer = $flex_layout_renderer; } /** * Renders the block content. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // Ignore font size set on the buttons block. // We rely on TypographyPreprocessor to set the font size on the buttons. // Rendering font size on the wrapper causes unwanted whitespace below the buttons. if ( isset( $parsed_block['attrs']['style']['typography']['fontSize'] ) ) { unset( $parsed_block['attrs']['style']['typography']['fontSize'] ); } return $this->flex_layout_renderer->render_inner_blocks_in_layout( $parsed_block, $rendering_context ); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-embed.php 0000777 00000043502 15252010675 0021135 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Audio; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Video; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Html_Processing_Helper; /** * Embed block renderer. * This renderer handles core/embed blocks, detecting audio and video provider embeds and rendering them appropriately. * * Audio providers: Spotify, SoundCloud, Pocket Casts, Mixcloud, ReverbNation - rendered as audio players. * Video providers: YouTube - rendered as video thumbnails with play buttons. */ class Embed extends Abstract_Block_Renderer { /** * Supported audio providers with their configuration. * * @var array */ private const AUDIO_PROVIDERS = array( 'pocket-casts' => array( 'domains' => array( 'pca.st' ), 'base_url' => 'https://pca.st/', ), 'spotify' => array( 'domains' => array( 'open.spotify.com' ), 'base_url' => 'https://open.spotify.com/', ), 'soundcloud' => array( 'domains' => array( 'soundcloud.com' ), 'base_url' => 'https://soundcloud.com/', ), 'mixcloud' => array( 'domains' => array( 'mixcloud.com' ), 'base_url' => 'https://www.mixcloud.com/', ), 'reverbnation' => array( 'domains' => array( 'reverbnation.com' ), 'base_url' => 'https://www.reverbnation.com/', ), ); /** * Supported video providers with their configuration. * * @var array */ private const VIDEO_PROVIDERS = array( 'youtube' => array( 'domains' => array( 'youtube.com', 'youtu.be' ), 'base_url' => 'https://www.youtube.com/', ), ); /** * Get all supported providers (audio and video). * * @return array All supported providers. */ private function get_all_supported_providers(): array { return array_merge( array_keys( self::AUDIO_PROVIDERS ), array_keys( self::VIDEO_PROVIDERS ) ); } /** * Get all provider configurations (audio and video). * * @return array All provider configurations. */ private function get_all_provider_configs(): array { return array_merge( self::AUDIO_PROVIDERS, self::VIDEO_PROVIDERS ); } /** * Detect provider from content by checking against known domains. * * @param string $content Content to check for provider domains. * @return string Provider name or empty string if not found. */ private function detect_provider_from_domains( string $content ): string { $all_providers = $this->get_all_provider_configs(); foreach ( $all_providers as $provider => $config ) { foreach ( $config['domains'] as $domain ) { if ( strpos( $content, $domain ) !== false ) { return $provider; } } } return ''; } /** * Validate URL using both filter_var and wp_http_validate_url. * * @param string $url URL to validate. * @return bool True if URL is valid. */ private function is_valid_url( string $url ): bool { return ! empty( $url ) && filter_var( $url, FILTER_VALIDATE_URL ) && wp_http_validate_url( $url ); } /** * Create fallback attributes for link rendering. * * @param string $url URL for the fallback. * @param string $label Label for the fallback. * @return array Fallback attributes. */ private function create_fallback_attributes( string $url, string $label ): array { return array( 'url' => $url, 'label' => $label, ); } /** * Renders the embed block. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ public function render( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // Validate input parameters and required dependencies. if ( ! isset( $parsed_block['attrs'] ) || ! is_array( $parsed_block['attrs'] ) || ! class_exists( '\Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper' ) ) { return ''; } $attr = $parsed_block['attrs']; // Check if this is a supported audio or video provider embed and has a valid URL. $provider = $this->get_supported_provider( $attr, $block_content ); if ( empty( $provider ) ) { // For non-supported embeds, try to render as a simple link fallback. return $this->render_link_fallback( $attr, $block_content, $parsed_block, $rendering_context ); } $url = $this->extract_provider_url( $attr, $block_content ); if ( empty( $url ) ) { // Provider was detected but URL extraction failed - provide graceful fallback. return $this->render_link_fallback( $attr, $block_content, $parsed_block, $rendering_context ); } // If we have a valid audio or video provider embed, proceed with normal rendering. return $this->render_content( $block_content, $parsed_block, $rendering_context ); } /** * Renders the embed block content. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context (required by parent contract but unused in this implementation). * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable $attr = $parsed_block['attrs'] ?? array(); // Get provider and URL (validation already done in render method). $provider = $this->get_supported_provider( $attr, $block_content ); $url = $this->extract_provider_url( $attr, $block_content ); // Check if this is a video provider - render as video block. if ( $this->is_video_provider( $provider ) ) { return $this->render_video_embed( $url, $provider, $parsed_block, $rendering_context, $block_content ); } // For audio providers, use the original audio rendering logic. $label = $this->get_provider_label( $provider, $attr ); // Create a mock audio block structure to reuse the Audio renderer. $mock_audio_block = array( 'blockName' => 'core/audio', 'attrs' => array( 'src' => $url, 'label' => $label, ), 'innerHTML' => '<figure class="wp-block-audio"><audio controls src="' . esc_attr( $url ) . '"></audio></figure>', ); // Copy email attributes to the mock block. if ( isset( $parsed_block['email_attrs'] ) ) { $mock_audio_block['email_attrs'] = $parsed_block['email_attrs']; } // Use the Audio renderer to render the audio provider embed. $audio_renderer = new Audio(); $audio_result = $audio_renderer->render( $mock_audio_block['innerHTML'], $mock_audio_block, $rendering_context ); // If audio rendering fails, fall back to a simple link. if ( empty( $audio_result ) ) { $fallback_attr = $this->create_fallback_attributes( $url, $label ); return $this->render_link_fallback( $fallback_attr, $block_content, $parsed_block, $rendering_context ); } return $audio_result; } /** * Get supported audio or video provider from block attributes or content. * * @param array $attr Block attributes. * @param string $block_content Block content. * @return string Provider name or empty string if not supported. */ private function get_supported_provider( array $attr, string $block_content ): string { $all_supported_providers = $this->get_all_supported_providers(); // Check provider name slug. if ( isset( $attr['providerNameSlug'] ) && in_array( $attr['providerNameSlug'], $all_supported_providers, true ) ) { return $attr['providerNameSlug']; } // Check for supported domains in URL or content. $url = $attr['url'] ?? ''; $content_to_check = ! empty( $url ) ? $url : $block_content; // Use sophisticated domain detection logic. return $this->detect_provider_from_domains( $content_to_check ); } /** * Extract URL from block content using DOM parsing. * * @param string $block_content Block content HTML. * @return string Extracted URL or empty string. */ private function extract_url_from_content( string $block_content ): string { $dom_helper = new Dom_Document_Helper( $block_content ); // Find the wp-block-embed__wrapper div. $wrapper_element = $dom_helper->find_element( 'div' ); if ( $wrapper_element ) { // Check if this div has the correct class. $class_attr = $dom_helper->get_attribute_value( $wrapper_element, 'class' ); if ( strpos( $class_attr, 'wp-block-embed__wrapper' ) !== false ) { // Get the text content (URL) from the div. $url = trim( $wrapper_element->textContent ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase // Decode HTML entities and validate URL. $url = html_entity_decode( $url, ENT_QUOTES | ENT_HTML5, 'UTF-8' ); // Validate the extracted URL. if ( $this->is_valid_url( $url ) ) { return $url; } } } return ''; } /** * Extract provider URL from block attributes or content. * * @param array $attr Block attributes. * @param string $block_content Block content. * @return string Provider URL or empty string. */ private function extract_provider_url( array $attr, string $block_content ): string { // First, try to get URL from attributes. if ( ! empty( $attr['url'] ) ) { $url = $attr['url']; // Validate the URL from attributes. if ( $this->is_valid_url( $url ) ) { return $url; } return ''; } // If not in attributes, extract from block content. return $this->extract_url_from_content( $block_content ); } /** * Get appropriate label for the provider. * * @param string $provider Provider name. * @param array $attr Block attributes. * @return string Label for the provider. */ private function get_provider_label( string $provider, array $attr ): string { // Use custom label if provided. if ( ! empty( $attr['label'] ) ) { return $attr['label']; } // Get translated label for the provider. return $this->get_translated_provider_label( $provider ); } /** * Get translated label for a provider. * * @param string $provider Provider name. * @return string Translated label for the provider. */ private function get_translated_provider_label( string $provider ): string { switch ( $provider ) { case 'spotify': return __( 'Listen on Spotify', 'woocommerce' ); case 'soundcloud': return __( 'Listen on SoundCloud', 'woocommerce' ); case 'pocket-casts': return __( 'Listen on Pocket Casts', 'woocommerce' ); case 'mixcloud': return __( 'Listen on Mixcloud', 'woocommerce' ); case 'reverbnation': return __( 'Listen on ReverbNation', 'woocommerce' ); case 'youtube': return __( 'Watch on YouTube', 'woocommerce' ); default: return __( 'Listen to the audio', 'woocommerce' ); } } /** * Render a simple link fallback for non-supported embeds. * * @param array $attr Block attributes. * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string Rendered link or empty string if no valid URL. */ private function render_link_fallback( array $attr, string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // Try to get URL from attributes first. $url = $attr['url'] ?? ''; // If no URL in attributes, try to extract from block content. if ( empty( $url ) ) { // First try the standard wrapper div extraction. $url = $this->extract_url_from_content( $block_content ); // If still no URL, try to find any HTTP/HTTPS URL in the entire content. if ( empty( $url ) ) { $dom_helper = new Dom_Document_Helper( $block_content ); $body_element = $dom_helper->find_element( 'body' ); if ( $body_element ) { $text_content = $body_element->textContent; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase // Look for HTTP/HTTPS URLs in the text content. if ( preg_match( '/(?<![a-zA-Z0-9.-])https?:\/\/[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}[a-zA-Z0-9\/?=&%-]*(?![a-zA-Z0-9.-])/', $text_content, $matches ) ) { $url = $matches[0]; } } } } // If still no URL, try to use provider-specific base URL if we have a provider. if ( empty( $url ) && isset( $attr['providerNameSlug'] ) ) { $url = $this->get_provider_base_url( $attr['providerNameSlug'] ); } // Validate URL with both filter_var and wp_http_validate_url. if ( ! $this->is_valid_url( $url ) ) { return ''; } // Get link text - use custom label if provided, otherwise use provider label for base URLs or URL. if ( ! empty( $attr['label'] ) ) { $link_text = $attr['label']; } else { // Check if this is a provider base URL (like https://open.spotify.com/). $provider = $attr['providerNameSlug'] ?? ''; $base_url = $this->get_provider_base_url( $provider ); if ( ! empty( $base_url ) && $url === $base_url ) { // Use provider-specific label for base URLs. $link_text = $this->get_provider_label( $provider, $attr ); } else { // Use the URL itself for specific URLs. $link_text = $url; } } // Get color from email attributes or theme styles. $email_styles = $rendering_context->get_theme_styles(); $link_color = $parsed_block['email_attrs']['color'] ?? $email_styles['color']['text'] ?? '#0073aa'; // Sanitize color value to ensure it's a valid hex color or CSS variable. $link_color = Html_Processing_Helper::sanitize_color( $link_color ); // Create a simple link. $link_html = sprintf( '<a href="%s" target="_blank" rel="noopener nofollow" style="color: %s; text-decoration: underline;">%s</a>', esc_url( $url ), esc_attr( $link_color ), esc_html( $link_text ) ); // Wrap with spacer if we have email attributes. return $this->add_spacer( $link_html, $parsed_block['email_attrs'] ?? array() ); } /** * Get base URL for a provider when specific URL extraction fails. * * @param string $provider Provider name. * @return string Base URL for the provider or empty string. */ private function get_provider_base_url( string $provider ): string { $all_providers = $this->get_all_provider_configs(); return $all_providers[ $provider ]['base_url'] ?? ''; } /** * Check if a provider is a video provider. * * @param string $provider Provider name. * @return bool True if video provider. */ private function is_video_provider( string $provider ): bool { return array_key_exists( $provider, self::VIDEO_PROVIDERS ); } /** * Render a video embed using the Video renderer. * * @param string $url URL of the video. * @param string $provider Provider name. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @param string $block_content Original block content. * @return string Rendered video embed or fallback. */ private function render_video_embed( string $url, string $provider, array $parsed_block, Rendering_Context $rendering_context, string $block_content ): string { // Try to get video thumbnail URL. $poster_url = $this->get_video_thumbnail_url( $url, $provider ); // If no poster available, fall back to a simple link. if ( empty( $poster_url ) ) { $fallback_attr = $this->create_fallback_attributes( $url, $url ); return $this->render_link_fallback( $fallback_attr, $block_content, $parsed_block, $rendering_context ); } // Create a mock video block structure to reuse the Video renderer. $mock_video_block = array( 'blockName' => 'core/video', 'attrs' => array( 'poster' => $poster_url, ), 'innerHTML' => '<figure class="wp-block-video wp-block-embed is-type-video is-provider-' . esc_attr( $provider ) . '"><div class="wp-block-embed__wrapper">' . esc_url( $url ) . '</div></figure>', ); // Copy email attributes to the mock block. if ( isset( $parsed_block['email_attrs'] ) ) { $mock_video_block['email_attrs'] = $parsed_block['email_attrs']; } // Use the Video renderer to render the video provider embed. $video_renderer = new Video(); $video_result = $video_renderer->render( $mock_video_block['innerHTML'], $mock_video_block, $rendering_context ); // If video rendering fails, fall back to a simple link. if ( empty( $video_result ) ) { $fallback_attr = $this->create_fallback_attributes( $url, $url ); return $this->render_link_fallback( $fallback_attr, $block_content, $parsed_block, $rendering_context ); } return $video_result; } /** * Get video thumbnail URL for supported providers. * * @param string $url Video URL. * @param string $provider Provider name. * @return string Thumbnail URL or empty string. */ private function get_video_thumbnail_url( string $url, string $provider ): string { // Currently only YouTube supports thumbnail extraction. if ( 'youtube' === $provider ) { return $this->get_youtube_thumbnail( $url ); } // For other providers, we don't have thumbnail extraction implemented. // Return empty to trigger link fallback. return ''; } /** * Extract YouTube video thumbnail URL. * * @param string $url YouTube video URL. * @return string Thumbnail URL or empty string. */ private function get_youtube_thumbnail( string $url ): string { // Extract video ID from various YouTube URL formats. $video_id = ''; if ( preg_match( '/(?:youtube\.com\/watch\?v=|youtu\.be\/)([a-zA-Z0-9_-]+)/', $url, $matches ) ) { $video_id = $matches[1]; } if ( empty( $video_id ) ) { return ''; } // Return YouTube thumbnail URL. // Using 0.jpg format as shown in the example. return 'https://img.youtube.com/vi/' . $video_id . '/0.jpg'; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-list-block.php 0000777 00000004340 15252010675 0022121 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; /** * Renders a list block. * We have to avoid using keyword `List` */ class List_Block extends Abstract_Block_Renderer { /** * Renders the block content * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $html = new \WP_HTML_Tag_Processor( $block_content ); $tag_name = ( $parsed_block['attrs']['ordered'] ?? false ) ? 'ol' : 'ul'; if ( $html->next_tag( array( 'tag_name' => $tag_name ) ) ) { /** @var string $styles */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $styles = $html->get_attribute( 'style' ) ?? ''; $styles = Styles_Helper::parse_styles_to_array( $styles ); // Font size. if ( isset( $parsed_block['email_attrs']['font-size'] ) ) { $styles['font-size'] = $parsed_block['email_attrs']['font-size']; } else { // Use font-size from email theme when those properties are not set. $theme_data = $rendering_context->get_theme_json()->get_data(); $styles['font-size'] = $theme_data['styles']['typography']['fontSize']; } $html->set_attribute( 'style', esc_attr( \WP_Style_Engine::compile_css( $styles, '' ) ) ); $block_content = $html->get_updated_html(); } $wrapper_style = \WP_Style_Engine::compile_css( array( 'margin-top' => $parsed_block['email_attrs']['margin-top'] ?? '0px', ), '' ); // \WP_HTML_Tag_Processor escapes the content, so we have to replace it back $block_content = str_replace( ''', "'", $block_content ); return sprintf( '<div style="%1$s">%2$s</div>', esc_attr( $wrapper_style ), $block_content ); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-post-content.php 0000777 00000006572 15252010675 0022524 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; /** * Stateless renderer for core/post-content block. * * This renderer replaces WordPress's default render_block_core_post_content() * which uses a static $seen_ids array that causes issues when rendering multiple * emails in a single request (e.g., MailPoet batch processing). * * Unlike other block renderers, this class does NOT extend Abstract_Block_Renderer * because it needs to directly replace WordPress's render_callback with a method * that matches the exact signature expected by WordPress. */ class Post_Content { /** * Stateless render callback for core/post-content block. * * This implementation avoids using get_the_content() which relies on * global query state, and instead directly accesses post content * and applies the_content filter for processing. * * Key differences from WordPress's implementation: * - No static $seen_ids array (allows multiple renders in same request) * - Uses direct post content access instead of get_the_content() * - Properly backs up and restores global state * * IMPORTANT: This method is only set as the render_callback during email rendering. * Outside of email rendering, the original callback is restored, so this method * will never be called in non-email contexts. * * @param array $attributes Block attributes. * @param string $content Block content. * @param \WP_Block $block Block instance. * @return string Rendered post content HTML. */ public function render_stateless( $attributes, $content, $block ): string { // This method is only called during email rendering, so we always use stateless logic. $post_id = $block->context['postId'] ?? null; if ( ! $post_id ) { return ''; } $email_post = get_post( $post_id ); if ( ! $email_post || empty( $email_post->post_content ) ) { return ''; } // Backup global state. global $post, $wp_query; $backup_post = $post; $backup_query = $wp_query; // Set up global state for block rendering. // This ensures that blocks which depend on global $post work correctly. $post = $email_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited // Create a query specifically for this post to ensure proper context. $wp_query = new \WP_Query( array( 'p' => $post_id ) ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited // Get raw post content and apply the_content filter. // The the_content filter processes blocks, shortcodes, etc. // We don't use get_the_content() to avoid issues with loop state. $post_content = $email_post->post_content; // Check for nextpage to display page links for paginated posts. if ( has_block( 'core/nextpage', $email_post ) ) { $post_content .= wp_link_pages( array( 'echo' => 0 ) ); } // Apply the_content filter to process blocks. $post_content = apply_filters( 'the_content', str_replace( ']]>', ']]>', $post_content ) ); // Restore global state. $post = $backup_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited $wp_query = $backup_query; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited if ( empty( $post_content ) ) { return ''; } return $post_content; } } email-editor/src/Integrations/Core/Renderer/Blocks/icons/x/x-white.png 0000777 00000000752 15252010675 0021722 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@G'�� �IDATx��Ѫ�0�n��,\�R�x"�Ї��bs(�l��oggg�~�y������7ͫ|��ᮁ�Ӣ�r�9�Z� �_C����OO� d]?!5�j������'�q�l+(!��RҺ� FE@ �zHB ����]RPB�*!q����U+h�����$�����@'A=���!AP � ��@CP �Η�7)| ��C�@ ]���@�C*8�#!���g��O读�KH��Cj� HQ���@�� I��3)���&H�`� � *����a!q缂4��O*v�+��D�� ��?c� �~4�~=��h-�� 9A iHA�(h�1�V�]��fHu\ ��@��א(hʼh��]���3�����OԿ���2�7�vvvv�Y���U^ IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/x/x-brand.png 0000777 00000000752 15252010675 0021670 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL Ӭ� tRNS ��@G'�� �IDATx��Ѫ�0�n��,\�R�x"�Ї��bs(�l��oggg�~�y������7ͫ|��ᮁ�Ӣ�r�9�Z� �_C����OO� d]?!5�j������'�q�l+(!��RҺ� FE@ �zHB ����]RPB�*!q����U+h�����$�����@'A=���!AP � ��@CP �Η�7)| ��C�@ ]���@�C*8�#!���g��O读�KH��Cj� HQ���@�� I��3)���&H�`� � *����a!q缂4��O*v�+��D�� ��?c� �~4�~=��h-�� 9A iHA�(h�1�V�]��fHu\ ��@��א(hʼh��]���3�����OԿ���2�7�vvvv�Y���U^ IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/vimeo/vimeo-brand.png 0000777 00000000745 15252010675 0023412 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL �� �� �� ��ˋ� tRNS �@��� �IDATx��KnC1 MJ�?s�n�$�즅g�|�"�.���`WU�(i��$aY?��}Ʋ' ��C�7 vT�g=��:���s<<B5��6�Bx n+,|B���/ �hmb�lm �>���A� ������ �' �G-�m �?<o�d�p %4xrz��5�{�6���w^����3���@��T�|胁p�pn� � w�dpF50 eӌ�8#�� gT� ���+2p< �(�gK�`�ؠB}>fx���/��y��ߩJ˕Ŀw��hAF����LX ,� �b �3��3�-�q�`&��3�Jp�ϰ~H�~�A?�@?Ơ�S� c����9�������s�9����u�\.�/y�.�Y�J IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/vimeo/vimeo-white.png 0000777 00000000746 15252010675 0023445 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @������ �IDATx��KnC1 M��?s�n�$�즅g�|�"�.��� UU�({��dcY?��}²'��C�7 vT�g=��:���q<<B5��6�Bx n+,|B���/ �hmf�lm �>���A� ��� ��� �'�G-�$�?<oY�d�p e4xrz��5�{�6���v^�ׯ�30�� �6@��T� |胁q�pn� �w�dpF50 eӌ�8# �� gT� ���+2P< �(�gK�`�ؠB}>fx���/��y��ߩ�K�Ŀw��hAF����LX ,� �b�3��3�-�Q�`&��3�JP�ϰ~H�~�@?�@?F��S� #����9��������s �9����u�\.�/;@#��Q� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/twitter/twitter-white.png 0000777 00000000660 15252010675 0024406 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@G'�� LIDATx�����0Pl����F��(ȗQ ��u]�u �df0 � �������n2�?T4b%;�� � ���xR���e���A�c�����<�ni��D��� ��L4gq6@w��' 7p�0u ��r��/�x��~a���~� 0 ��!G�%�8 �C�F!r�� �\%s@���s� �d�W w@�T4`��Bφ���&0� �-0m��5@� H� t߀�7@� E� �m ��7Q �b��S�=� ����_�e-��O����K �{���Y\� \� ����5�T� X�(S H>m�R\�u]?���0W�Uز IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/twitter/twitter-brand.png 0000777 00000000660 15252010675 0024354 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL �� ���� ��*�m tRNS ��@G'�� LIDATx�����0Pl����F��(ȗQ ��u]�u �df0 � �������n2�?T4b%;�� � ���xR���e���A�c�����<�ni��D��� ��L4gq6@w��' 7p�0u ��r��/�x��~a���~� 0 ��!G�%�8 �C�F!r�� �\%s@���s� �d�W w@�T4`��Bφ���&0� �-0m��5@� H� t߀�7@� E� �m ��7Q �b��S�=� ����_�e-��O����K �{���Y\� \� ����5�T� X�(S H>m�R\�u]?���0W�Uز IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/youtube/youtube-white.png 0000777 00000000512 15252010675 0024366 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@0�l �IDATx��� �0E�̛��77��[��\�2g�\�hZ)��R 9��!�Dl�9��H�x�Y����� }�d`-��Xҁ�v�&b���a�.���iL �� �-q60� ���� ��� ��,�@�E �< x<�x$��H���ϝ9p�=2 �v�����. H:оţj�� qv�D_���9l!��ȶKA��L �I9��2[)��R�{6G>�l�~� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/youtube/youtube-brand.png 0000777 00000000512 15252010675 0024334 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL� � � � ���� tRNS @���T� �IDATx��� �0E�̛��77��[��\�2g�\�hZ)��R 1��!�Dn�9��H�x�Y����� }�`` -��XЁ�v�&b���a�.�ʋ�iN �� �-q60� ���� ��� ��,�@$�E �< x<�x$��H���ϝ9p�=2 �v�����. :о�j�� qv�D_���9l!����KI�� ���I1��"Z)��R�{��>�z�` IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/github/github-white.png 0000777 00000001061 15252010675 0023742 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@G'�� �IDATx����0 3��o^u/����Z-s& � d���ԉ I�@\ \�\ �D��+?�4�E �{�axg�a� �0��Ay���Q��h� � ��=t� ��� ������j� 3� y�J�$ �&��8?�� �ݰ�8�l���V��� ��p$9�2�iQ�v�EO�r^@i��#*J�j'���?�Z�-�'�#�!W �z���b�֚��o � dh÷�ASA^/�� dh�=A �X��������7Ex�J� ���@!=&%� ]Lz���L|���` �̪� 3����b��V<�OT �C0��e�/?�R�î G��u����;=UV��I6n�����6I�j���k��j�p�ͶP�)��/�� �+/���]���;�tp�%P�� �"��/X-� XM� b��.`���u �&�g�b��M�� ss� ��* *�= IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/github/github-brand.png 0000777 00000001060 15252010675 0023707 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL#)-$)-#'+$)-�KZ tRNS ��@G'�� �IDATx���n�0E}��y�P5M �Hմ���ؕ���M $EH �8���*:�����a>E ���a� �ď���h�$��� no�<�?G��_h 0��C'>( ����P� � �TK>��n�c/�*$� ��p]����f���� U'h5�Z ��$F����kZ��a� �P:0t��r�T��ϫ��Z�-�'pޣ$~���=8�I �֬G|Z�T�4�6|ZOh*��J�c� �����=&��>,��������пp5)�BzLJ� �� �ˏĐ�ϿS ����*�eI&���h5��c|\q؊]H���� � �G��@� T B>z1P�Se"�M��D��s���=� ���Q�l��A�2ye����V��ɋ3:g���NGڂ��[���@�H�&�xA�jAW�jBO�Շ��u T��,bM��y��������|� * N� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/spotify/spotify-brand.png 0000777 00000001051 15252010675 0024335 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�_�`�_�`�e�� tRNS ��@G'�� �IDATx��An�0 =K��� ���B�x�rvC�YI���P� $�K vX\��RG�@X_^�? �bH>����d LX��� p����͑�|�@� u����;�M��v�u��( ���hO_� �]��H�Q�����V oE/�K0���j%��b��Z{8� ��͂���͐n�N�8q&�8�Z �QX-㹜�[;�sa�g ^4�H�Y���~�L�i �4K뉪�c�Aǀ��,�0��{�5� ��@�2�E�[[�W�j�}�vbH��^ �Q����9����U9W�-�I�;y�}�\����@^U:Gd�5���:*g�ΕWˇg� �0S��O�}\�"�@ �� ��X�� ���-Ly�� |�" �H�%�ڥ�o1�R�QK�ᐣ�6f����|{��}h.o�1$ �!��A����>@ ��%����P� �?#^�6 IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/spotify/spotify-white.png 0000777 00000001051 15252010675 0024367 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@G'�� �IDATx��An�0 =K��� ���B�x�rvC�YI���P� $�K vX\��RG�@X_^�? �bH>����d LX��� p����͑�|�@� u����;�M��v�u��( ���hO_� �]��H�Q�����V oE/�K0���j%��b��Z{8� ��͂���͐n�N�8q&�8�Z �QX-㹜�[;�sa�g ^4�H�Y���~�L�i �4K뉪�c�Aǀ��,�0��{�5� ��@�2�E�[[�W�j�}�vbH��^ �Q����9����U9W�-�I�;y�}�\����@^U:Gd�5���:*g�ΕWˇg� �0S��O�}\�"�@ �� ��X�� ���-Ly�� |�" �H�%�ڥ�o1�R�QK�ᐣ�6f����|{��}h.o�1$ �!��A����>@ ��%����P� �?#^�6 IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/linkedin/linkedin-white.png 0000777 00000000504 15252010675 0024571 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS �@�`P� �IDATx���j�PDѮ���o�H��8.2]������A�b���"П%�I�Toc�D�Lx �M�p@��l ��wx�YC���D7P n�i��k� s`^¹�ٮ/ @|$� � 1'� �cj P=�m��+���� ��p�@� h ��*����E`n=��� @��[� ��?� Ї��� �&��X�?�N��J)���>;sgn�s IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/linkedin/linkedin-brand.png 0000777 00000000504 15252010675 0024537 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL f� g� e� f�A�� tRNS �@�`P� �IDATx���j�PDѮ���o�H��8.2]������A�b���"П%�I�Toc�D�Lx �M�p@��l ��wx�YC���D7P n�i��k� s`^¹�ٮ/ @|$� � 1'� �cj P=�m��+���� ��p�@� h ��*����E`n=��� @��[� ��?� Ї��� �&��X�?�N��J)���>;sgn�s IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/behance/behance-brand.png 0000777 00000000703 15252010675 0024120 0 ustar 00 �PNG IHDR ` ` �F� PLTE X�W�W�X����C tRNS @���i[6 ^IDATx��ю� E�{���7�:*ƺ�&��)�#6���4M�4M�.��@} ���B�0@W�@��-P�-�m����)�������� ܶI�"?&x��c��:��w�t �L�N�@A�����6"�R����{��0�<'�W<�v�.Ri������>��BI�f�ӛp&0����V �o#��p=r��N|w�S�Q �J��Ă�T�"���� @����h?\��4�3'�a~FM�FƂ�vŠ�O � : E3A����7ul� `��/|�1)�3��]��2X�? ӏ {�ٯ���\ �_��ҟ#$� )2��i��i�-?.1o�2�P IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/behance/behance-white.png 0000777 00000000703 15252010675 0024152 0 ustar 00 �PNG IHDR ` ` �F� PLTE �������������B�h tRNS @���i[6 ^IDATx��ю� E�{���7�:*ƺ�&��)�#6���4M�4M�.��@} ���B�0@W�@��-P�-�m����)�������� ܶI�"?&x��c��:��w�t �L�N�@A�����6"�R����{��0�<'�W<�v�.Ri������>��BI�f�ӛp&0����V �o#��p=r��N|w�S�Q �J��Ă�T�"���� @����h?\��4�3'�a~FM�FƂ�vŠ�O � : E3A����7ul� `��/|�1)�3��]��2X�? ӏ {�ٯ���\ �_��ҟ#$� )2��i��i�-?.1o�2�P IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/tumblr/tumblr-white.png 0000777 00000000422 15252010675 0024010 0 ustar 00 �PNG IHDR ` ` �j PLTEGpL�������������1 tRNS ���@�+w� �IDATx�ֵ��0@QQnl���@.��KǴ���z�cn7��G��� 8 F J ���QPR X F OA�� A���~�RVjv�@ N�&�.��N+P��A<;��M?"/� ="�mJ�� �ف� P`���H�))�[�Y�д7�/�<h�Z IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/tumblr/tumblr-brand.png 0000777 00000000422 15252010675 0023756 0 ustar 00 �PNG IHDR ` ` �j PLTEGpL555 3� �y tRNS ���@�+w� �IDATx�ֵ��0@QQnl���@.��KǴ���z�cn7��G��� 8 F J ���QPR X F OA�� A���~�RVjv�@ N�&�.��N+P��A<;��M?"/� ="�mJ�� �ف� P`���H�))�[�Y�д7�/�<h�Z IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/mastodon/mastodon-white.png 0000777 00000001037 15252010675 0024651 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @���T� �IDATx���n�0 E���'M���IcO���F�`� �SHJ�$ ض%��H�q�$�� %\���R%�ˡ���o�1��M��j`l�Ȉ�586����� �����IIyMY-o!2L<�ky ���M&�i ��'5UB�������g�R\),�� OH��i?vc'5 ���&5/ ��v��Y�&�`�t�m2�T�tqή{Q�4�����Tyz.�,P>�~� / X�����7n�-x�[p . ��|�(@QpP� �-���I�n~L����D�����f�p�h ��5��`s>[1ۿ3��H`o<���=32 $-�-b��)�IݖH�)�_A G� v �������-$-��{p�x��U7�1��ߨ�էзwĨbq� ��6 � ��T��;\}���q'6� R�� �+�� �S�W��e IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/mastodon/mastodon-brand.png 0000777 00000001037 15252010675 0024617 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL3��1��2��2�Ԕa�� tRNS @���T� �IDATx���n�0 E���'M���IcO���F�`� �SHJ�$ ض%��H�q�$�� %\���R%�ˡ���o�1��M��j`l�Ȉ�586����� �����IIyMY-o!2L<�ky ���M&�i ��'5UB�������g�R\),�� OH��i?vc'5 ���&5/ ��v��Y�&�`�t�m2�T�tqή{Q�4�����Tyz.�,P>�~� / X�����7n�-x�[p . ��|�(@QpP� �-���I�n~L����D�����f�p�h ��5��`s>[1ۿ3��H`o<���=32 $-�-b��)�IݖH�)�_A G� v �������-$-��{p�x��U7�1��ߨ�էзwĨbq� ��6 � ��T��;\}���q'6� R�� �+�� �S�W��e IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/reddit/reddit-brand.png 0000777 00000000747 15252010675 0023704 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�C �E �E �E �l5� tRNS @���T� �IDATx��K��0 D՟��yj �aǶRY�m���,��f��|�Jd�bA?`���b}�ʠ�Iva@�_���gP���%-:��<E|������(�!�D6��ybq����' �7��(��D"W�K�b� �pT��� ��R|g+�!߲`o&��(n�pN+�@/�E :(`��@� ��� �� �b�*����z nJ6�*� ���.lGPRjW#�"0Y#�*;7;&ޭ�"E+(r�y�{zQn�W94]�pH?p��ەL��$('�����)��� � ��٣�O@� �q������#�Fe F�@��&a�}�v�`���s@�J�S&sys�k-K�A�!F�Qa!�8`�|;��X �+$�:H��z ��*m6����'�\�� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/reddit/reddit-white.png 0000777 00000000747 15252010675 0023736 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @���T� �IDATx��K��0 D՟��yj �aǶRY�m���,��f��|�Jd�bA?`���b}�ʠ�Iva@�_���gP���%-:��<E|������(�!�D6��ybq����' �7��(��D"W�K�b� �pT��� ��R|g+�!߲`o&��(n�pN+�@/�E :(`��@� ��� �� �b�*����z nJ6�*� ���.lGPRjW#�"0Y#�*;7;&ޭ�"E+(r�y�{zQn�W94]�pH?p��ەL��$('�����)��� � ��٣�O@� �q������#�Fe F�@��&a�}�v�`���s@�J�S&sys�k-K�A�!F�Qa!�8`�|;��X �+$�:H��z ��*m6����'�\�� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/video/play2x.png 0000777 00000001041 15252010675 0022403 0 ustar 00 �PNG IHDR | | � Ծ �IDATx��AMCAF�P OB%TB%T�p��J��' �,:aC����w�Qpҗ��6� z��.���������m e��ϼ�z����;7��|��g ���KC���ͯ=@�QG�.P�䭢x:p��G�}i( ܨ#� G�._A�QG��p]�p��p' �� 7�w���n��#\�'ܨ#� G�.��:p���u�;��� 7�w���n���Xvy:p���u�;��� 7�w���n������ �"��<���A8v�� �6���p�� �dĖ����u��� 7ʎ� 5�wj�n��9���}}j^i�]ۄp��p��7�7�7�7�F�N-��w�w�wFYN�0��0��0��0��0��0�Za��a��a��a��aea8��п�п�п�п�0��pj���������a���� C�#�~��߄ �۳�7��xg�o ��L��]A^ IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/threads/threads-brand.png 0000777 00000001134 15252010675 0024231 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL Ӭ� tRNS ��@G'�� �IDATx��YK�1 ۽���Г0�T�$�i��֮�~B8nܸq� $�Z$ �Zvr W����1�7ơ��02�� p?I��Aa�O���\[vC�) �G`��}&�.��FU0�`)�,V̪n �p� �\b@�|� � �U �42�m$m h�mq�H�i�,DH ��v�Cg jE�� ��j�,�`!�!HR�<�~�2����� O��<���uv������ \���<9ޖ� �U0,U�D~�A���Hz�(�,���]�H�� D�q���؎�XP*��|x��]̞�W[E g:Y`7[P� �Y��{ %m�^��eP�j{�H�A�`+�e�y�mX���L�w�Ucd�,�v��}�5_��Y0�$���gl�z�dƼfa :�� s�ǮdS����ᐍ�WٹFmGe jL�z�g��F�V0H�ֲ���g�0���9��~`�>����� 7nܸ�;��k�7xX IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/threads/threads-white.png 0000777 00000001134 15252010675 0024263 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@G'�� �IDATx��YK�1 ۽���Г0�T�$�i��֮�~B8nܸq� $�Z$ �Zvr W����1�7ơ��02�� p?I��Aa�O���\[vC�) �G`��}&�.��FU0�`)�,V̪n �p� �\b@�|� � �U �42�m$m h�mq�H�i�,DH ��v�Cg jE�� ��j�,�`!�!HR�<�~�2����� O��<���uv������ \���<9ޖ� �U0,U�D~�A���Hz�(�,���]�H�� D�q���؎�XP*��|x��]̞�W[E g:Y`7[P� �Y��{ %m�^��eP�j{�H�A�`+�e�y�mX���L�w�Ucd�,�v��}�5_��Y0�$���gl�z�dƼfa :�� s�ǮdS����ᐍ�WٹFmGe jL�z�g��F�V0H�ֲ���g�0���9��~`�>����� 7nܸ�;��k�7xX IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/discord/discord-brand.png 0000777 00000000764 15252010675 0024233 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpLWc�We�Xe�Xe�Q�� tRNS @���T� �IDATx���j�0�-�����G�Ov. ����Rti M; �(�U���Kq1�� ���� ��uO+�O�U�� b;s}���x��p&! �y�<Q�� ��K�2p�VPԁ)PF���C&`c�xn.2�(��a6�gG���Ж )6�( ��7� ���ejC�[#�eL0�ge�_r��,{ ��F� 0+4��;�+� @�r@���YG� (P�� �Wd��ɱ@#� ��� `*��.� xy=��s��>�G ���!��J ��l�? � pO}��¢J Z#Sw`T��чF_u x˚�w��z�6����T��a��9{� �Z��>����� �#���Wd��~Qh��ù����5f.D@�ʼn���p8 _w�<�( � IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/discord/discord-white.png 0000777 00000000764 15252010675 0024265 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @���T� �IDATx���j�0�-�����G�Ov. ����Rti M; �(�U���Kq1�� ���� ��uO+�O�U�� b;s}���x��p&! �y�<Q�� ��K�2p�VPԁ)PF���C&`c�xn.2�(��a6�gG���Ж )6�( ��7� ���ejC�[#�eL0�ge�_r��,{ ��F� 0+4��;�+� @�r@���YG� (P�� �Wd��ɱ@#� ��� `*��.� xy=��s��>�G ���!��J ��l�? � pO}��¢J Z#Sw`T��чF_u x˚�w��z�6����T��a��9{� �Z��>����� �#���Wd��~Qh��ù����5f.D@�ʼn���p8 _w�<�( � IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/whatsapp/whatsapp-brand.png 0000777 00000001163 15252010675 0024625 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL#�g%�e%�f%�f ��� tRNS @���T� IDATx��Y�r�P �s��b�d�Q�� ��˳z�x���T%�$ &W��� �1v���G�K� ~)�9���I ��t� �`+�QP9�g }�/��b����=0ԴU����Q�Vo�AX��V�~g*��tVi1|����L� /�h�k�_����@�a�7��>s ��@��)4Lhn!!�ZPC�^����P��.��� ��[5��D�=4� B@k�|��=�<\�nA{����,�x܁��@��� xH|X�C�x dW�o4ݻ��X� ��s� �1g ���VI�� ŋ����tڹur <#Wp�@u0V@(2d�_��z��M($ԟk���U�������,�0x�e��B�! Adө._��;�.��ggՂ�:˴��1k���0�~ ��;h 9 ��dS#'D@��"}���Af�d6 �d`7�����@J��rD- �?y�pW�����m��+� �����x���8���A��3��!)�$� ��/^����&3�u8| IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/whatsapp/whatsapp-white.png 0000777 00000001163 15252010675 0024657 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @���T� IDATx��Y�r�P �s��b�d�Q�� ��˳z�x���T%�$ &W��� �1v���G�K� ~)�9���I ��t� �`+�QP9�g }�/��b����=0ԴU����Q�Vo�AX��V�~g*��tVi1|����L� /�h�k�_����@�a�7��>s ��@��)4Lhn!!�ZPC�^����P��.��� ��[5��D�=4� B@k�|��=�<\�nA{����,�x܁��@��� xH|X�C�x dW�o4ݻ��X� ��s� �1g ���VI�� ŋ����tڹur <#Wp�@u0V@(2d�_��z��M($ԟk���U�������,�0x�e��B�! Adө._��;�.��ggՂ�:˴��1k���0�~ ��;h 9 ��dS#'D@��"}���Af�d6 �d`7�����@J��rD- �?y�pW�����m��+� �����x���8���A��3��!)�$� ��/^����&3�u8| IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/tiktok/tiktok-white.png 0000777 00000001110 15252010675 0024003 0 ustar 00 �PNG IHDR � � �� PLTEGpL�������������1 tRNS @���i[6 �IDATx���Kn�0Ю�� x� `,5��$���z2��̮y�o��W ���� " p�4�H�0p@�J�4@i ��i ��i �Pi �4�NH��� RF �1b������ �x �vPN��Ty7 �\ �� Hb�(�T�s $��7 � ���ˀ� :�%@�� �Z��s@��crb`2 0� 3 0� 3 0� 3 0� ��0�a�� ��8 ���x������ �B� �7�^?�y�z˟`�?�W�� ����x��k�M[�i@�u� ��� @ p�{�i��6�G��X�n�>|(�t�̧so�7�jx����yp�=>��w�XW��[A�ۧ箽�{� �m�W�=4��rW9�G�^99� ����Fq��(�_�.�|PY���WE�� \�*)P�G���' 8=7_v��X���A@}0�%��$y[�0�� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/tiktok/tiktok-brand.png 0000777 00000001107 15252010675 0023757 0 ustar 00 �PNG IHDR � � �� PLTEGpL Ӭ� tRNS �@��� �IDATx���Kn�0Ю�� x� `,5��$���z2��̮y�o��W ���� 3 @�4�L�8@`�J�4@i��i��i��Xi��4�Hl�6� [` �c������ �x �@PH��Ta7��\ � @Jr�(�Ts %��7 � ���ˀ� :�%@�� Z��s@���{�r ; �� 8 �� 8 �� 8 �� ��0�a � �� ��|� ��� �B� �7�X?�y�z˟p�?�W�� | �����`��k�M[ i@�u� ��� ` p�{�i��6�G��X�n�8|(�t�̧so�7�jx����ap�=>��w�XW��[A�� ۧ箽�c� �m&V�=4���r�W9�G�^99� σ���FA��(�_�.�|XY��TE�� P�*)P�G���' "=7_@��@���Ad}0$ɶ$a[��Z��斊 IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/instagram/instagram-brand.png 0000777 00000001051 15252010675 0025115 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL� u� u� s� u�X�� tRNS ��@G'�� �IDATx���� C+�����M��&¸�怎 � ��ymmmm=]xh\�$ -�sL (�sUC�.B kҜ?ƲP��!\���y6����,��s �f�i���I��Uũ$!�gg�ځ%o���� �4���(�(, �Z��S ��'��#� � � �p'}�蜢�b8u��U����i� @<�{ � � pX�Z؟�N�}�\��A��"�6�՛W`�P_� h�+��l�]� �� ��� p�� � PHї��.b�#�r� ŋl �s4Z�]���� � �%�6 Ý� �E��0:�E�k�.^��C/��� �W `!�� ��� �vI,�W@R�o �����h�����T"�0�K���R�Ex�vK-M�61ݶ�Z/�ҘT��߷����,U}���/����}�,��^�w}I����|kkk���.!o��g% IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/instagram/instagram-white.png 0000777 00000001051 15252010675 0025147 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@G'�� �IDATx���� C+�����M��&¸�怎 � ��ymmmm=]xh\�$ -�sL (�sUC�.B kҜ?ƲP��!\���y6����,��s �f�i���I��Uũ$!�gg�ځ%o���� �4���(�(, �Z��S ��'��#� � � �p'}�蜢�b8u��U����i� @<�{ � � pX�Z؟�N�}�\��A��"�6�՛W`�P_� h�+��l�]� �� ��� p�� � PHї��.b�#�r� ŋl �s4Z�]���� � �%�6 Ý� �E��0:�E�k�.^��C/��� �W `!�� ��� �vI,�W@R�o �����h�����T"�0�K���R�Ex�vK-M�61ݶ�Z/�ҘT��߷����,U}���/����}�,��^�w}I����|kkk���.!o��g% IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/mail/mail-brand.png 0000777 00000000556 15252010675 0023020 0 ustar 00 �PNG IHDR ` ` �j PLTEGpL Ӭ� tRNS �@��� IDATx^��Aj�@ �aM���8$NP����J�Q��D�U¼�����#ﹹ�����t�Y1/NPz�>�Y���&�M�.f���� tf�@��� 4� ?���$�$�Y�u ��X N��4 Q���@>~�mA�� �% Q>(�rA1@�J�3��R���D!� ���# Q" Q� bA�B�B� Q�AC� Q*�m �?L�(� �O {�\k�5����t�(� �-777���m� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/mail/mail-white.png 0000777 00000000556 15252010675 0023052 0 ustar 00 �PNG IHDR ` ` �j PLTEGpL�������������1 tRNS �@��� IDATx^��Aj�0��Q���8$0�P�s�3�.�����W1z������sccc���Z��x�(nh�@~�3/Q$� {���>)p!��� @S�I��>(N�:�Q�/D�WDAA�spC j�_�D�}���-ƀ���.{- � D� �D� P ��`��CPĨ �@���C��B��B�A @��(i � �RP�i��f�e:�� `K��#ȟ���䙃�c��� }$Z�7֫�rccc?��mt�� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/telegram/telegram-white.png 0000777 00000002632 15252010675 0024603 0 ustar 00 �PNG IHDR V�� PLTEGpL�������������1 tRNS @���T� 6IDATx� ����� ��;��q(���9O\�H;*@zD�-]�h��>�`�1x��'�=>>�|֕��{,A���'LQ�� ����P!Ɲ�a���vɏ����'5�ߐ��}��w�Y2� Y\?g����9+ƿe��Y1�-��~Ί�o���ߒ�3�#�Ai�ʗQ�O���믊�o1q�4q�4����+ƿe��/`@\�ŬX��Y\?3 � +�I��ߢ���b�[L\?M\?M��-��~n�� +�a�����G?Yq��dq�L��{��>õ��=�ȳ~ _��8f��' @�0��~f�b��v���%6���hG:1 �� ����нw���8 �{ϸ7>!�Կ�'�B��|Frx�S���C��@��_ ����0 ���_ӑ м�g> ������ݙ~ñ p�����; gW� �'���ȑ (젦��"9��;w���/]������ߚ�`^�3w��E�ҹ�� ���q��>����|�ͅ~�'À�^�����|2t�ف��N4)�����w 0���#���p& ^M�P�?��]����� \���K���_�� pZ?�� pZ�r�81�p�90��X�\&�� �8�� �c���`6 �+@��\< p�Xċ@�O�g��Q6�0\ ڠ HW�D�>��eeȀ' [πp�GqķVv�:��(0? �@`�ln�c���ں�F};a�(�+;�h,�^�U��� v�a�g�b�;7�m �89 �����rf �8xFm:��H �������s�ݼ"J�ߵ�1 ���������]�=� ��G����z����M�X^� ��� �"��S�S�0�O?~ �~R:Lӗ�o � ���/)n@�If� 0��Y< L��z �����T��zL���� CqI�`�7@݀/ �' �C��`�U݀w�0n�;a@ހ� ��R\�k� �$�G �� @<P.�A��K�C܁ �.� q2�]� q2�]@� �%�w��n@X�wª%���(�G�� � o��K� � �T�;` �K`w`�K�A܁ �.� q2�]� q h� �T �%0�;`�v 6�;��%�w �%Hw �t �4(�`Ƿ��.A�KPm �t 6qSJP!E(#���v�B��-�x�!�XТ7 ���� ��}5���@ `���=� ��2P��]�� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/telegram/telegram-brand.png 0000777 00000002632 15252010675 0024551 0 ustar 00 �PNG IHDR V�� PLTEGpL+��)��*��*��#� tRNS @���T� 6IDATx� ����� ��;��q(���9O\�H;*@zD�-]�h��>�`�1x��'�=>>�|֕��{,A���'LQ�� ����P!Ɲ�a���vɏ����'5�ߐ��}��w�Y2� Y\?g����9+ƿe��Y1�-��~Ί�o���ߒ�3�#�Ai�ʗQ�O���믊�o1q�4q�4����+ƿe��/`@\�ŬX��Y\?3 � +�I��ߢ���b�[L\?M\?M��-��~n�� +�a�����G?Yq��dq�L��{��>õ��=�ȳ~ _��8f��' @�0��~f�b��v���%6���hG:1 �� ����нw���8 �{ϸ7>!�Կ�'�B��|Frx�S���C��@��_ ����0 ���_ӑ м�g> ������ݙ~ñ p�����; gW� �'���ȑ (젦��"9��;w���/]������ߚ�`^�3w��E�ҹ�� ���q��>����|�ͅ~�'À�^�����|2t�ف��N4)�����w 0���#���p& ^M�P�?��]����� \���K���_�� pZ?�� pZ�r�81�p�90��X�\&�� �8�� �c���`6 �+@��\< p�Xċ@�O�g��Q6�0\ ڠ HW�D�>��eeȀ' [πp�GqķVv�:��(0? �@`�ln�c���ں�F};a�(�+;�h,�^�U��� v�a�g�b�;7�m �89 �����rf �8xFm:��H �������s�ݼ"J�ߵ�1 ���������]�=� ��G����z����M�X^� ��� �"��S�S�0�O?~ �~R:Lӗ�o � ���/)n@�If� 0��Y< L��z �����T��zL���� CqI�`�7@݀/ �' �C��`�U݀w�0n�;a@ހ� ��R\�k� �$�G �� @<P.�A��K�C܁ �.� q2�]� q2�]@� �%�w��n@X�wª%���(�G�� � o��K� � �T�;` �K`w`�K�A܁ �.� q2�]� q h� �T �%0�;`�v 6�;��%�w �%Hw �t �4(�`Ƿ��.A�KPm �t 6qSJP!E(#���v�B��-�x�!�XТ7 ���� ��}5���@ `���=� ��2P��]�� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/twitch/twitch-brand.png 0000777 00000000463 15252010675 0023755 0 ustar 00 �PNG IHDR ` ` �j PLTEGpLc?�c?�d@�d@�]^] tRNS @���p�c �IDATx����@���N�M����$�?��'�73!�Z���Q�}z_] ` j�a����+`�[b<@�������zP� ǁ� ��� @�������`w@~%@�[4`@4@@ ����=�@�\��#�v�(��H��H��H� �@Dύ\��8M���0�� �7n ��t����&}u!� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/twitch/twitch-white.png 0000777 00000000463 15252010675 0024007 0 ustar 00 �PNG IHDR ` ` �j PLTEGpL�������������1 tRNS @���p�c �IDATx����@���N�M����$�?��'�73!�Z���Q�}z_] ` j�a����+`�[b<@�������zP� ǁ� ��� @�������`w@~%@�[4`@4@@ ����=�@�\��#�v�(��H��H��H� �@Dύ\��8M���0�� �7n ��t����&}u!� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/feed/feed-brand.png 0000777 00000001005 15252010675 0022750 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL Ӭ� tRNS @���T� �IDATx���KjD1C�H�� �ă_W��4ִy �?������Z+Ilk ؉�9`+�62 �{ ��4�'�M`�`� ��5-�'I���N_`%L���I��oBC���� �~LB?� auA�F��7�;���P�� o!*��u-�xґ`�@CA��/ e`�N@�` ��j �� -�Y eA� �m�$�[��B�A�YH��M� �A� �;�+0���$��S;U뷗N �B�ߏ�i�(p{�#$��ۂN��P�ƈ�s��4��`��ѱ��F���ɲuS��q�F\�0F�X�� :�7K�T!��U=���I�h�V�[�݈c \y��$ @cē���$�bx�f��B ����w@Jˈ�)%�7 *� 8�`1��u � ���e� �%�����o��,&6��' IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/feed/feed-white.png 0000777 00000001005 15252010675 0023002 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @���T� �IDATx���KjD1C�H�� �ă_W��4ִy �?������Z+Ilk ؉�9`+�62 �{ ��4�'�M`�`� ��5-�'I���N_`%L���I��oBC���� �~LB?� auA�F��7�;���P�� o!*��u-�xґ`�@CA��/ e`�N@�` ��j �� -�Y eA� �m�$�[��B�A�YH��M� �A� �;�+0���$��S;U뷗N �B�ߏ�i�(p{�#$��ۂN��P�ƈ�s��4��`��ѱ��F���ɲuS��q�F\�0F�X�� :�7K�T!��U=���I�h�V�[�݈c \y��$ @cē���$�bx�f��B ����w@Jˈ�)%�7 *� 8�`1��u � ���e� �%�����o��,&6��' IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/bluesky/bluesky-brand.png 0000777 00000000757 15252010675 0024313 0 ustar 00 �PNG IHDR ` ` �F� PLTE |� {� z� z����� tRNS @��M�� �IDATx��n�0����V����2!��\<�b=<<<�343�ˈd��p��q�e��T�ɋySO�(� �k�2L~"$�?�K�ׄ$�� �`��468��938�� J/� S� �'sG� vtty�r�!��7�c�n�0�@-�!��Cr �����@0� Bph- �}�R|&�.D� 3 �?a���u*��FqW�� cx����P#�����ķ:F� ����3n���G���G�b&����uyv�^�x��n�6������h �1.��� R*"�24�Z�� �:C�ᴂ������s�k���?�� }��c����U �g|��� �j���+�h�����d骦����� �;{ �w' IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/bluesky/bluesky-white.png 0000777 00000000757 15252010675 0024345 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@G'�� �IDATx��n�0����V����2!��\<�b=<<<�3<3�ʈd��P��q�e��T�ɋySO�(� �k�2L~b$�?�K�ׄ$�� �`ߠ46(��93(�� N/�!S� �'sG� vtty�s� �D7�#�n�0�@-� ��CR �����@0� �ph- �}�Rt&�/D� 3 �?a���u*��Fqw�X #x��F�Pc�����ķ:�� ����3j��HG����b&����ukv�^�x�Dj�6��M���h �1*��� R*b�24�Z� �:C�ᴂ������q�k��A�?�� }��c����U �gt��� �j�ݢ+�x������1,������� �; �SG� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/patreon/patreon-white.png 0000777 00000000551 15252010675 0024321 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @���T� IDATx��1nA �F3���]�P8��Db`� ruN����UT9I?IlT�������~��� � ��s �@܍��Ə����]��04�p�GF�cr0 pH���~#Ӂ �C-:� ���+0 �w\D� ��f�D|���Jl��RB��@� �� ة@�NƎ�S��>`-(د���ҿ?#�k�7���,� ��*: h�C�T� C�C y1 ��H���}�� �P������.����y 2i0gگ� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/patreon/patreon-brand.png 0000777 00000000551 15252010675 0024267 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL Ӭ� tRNS ��@G'�� IDATx��1nA �fF���]�P8��Db`� ruN����UT9I?IlT�������~��� � ��s �@܍��Ə����]��04�p�GF�cr0 pH���~#Ӂ �C-:� ���+0 �w\D� ��f�D|���Jl��RB��@� �� ة@�NƎ�S��>`-(د���ҿ?#�k�7���,� ��*: h�C�T� C�C y1 ��H���}�� �P������.����y 00LJP%� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/gravatar/gravatar-white.png 0000777 00000000766 15252010675 0024627 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@0�l �IDATx��A�1��y�\F ����u�@����r�� �� H~+�����;�� � ��|W�P s�\�D�,}�C�Ai) A� � ڡ�� �U$����� B*��6��] ��lC��`i@�ϥ`�ow`-06J�!k��� ��� � ��2� Z!H� ��t��ӵ�RR� Ǹpʸ'� �,ȫ~^�܂Z`E�7���2qD�8"0]P�&ss����DAN/66��./��S?�,��A�����T Ԥ��z��@m���P��օ<���s��"���ZBP����� U�9�w���#1�pC�!�� �pw ����_�ͣM��� 4��e����pk���om8ޞ�n3�n�y��!H��u��J ���r�\.�ք& ��9� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/gravatar/gravatar-brand.png 0000777 00000000766 15252010675 0024575 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL N� O�O� O���� tRNS ��@0�l �IDATx��A�1��y�\F ����u�@����r�� �� H~+�����;�� � ��|W�P s�\�D�,}�C�Ai) A� � ڡ�� �U$����� B*��6��] ��lC��`i@�ϥ`�ow`-06J�!k��� ��� � ��2� Z!H� ��t��ӵ�RR� Ǹpʸ'� �,ȫ~^�܂Z`E�7���2qD�8"0]P�&ss����DAN/66��./��S?�,��A�����T Ԥ��z��@m���P��օ<���s��"���ZBP����� U�9�w���#1�pC�!�� �pw ����_�ͣM��� 4��e����pk���om8ޞ�n3�n�y��!H��u��J ���r�\.�ք& ��9� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/wordpress/wordpress-white.png 0000777 00000001425 15252010675 0025262 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @���T� �IDATx��Q�� ����7�t���o�ؽ5o���N=�z���l��-I�er�(���,��a�[�""�fH�j��AP�4N��� � }+��m����"?����hQ!�Xw ��ѓk��r�{���Wn��^�W��n�� �;hu�@� >�r?x�&$ e���Gg�A����r{��y+��� h�q � Ĵ Hۃ2�vjB�v�t�{|��0 M��(��.[��Az��t�Kќ�Í�� ZH)0dĄ�2�9%�P����s�Q� ǂ��bJ@�nF�(�yF/��eD$� �A� ����� p��Ah�2� � jc�*<��: (R��A��z�cB��H8�� ��=* O �]1 ľ ��3E(9�]�2ʄ 1�D��u�g1 $t`�f� $�� �(5!�^� >�ŀʄ�2ʄ1����Q&DH �+���i`����ӈ�q! (Ƅ�μ�Ȅ�K� �\@���H���Ёւ!� J�<wV-�q�1� 䎟 H��b�Y B2Y�ˋXG�m aX�`����� )�����W Z� �� q�}9=D! (��_�*Y��.f��] \��*8�E���]�߳2!����"#8\5��\����IG��5����+$��� �w*� �[Q��F$]�{-E O=��t� a.''%z+ IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/wordpress/wordpress-brand.png 0000777 00000001425 15252010675 0025230 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL3��3��4��4���?� tRNS @���T� �IDATx��Q�� ����7�t���o�ؽ5o���N=�z���l��-I�er�(���,��a�[�""�fH�j��AP�4N��� � }+��m����"?����hQ!�Xw ��ѓk��r�{���Wn��^�W��n�� �;hu�@� >�r?x�&$ e���Gg�A����r{��y+��� h�q � Ĵ Hۃ2�vjB�v�t�{|��0 M��(��.[��Az��t�Kќ�Í�� ZH)0dĄ�2�9%�P����s�Q� ǂ��bJ@�nF�(�yF/��eD$� �A� ����� p��Ah�2� � jc�*<��: (R��A��z�cB��H8�� ��=* O �]1 ľ ��3E(9�]�2ʄ 1�D��u�g1 $t`�f� $�� �(5!�^� >�ŀʄ�2ʄ1����Q&DH �+���i`����ӈ�q! (Ƅ�μ�Ȅ�K� �\@���H���Ёւ!� J�<wV-�q�1� 䎟 H��b�Y B2Y�ˋXG�m aX�`����� )�����W Z� �� q�}9=D! (��_�*Y��.f��] \��*8�E���]�߳2!����"#8\5��\����IG��5����+$��� �w*� �[Q��F$]�{-E O=��t� a.''%z+ IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/pinterest/pinterest-white.png 0000777 00000001046 15252010675 0025233 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @���T� �IDATx��A��0C���<�ٵ�V0f�U���$&N%>}��^ )I�)����R.������8��0��Q�����#c�<� � �!T�#`YAS�B|a���n�� G�+V㝞Z� (`ˮ7�R>�?�~˔ �`�±�����an��B���c�+�}�2t07S�F���۲ z0�j5�D�ld&W �ͺ� ,� ��5��&�q�*��`�����n�h](?tM�&ء�� �w{�c#�Km~Ƣ� � �E7�Y�HV��/r]0-0��0���_S�I��� ��F�\Z(��^"��.s���S��މ��] �H�S��?r#I��1߉1 `D�B�' q�@3}�/�������[" �վ� Ўm��m@�Hf+ hAC� f�� �y@ 8 �a �1 �4 Ƅ� ��A��}@�J���>���?!�m��� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/pinterest/pinterest-brand.png 0000777 00000001046 15252010675 0025201 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL� #�!�"�"X�t tRNS @���T� �IDATx��A��0C���<�ٵ�V0f�U���$&N%>}��^ )I�)����R.������8��0��Q�����#c�<� � �!T�#`YAS�B|a���n�� G�+V㝞Z� (`ˮ7�R>�?�~˔ �`�±�����an��B���c�+�}�2t07S�F���۲ z0�j5�D�ld&W �ͺ� ,� ��5��&�q�*��`�����n�h](?tM�&ء�� �w{�c#�Km~Ƣ� � �E7�Y�HV��/r]0-0��0���_S�I��� ��F�\Z(��^"��.s���S��މ��] �H�S��?r#I��1߉1 `D�B�' q�@3}�/�������[" �վ� Ўm��m@�Hf+ hAC� f�� �y@ 8 �a �1 �4 Ƅ� ��A��}@�J���>���?!�m��� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/audio/audio-play.png 0000777 00000000646 15252010675 0023235 0 ustar 00 �PNG IHDR $ $ ��h� TPLTE �������������������������������������������������;@A��齿�������uxygjk-13 #%F�� tRNS � �`�p���@����� �IDAT8ˍ�Yr�0�hdy#�8d���\50Bϸ�?��Զ6Ԥ2Ig��X���� fk�V�l�~@ER�DR�P�����'[z+gY�X���.-� �f�HHW�)>P-q3�F��H�H�L($Q�`$���$j :���H��t������<'O��/��B��3�����D)� ��@ۭ� ��R X�C��%>x���@�W羥�x�߹0�,���d}8Hۤ2�z ��x ^ �@ #�P IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/chain/chain-white.png 0000777 00000000600 15252010675 0023340 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS ��@G'�� IDATx����j�0 P�L��� k��4Tք�-�<梱L;1�c�1ƿ��8ly|��<Cȯ^,�. K����u@�W�K�pq������d��d�~}EC#!�ߢw��P��{-�ti�V�0�n4���Э �s� �3-0p� �G�� ��v � h� zy� ����@@1��d����� ��5����%tx�Y�t�>�E����r/�_��n���[��o���}W��tF���Db���<?���i�T� � * �^ >�קHR�1�c���މ�ی�� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/chain/chain-brand.png 0000777 00000000600 15252010675 0023306 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL Ӭ� tRNS ��@G'�� IDATx����j�0 P�L��� k��4Tք�-�<梱L;1�c�1ƿ��8ly|��<Cȯ^,�. K����u@�W�K�pq������d��d�~}EC#!�ߢw��P��{-�ti�V�0�n4���Э �s� �3-0p� �G�� ��v � h� zy� ����@@1��d����� ��5����%tx�Y�t�>�E����r/�_��n���[��o���}W��tF���Db���<?���i�T� � * �^ >�קHR�1�c���މ�ی�� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/facebook/facebook-brand.png 0000777 00000000732 15252010675 0024472 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpLg�e�f�f�eRH� tRNS @���T� vIDATx���� �@ E�s�s)��bǣ�4��wie b����|�d;$/w\�&��g��xN�ˤ��C�p,��������^p�Q�Qʵ��"� �F�o۲]�L>�O���Gn^ .G�9���Ll 5�~�X� r� �N�� Y���c@p� ���Ӏ���q�G�ؿ<�v �a@�'O,��S��D�e�� ���1 DVe� �� ��� ���@\*��X��K ���;⏨_9n��x)��8w�4 O�}< �3��)�� @� OP s0�c ����D�F*W#�k�����H����va3z0���PJI�D5% ��g�D7�3`b$�W�"&�"������$<L���� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/facebook/facebook-white.png 0000777 00000000732 15252010675 0024524 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS @���T� vIDATx���� �@ E�s�s)��bǣ�4��wie b����|�d;$/w\�&��g��xN�ˤ��C�p,��������^p�Q�Qʵ��"� �F�o۲]�L>�O���Gn^ .G�9���Ll 5�~�X� r� �N�� Y���c@p� ���Ӏ���q�G�ؿ<�v �a@�'O,��S��D�e�� ���1 DVe� �� ��� ���@\*��X��K ���;⏨_9n��x)��8w�4 O�}< �3��)�� @� OP s0�c ����D�F*W#�k�����H����va3z0���PJI�D5% ��g�D7�3`b$�W�"&�"������$<L���� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/medium/medium-brand.png 0000777 00000000614 15252010675 0023707 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL Ӭ� tRNS @���T� (IDATx��A�! �n���� ���x��R\G�l�hEQEQ� �/�vH}@�7���������up��@6q^RjS���)�vz���rECf�N�y���؝RD��G65�������c9�բ�& $�Ւ zJ��:�ȸ O�Ye>� x+P�� &[���{ �&�� ���{�o���ݣⰀ�iʽ�&��q��B[�_�B .U�`��T��.^�ۈr��h�eD�s���L�7]�a��' ��<���V i�:������ g��N ��VEQEQ��B$�o� IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/icons/medium/medium-white.png 0000777 00000000614 15252010675 0023741 0 ustar 00 �PNG IHDR ` ` �F� PLTEGpL�������������1 tRNS �@��� (IDATx��A�! �n���� ���x��R\G�l�hEQEQ�@/�vJ} �7����������u`��@6q^RjS���)�v{���rECf��N��y���؝RD��G65�������c9�բ�& $�Ւ zJ��:�ȸ�O�Ye<� p+P�� $[�A��{ �&��輀���{�o���ݣ� �i���&�q��B[�_�B .U�`��T ��.^�ۈb��h�ED�s���L�7]�i��' ��8���V i�:����Ķ f��N@��VEQEQ���#���& IEND�B`� email-editor/src/Integrations/Core/Renderer/Blocks/class-abstract-block-renderer.php 0000777 00000010224 15252010675 0024553 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Block_Renderer; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; use WP_Style_Engine; /** * Shared functionality for block renderers. */ abstract class Abstract_Block_Renderer implements Block_Renderer { /** * Wrapper for wp_style_engine_get_styles which ensures all values are returned. * * @param array $block_styles Array of block styles. * @param bool $skip_convert_vars If true, --wp_preset--spacing--x type values will be left in the original var:preset:spacing:x format. * @return array */ protected function get_styles_from_block( array $block_styles, $skip_convert_vars = false ) { return Styles_Helper::get_styles_from_block( $block_styles, $skip_convert_vars ); } /** * Compile objects containing CSS properties to a string. * * @param array ...$styles Style arrays to compile. * @return string */ protected function compile_css( ...$styles ): string { return WP_Style_Engine::compile_css( array_merge( ...$styles ), '' ); } /** * Extract inner content from a wrapper element. * * Removes the outer wrapper element (e.g., div) and returns only the inner HTML content. * This is useful when you need to strip the wrapper and use only the inner content. * * @param string $block_content Block content with wrapper element. * @param string $tag_name Tag name of the wrapper element (default: 'div'). * @return string Inner content without the wrapper element, or original content if wrapper not found. */ protected function get_inner_content( string $block_content, string $tag_name = 'div' ): string { $dom_helper = new Dom_Document_Helper( $block_content ); $element = $dom_helper->find_element( $tag_name ); return $element ? $dom_helper->get_element_inner_html( $element ) : $block_content; } /** * Add a spacer around the block. * * @param string $content The block content. * @param array $email_attrs The email attributes. * @return string */ protected function add_spacer( $content, $email_attrs ): string { $gap_style = WP_Style_Engine::compile_css( array_intersect_key( $email_attrs, array_flip( array( 'margin-top' ) ) ), '' ) ?? ''; $padding_style = WP_Style_Engine::compile_css( array_intersect_key( $email_attrs, array_flip( array( 'padding-left', 'padding-right' ) ) ), '' ) ?? ''; $table_attrs = array( 'align' => 'left', 'width' => '100%', 'style' => $gap_style, ); $cell_attrs = array( 'style' => $padding_style, ); $div_content = sprintf( '<div class="email-block-layout" style="%1$s %2$s">%3$s</div>', esc_attr( $gap_style ), esc_attr( $padding_style ), $content ); return Table_Wrapper_Helper::render_outlook_table_wrapper( $div_content, $table_attrs, $cell_attrs ); } /** * Render the block. * * @param string $block_content The block content. * @param array $parsed_block The parsed block. * @param Rendering_Context $rendering_context The rendering context. * @return string */ public function render( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { return $this->add_spacer( $this->render_content( $block_content, $parsed_block, $rendering_context ), $parsed_block['email_attrs'] ?? array() ); } /** * Render the block content. * * @param string $block_content The block content. * @param array $parsed_block The parsed block. * @param Rendering_Context $rendering_context The rendering context. * @return string */ abstract protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string; } email-editor/src/Integrations/Core/Renderer/Blocks/class-columns.php 0000777 00000007276 15252010675 0021551 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; /** * Renders a columns block. */ class Columns extends Abstract_Block_Renderer { /** * Override this method to disable spacing (block gap) for columns. * Spacing is applied on wrapping columns block. Columns are rendered side by side so no spacer is needed. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { return str_replace( '{columns_content}', $this->get_inner_content( $block_content ), $this->getBlockWrapper( $block_content, $parsed_block, $rendering_context ) ); } /** * Based on MJML <mj-section> * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. */ private function getBlockWrapper( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $original_wrapper_classname = ( new Dom_Document_Helper( $block_content ) )->get_attribute_value_by_tag_name( 'div', 'class' ) ?? ''; $block_attributes = wp_parse_args( $parsed_block['attrs'] ?? array(), array( 'align' => null, 'width' => $rendering_context->get_layout_width_without_padding(), 'style' => array(), ) ); $columns_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'padding', 'border', 'background', 'background-color', 'color' ) ); $columns_styles = Styles_Helper::extend_block_styles( $columns_styles, array( 'width' => '100%', 'border-collapse' => 'separate', 'text-align' => 'left', 'background-size' => $columns_styles['declarations']['background-size'] ?? 'cover', ) ); $columns_table_attrs = array( 'class' => 'email-block-columns ' . $original_wrapper_classname, 'style' => $columns_styles['css'], 'align' => 'center', ); $columns_content = Table_Wrapper_Helper::render_table_wrapper( '{columns_content}', $columns_table_attrs, array(), array(), false ); // Margins are not supported well in outlook for tables, so wrap in another table. $margins = $block_attributes['style']['spacing']['margin'] ?? array(); if ( ! empty( $margins ) ) { $magin_to_padding_attributes = array( 'style' => array( 'spacing' => array( 'padding' => $margins ) ) ); $margin_wrapper_styles = Styles_Helper::get_block_styles( $magin_to_padding_attributes, $rendering_context, array( 'padding' ) ); $margin_wrapper_styles = Styles_Helper::extend_block_styles( $margin_wrapper_styles, array( 'width' => '100%', 'border-collapse' => 'separate', 'text-align' => 'left', ) ); $wrapper_table_attrs = array( 'class' => 'email-block-columns-wrapper', 'style' => $margin_wrapper_styles['css'], 'align' => 'center', ); return Table_Wrapper_Helper::render_table_wrapper( $columns_content, $wrapper_table_attrs ); } return $columns_content; } } email-editor/src/Integrations/Core/Renderer/Blocks/class-quote.php 0000777 00000010764 15252010675 0021222 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; /** * Renders a quote block. */ class Quote extends Abstract_Block_Renderer { /** * Renders the block content * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $dom_helper = new Dom_Document_Helper( $block_content ); // Extract citation if present. $citation_content = ''; $cite_element = $dom_helper->find_element( 'cite' ); if ( $cite_element ) { $citation_content = $this->get_citation_wrapper( $dom_helper->get_element_inner_html( $cite_element ), $parsed_block, $rendering_context ); } return str_replace( array( '{quote_content}', '{citation_content}' ), array( $this->get_inner_content( $block_content ), $citation_content ), $this->get_block_wrapper( $block_content, $parsed_block, $rendering_context ) ); } /** * Returns the citation content with a wrapper. * * @param string $citation_content The citation text. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context instance. * @return string The wrapped citation HTML or empty string if no citation. */ private function get_citation_wrapper( string $citation_content, array $parsed_block, Rendering_Context $rendering_context ): string { if ( empty( $citation_content ) ) { return ''; } // The HTML cite tag should use block gap as margin-top. $theme_styles = $rendering_context->get_theme_styles(); $margin_top = $theme_styles['spacing']['blockGap'] ?? '0px'; $citation_styles = Styles_Helper::get_block_styles( $parsed_block['attrs'], $rendering_context, array( 'text-align' ) ); $citation_styles = Styles_Helper::extend_block_styles( $citation_styles, array( 'margin' => "{$margin_top} 0px 0px 0px" ) ); return $this->add_spacer( sprintf( '<p style="%2$s"><cite class="email-block-quote-citation" style="display: block; margin: 0;">%1$s</cite></p>', $citation_content, $citation_styles['css'], ), $parsed_block['email_attrs'] ?? array() ); } /** * Returns the block wrapper. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. */ private function get_block_wrapper( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $original_classname = ( new Dom_Document_Helper( $block_content ) )->get_attribute_value_by_tag_name( 'blockquote', 'class' ) ?? ''; $block_attributes = wp_parse_args( $parsed_block['attrs'] ?? array(), array( 'style' => array(), 'backgroundColor' => '', 'textColor' => '', 'borderColor' => '', ) ); // Layout, background, borders need to be on the outer table element. $table_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'border', 'background', 'background-color', 'color', 'text-align' ) ); $table_styles = Styles_Helper::extend_block_styles( $table_styles, array( 'border-collapse' => 'separate', 'background-size' => $table_styles['declarations']['background-size'] ?? 'cover', ) ); // Padding properties need to be added to the table cell. $cell_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'padding' ) ); $table_attrs = array( 'class' => 'email-block-quote ' . $original_classname, 'style' => $table_styles['css'], 'width' => '100%', ); $cell_attrs = array( 'class' => 'email-block-quote-content', 'style' => $cell_styles['css'], 'width' => '100%', ); return Table_Wrapper_Helper::render_table_wrapper( '{quote_content}{citation_content}', $table_attrs, $cell_attrs ); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-group.php 0000777 00000005552 15252010675 0021220 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Dom_Document_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; /** * Renders a group block. */ class Group extends Abstract_Block_Renderer { /** * Renders the block content * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { return str_replace( '{group_content}', $this->get_inner_content( $block_content ), $this->get_block_wrapper( $block_content, $parsed_block, $rendering_context ) ); } /** * Returns the block wrapper. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. */ private function get_block_wrapper( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { $original_classname = ( new Dom_Document_Helper( $block_content ) )->get_attribute_value_by_tag_name( 'div', 'class' ) ?? ''; $block_attributes = wp_parse_args( $parsed_block['attrs'] ?? array(), array( 'style' => array(), 'backgroundColor' => '', 'textColor' => '', 'borderColor' => '', 'layout' => array(), ) ); $table_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'border', 'background', 'background-color', 'color', 'text-align' ) ); $table_styles = Styles_Helper::extend_block_styles( $table_styles, array_filter( array( 'border-collapse' => 'separate', 'background-size' => $table_styles['background-size'] ?? 'cover', ) ) ); // Padding properties need to be added to the table cell. $cell_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'padding' ) ); $table_attrs = array( 'class' => 'email-block-group ' . $original_classname, 'style' => $table_styles['css'], 'width' => '100%', ); $cell_attrs = array( 'class' => 'email-block-group-content', 'style' => $cell_styles['css'], 'width' => $parsed_block['email_attrs']['width'] ?? '100%', ); return Table_Wrapper_Helper::render_table_wrapper( '{group_content}', $table_attrs, $cell_attrs ); } } email-editor/src/Integrations/Core/Renderer/Blocks/class-audio.php 0000777 00000016275 15252010675 0021171 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; /** * Audio block renderer. * This renderer handles core/audio blocks for email. */ class Audio extends Abstract_Block_Renderer { /** * Render the block. * * @param string $block_content The block content. * @param array $parsed_block The parsed block. * @param Rendering_Context $rendering_context The rendering context. * @return string */ public function render( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // Validate input parameters and required dependencies. if ( ! isset( $parsed_block['attrs'] ) || ! is_array( $parsed_block['attrs'] ) || ! class_exists( '\Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper' ) ) { return ''; } $attr = $parsed_block['attrs']; // Check if we have a valid audio source - return empty string immediately if not. // For attachments, check the 'id' attribute. For external URLs, check if src exists in HTML content. $has_attachment_id = ! empty( $attr['id'] ); $has_src_in_html = preg_match( '#<audio[^>]*\ssrc=["\']([^"\']*)["\'][^>]*/?>#', $block_content ); // If we have neither an attachment ID nor a src in the HTML content, return empty. if ( ! $has_attachment_id && ! $has_src_in_html ) { return ''; } // If we have a valid source, proceed with normal rendering. $rendered_content = $this->render_content( $block_content, $parsed_block, $rendering_context ); // If render_content returns empty (e.g., invalid URL), return empty string. if ( empty( $rendered_content ) ) { return ''; } return $this->add_spacer( $rendered_content, $parsed_block['email_attrs'] ?? array() ); } /** * Renders the audio block content as an audio player for email. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context (required by parent contract but unused in this implementation). * @return string */ protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable $attr = $parsed_block['attrs']; // Get URL and length. if ( isset( $attr['id'] ) ) { // Audio file from site's media library. $url = \wp_get_attachment_url( $attr['id'] ); $meta = \get_post_meta( $attr['id'], '_wp_attachment_metadata', true ); $length = ( is_array( $meta ) && isset( $meta['length_formatted'] ) && is_string( $meta['length_formatted'] ) ) ? $meta['length_formatted'] : ''; } else { // Audio file from external URL. preg_match( '#<audio[^>]*\ssrc=["\']([^"\']*)["\'][^>]*/?>#', $block_content, $audio ); $url = isset( $audio[1] ) ? $audio[1] : $attr['src'] ?? ''; $length = null; } // Validate URL with proper ordering and comprehensive checks. if ( empty( $url ) ) { return ''; } // Validate URL type and format. if ( ! str_starts_with( $url, 'data:audio/' ) && ! str_starts_with( $url, '/' ) && ! str_starts_with( $url, 'https://' ) ) { // Reject everything else (http://, ftp://, relative paths, etc.). return ''; } // For HTTPS URLs, validate with wp_http_validate_url. if ( str_starts_with( $url, 'https://' ) && ! wp_http_validate_url( $url ) ) { return ''; } // Get spacing from email_attrs for better consistency with core blocks. $email_attrs = $parsed_block['email_attrs'] ?? array(); $table_margin_style = ''; if ( ! empty( $email_attrs ) && class_exists( '\WP_Style_Engine' ) ) { // Get margin for table styling. $table_margin_style = \WP_Style_Engine::compile_css( array_intersect_key( $email_attrs, array_flip( array( 'margin' ) ) ), '' ); } $icon_image = $this->get_audio_icon_url(); $label = ! empty( $attr['label'] ) ? $attr['label'] : __( 'Listen to the audio', 'woocommerce' ); // Add duration to label if available. if ( ! empty( $length ) ) { $label .= ' (' . esc_html( (string) $length ) . ')'; } $audio_url = esc_url( $url ); // Define pill-style colors and styling. $background_color = '#f6f7f7'; $border_color = '#AAA'; $icon_size = '18px'; $font_size = '14px'; // Generate the icon content. $icon_content = sprintf( '<a href="%1$s" rel="noopener nofollow" target="_blank" style="padding: 0.25em; padding-left: 17px; display: inline-block; vertical-align: middle;"><img height="%2$s" src="%3$s" style="display:block;margin-right:0;vertical-align:middle;" width="%2$s" alt="%4$s"></a>', $audio_url, esc_attr( $icon_size ), esc_url( $icon_image ), // translators: %s is the audio player icon. sprintf( __( '%s icon', 'woocommerce' ), __( 'Audio', 'woocommerce' ) ) ); $icon_content = Table_Wrapper_Helper::render_table_cell( $icon_content, array( 'style' => sprintf( 'vertical-align:middle;font-size:%s;', $font_size ) ) ); // Generate the label content. $label_content = sprintf( '<a href="%1$s" rel="noopener nofollow" target="_blank" style="text-decoration:none; padding: 0.25em; padding-right: 17px; display: inline-block;"><span style="margin-left:.5em;margin-right:.5em;font-weight:bold"> %2$s </span></a>', $audio_url, esc_html( $label ) ); $label_cell_style = sprintf( 'vertical-align:middle;font-size:%s;', $font_size ); $label_content = Table_Wrapper_Helper::render_table_cell( $label_content, array( 'style' => $label_cell_style ) ); // Combine icon and label tables. $audio_content = $icon_content . $label_content; // Create the main pill-style table. $main_table_styles = sprintf( 'background-color: %s; border-radius: 9999px; float: none; border: 1px solid %s; border-collapse: separate;', $background_color, $border_color ); $main_table_attrs = array( 'align' => 'left', 'style' => $main_table_styles, ); $main_table = Table_Wrapper_Helper::render_table_wrapper( $audio_content, $main_table_attrs, array(), array(), false ); // Create the main wrapper table. $table_style = 'width: 100%;'; if ( ! empty( $table_margin_style ) ) { $table_style = $table_margin_style . '; ' . $table_style; } else { $table_style = 'margin: 16px 0; ' . $table_style; } $table_attrs = array( 'style' => $table_style, ); $cell_attrs = array( 'style' => 'min-width: 100%; vertical-align: middle; word-break: break-word; text-align: left;', ); $main_wrapper = Table_Wrapper_Helper::render_table_wrapper( $main_table, $table_attrs, $cell_attrs ); return Table_Wrapper_Helper::render_outlook_table_wrapper( $main_wrapper, array( 'align' => 'left' ) ); } /** * Gets the audio icon URL. * * @return string The audio icon URL. */ private function get_audio_icon_url(): string { $file_name = '/icons/audio/audio-play.png'; return plugins_url( $file_name, __FILE__ ); } } email-editor/src/Integrations/Core/theme.json 0000777 00000002654 15252010675 0015262 0 ustar 00 { "$schema": "https://schemas.wp.org/trunk/theme.json", "version": 3, "styles": { "blocks": { "core/button": { "variations": {} }, "core/quote": { "border": { "style": "solid", "width": "0 0 0 1px", "color": "currentColor" }, "spacing": { "margin": { "right": "0", "left": "0" }, "padding": { "top": "20px", "right": "20px", "bottom": "20px", "left": "20px" } }, "typography": { "fontSize": "20px" }, "elements": { "cite": { "typography": { "fontSize": "13px", "fontStyle": "italic", "fontWeight": "300" } } }, "css": "&.has-text-align-right { border-width: 0 1px 0 0; } &.has-text-align-center { border-width: 0; border-inline: 0; padding-inline: 0; }", "variations": {} }, "core/table": { "spacing": { "margin": { "top": "0", "bottom": "0" }, "padding": { "top": "10px", "right": "10px", "bottom": "10px", "left": "10px" } }, "typography": {}, "border": {}, "css": "& table { border-collapse: collapse; width: 100%; } & th, & td { border: 1px solid currentColor; padding: 8px; } & thead th { font-weight: bold; } & .has-text-align-left { text-align: left; } & .has-text-align-center { text-align: center; } & .has-text-align-right { text-align: right; }", "variations": {} } } } } email-editor/src/Integrations/Utils/class-table-wrapper-helper.php 0000777 00000010123 15252010675 0021321 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Utils; /** * Helper class for generating table wrappers for email blocks. */ class Table_Wrapper_Helper { /** * Default table attributes. * * @var array<string, string> */ private const DEFAULT_TABLE_ATTRS = array( 'border' => '0', 'cellpadding' => '0', 'cellspacing' => '0', 'role' => 'presentation', ); /** * Render a table cell. * * @param string $content The content to wrap. * @param array $cell_attrs Cell attributes. * @return string The generated table cell HTML. */ public static function render_table_cell( string $content, array $cell_attrs = array() ): string { $cell_attr_string = self::build_attributes_string( $cell_attrs ); return sprintf( '<td%1$s>%2$s</td>', $cell_attr_string ? ' ' . $cell_attr_string : '', $content ); } /** * Render an Outlook-specific table cell using conditional comments. * * @param string $content The content to wrap. * @param array $cell_attrs Cell attributes. * @return string The generated table cell HTML with Outlook conditionals. */ public static function render_outlook_table_cell( string $content, array $cell_attrs = array() ): string { $content_with_outlook_conditional = '<![endif]-->' . $content . '<!--[if mso | IE]>'; return '<!--[if mso | IE]>' . self::render_table_cell( $content_with_outlook_conditional, $cell_attrs ) . '<![endif]-->'; } /** * Render a table wrapper for email blocks. * * @param string $content The content to wrap (e.g., '{block_content}'). * @param array $table_attrs Table attributes to merge with defaults. * @param array $cell_attrs Cell attributes. * @param array $row_attrs Row attributes. * @param bool $render_cell Whether to render the td wrapper (default true). * @return string The generated table wrapper HTML. */ public static function render_table_wrapper( string $content, array $table_attrs = array(), array $cell_attrs = array(), array $row_attrs = array(), bool $render_cell = true ): string { $merged_table_attrs = array_merge( self::DEFAULT_TABLE_ATTRS, $table_attrs ); $table_attr_string = self::build_attributes_string( $merged_table_attrs ); $row_attr_string = self::build_attributes_string( $row_attrs ); if ( $render_cell ) { $content = self::render_table_cell( $content, $cell_attrs ); } return sprintf( '<table%2$s> <tbody> <tr%3$s> %1$s </tr> </tbody> </table>', $content, $table_attr_string ? ' ' . $table_attr_string : '', $row_attr_string ? ' ' . $row_attr_string : '' ); } /** * Render an Outlook-specific table wrapper using conditional comments. * * @param string $content The content to wrap (e.g., '{block_content}'). * @param array $table_attrs Table attributes to merge with defaults. * @param array $cell_attrs Cell attributes. * @param array $row_attrs Row attributes. * @param bool $render_cell Whether to render the td wrapper (default true). * @return string The generated table wrapper HTML. */ public static function render_outlook_table_wrapper( string $content, array $table_attrs = array(), array $cell_attrs = array(), array $row_attrs = array(), bool $render_cell = true ): string { $content_with_outlook_conditional = '<![endif]-->' . $content . '<!--[if mso | IE]>'; return '<!--[if mso | IE]>' . self::render_table_wrapper( $content_with_outlook_conditional, $table_attrs, $cell_attrs, $row_attrs, $render_cell ) . '<![endif]-->'; } /** * Build an HTML attributes string from an array. * * @param array<string, string> $attributes The attributes array. * @return string The attributes string. */ private static function build_attributes_string( array $attributes ): string { $attr_parts = array(); foreach ( $attributes as $key => $value ) { if ( '' !== $value ) { $attr_parts[] = sprintf( '%s="%s"', $key, esc_attr( $value ) ); } } return implode( ' ', $attr_parts ); } } email-editor/src/Integrations/Utils/class-html-processing-helper.php 0000777 00000046534 15252010675 0021711 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Utils; /** * Helper class for HTML processing and manipulation. */ class Html_Processing_Helper { /** * Clean CSS classes by removing background and border related classes. * * @param string $classes CSS classes to clean. * @return string Cleaned CSS classes. */ public static function clean_css_classes( string $classes ): string { // Limit input length to prevent DoS attacks. if ( strlen( $classes ) > 1000 ) { $classes = substr( $classes, 0, 1000 ); } // Remove generic background classes but keep specific color classes. $result = preg_replace( '/\bhas-background\b/', '', $classes ); if ( null === $result ) { $classes = ''; } else { $classes = $result; } // Remove border classes. $result = preg_replace( '/\bhas-[a-z-]*border[a-z-]*\b/', '', $classes ); if ( null === $result ) { $classes = ''; } else { $classes = $result; } $result = preg_replace( '/\b[a-z-]+-border-[a-z-]+\b/', '', $classes ); if ( null === $result ) { $classes = ''; } else { $classes = $result; } // Clean up multiple spaces. $result = preg_replace( '/\s+/', ' ', $classes ); if ( null === $result ) { $classes = ''; } else { $classes = $result; } return trim( $classes ); } /** * Sanitize CSS value to prevent injection attacks. * * @param string $value CSS value to sanitize. * @return string Sanitized CSS value or empty string if invalid. */ public static function sanitize_css_value( string $value ): string { // Remove dangerous script injection characters (angle brackets) but preserve quotes for CSS strings. $result = preg_replace( '/[<>]/', '', $value ); if ( null === $result ) { $value = ''; } else { $value = $result; } // Remove dangerous CSS functions and expressions. $dangerous_patterns = array( '/expression\s*\(/i', '/url\s*\(\s*javascript\s*:/i', '/url\s*\(\s*data\s*:/i', '/url\s*\(\s*vbscript\s*:/i', '/import\s*\(/i', '/behavior\s*:/i', '/binding\s*:/i', '/filter\s*:/i', '/progid\s*:/i', ); foreach ( $dangerous_patterns as $pattern ) { if ( preg_match( $pattern, $value ) ) { return ''; } } return trim( $value ); } /** * Sanitize dimension value to ensure it's a valid CSS dimension. * * Supports numeric values (converted to px) and standard CSS units. * * @param mixed $value The dimension value to sanitize. * @return string Sanitized dimension value or empty string if invalid. */ public static function sanitize_dimension_value( $value ): string { if ( ! is_string( $value ) && ! is_numeric( $value ) ) { return ''; } $value = (string) $value; // If it's just a number, assume pixels. if ( is_numeric( $value ) ) { $value = $value . 'px'; } // Use existing CSS value sanitization for security. $sanitized_value = self::sanitize_css_value( $value ); // Additional validation for dimension-specific units. if ( ! empty( $sanitized_value ) && preg_match( '/^(\d+(?:\.\d+)?)(px|em|rem|%|vh|vw|ex|ch|in|cm|mm|pt|pc)$/', $sanitized_value ) ) { return $sanitized_value; } return ''; } /** * Sanitize color value to ensure it's a valid color format. * * Supports hex colors, rgb/rgba, hsl/hsla, named colors, and CSS variables. * * @param string $color The color value to sanitize. * @return string Sanitized color value or safe default if invalid. */ public static function sanitize_color( string $color ): string { // Remove any whitespace. $color = trim( $color ); // Check if it's a valid hex color (#fff, #ffffff, #ffffffff). if ( preg_match( '/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/', $color ) ) { return strtolower( $color ); } // Check for rgb/rgba colors. if ( preg_match( '/^rgba?\(\s*(25[0-5]|2[0-4]\d|1\d{2}|\d{1,2})\s*,\s*(25[0-5]|2[0-4]\d|1\d{2}|\d{1,2})\s*,\s*(25[0-5]|2[0-4]\d|1\d{2}|\d{1,2})\s*(?:,\s*(?:1(?:\.0+)?|0(?:\.\d+)?|\.\d+)\s*)?\)$/', $color ) ) { return $color; } // Check for hsl/hsla colors. if ( preg_match( '/^hsla?\(\s*(360|3[0-5]\d|[12]\d{2}|\d{1,2})\s*,\s*(100|[1-9]?\d)%\s*,\s*(100|[1-9]?\d)%\s*(?:,\s*(?:1(?:\.0+)?|0(?:\.\d+)?|\.\d+)\s*)?\)$/', $color ) ) { return $color; } // Check for named colors and other valid CSS color values. // We use a permissive approach: accept any string that doesn't contain dangerous characters // and let the CSS engine handle the actual validation. if ( preg_match( '/^[a-zA-Z][a-zA-Z0-9-]*$/', $color ) && ! preg_match( '/^(expression|javascript|vbscript|data|import|behavior|binding|filter|progid)/i', $color ) ) { return strtolower( $color ); } // Check if it's a CSS variable (var(--variable-name)). if ( preg_match( '/^var\(--[a-zA-Z0-9\-_]+\)$/', $color ) ) { return $color; } // If not a valid color format, return a safe default. return '#000000'; } /** * Normalize rel attribute by lowercasing, deduplicating tokens, and ensuring required tokens. * * @param string|null $rel_value Current rel attribute value. * @param bool $require_security_tokens Whether to require noopener and noreferrer tokens. * @return string Normalized rel attribute value. */ private static function normalize_rel_attribute( ?string $rel_value, bool $require_security_tokens = false ): string { $allowed_tokens = array( 'noopener', 'noreferrer', 'nofollow', 'external' ); $required_tokens = $require_security_tokens ? array( 'noopener', 'noreferrer' ) : array(); // If no rel value and no required tokens, return empty. if ( null === $rel_value && empty( $required_tokens ) ) { return ''; } // Start with required tokens. $tokens = $required_tokens; // If rel value exists, parse and normalize it. if ( null !== $rel_value ) { $existing_tokens = preg_split( '/\s+/', trim( $rel_value ) ); if ( false !== $existing_tokens ) { // Normalize existing tokens: lowercase, remove empty, filter allowed. $normalized_existing = array_filter( array_map( 'strtolower', $existing_tokens ), function ( $token ) use ( $allowed_tokens ) { return ! empty( $token ) && in_array( $token, $allowed_tokens, true ); } ); // Merge with required tokens, removing duplicates. $tokens = array_unique( array_merge( $tokens, $normalized_existing ) ); } } // Return normalized rel attribute or empty string if no valid tokens. return empty( $tokens ) ? '' : implode( ' ', $tokens ); } /** * Validate and sanitize specific caption attributes for security. * * @param \WP_HTML_Tag_Processor $html HTML tag processor. * @param string $attr_name Attribute name to validate. */ public static function validate_caption_attribute( \WP_HTML_Tag_Processor $html, string $attr_name ): void { $attr_value = $html->get_attribute( $attr_name ); if ( null === $attr_value ) { return; } // Block all event handler attributes (on*) - Critical security fix. if ( str_starts_with( $attr_name, 'on' ) ) { $html->remove_attribute( $attr_name ); return; } switch ( $attr_name ) { case 'href': // Only allow http, https, mailto, and tel protocols. if ( ! preg_match( '/^(https?:\/\/|mailto:|tel:)/i', (string) $attr_value ) ) { $html->remove_attribute( $attr_name ); break; } // Sanitize and normalize the URL using WordPress's esc_url_raw. $sanitized_url = esc_url_raw( (string) $attr_value ); if ( empty( $sanitized_url ) ) { // If esc_url_raw returns empty, the URL was invalid - remove the attribute. $html->remove_attribute( $attr_name ); } else { // Set the attribute to the sanitized/normalized value. $html->set_attribute( $attr_name, $sanitized_url ); } break; case 'target': // Allow only common safe targets. $allowed_targets = array( '_blank', '_self' ); $target_value = strtolower( (string) $attr_value ); if ( ! in_array( $target_value, $allowed_targets, true ) ) { $html->remove_attribute( $attr_name ); } elseif ( '_blank' === $target_value ) { // When target is "_blank", ensure rel attribute has noopener and noreferrer. $current_rel = $html->get_attribute( 'rel' ); $rel_value = is_string( $current_rel ) ? $current_rel : null; $normalized_rel = self::normalize_rel_attribute( $rel_value, true ); $html->set_attribute( 'rel', $normalized_rel ); } break; case 'rel': // Normalize rel attribute: lowercase, deduplicate, preserve safe tokens. $rel_value = is_string( $attr_value ) ? $attr_value : null; $normalized_rel = self::normalize_rel_attribute( $rel_value, false ); if ( empty( $normalized_rel ) ) { $html->remove_attribute( $attr_name ); } else { $html->set_attribute( $attr_name, $normalized_rel ); } break; case 'style': // Only allow safe CSS properties for typography and basic styling. $safe_properties = self::get_safe_css_properties(); $sanitized_styles = array(); $style_parts = explode( ';', (string) $attr_value ); foreach ( $style_parts as $style_part ) { $style_part = trim( $style_part ); if ( empty( $style_part ) ) { continue; } $property_parts = explode( ':', $style_part, 2 ); if ( count( $property_parts ) !== 2 ) { continue; } $property = trim( strtolower( $property_parts[0] ) ); $value = trim( $property_parts[1] ); // Only allow safe properties. if ( in_array( $property, $safe_properties, true ) ) { // Use centralized CSS value sanitization. $sanitized_value = self::sanitize_css_value( $value ); if ( ! empty( $sanitized_value ) ) { $sanitized_styles[] = $property . ': ' . $sanitized_value; } } } if ( empty( $sanitized_styles ) ) { $html->remove_attribute( $attr_name ); } else { $html->set_attribute( $attr_name, implode( '; ', $sanitized_styles ) ); } break; case 'class': // Only allow alphanumeric characters, hyphens, and underscores. if ( ! preg_match( '/^[a-zA-Z0-9\s\-_]+$/', (string) $attr_value ) ) { $html->remove_attribute( $attr_name ); } break; case 'data-type': case 'data-id': // Only allow alphanumeric characters, hyphens, and underscores. if ( ! preg_match( '/^[a-zA-Z0-9\-_]+$/', (string) $attr_value ) ) { $html->remove_attribute( $attr_name ); } break; default: // Handle data-* attributes with strict validation. if ( str_starts_with( $attr_name, 'data-' ) ) { if ( ! preg_match( '/^[a-zA-Z0-9\-_]+$/', (string) $attr_value ) ) { $html->remove_attribute( $attr_name ); } break; } // Default deny policy: Remove any attribute not explicitly allowed. $html->remove_attribute( $attr_name ); break; } } /** * Get list of safe CSS properties for typography and basic styling. * * @return array Array of safe CSS property names. */ public static function get_safe_css_properties(): array { return array( 'color', 'background-color', 'font-family', 'font-size', 'font-weight', 'font-style', 'text-decoration', 'text-align', 'line-height', 'letter-spacing', 'text-transform', ); } /** * Get list of safe CSS properties for caption typography (excludes background properties). * * @return array Array of safe CSS property names for captions. */ public static function get_caption_css_properties(): array { return array( 'font-family', 'font-size', 'font-weight', 'font-style', 'text-decoration', 'line-height', 'letter-spacing', 'text-transform', ); } /** * Validate HTML container attributes for security before content extraction. * This method checks if a container element (like figcaption, span) has safe attributes. * * @param string $container_html Full container HTML (e.g., <figcaption class="...">content</figcaption>). * @return bool True if container attributes are safe, false otherwise. */ public static function validate_container_attributes( string $container_html ): bool { // Use WP_HTML_Tag_Processor to validate container attributes. $html = new \WP_HTML_Tag_Processor( $container_html ); if ( ! $html->next_tag() ) { return false; } // Get all attributes and validate each one using our existing validation logic. $attributes = $html->get_attribute_names_with_prefix( '' ); if ( is_array( $attributes ) ) { foreach ( $attributes as $attr_name ) { // Use the same validation logic as validate_caption_attribute for consistency. $attr_value = $html->get_attribute( $attr_name ); if ( null === $attr_value ) { continue; } // Block event handlers immediately. if ( str_starts_with( $attr_name, 'on' ) ) { return false; } // Apply the same validation rules as caption attributes. // Create a temporary processor to test validation. $escaped_value = htmlspecialchars( (string) $attr_value, ENT_QUOTES, 'UTF-8' ); $temp_html = new \WP_HTML_Tag_Processor( '<span ' . $attr_name . '="' . $escaped_value . '">test</span>' ); if ( $temp_html->next_tag() ) { $original_value = $temp_html->get_attribute( $attr_name ); self::validate_caption_attribute( $temp_html, $attr_name ); $validated_value = $temp_html->get_attribute( $attr_name ); // If attribute was removed during validation, container is unsafe. if ( null !== $original_value && null === $validated_value ) { return false; } } } } return true; } /** * Sanitize caption HTML to allow only specific tags and attributes. * * @param string $caption_html Raw caption HTML. * @return string Sanitized caption HTML. */ public static function sanitize_caption_html( string $caption_html ): string { // If no HTML tags, return as-is. if ( false === strpos( $caption_html, '<' ) ) { return $caption_html; } // Remove dangerous content: script, style, and other executable elements. $result = preg_replace( '/<(script|style|iframe|object|embed|form|input|button)\b[^>]*>.*?<\/\1>/is', '', $caption_html ); if ( null === $result ) { $caption_html = ''; } else { $caption_html = $result; } // Use a more conservative approach - only validate attributes, don't modify tags. $allowed_tags = array( 'strong', 'em', 'a', 'mark', 'kbd', 's', 'sub', 'sup', 'span', 'br' ); $html = new \WP_HTML_Tag_Processor( $caption_html ); // First pass: Process attributes for allowed tags only. while ( $html->next_tag() ) { $tag_name = $html->get_tag(); // Skip processing for disallowed tags. if ( ! in_array( $tag_name, $allowed_tags, true ) ) { continue; } // Only process attributes for allowed tags. $attributes = $html->get_attribute_names_with_prefix( '' ); if ( is_array( $attributes ) ) { foreach ( $attributes as $attr_name ) { // Validate and sanitize each attribute individually. self::validate_caption_attribute( $html, $attr_name ); } } } // Second pass: Remove disallowed tags using a simple regex approach. $final_html = $html->get_updated_html(); // Create a regex pattern to match disallowed tags. $allowed_tags_pattern = implode( '|', array_map( 'preg_quote', $allowed_tags ) ); // Remove disallowed opening and closing tags, keeping only their content. $result = preg_replace( '/<(?!(?:' . $allowed_tags_pattern . ')\b)[^>]*>(.*?)<\/(?!(?:' . $allowed_tags_pattern . ')\b)[^>]*>/s', '$1', $final_html ); if ( null === $result ) { $final_html = ''; } else { $final_html = $result; } // Remove disallowed self-closing tags. $result = preg_replace( '/<(?!(?:' . $allowed_tags_pattern . ')\b)[^>]*\/>/s', '', $final_html ); if ( null === $result ) { $final_html = ''; } else { $final_html = $result; } return $final_html; } /** * Sanitize image HTML while preserving necessary attributes for email rendering. * * @param string $image_html Raw image HTML. * @return string Sanitized image HTML. */ public static function sanitize_image_html( string $image_html ): string { // If no HTML tags, return as-is. if ( false === strpos( $image_html, '<' ) ) { return $image_html; } // Extract img tag using regex for reliable processing. if ( ! preg_match( '/<img[^>]*>/i', $image_html, $matches ) ) { return $image_html; } $img_tag = $matches[0]; $sanitized_attributes = array(); $has_src = false; // Extract and sanitize individual attributes using WP_HTML_Tag_Processor for attribute processing. $html = new \WP_HTML_Tag_Processor( $img_tag ); if ( $html->next_tag() ) { $attributes = $html->get_attribute_names_with_prefix( '' ); if ( is_array( $attributes ) ) { foreach ( $attributes as $attr_name ) { $attr_value = $html->get_attribute( $attr_name ); // Sanitize specific attributes. switch ( $attr_name ) { case 'src': // Sanitize image source URL. $sanitized_src = esc_url( (string) $attr_value ); if ( ! empty( $sanitized_src ) ) { $sanitized_attributes[] = $attr_name . '="' . $sanitized_src . '"'; $has_src = true; } break; case 'alt': case 'width': case 'height': // Sanitize text attributes. $sanitized_attributes[] = $attr_name . '="' . esc_attr( (string) $attr_value ) . '"'; break; case 'class': // Clean CSS classes. $cleaned_classes = self::clean_css_classes( (string) $attr_value ); if ( ! empty( $cleaned_classes ) ) { $sanitized_attributes[] = $attr_name . '="' . esc_attr( $cleaned_classes ) . '"'; } break; case 'style': // Sanitize inline styles - only allow safe properties for email rendering. $sanitized_styles = self::sanitize_image_styles( (string) $attr_value ); if ( ! empty( $sanitized_styles ) ) { $sanitized_attributes[] = $attr_name . '="' . esc_attr( $sanitized_styles ) . '"'; } break; } } } } // If no valid src attribute, return empty string. if ( ! $has_src ) { return ''; } // Rebuild the img tag with sanitized attributes. if ( empty( $sanitized_attributes ) ) { return ''; } return '<img ' . implode( ' ', $sanitized_attributes ) . '>'; } /** * Sanitize inline styles for image elements - only allow safe properties for email rendering. * * @param string $style_value Raw style value. * @return string Sanitized style value. */ private static function sanitize_image_styles( string $style_value ): string { $sanitized_styles = array(); $style_parts = explode( ';', $style_value ); foreach ( $style_parts as $style_part ) { $style_part = trim( $style_part ); if ( empty( $style_part ) ) { continue; } $property_parts = explode( ':', $style_part, 2 ); if ( count( $property_parts ) !== 2 ) { continue; } $property = trim( strtolower( $property_parts[0] ) ); $value = trim( $property_parts[1] ); // Allow safe CSS properties for images in email rendering. $safe_properties = array( 'width', 'height', 'max-width', 'max-height', 'display', 'margin', 'padding', 'border', 'border-radius' ); if ( in_array( $property, $safe_properties, true ) ) { $sanitized_value = self::sanitize_css_value( $value ); if ( ! empty( $sanitized_value ) ) { $sanitized_styles[] = $property . ': ' . $sanitized_value; } } } return implode( '; ', $sanitized_styles ); } } email-editor/src/Integrations/Utils/class-dom-document-helper.php 0000777 00000006065 15252010675 0021161 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Utils; /** * This class should guarantee that our work with the DOMDocument is unified and safe. */ class Dom_Document_Helper { /** * Instance of the DOMDocument. * * @var \DOMDocument */ private \DOMDocument $dom; /** * Constructor. * * @param string $html_content The HTML content to load. */ public function __construct( string $html_content ) { $this->load_html( $html_content ); } /** * Loads the given HTML content into the DOMDocument. * * @param string $html_content The HTML content to load. */ private function load_html( string $html_content ): void { libxml_use_internal_errors( true ); $this->dom = new \DOMDocument(); if ( ! empty( $html_content ) ) { // prefixing the content with the XML declaration to force the input encoding to UTF-8. $this->dom->loadHTML( '<?xml encoding="UTF-8">' . $html_content, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD ); } libxml_clear_errors(); } /** * Searches for the first appearance of the given tag name. * * @param string $tag_name The tag name to search for. */ public function find_element( string $tag_name ): ?\DOMElement { $elements = $this->dom->getElementsByTagName( $tag_name ); return $elements->item( 0 ) ? $elements->item( 0 ) : null; } /** * Returns the value of the given attribute from the given element. * * @param \DOMElement $element The element to get the attribute value from. * @param string $attribute The attribute to get the value from. */ public function get_attribute_value( \DOMElement $element, string $attribute ): string { return $element->hasAttribute( $attribute ) ? $element->getAttribute( $attribute ) : ''; } /** * Searches for the first appearance of the given tag name and returns the value of specified attribute. * * @param string $tag_name The tag name to search for. * @param string $attribute The attribute to get the value from. */ public function get_attribute_value_by_tag_name( string $tag_name, string $attribute ): ?string { $element = $this->find_element( $tag_name ); if ( ! $element ) { return null; } return $this->get_attribute_value( $element, $attribute ); } /** * Returns the outer HTML of the given element. * * @param \DOMElement $element The element to get the outer HTML from. */ public function get_outer_html( \DOMElement $element ): string { return (string) $this->dom->saveHTML( $element ); } /** * Returns the inner HTML of the given element. * * @param \DOMElement $element The element to get the inner HTML from. */ public function get_element_inner_html( \DOMElement $element ): string { $inner_html = ''; $children = $element->childNodes; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase foreach ( $children as $child ) { $inner_html .= $this->dom->saveHTML( $child ); } return $inner_html; } } email-editor/src/Integrations/Utils/class-styles-helper.php 0000777 00000030163 15252010675 0020105 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Utils; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use WP_Style_Engine; /** * This class should guarantee that our work with the DOMDocument is unified and safe. */ class Styles_Helper { /** * Default empty styles block structure. * * @var array */ public static $empty_block_styles = array( 'css' => '', 'declarations' => array(), 'classnames' => '', ); /** * Parse number value from a string. * * @param string|float|int $value String with value and unit or integer value. * @return float */ public static function parse_value( $value ): float { // Handle numeric values. if ( is_numeric( $value ) ) { return (float) $value; } // Handle string values. if ( is_string( $value ) ) { if ( preg_match( '/^\s*(-?\d+(?:\.\d+)?)/', $value, $m ) ) { return (float) $m[1]; } } return 0.0; } /** * Parse styles string to array. * * @param string $styles Styles string. * @return array */ public static function parse_styles_to_array( string $styles ): array { $styles = explode( ';', $styles ); $parsed_styles = array(); foreach ( $styles as $style ) { $style = explode( ':', $style, 2 ); if ( count( $style ) === 2 ) { $parsed_styles[ trim( $style[0] ) ] = trim( $style[1] ); } } return $parsed_styles; } /** * Get normalized block styles by translating color slugs to actual color values. * * This method handles the normalization of color-related attributes like backgroundColor, * textColor, borderColor, and linkColor by translating them from slugs to actual color values * using the rendering context. * * @param array $block_attributes Block attributes containing color slugs. * @param Rendering_Context $rendering_context Rendering context for color translation. * @return array Normalized block styles with translated color values. */ public static function get_normalized_block_styles( array $block_attributes, Rendering_Context $rendering_context ): array { $normalized_colors = array_filter( array( 'color' => array_filter( array( 'background' => isset( $block_attributes['backgroundColor'] ) && $block_attributes['backgroundColor'] ? $rendering_context->translate_slug_to_color( $block_attributes['backgroundColor'] ) : null, 'text' => isset( $block_attributes['textColor'] ) && $block_attributes['textColor'] ? $rendering_context->translate_slug_to_color( $block_attributes['textColor'] ) : null, ) ), 'border' => array_filter( array( 'color' => isset( $block_attributes['borderColor'] ) && $block_attributes['borderColor'] ? $rendering_context->translate_slug_to_color( $block_attributes['borderColor'] ) : null, ) ), ) ); return array_replace_recursive( $normalized_colors, $block_attributes['style'] ?? array() ); } /** * Wrapper for wp_style_engine_get_styles which ensures all values are returned. * * @param array $block_styles Array of block styles. * @param bool $skip_convert_vars If true, --wp_preset--spacing--x type values will be left in the original var:preset:spacing:x format. * @return array { * @type string $css A CSS ruleset or declarations block * formatted to be placed in an HTML `style` attribute or tag. * @type string[] $declarations An associative array of CSS definitions, * e.g. `array( "$property" => "$value", "$property" => "$value" )`. * @type string $classnames Classnames separated by a space. * } */ public static function get_styles_from_block( array $block_styles, $skip_convert_vars = false ) { return wp_parse_args( wp_style_engine_get_styles( $block_styles, array( 'convert_vars_to_classnames' => $skip_convert_vars ) ), self::$empty_block_styles ); } /** * Extend block styles with CSS declarations. * * @param array $block_styles WP_Style_Engine styles array (must contain 'declarations' and 'css' keys). * @param array $css_declarations An associative array of CSS definitions, * e.g. `array( "$property" => "$value", "$property" => "$value" )`. * @return array { * @type string $css A CSS ruleset or declarations block * formatted to be placed in an HTML `style` attribute or tag. * @type string[] $declarations An associative array of CSS definitions, * e.g. `array( "$property" => "$value", "$property" => "$value" )`. * @type string $classnames Classnames separated by a space. * } */ public static function extend_block_styles( array $block_styles, array $css_declarations ) { // Ensure block_styles has the required WP_Style_Engine structure. if ( ! isset( $block_styles['declarations'] ) || ! is_array( $block_styles['declarations'] ) ) { $block_styles = self::$empty_block_styles; } $block_styles['declarations'] = array_merge( $block_styles['declarations'], $css_declarations ); $block_styles['css'] = WP_Style_Engine::compile_css( $block_styles['declarations'], '' ); return $block_styles; } /** * Get block styles. * * @param array $block_attributes Block attributes. * @param Rendering_Context $rendering_context Rendering context. * @param array $properties List of style properties to include. Supported values: * 'spacing', 'padding', 'margin', * 'border', 'border-width', 'border-style', 'border-radius', 'border-color', * 'background', 'background-color', 'color', * 'typography', 'font-size', 'font-family', 'font-weight', 'text-align'. * @return array { * @type string $css A CSS ruleset or declarations block * formatted to be placed in an HTML `style` attribute or tag. * @type string[] $declarations An associative array of CSS definitions, * e.g. `array( "$property" => "$value", "$property" => "$value" )`. * @type string $classnames Classnames separated by a space. * } */ public static function get_block_styles( array $block_attributes, Rendering_Context $rendering_context, array $properties ) { $styles = self::get_normalized_block_styles( $block_attributes, $rendering_context ); $filtered_styles = array(); $style_mappings = array( 'spacing' => array( 'spacing' ), 'padding' => array( 'spacing', 'padding' ), 'margin' => array( 'spacing', 'margin' ), 'border' => array( 'border' ), 'border-width' => array( 'border', 'width' ), 'border-style' => array( 'border', 'style' ), 'border-radius' => array( 'border', 'radius' ), 'border-color' => array( 'border', 'color' ), 'background' => array( 'background' ), 'background-color' => array( 'color', 'background' ), 'color' => array( 'color', 'text' ), 'typography' => array( 'typography' ), 'font-size' => array( 'typography', 'fontSize' ), 'font-family' => array( 'typography', 'fontFamily' ), 'font-weight' => array( 'typography', 'fontWeight' ), ); foreach ( $properties as $property ) { if ( ! isset( $style_mappings[ $property ] ) ) { continue; } $style_pointer = $styles; foreach ( $style_mappings[ $property ] as $path_segment ) { if ( ! isset( $style_pointer[ $path_segment ] ) ) { continue 2; } $style_pointer = $style_pointer[ $path_segment ]; } /** * Pointer to filtered styles. * * @var array<string, mixed> $filtered_styles_pointer */ $filtered_styles_pointer = & $filtered_styles; foreach ( $style_mappings[ $property ] as $path_index => $path_segment ) { if ( count( $style_mappings[ $property ] ) - 1 === $path_index ) { $filtered_styles_pointer[ $path_segment ] = $style_pointer; break; } if ( ! isset( $filtered_styles_pointer[ $path_segment ] ) || ! is_array( $filtered_styles_pointer[ $path_segment ] ) ) { $filtered_styles_pointer[ $path_segment ] = array(); } $filtered_styles_pointer = & $filtered_styles_pointer[ $path_segment ]; } } $additional_css_declarations = array_filter( array_intersect_key( array( 'text-align' => $block_attributes['textAlign'] ?? null, ), array_flip( $properties ) ) ); $styles = count( $filtered_styles ) > 0 ? self::get_styles_from_block( $filtered_styles ) : self::$empty_block_styles; return self::extend_block_styles( $styles, $additional_css_declarations ); } /** * Convert a CSS value to a static px value for email clients. * * This is mostly for use in font size, spacing, etc. * * @param string $input The CSS value to convert. * @param bool $use_fallback Whether to use the fallback value if the input is not a valid CSS value. * @param ?int $base_font_size The base font size to use for conversion. * @return ?string The static pixel value (e.g., 30px). */ public static function convert_to_px( string $input, bool $use_fallback = true, ?int $base_font_size = 16 ): ?string { $fallback = $use_fallback ? $base_font_size . 'px' : null; if ( ! $input ) { return $fallback; } $input = trim( $input ); // Validate input against potentially malicious values. if ( preg_match( '/[<>"\']/', $input ) ) { return $fallback; } if ( str_ends_with( $input, 'px' ) ) { // If already in px, return as is. return $input; } if ( str_ends_with( $input, 'rem' ) || str_ends_with( $input, 'em' ) ) { // Convert rem/em to px (assuming 16px base). $value = (float) str_replace( array( 'rem', 'em' ), '', $input ); return round( $value * $base_font_size ) . 'px'; } if ( str_ends_with( $input, '%' ) ) { // Convert percentage to px (assuming 16px base). $value = (float) str_replace( '%', '', $input ); return round( ( $value / 100 ) * $base_font_size ) . 'px'; } if ( is_numeric( $input ) ) { // If it's just a number, assume px. return $input . 'px'; } return $fallback; } /** * Remove the CSS unit from a string. * * @param string $input The string to remove the unit from. * @return string The string without the unit. */ public static function remove_css_unit( string $input ): string { $units = array( 'px', 'pt', 'pc', 'rem', 'em', 'vmin', 'vmax', '%', 'vh', 'vw', 'ex', 'ch', 'fr' ); return str_ireplace( $units, '', $input ); } /** * Convert a CSS clamp() value to a static px value for email clients. * * @param string $clamp_str The clamp() CSS string (e.g., "clamp(30px, 5vw, 50px)"). * @param string $strategy "min"|"max"|"avg" — which strategy to use. * @return ?string The static pixel value (e.g., 30px). */ public static function clamp_to_static_px( $clamp_str, $strategy = 'min' ): ?string { if ( stripos( $clamp_str, 'clamp(' ) === false ) { return $clamp_str; } $value_array = explode( ',', $clamp_str ); if ( count( $value_array ) < 2 ) { return $clamp_str; // Invalid clamp format. } $first_element = $value_array[0]; $min = trim( str_ireplace( array( 'clamp(', 'min(', 'max(' ), '', $first_element ) ); $last_element = $value_array[ count( $value_array ) - 1 ]; $max = trim( rtrim( $last_element, ')' ) ); $min_px = self::convert_to_px( $min, false ); $max_px = self::convert_to_px( $max, false ); // Determine which value to use. if ( 'min' === $strategy && ! is_null( $min_px ) ) { return $min_px; } if ( 'max' === $strategy && ! is_null( $max_px ) ) { return $max_px; } if ( 'avg' === $strategy && ! is_null( $min_px ) && ! is_null( $max_px ) ) { $avg = ( self::parse_value( $min_px ) + self::parse_value( $max_px ) ) / 2; return $avg . 'px'; } // Default. return $min_px ?? $max_px ?? $clamp_str; } } email-editor/src/Integrations/Utils/class-social-links-helper.php 0000777 00000010212 15252010675 0021143 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Integrations\Utils; /** * This class should provide helper functions for the Social Links block. */ class Social_Links_Helper { /** * Detects if the input color is whiteish. * This is a helper function to detect if the input color is white or white-ish colors when * provided an input color in format #ffffff or #fff. * * @param string $input_color The input color. * @return bool True if the color is whiteish, false otherwise. */ public static function detect_whiteish_color( $input_color ) { if ( empty( $input_color ) ) { return false; } // Remove # if present. $color = ltrim( $input_color, '#' ); // Convert 3-digit hex to 6-digit hex. if ( strlen( $color ) === 3 ) { $color = $color[0] . $color[0] . $color[1] . $color[1] . $color[2] . $color[2]; } // Convert hex to RGB. $r = hexdec( substr( $color, 0, 2 ) ); $g = hexdec( substr( $color, 2, 2 ) ); $b = hexdec( substr( $color, 4, 2 ) ); // Calculate brightness using perceived brightness formula. // Using the formula: (0.299*R + 0.587*G + 0.114*B). $brightness = ( 0.299 * $r + 0.587 * $g + 0.114 * $b ); // Consider colors with brightness above 240 as whiteish. // This threshold can be adjusted based on requirements. return $brightness > 240; } /** * Gets the brand color for a given service. * * From core: https://github.com/WordPress/gutenberg/blob/edbd36057d3d25b7140af9e90a2adcca02a9201c/packages/block-library/src/social-link/socials-without-bg.scss * * @param string $service_name The name of the service. * @return string The brand color for the service. */ public static function get_service_brand_color( $service_name ) { $service_brand_color = array( 'amazon' => '#f90', 'bandcamp' => '#1ea0c3', 'behance' => '#0757fe', 'bluesky' => '#0a7aff', 'codepen' => '#1e1f26', 'deviantart' => '#02e49b', 'discord' => '#5865f2', 'dribbble' => '#e94c89', 'dropbox' => '#4280ff', 'etsy' => '#f45800', 'facebook' => '#0866ff', 'fivehundredpx' => '#000', 'flickr' => '#0461dd', 'foursquare' => '#e65678', 'github' => '#24292d', 'goodreads' => '#382110', 'google' => '#ea4434', 'gravatar' => '#1d4fc4', 'instagram' => '#f00075', 'lastfm' => '#e21b24', 'linkedin' => '#0d66c2', 'mastodon' => '#3288d4', 'medium' => '#000', 'meetup' => '#f6405f', 'patreon' => '#000', 'pinterest' => '#e60122', 'pocket' => '#ef4155', 'reddit' => '#ff4500', 'skype' => '#0478d7', 'snapchat' => '#fff', 'soundcloud' => '#ff5600', 'spotify' => '#1bd760', 'telegram' => '#2aabee', 'threads' => '#000', 'tiktok' => '#000', 'tumblr' => '#011835', 'twitch' => '#6440a4', 'twitter' => '#1da1f2', 'vimeo' => '#1eb7ea', 'vk' => '#4680c2', 'whatsapp' => '#25d366', 'wordpress' => '#3499cd', 'x' => '#000', 'yelp' => '#d32422', 'youtube' => '#f00', ); return $service_brand_color[ $service_name ] ?? ''; } /** * Gets the default social link size. * * @return string The default social link size. */ public static function get_default_social_link_size() { return 'has-normal-icon-size'; } /** * Gets the size option value for a given size. * Source: https://github.com/WordPress/gutenberg/blob/c7c09cfe16c78f9a949956e5d0088cd4c747bdca/packages/block-library/src/social-links/style.scss#L36-L56 * * @param string $size The size. * @return string The size option value. */ public static function get_social_link_size_option_value( $size ) { $options = array( 'has-small-icon-size' => '16px', 'has-normal-icon-size' => '24px', 'has-large-icon-size' => '36px', 'has-huge-icon-size' => '48px', ); return $options[ $size ] ?? '24px'; // default to normal size. } } email-editor/src/Engine/class-email-api-controller.php 0000777 00000011032 15252010675 0016755 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine; use Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags\Personalization_Tag; use Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags\Personalization_Tags_Registry; use Automattic\WooCommerce\EmailEditor\Validator\Builder; use WP_Post; use WP_REST_Request; use WP_REST_Response; /** * Class for email API controller. */ class Email_Api_Controller { /** * Personalization tags registry to get all personalization tags. * * @var Personalization_Tags_Registry */ private Personalization_Tags_Registry $personalization_tags_registry; /** * Email_Api_Controller constructor with all dependencies. * * @param Personalization_Tags_Registry $personalization_tags_registry Personalization tags registry. */ public function __construct( Personalization_Tags_Registry $personalization_tags_registry ) { $this->personalization_tags_registry = $personalization_tags_registry; } /** * Returns email specific data. * * @return array - Email specific data such styles. */ public function get_email_data(): array { // Here comes code getting Email specific data that will be passed on 'email_data' attribute. return array(); } /** * Update Email specific data we store. * * @param array $data - Email specific data. * @param WP_Post $email_post - Email post object. */ public function save_email_data( array $data, WP_Post $email_post ): void { // Here comes code saving of Email specific data that will be passed on 'email_data' attribute. } /** * Sends preview email. * * @param WP_REST_Request $request Route request parameters. * @return WP_REST_Response * @phpstan-param WP_REST_Request<array{_locale: string, email: string, postId: int}> $request */ public function send_preview_email_data( WP_REST_Request $request ): WP_REST_Response { /** * $data - Post Data * format * [_locale] => user * [email] => Provided email address * [postId] => POST_ID * * @var array{_locale: string, email: string, postId: int} $data */ $data = $request->get_params(); try { $result = apply_filters( 'woocommerce_email_editor_send_preview_email', $data ); return new WP_REST_Response( array( 'success' => (bool) $result, 'result' => $result, ), $result ? 200 : 400 ); } catch ( \Exception $exception ) { return new WP_REST_Response( array( 'error' => $exception->getMessage() ), 400 ); } } /** * Returns all registered personalization tags. * We need to keep this endpoint for backward compatibility for older JS clients. * We might consider removing it in the future (perhaps in late 2026). * * @deprecated Use get_personalization_tags_collection instead. * @return WP_REST_Response */ public function get_personalization_tags(): WP_REST_Response { $tags = $this->personalization_tags_registry->get_all(); return new WP_REST_Response( array( 'success' => true, 'result' => array_values( array_map( function ( Personalization_Tag $tag ) { return array( 'name' => $tag->get_name(), 'token' => $tag->get_token(), 'category' => $tag->get_category(), 'attributes' => $tag->get_attributes(), 'valueToInsert' => $tag->get_value_to_insert(), 'postTypes' => $tag->get_post_types(), ); }, $tags ), ), ), 200 ); } /** * Returns all registered personalization tags as a collection. * This endpoint follows WordPress REST API conventions by returning * the array directly instead of wrapping it in a response object. * * @return WP_REST_Response */ public function get_personalization_tags_collection(): WP_REST_Response { $tags = $this->personalization_tags_registry->get_all(); return new WP_REST_Response( array_values( array_map( function ( Personalization_Tag $tag ) { return array( 'name' => $tag->get_name(), 'token' => $tag->get_token(), 'category' => $tag->get_category(), 'attributes' => $tag->get_attributes(), 'valueToInsert' => $tag->get_value_to_insert(), 'postTypes' => $tag->get_post_types(), ); }, $tags ) ), 200 ); } /** * Returns the schema for email data. * * @return array */ public function get_email_data_schema(): array { return Builder::object()->to_array(); } } email-editor/src/Engine/Templates/class-templates-registry.php 0000777 00000004514 15252010675 0020547 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Templates; /** * Registry for email templates. */ class Templates_Registry { /** * List of registered templates. * * @var Template[] */ private $templates = array(); /** * Initialize the template registry. * This method should be called only once. * * @return void */ public function initialize(): void { apply_filters( 'woocommerce_email_editor_register_templates', $this ); } /** * Register a template instance in the registry. * * @param Template $template The template to register. * @return void */ public function register( Template $template ): void { if ( ! \WP_Block_Templates_Registry::get_instance()->is_registered( $template->get_name() ) ) { // skip registration if the template was already registered. $result = register_block_template( $template->get_name(), array( 'title' => $template->get_title(), 'description' => $template->get_description(), 'content' => $template->get_content(), 'post_types' => $template->get_post_types(), ) ); $this->templates[ $template->get_name() ] = $template; } } /** * Retrieve a template by its name. * Example: get_by_name( 'woocommerce//email-general' ) will return the instance of Template with identical name. * * @param string $name The name of the template. * @return Template|null The template object or null if not found. */ public function get_by_name( string $name ): ?Template { return $this->templates[ $name ] ?? null; } /** * Retrieve a template by its slug. * Example: get_by_slug( 'email-general' ) will return the instance of Template with identical slug. * * @param string $slug The slug of the template. * @return Template|null The template object or null if not found. */ public function get_by_slug( string $slug ): ?Template { foreach ( $this->templates as $template ) { if ( $template->get_slug() === $slug ) { return $template; } } return null; } /** * Retrieve all registered templates. * * @return array List of all registered templates. */ public function get_all() { return $this->templates; } } email-editor/src/Engine/Templates/single-email-post-template.php 0000777 00000000641 15252010675 0020737 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * Template canvas file to render the emails custom post type. * * @package Automattic\WooCommerce\EmailEditor */ // get the rendered post HTML content. $template_html = apply_filters( 'woocommerce_email_editor_preview_post_template_html', get_post() ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped echo $template_html; email-editor/src/Engine/Templates/email-general.html 0000777 00000000307 15252010675 0016453 0 ustar 00 <!-- wp:group {"layout":{"type":"constrained"}} --> <div class="wp-block-group"> <!-- wp:post-content {"lock":{"move":true,"remove":true},"layout":{"type":"default"}} /--> </div> <!-- /wp:group --> email-editor/src/Engine/Templates/class-template.php 0000777 00000005417 15252010675 0016521 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Templates; /** * The class represents a template */ class Template { /** * Plugin uri used in the template name. * * @var string $plugin_uri */ private string $plugin_uri; /** * The template slug used in the template name. * * @var string $slug */ private string $slug; /** * The template name used for block template registration. * * @var string $name */ private string $name; /** * The template title. * * @var string $title */ private string $title; /** * The template description. * * @var string $description */ private string $description; /** * The template content. * * @var string $content */ private string $content; /** * The list of supoorted post types. * * @var string[] */ private array $post_types; /** * Constructor of the class. * * @param string $plugin_uri The plugin uri. * @param string $slug The template slug. * @param string $title The template title. * @param string $description The template description. * @param string $content The template content. * @param string[] $post_types The list of post types supported by the template. */ public function __construct( string $plugin_uri, string $slug, string $title, string $description, string $content, array $post_types = array() ) { $this->plugin_uri = $plugin_uri; $this->slug = $slug; $this->name = "{$plugin_uri}//{$slug}"; // The template name is composed from the namespace and the slug. $this->title = $title; $this->description = $description; $this->content = $content; $this->post_types = $post_types; } /** * Get the plugin uri. * * @return string */ public function get_pluginuri(): string { return $this->plugin_uri; } /** * Get the template slug. * * @return string */ public function get_slug(): string { return $this->slug; } /** * Get the template name composed from the plugin_uri and the slug. * * @return string */ public function get_name(): string { return $this->name; } /** * Get the template title. * * @return string */ public function get_title(): string { return $this->title; } /** * Get the template description. * * @return string */ public function get_description(): string { return $this->description; } /** * Get the template content. * * @return string */ public function get_content(): string { return $this->content; } /** * Get the list of supported post types. * * @return string[] */ public function get_post_types(): array { return $this->post_types; } } email-editor/src/Engine/Templates/class-templates.php 0000777 00000013210 15252010675 0016672 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Templates; use Automattic\WooCommerce\EmailEditor\Validator\Builder; use WP_Block_Template; /** * Templates class. */ class Templates { /** * The plugin slug. * * @var string $plugin_slug */ private string $template_prefix = 'woocommerce'; /** * The post type. * * @var string[] $post_type */ private array $post_types = array(); /** * The template directory. * * @var string $template_directory */ private string $template_directory = __DIR__ . DIRECTORY_SEPARATOR; /** * The templates registry. * * @var Templates_Registry $templates_registry */ private Templates_Registry $templates_registry; /** * Constructor of the class. * * @param Templates_Registry $templates_registry The templates registry. */ public function __construct( Templates_Registry $templates_registry ) { $this->templates_registry = $templates_registry; } /** * Initializes the class. * * @param string[] $post_types The list of post types registered for usage with email editor. */ public function initialize( array $post_types ): void { $this->post_types = $post_types; add_filter( 'theme_templates', array( $this, 'add_theme_templates' ), 10, 4 ); // Workaround needed when saving post – template association. add_filter( 'woocommerce_email_editor_register_templates', array( $this, 'register_templates' ) ); $this->templates_registry->initialize(); $this->register_post_types_to_api(); } /** * Get a block template by ID. * * @param string $template_slug The template slug. * @return WP_Block_Template|null */ public function get_block_template( $template_slug ) { // Template id is always prefixed by active theme and get_stylesheet returns the active theme slug. $template_id = get_stylesheet() . '//' . $template_slug; return get_block_template( $template_id ); } /** * Register the templates via register_block_template * * @param Templates_Registry $templates_registry The templates registry. */ public function register_templates( Templates_Registry $templates_registry ): Templates_Registry { // Register basic blank template. $general_email_slug = 'email-general'; $template_filename = $general_email_slug . '.html'; $general_email = new Template( $this->template_prefix, $general_email_slug, __( 'General Email', 'woocommerce' ), __( 'A general template for emails.', 'woocommerce' ), (string) file_get_contents( $this->template_directory . $template_filename ), $this->post_types ); $templates_registry->register( $general_email ); return $templates_registry; } /** * Register post_types property to the templates rest api response. * * There is a PR that adds the property into the core https://github.com/WordPress/wordpress-develop/pull/7530 * Until it is merged, we need to add it manually. */ public function register_post_types_to_api(): void { $controller = new \WP_REST_Templates_Controller( 'wp_template' ); $schema = $controller->get_item_schema(); // Future compatibility check if the post_types property is already registered. if ( isset( $schema['properties']['post_types'] ) ) { return; } register_rest_field( 'wp_template', 'post_types', array( 'get_callback' => array( $this, 'get_post_types' ), 'update_callback' => null, 'schema' => Builder::string()->to_array(), ) ); } /** * This is a callback function for adding post_types property to templates rest api response. * * @param array $response_object The rest API response object. * @return array */ public function get_post_types( $response_object ): array { $template = $this->templates_registry->get_by_slug( $response_object['slug'] ?? '' ); if ( $template ) { return $template->get_post_types(); } return $response_object['post_types'] ?? array(); } /** * This is need to enable saving post – template association. * When a theme doesn't support block_templates feature the association is not saved, because templates registered via register_block_template are not added to the list of available templates. * https://github.com/WordPress/wordpress-develop/blob/cdc2f255acce57372b849d6278c4156e1056c749/src/wp-includes/class-wp-theme.php#L1355 * * This function ensures that the email templates are in the list which is used for checking if the template can be saved in the association. * See https://github.com/WordPress/wordpress-develop/blob/cdc2f255acce57372b849d6278c4156e1056c749/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php#L1595-L1599 * * @param array $templates The templates. * @param string $theme The theme. * @param \WP_Post $post The post. * @param string $post_type The post type. * @return array */ public function add_theme_templates( $templates, $theme, $post, $post_type ) { if ( $post_type && ! in_array( $post_type, $this->post_types, true ) ) { return $templates; } $block_templates = get_block_templates(); $email_templates_slugs = array_map( function ( Template $template ) { return $template->get_slug(); }, $this->templates_registry->get_all() ); foreach ( $block_templates as $block_template ) { if ( ! in_array( $block_template->slug, $email_templates_slugs, true ) ) { continue; } if ( isset( $templates[ $block_template->slug ] ) ) { continue; } $templates[ $block_template->slug ] = $block_template->title; // Requires only the template title, not the full template object. } return $templates; } } email-editor/src/Engine/class-email-editor.php 0000777 00000030164 15252010675 0015320 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine; use Automattic\WooCommerce\EmailEditor\Engine\Patterns\Patterns; use Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags\Personalization_Tags_Registry; use Automattic\WooCommerce\EmailEditor\Engine\Templates\Templates; use Automattic\WooCommerce\EmailEditor\Engine\Logger\Email_Editor_Logger; use WP_Post; use WP_Theme_JSON; /** * Email editor class. * * @phpstan-type EmailPostType array{name: string, args: array, meta: array{key: string, args: array}[]} * See register_post_type for details about EmailPostType args. */ class Email_Editor { public const WOOCOMMERCE_EMAIL_META_THEME_TYPE = 'woocommerce_email_theme'; /** * Property for the email API controller. * * @var Email_Api_Controller Email API controller. */ private Email_Api_Controller $email_api_controller; /** * Property for the templates. * * @var Templates Templates. */ private Templates $templates; /** * Property for the patterns. * * @var Patterns Patterns. */ private Patterns $patterns; /** * Property for the send preview email controller. * * @var Send_Preview_Email Send Preview controller. */ private Send_Preview_Email $send_preview_email; /** * Property for Personalization_Tags_Controller that allows initializing personalization tags. * * @var Personalization_Tags_Registry Personalization tags registry. */ private Personalization_Tags_Registry $personalization_tags_registry; /** * Property for the logger. * * @var Email_Editor_Logger Logger instance. */ private Email_Editor_Logger $logger; /** * Property for Assets Manager that should be initialized. * * @var Assets_Manager Assets manager instance. */ private Assets_Manager $assets_manager; /** * Constructor. * * @param Email_Api_Controller $email_api_controller Email API controller. * @param Templates $templates Templates. * @param Patterns $patterns Patterns. * @param Send_Preview_Email $send_preview_email Preview email controller. * @param Personalization_Tags_Registry $personalization_tags_controller Personalization tags registry that allows initializing personalization tags. * @param Email_Editor_Logger $logger Logger instance. * @param Assets_Manager $assets_manager Assets manager instance. */ public function __construct( Email_Api_Controller $email_api_controller, Templates $templates, Patterns $patterns, Send_Preview_Email $send_preview_email, Personalization_Tags_Registry $personalization_tags_controller, Email_Editor_Logger $logger, Assets_Manager $assets_manager ) { $this->email_api_controller = $email_api_controller; $this->templates = $templates; $this->patterns = $patterns; $this->send_preview_email = $send_preview_email; $this->personalization_tags_registry = $personalization_tags_controller; $this->logger = $logger; $this->assets_manager = $assets_manager; } /** * Initialize the email editor. * * @return void */ public function initialize(): void { $this->logger->info( 'Initializing email editor' ); do_action( 'woocommerce_email_editor_initialized' ); add_filter( 'woocommerce_email_editor_rendering_theme_styles', array( $this, 'extend_email_theme_styles' ), 10, 2 ); $this->register_block_patterns(); $this->register_email_post_types(); $this->register_block_templates(); $this->register_email_post_sent_status(); $this->register_personalization_tags(); $is_editor_page = apply_filters( 'woocommerce_is_email_editor_page', false ); if ( $is_editor_page ) { $this->extend_email_post_api(); // Initialize the assets manager. $this->assets_manager->initialize(); } add_action( 'rest_api_init', array( $this, 'register_email_editor_api_routes' ) ); add_filter( 'woocommerce_email_editor_send_preview_email', array( $this->send_preview_email, 'send_preview_email' ), 11, 1 ); // allow for other filter methods to take precedent. add_filter( 'single_template', array( $this, 'load_email_preview_template' ) ); add_filter( 'preview_post_link', array( $this, 'update_preview_post_link' ), 10, 2 ); $this->logger->info( 'Email editor initialized successfully' ); } /** * Register block templates. * * @return void */ private function register_block_templates(): void { // Since we cannot currently disable blocks in the editor for specific templates, disable templates when viewing site editor. @see https://github.com/WordPress/gutenberg/issues/41062. $request_uri = ''; if ( isset( $_SERVER['REQUEST_URI'] ) && is_string( $_SERVER['REQUEST_URI'] ) ) { $request_uri = sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ) ); } if ( strstr( $request_uri, 'site-editor.php' ) === false ) { $post_types = array_column( $this->get_post_types(), 'name' ); $this->templates->initialize( $post_types ); } } /** * Register block patterns. * * @return void */ private function register_block_patterns(): void { $this->patterns->initialize(); } /** * Register all custom post types that should be edited via the email editor * The post types are added via woocommerce_email_editor_post_types filter. * * @return void */ private function register_email_post_types(): void { foreach ( $this->get_post_types() as $post_type ) { register_post_type( $post_type['name'], array_merge( $this->get_default_email_post_args(), $post_type['args'] ) ); } } /** * Register all personalization tags registered via * the woocommerce_email_editor_register_personalization_tags filter. * * @return void */ private function register_personalization_tags(): void { $this->personalization_tags_registry->initialize(); } /** * Returns the email post types. * * @return array * @phpstan-return EmailPostType[] */ private function get_post_types(): array { $post_types = array(); return apply_filters( 'woocommerce_email_editor_post_types', $post_types ); } /** * Returns the default arguments for email post types. * * @return array */ private function get_default_email_post_args(): array { return array( 'public' => false, 'hierarchical' => false, 'show_ui' => true, 'show_in_menu' => false, 'show_in_nav_menus' => false, 'supports' => array( 'editor' => array( 'default-mode' => 'template-locked', ), 'title', 'custom-fields', ), // 'custom-fields' is required for loading meta fields via API. 'has_archive' => true, 'show_in_rest' => true, // Important to enable Gutenberg editor. 'default_rendering_mode' => 'template-locked', 'publicly_queryable' => true, // required by the preview in new tab feature. ); } /** * Register the 'sent' post status for emails. * * @return void */ private function register_email_post_sent_status(): void { $default_args = array( 'public' => false, 'exclude_from_search' => true, 'internal' => true, // for now, we hide it, if we use the status in the listings we may flip this and following values. 'show_in_admin_all_list' => false, 'show_in_admin_status_list' => false, 'private' => true, // required by the preview in new tab feature for sent post (newsletter). Posts are only visible to site admins and editors. ); $args = apply_filters( 'woocommerce_email_editor_post_sent_status_args', $default_args ); register_post_status( 'sent', $args ); } /** * Extends the email post types with email specific data. * * @return void */ public function extend_email_post_api() { $email_post_types = array_column( $this->get_post_types(), 'name' ); register_rest_field( $email_post_types, 'email_data', array( 'get_callback' => array( $this->email_api_controller, 'get_email_data' ), 'update_callback' => array( $this->email_api_controller, 'save_email_data' ), 'schema' => $this->email_api_controller->get_email_data_schema(), ) ); } /** * Registers the API route endpoint for the email editor * * @return void */ public function register_email_editor_api_routes() { register_rest_route( 'woocommerce-email-editor/v1', '/send_preview_email', array( 'methods' => 'POST', 'callback' => array( $this->email_api_controller, 'send_preview_email_data' ), 'permission_callback' => function () { return current_user_can( 'edit_posts' ); }, ) ); register_rest_route( 'woocommerce-email-editor/v1', '/get_personalization_tags', array( 'methods' => 'GET', 'callback' => array( $this->email_api_controller, 'get_personalization_tags' ), 'permission_callback' => function () { return current_user_can( 'edit_posts' ); }, ) ); register_rest_route( 'woocommerce-email-editor/v1', '/personalization_tags', array( 'methods' => 'GET', 'callback' => array( $this->email_api_controller, 'get_personalization_tags_collection' ), 'permission_callback' => function () { return current_user_can( 'edit_posts' ); }, ) ); } /** * Extends the email theme styles with the email specific styles. * * @param WP_Theme_JSON $theme Email theme styles. * @param WP_Post $post Email post object. * @return WP_Theme_JSON */ public function extend_email_theme_styles( WP_Theme_JSON $theme, WP_Post $post ): WP_Theme_JSON { $email_theme = get_post_meta( $post->ID, self::WOOCOMMERCE_EMAIL_META_THEME_TYPE, true ); if ( $email_theme && is_array( $email_theme ) ) { $theme->merge( new WP_Theme_JSON( $email_theme ) ); } return $theme; } /** * Get the current post object * * @return array|mixed|WP_Post|null */ public function get_current_post() { if ( isset( $_GET['post'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended $post_id = 0; if ( is_string( $_GET['post'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- data valid $post_id = intval( $_GET['post'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- data valid } $current_post = get_post( $post_id ); } else { $current_post = $GLOBALS['post']; } return $current_post; } /** * Check if the current post type is an email post type. * * @param string $current_post_type The current post type. * @return bool */ private function current_post_is_email_post_type( $current_post_type ): bool { if ( ! $current_post_type ) { return false; } $email_post_types = array_column( $this->get_post_types(), 'name' ); return in_array( $current_post_type, $email_post_types, true ); } /** * Use a custom page template for the email editor frontend rendering. * * @param string $template post template. * @return string */ public function load_email_preview_template( $template ) { $post = $this->get_current_post(); if ( ! $post instanceof \WP_Post ) { return $template; } if ( ! $this->current_post_is_email_post_type( $post->post_type ) ) { return $template; } add_filter( 'woocommerce_email_editor_preview_post_template_html', function () use ( $post ) { // Generate HTML content for email editor post. return $this->send_preview_email->render_html( $post ); } ); return __DIR__ . '/Templates/single-email-post-template.php'; } /** * Update the preview post link to remove the preview nonce. * * @param string $preview_link The preview post link. * @param WP_Post $post The post object. * @return string */ public function update_preview_post_link( $preview_link, $post ) { if ( ! $post instanceof \WP_Post ) { return $preview_link; } if ( ! $this->current_post_is_email_post_type( $post->post_type ) ) { return $preview_link; } // Remove preview_nonce from the link. return remove_query_arg( 'preview_nonce', $preview_link ); } } email-editor/src/Engine/Patterns/class-patterns.php 0000777 00000002007 15252010675 0016400 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Patterns; /** * Register block patterns. */ class Patterns { /** * Initialize block patterns. * * @return void */ public function initialize(): void { $this->register_block_pattern_categories(); } /** * Register block pattern category. * * @return void */ private function register_block_pattern_categories(): void { $categories = array( array( 'name' => 'email-contents', 'label' => _x( 'Email Contents', 'Block pattern category', 'woocommerce' ), 'description' => __( 'A collection of email content layouts.', 'woocommerce' ), ), ); foreach ( $categories as $category ) { register_block_pattern_category( $category['name'], array( 'label' => $category['label'], 'description' => $category['description'] ?? '', ) ); } } } email-editor/src/Engine/Patterns/class-abstract-pattern.php 0000777 00000004463 15252010675 0020026 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Patterns; /** * Abstract class for block patterns. */ abstract class Abstract_Pattern { /** * Name of the pattern. * * @var string $name */ protected $name = ''; /** * Namespace of the pattern. * * @var string $namespace */ protected $namespace = ''; /** * List of block types. * * @var array $block_types */ protected $block_types = array(); /** * List of template types. * * @var string[] $template_types */ protected $template_types = array(); /** * List of supported post types. * * @var string[] $post_types */ protected $post_types = array(); /** * Flag to enable/disable inserter. * * @var bool $inserter */ protected $inserter = true; /** * Source of the pattern. * * @var string $source */ protected $source = 'plugin'; /** * List of categories. * * @var array $categories */ protected $categories = array(); /** * Viewport width. * * @var int $viewport_width */ protected $viewport_width = 620; /** * Get name of the pattern. * * @return string */ public function get_name(): string { return $this->name; } /** * Get namespace of the pattern. * * @return string */ public function get_namespace(): string { return $this->namespace; } /** * Return properties of the pattern. * * @return array */ public function get_properties(): array { return array( 'title' => $this->get_title(), 'content' => $this->get_content(), 'description' => $this->get_description(), 'categories' => $this->categories, 'inserter' => $this->inserter, 'blockTypes' => $this->block_types, 'templateTypes' => $this->template_types, 'postTypes' => $this->post_types, 'source' => $this->source, 'viewportWidth' => $this->viewport_width, ); } /** * Get content. * * @return string */ abstract protected function get_content(): string; /** * Get title. * * @return string */ abstract protected function get_title(): string; /** * Get description. * * @return string */ protected function get_description(): string { return ''; } } email-editor/src/Engine/class-email-styles-schema.php 0000777 00000005732 15252010675 0016616 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine; use Automattic\WooCommerce\EmailEditor\Validator\Builder; /** * Class for email styles schema. */ class Email_Styles_Schema { /** * Returns the schema for email styles. * * @return array */ public function get_schema(): array { $typography_props = Builder::object( array( 'fontFamily' => Builder::string()->nullable(), 'fontSize' => Builder::string()->nullable(), 'fontStyle' => Builder::string()->nullable(), 'fontWeight' => Builder::string()->nullable(), 'letterSpacing' => Builder::string()->nullable(), 'lineHeight' => Builder::string()->nullable(), 'textTransform' => Builder::string()->nullable(), 'textDecoration' => Builder::string()->nullable(), ) )->nullable(); return Builder::object( array( 'version' => Builder::integer(), 'styles' => Builder::object( array( 'spacing' => Builder::object( array( 'padding' => Builder::object( array( 'top' => Builder::string(), 'right' => Builder::string(), 'bottom' => Builder::string(), 'left' => Builder::string(), ) )->nullable(), 'blockGap' => Builder::string()->nullable(), ) )->nullable(), 'color' => Builder::object( array( 'background' => Builder::string()->nullable(), 'text' => Builder::string()->nullable(), ) )->nullable(), 'typography' => $typography_props, 'elements' => Builder::object( array( 'heading' => Builder::object( array( 'typography' => $typography_props, ) )->nullable(), 'button' => Builder::object( array( 'typography' => $typography_props, ) )->nullable(), 'link' => Builder::object( array( 'typography' => $typography_props, ) )->nullable(), 'h1' => Builder::object( array( 'typography' => $typography_props, ) )->nullable(), 'h2' => Builder::object( array( 'typography' => $typography_props, ) )->nullable(), 'h3' => Builder::object( array( 'typography' => $typography_props, ) )->nullable(), 'h4' => Builder::object( array( 'typography' => $typography_props, ) )->nullable(), 'h5' => Builder::object( array( 'typography' => $typography_props, ) )->nullable(), 'h6' => Builder::object( array( 'typography' => $typography_props, ) )->nullable(), ) )->nullable(), ) )->nullable(), ) )->to_array(); } } email-editor/src/Engine/class-settings-controller.php 0000777 00000015150 15252010675 0016764 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine; /** * Class managing the settings for the email editor. */ class Settings_Controller { const DEFAULT_SETTINGS = array( 'enableCustomUnits' => array( 'px', '%' ), ); /** * Theme controller. * * @var Theme_Controller */ private Theme_Controller $theme_controller; /** * Allowed iframe style handles. * * @var string[] */ private array $allowed_iframe_style_handles = array(); /** * Assets for iframe editor (component styles, scripts, etc.) * * @var array */ private array $iframe_assets = array(); /** * Class constructor. * * @param Theme_Controller $theme_controller Theme controller. */ public function __construct( Theme_Controller $theme_controller ) { $this->theme_controller = $theme_controller; } /** * Get the settings for the email editor. * * @return array */ public function get_settings(): array { $this->init_iframe_assets(); $core_default_settings = \get_default_block_editor_settings(); $theme_settings = $this->theme_controller->get_settings(); $settings = array_merge( $core_default_settings, self::DEFAULT_SETTINGS ); // Assets for iframe editor (component styles, scripts, etc.). $settings['__unstableResolvedAssets'] = $this->iframe_assets; $settings['allowedIframeStyleHandles'] = $this->allowed_iframe_style_handles; $editor_content_styles = file_get_contents( __DIR__ . '/content-editor.css' ); $shares_content_styles = file_get_contents( __DIR__ . '/content-shared.css' ); $settings['styles'] = array( array( 'css' => $editor_content_styles ), array( 'css' => $shares_content_styles ), ); $settings['autosaveInterval'] = 60; // Disable code editing in the email editor. We manipulate HTML in renderer so it doesn't make sense to have it enabled. $settings['codeEditingEnabled'] = false; $settings['__experimentalFeatures'] = $theme_settings; // Controls which alignment options are available for blocks. $settings['supportsLayout'] = true; // Allow using default layouts. $settings['__unstableIsBlockBasedTheme'] = true; // For default setting this to true disables wide and full alignments. return $settings; } /** * Returns the layout settings for the email editor. * * @return array{contentSize: string, wideSize: string} */ public function get_layout(): array { $layout_settings = $this->theme_controller->get_layout_settings(); return array( 'contentSize' => $layout_settings['contentSize'], 'wideSize' => $layout_settings['wideSize'], ); } /** * Get the email styles. * * @return array{ * spacing: array{ * blockGap: string, * padding: array{bottom: string, left: string, right: string, top: string} * }, * color: array{ * background: string, * text: string * }, * typography: array{ * fontFamily: string * } * } */ public function get_email_styles(): array { $theme = $this->get_theme(); return $theme->get_data()['styles']; } /** * Returns the width of the layout without padding. * * @return string */ public function get_layout_width_without_padding(): string { $styles = $this->get_email_styles(); $layout = $this->get_layout(); $width = $this->parse_number_from_string_with_pixels( $layout['contentSize'] ); $width -= $this->parse_number_from_string_with_pixels( $styles['spacing']['padding']['left'] ); $width -= $this->parse_number_from_string_with_pixels( $styles['spacing']['padding']['right'] ); return "{$width}px"; } /** * Parse styles string to array. * * @param string $styles Styles string. * @return array */ public function parse_styles_to_array( string $styles ): array { $styles = explode( ';', $styles ); $parsed_styles = array(); foreach ( $styles as $style ) { $style = explode( ':', $style ); if ( count( $style ) === 2 ) { $parsed_styles[ trim( $style[0] ) ] = trim( $style[1] ); } } return $parsed_styles; } /** * Returns float number parsed from string with pixels. * * @param string $value Value with pixels. * @return float */ public function parse_number_from_string_with_pixels( string $value ): float { return (float) str_replace( 'px', '', $value ); } /** * Returns the theme. * * @return \WP_Theme_JSON */ public function get_theme(): \WP_Theme_JSON { return $this->theme_controller->get_theme(); } /** * Translate slug to font size. * * @param string $font_size Font size slug. * @return string */ public function translate_slug_to_font_size( string $font_size ): string { return $this->theme_controller->translate_slug_to_font_size( $font_size ); } /** * Translate slug to color. * * @param string $color_slug Color slug. * @return string */ public function translate_slug_to_color( string $color_slug ): string { return $this->theme_controller->translate_slug_to_color( $color_slug ); } /** * Get the allowed iframe style handles. * * @return array */ private function get_allowed_iframe_style_handles() { // Core style handles. $allowed_iframe_style_handles = array( 'wp-components-css', 'wp-reset-editor-styles-css', 'wp-block-library-css', 'wp-block-editor-content-css', 'wp-edit-blocks-css', ); foreach ( \WP_Block_Type_Registry::get_instance()->get_all_registered() as $block ) { if ( ! isset( $block->supports['email'] ) || ! $block->supports['email'] ) { continue; } foreach ( $block->style_handles as $handle ) { $allowed_iframe_style_handles[] = $handle . '-css'; } foreach ( $block->editor_style_handles as $handle ) { $allowed_iframe_style_handles[] = $handle . '-css'; } } return apply_filters( 'woocommerce_email_editor_allowed_iframe_style_handles', $allowed_iframe_style_handles ); } /** * Method to initialize iframe assets. * * @return void */ private function init_iframe_assets(): void { if ( ! empty( $this->iframe_assets ) ) { return; } $this->iframe_assets = _wp_get_iframed_editor_assets(); $this->allowed_iframe_style_handles = $this->get_allowed_iframe_style_handles(); $cleaned_styles = array(); foreach ( explode( "\n", (string) $this->iframe_assets['styles'] ) as $asset ) { foreach ( $this->allowed_iframe_style_handles as $handle ) { if ( strpos( $asset, $handle ) !== false ) { $cleaned_styles[] = $asset; break; } } } $this->iframe_assets['styles'] = implode( "\n", $cleaned_styles ); } } email-editor/src/Engine/class-user-theme.php 0000777 00000005121 15252010675 0015016 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine; use WP_Post; use WP_Theme_JSON; /** * This class is responsible for managing and accessing theme data aka email styles created by users. */ class User_Theme { private const USER_THEME_POST_NAME = 'wp-global-styles-woocommerce-email'; private const INITIAL_THEME_DATA = array( 'version' => 3, 'isGlobalStylesUserThemeJSON' => true, ); /** * Core theme loaded from the WordPress core. * * @var WP_Post | null */ private ?WP_Post $user_theme_post = null; /** * Getter for user theme. * * @throws \Exception If the user theme post cannot be created. * @return WP_Theme_JSON */ public function get_theme(): WP_Theme_JSON { $post = $this->get_user_theme_post(); $theme_data = json_decode( $post->post_content, true ); if ( ! is_array( $theme_data ) ) { $theme_data = self::INITIAL_THEME_DATA; } return new WP_Theme_JSON( $theme_data, 'custom' ); } /** * Getter for user theme post. * If the post does not exist, it will be created. * * @throws \Exception If the user theme post cannot be created. * @return WP_Post */ public function get_user_theme_post(): WP_Post { $this->ensure_theme_post(); if ( ! $this->user_theme_post instanceof WP_Post ) { throw new \Exception( 'Error creating user theme post' ); } return $this->user_theme_post; } /** * Ensures that the user theme post exists and is loaded. * * @throws \Exception If the user theme post cannot be created. */ private function ensure_theme_post(): void { if ( $this->user_theme_post ) { return; } $this->user_theme_post = get_page_by_path( self::USER_THEME_POST_NAME, OBJECT, 'wp_global_styles' ); if ( $this->user_theme_post instanceof WP_Post ) { return; } $post_data = array( 'post_title' => __( 'Custom Email Styles', 'woocommerce' ), 'post_name' => self::USER_THEME_POST_NAME, 'post_content' => (string) wp_json_encode( self::INITIAL_THEME_DATA, JSON_FORCE_OBJECT ), 'post_status' => 'publish', 'post_type' => 'wp_global_styles', ); /** * The doc is needed since PHPStan thinks that wp_insert_post can't return WP_Error. * * @var int|\WP_Error $post_id */ $post_id = wp_insert_post( $post_data ); if ( is_wp_error( $post_id ) ) { throw new \Exception( 'Error creating user theme post: ' . esc_html( $post_id->get_error_message() ) ); } $this->user_theme_post = get_post( $post_id ); } } email-editor/src/Engine/theme.json 0000777 00000016060 15252010675 0013125 0 ustar 00 { "$schema": "https://schemas.wp.org/trunk/theme.json", "version": 3, "settings": { "color": { "customGradient": false, "defaultGradients": false, "gradients": [], "background": true, "text": true, "link": true, "customDuotone": false, "defaultDuotone": false }, "layout": { "contentSize": "660px", "wideSize": "", "allowEditing": false, "allowCustomContentAndWideSize": false }, "background": { "backgroundImage": true }, "spacing": { "units": ["px"], "blockGap": false, "padding": true, "margin": false, "spacingSizes": [ { "name": "1", "size": "10px", "slug": "10" }, { "name": "2", "size": "20px", "slug": "20" }, { "name": "3", "size": "30px", "slug": "30" }, { "name": "4", "size": "40px", "slug": "40" }, { "name": "5", "size": "50px", "slug": "50" }, { "name": "6", "size": "60px", "slug": "60" } ] }, "border": { "radius": true, "color": true, "style": true, "width": true }, "typography": { "dropCap": false, "fontWeight": true, "lineHeight": true, "defaultFontSizes": true, "fontFamilies": [ { "name": "Arial", "slug": "arial", "fontFamily": "Arial, 'Helvetica Neue', Helvetica, sans-serif" }, { "name": "Comic Sans MS", "slug": "comic-sans-ms", "fontFamily": "'Comic Sans MS', 'Marker Felt-Thin', Arial, sans-serif" }, { "name": "Courier New", "slug": "courier-new", "fontFamily": "'Courier New', Courier, 'Lucida Sans Typewriter', 'Lucida Typewriter', monospace" }, { "name": "Georgia", "slug": "georgia", "fontFamily": "Georgia, Times, 'Times New Roman', serif" }, { "name": "Lucida", "slug": "lucida", "fontFamily": "'Lucida Sans Unicode', 'Lucida Grande', sans-serif" }, { "name": "Tahoma", "slug": "tahoma", "fontFamily": "'Tahoma, Verdana, Segoe, sans-serif'" }, { "name": "Times New Roman", "slug": "times-new-roman", "fontFamily": "'Times New Roman', Times, Baskerville, Georgia, serif" }, { "name": "Trebuchet MS", "slug": "trebuchet-ms", "fontFamily": "'Trebuchet MS', 'Lucida Grande', 'Lucida Sans Unicode', 'Lucida Sans', Tahoma, sans-serif" }, { "name": "Verdana", "slug": "verdana", "fontFamily": "'Verdana, Geneva, sans-serif'" }, { "name": "Arvo", "slug": "arvo", "fontFamily": "'arvo, courier, georgia, serif'" }, { "name": "Lato", "slug": "lato", "fontFamily": "lato, 'helvetica neue', helvetica, arial, sans-serif" }, { "name": "Lora", "slug": "lora", "fontFamily": "lora, georgia, 'times new roman', serif" }, { "name": "Merriweather", "slug": "merriweather", "fontFamily": "merriweather, georgia, 'times new roman', serif" }, { "name": "Merriweather Sans", "slug": "merriweather-sans", "fontFamily": "'merriweather sans', 'helvetica neue', helvetica, arial, sans-serif" }, { "name": "Noticia Text", "slug": "noticia-text", "fontFamily": "'noticia text', georgia, 'times new roman', serif" }, { "name": "Open Sans", "slug": "open-sans", "fontFamily": "'open sans', 'helvetica neue', helvetica, arial, sans-serif" }, { "name": "Playfair Display", "slug": "playfair-display", "fontFamily": "'playfair display', georgia, 'times new roman', serif" }, { "name": "Roboto", "slug": "roboto", "fontFamily": "roboto, 'helvetica neue', helvetica, arial, sans-serif" }, { "name": "Source Sans Pro", "slug": "source-sans-pro", "fontFamily": "'source sans pro', 'helvetica neue', helvetica, arial, sans-serif" }, { "name": "Oswald", "slug": "oswald", "fontFamily": "Oswald, 'Trebuchet MS', 'Lucida Grande', 'Lucida Sans Unicode', 'Lucida Sans', Tahoma, sans-serif" }, { "name": "Raleway", "slug": "raleway", "fontFamily": "Raleway, 'Century Gothic', CenturyGothic, AppleGothic, sans-serif" }, { "name": "Permanent Marker", "slug": "permanent-marker", "fontFamily": "'Permanent Marker', Tahoma, Verdana, Segoe, sans-serif" }, { "name": "Pacifico", "slug": "pacifico", "fontFamily": "Pacifico, 'Arial Narrow', Arial, sans-serif" } ], "fontSizes": [ { "name": "small", "size": "13px", "slug": "small" }, { "name": "medium", "size": "16px", "slug": "medium" }, { "name": "large", "size": "24px", "slug": "large" }, { "name": "extra-large", "size": "32px", "slug": "x-large" }, { "name": "extra-extra-large", "size": "40px", "slug": "xx-large" } ] }, "useRootPaddingAwareAlignments": true }, "styles": { "spacing": { "blockGap": "16px", "padding": { "bottom": "20px", "left": "20px", "right": "20px", "top": "20px" } }, "color": { "background": "#ffffff", "text": "#1e1e1e" }, "typography": { "fontFamily": "Arial, 'Helvetica Neue', Helvetica, sans-serif", "fontSize": "16px", "fontWeight": "400", "fontStyle": "normal", "letterSpacing": "0", "lineHeight": "1.5", "textDecoration": "none", "textTransform": "none" }, "elements": { "heading": { "typography": { "fontFamily": "Arial, 'Helvetica Neue', Helvetica, sans-serif", "fontWeight": "400", "fontStyle": "normal", "lineHeight": "1.2" } }, "h1": { "typography": { "fontSize": "40px" } }, "h2": { "typography": { "fontSize": "32px" } }, "h3": { "typography": { "fontSize": "24px" } }, "h4": { "typography": { "fontSize": "16px" } }, "h5": { "typography": { "fontSize": "14px" } }, "h6": { "typography": { "fontSize": "12px" } } } } } email-editor/src/Engine/class-personalizer.php 0000777 00000015651 15252010675 0015466 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine; use Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags\HTML_Tag_Processor; use Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags\Personalization_Tags_Registry; /** * Class for replacing personalization tags with their values in the email content. */ class Personalizer { /** * Personalization tags registry. * * @var Personalization_Tags_Registry */ private Personalization_Tags_Registry $tags_registry; /** * Context for personalization tags. * * The `context` is an associative array containing recipient-specific or * campaign-specific data. This data is used to resolve personalization tags * and provide input for tag callbacks during email content processing. * * Example context: * array( * 'recipient_email' => 'john@example.com', // Recipient's email * 'custom_field' => 'Special Value', // Custom campaign-specific data * ) * * @var array<string, mixed> */ private array $context; /** * Class constructor with required dependencies. * * @param Personalization_Tags_Registry $tags_registry Personalization tags registry. */ public function __construct( Personalization_Tags_Registry $tags_registry ) { $this->tags_registry = $tags_registry; $this->context = array(); } /** * Set the context for personalization. * * The `context` provides data required for resolving personalization tags * during content processing. This method allows the context to be set or updated. * * Example usage: * $personalizer->set_context(array( * 'recipient_email' => 'john@example.com', * )); * * @param array<string, mixed> $context Associative array containing personalization data. * @return void */ public function set_context( array $context ) { $this->context = $context; } /** * Get the current context. * * The `context` is an associative array containing recipient-specific or * campaign-specific data. This data is used to resolve personalization tags * and provide input for tag callbacks during email content processing. * * @return array<string, mixed> The current context. */ public function get_context(): array { return $this->context; } /** * Personalize the content by replacing the personalization tags with their values. * * @param string $content The content to personalize. * @return string The personalized content. */ public function personalize_content( string $content ): string { $content_processor = new HTML_Tag_Processor( $content ); while ( $content_processor->next_token() ) { if ( $content_processor->get_token_type() === '#comment' ) { $modifiable_text = $content_processor->get_modifiable_text(); $token = $this->parse_token( $modifiable_text ); $tag = $this->tags_registry->get_by_token( $token['token'] ); if ( ! $tag ) { continue; } $value = $tag->execute_callback( $this->context, $token['arguments'] ); $content_processor->replace_token( $value ); } elseif ( $content_processor->get_token_type() === '#tag' && $content_processor->get_tag() === 'TITLE' ) { // The title tag contains the subject of the email which should be personalized. HTML_Tag_Processor does parse the header tags. $modifiable_text = $content_processor->get_modifiable_text(); $title = $this->personalize_content( $modifiable_text ); $content_processor->set_modifiable_text( $title ); } elseif ( $content_processor->get_token_type() === '#tag' && $content_processor->get_tag() === 'A' && $content_processor->get_attribute( 'data-link-href' ) ) { // The anchor tag contains the data-link-href attribute which should be personalized. $href = (string) $content_processor->get_attribute( 'data-link-href' ); $token = $this->parse_token( $href ); $tag = $this->tags_registry->get_by_token( $token['token'] ); if ( ! $tag ) { continue; } $value = $tag->execute_callback( $this->context, $token['arguments'] ); $value = $this->replace_link_href( $href, $tag->get_token(), $value ); if ( $value ) { $content_processor->set_attribute( 'href', $value ); $content_processor->remove_attribute( 'data-link-href' ); $content_processor->remove_attribute( 'contenteditable' ); } } elseif ( $content_processor->get_token_type() === '#tag' && $content_processor->get_tag() === 'A' ) { $href = $content_processor->get_attribute( 'href' ); if ( ! is_string( $href ) ) { continue; } if ( ! $href || ! preg_match( '/\[[a-z-\/]+\]/', urldecode( $href ), $matches ) ) { continue; } $token = $this->parse_token( $matches[0] ); $tag = $this->tags_registry->get_by_token( $token['token'] ); if ( ! $tag ) { continue; } $value = $tag->execute_callback( $this->context, $token['arguments'] ); if ( $value ) { $content_processor->set_attribute( 'href', $value ); } } } $content_processor->flush_updates(); return $content_processor->get_updated_html(); } /** * Parse a personalization tag to the token and attributes. * * @param string $token The token to parse. * @return array{token: string, arguments: array<string, string>} The parsed token. */ private function parse_token( string $token ): array { $result = array( 'token' => '', 'arguments' => array(), ); // Step 1: Separate the tag and attributes. if ( preg_match( '/^\[([a-zA-Z0-9\-\/]+)\s*(.*?)\]$/', trim( $token ), $matches ) ) { $result['token'] = "[{$matches[1]}]"; // The tag part (e.g., "[mailpoet/subscriber-firstname]"). $attributes_string = $matches[2]; // The attributes part (e.g., 'default="subscriber"'). // Step 2: Extract attributes from the attribute string. if ( preg_match_all( '/(\w+)=["\']([^"\']*)["\']/', $attributes_string, $attribute_matches, PREG_SET_ORDER ) ) { foreach ( $attribute_matches as $attribute ) { $result['arguments'][ $attribute[1] ] = $attribute[2]; } } } return $result; } /** * Replace the href attribute of the anchor tag with the personalized value. * The replacement uses regular expression to match the shortcode and its attributes. * * @param string $content The content to replace the link href. * @param string $token Personalization tag token. * @param string $replacement The callback output to replace the link href. * @return string */ private function replace_link_href( string $content, string $token, string $replacement ) { // Escape the shortcode name for safe regex usage and strip the brackets. $escaped_shortcode = preg_quote( substr( $token, 1, strlen( $token ) - 2 ), '/' ); // Create a regex pattern dynamically. $pattern = '/\[' . $escaped_shortcode . '(?:\s+[^\]]+)?\]/'; return trim( (string) preg_replace( $pattern, $replacement, $content ) ); } } email-editor/src/Engine/class-assets-manager.php 0000777 00000021651 15252010675 0015660 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types=1); namespace Automattic\WooCommerce\EmailEditor\Engine; use Automattic\WooCommerce\EmailEditor\Engine\Logger\Email_Editor_Logger; /** * Class responsible for managing email editor assets. */ class Assets_Manager { /** * Settings controller instance. * * @var Settings_Controller */ private Settings_Controller $settings_controller; /** * Theme controller instance. * * @var Theme_Controller */ private Theme_Controller $theme_controller; /** * User theme instance. * * @var User_Theme */ private User_Theme $user_theme; /** * Email editor assets path. * * @var string */ private string $assets_path = ''; /** * Email editor assets URL. * * @var string */ private string $assets_url = ''; /** * Logger instance. * * @var Email_Editor_Logger */ private Email_Editor_Logger $logger; /** * Assets Manager constructor with all dependencies. * * @param Settings_Controller $settings_controller Settings controller instance. * @param Theme_Controller $theme_controller Theme controller instance. * @param User_Theme $user_theme User theme instance. * @param Email_Editor_Logger $logger Email editor logger instance. */ public function __construct( Settings_Controller $settings_controller, Theme_Controller $theme_controller, User_Theme $user_theme, Email_Editor_Logger $logger ) { $this->settings_controller = $settings_controller; $this->theme_controller = $theme_controller; $this->user_theme = $user_theme; $this->logger = $logger; } /** * Sets the path for the email editor assets. * * @param string $assets_path The path to the email editor assets directory. * @return void */ public function set_assets_path( string $assets_path ): void { $this->assets_path = $assets_path; } /** * Sets the URL for the email editor assets. * * @param string $assets_url The URL to the email editor assets directory. * @return void */ public function set_assets_url( string $assets_url ): void { $this->assets_url = $assets_url; } /** * Initialize the assets manager. */ public function initialize(): void { add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) ); } /** * Enqueue admin styles that are needed by the email editor. */ public function enqueue_admin_styles(): void { // Calling action that loads registered blockTypes. do_action( 'enqueue_block_editor_assets' ); // Load CSS from Post Editor. wp_enqueue_style( 'wp-edit-post' ); // Load CSS for the format library - used for example in popover. wp_enqueue_style( 'wp-format-library' ); // Enqueue CSS containing --wp--preset variables. wp_enqueue_global_styles_css_custom_properties(); // Enqueue media library scripts. wp_enqueue_media(); } /** * Render the email editor's required HTML and admin header. * * @param string $element_id Optional. The ID of the main container element. Default is 'woocommerce-email-editor'. */ public function render_email_editor_html( string $element_id = 'woocommerce-email-editor' ): void { // @phpstan-ignore-next-line -- PHPStan tried to check if the file exists. require_once ABSPATH . 'wp-admin/admin-header.php'; echo '<div id="' . esc_attr( $element_id ) . '" class="block-editor block-editor__container hide-if-no-js"></div>'; } /** * Load editor assets. * * @param \WP_Post|\WP_Block_Template $edited_item The edited post or template. * @param string $script_name The name of the registered script. */ public function load_editor_assets( $edited_item, string $script_name ): void { $post_type = $edited_item instanceof \WP_Post ? $edited_item->post_type : 'wp_template'; $post_id = $edited_item instanceof \WP_Post ? $edited_item->ID : $edited_item->id; $email_editor_assets_path = rtrim( $this->assets_path, '/' ) . '/'; $email_editor_assets_url = rtrim( $this->assets_url, '/' ) . '/'; // Email editor rich text JS - Because the Personalization Tags depend on Gutenberg 19.8.0 and higher // the following code replaces used Rich Text for the version containing the necessary changes. $rich_text_assets_file = $email_editor_assets_path . 'assets/rich-text.asset.php'; if ( ! file_exists( $rich_text_assets_file ) ) { $this->logger->error( 'Rich Text assets file does not exist.', array( 'path' => $rich_text_assets_file ) ); } else { $rich_text_assets = require $rich_text_assets_file; wp_deregister_script( 'wp-rich-text' ); wp_enqueue_script( 'wp-rich-text', $email_editor_assets_url . 'assets/rich-text.js', $rich_text_assets['dependencies'], $rich_text_assets['version'], true ); } // End of replacing Rich Text package. $assets_file = $email_editor_assets_path . 'style.asset.php'; if ( ! file_exists( $assets_file ) ) { $this->logger->error( 'Email editor assets file does not exist.', array( 'path' => $assets_file ) ); } else { $assets_file = require $assets_file; wp_enqueue_style( 'wc-admin-email-editor-integration', $email_editor_assets_url . 'style.css', array(), $assets_file['version'] ); } // The get_block_categories() function expects a WP_Post or WP_Block_Editor_Context object. // Therefore, we need to create an instance of WP_Block_Editor_Context when $edited_item is an instance of WP_Block_Template. if ( $edited_item instanceof \WP_Block_Template ) { $context = new \WP_Block_Editor_Context( array( 'post' => $edited_item, ) ); } else { $context = $edited_item; } // The email editor needs to load block categories to avoid warning and missing category names. // See: https://github.com/WordPress/WordPress/blob/753817d462955eb4e40a89034b7b7c375a1e43f3/wp-admin/edit-form-blocks.php#L116-L120. wp_add_inline_script( 'wp-blocks', sprintf( 'wp.blocks.setCategories( %s );', wp_json_encode( get_block_categories( $context ), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) ), 'after' ); // Preload server-registered block schemas to avoid warning about missing block titles. // See: https://github.com/WordPress/WordPress/blob/753817d462955eb4e40a89034b7b7c375a1e43f3/wp-admin/edit-form-blocks.php#L144C1-L148C3. wp_add_inline_script( 'wp-blocks', sprintf( 'wp.blocks.unstable__bootstrapServerSideBlockDefinitions( %s );', wp_json_encode( get_block_editor_server_block_settings(), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) ) ); $localization_data = array( 'current_post_type' => $post_type, 'current_post_id' => $post_id, 'current_wp_user_email' => wp_get_current_user()->user_email, 'editor_settings' => $this->settings_controller->get_settings(), 'editor_theme' => $this->theme_controller->get_base_theme()->get_raw_data(), 'user_theme_post_id' => $this->user_theme->get_user_theme_post()->ID, 'urls' => array( 'listings' => admin_url( 'admin.php?page=wc-settings&tab=email' ), 'send' => admin_url( 'admin.php?page=wc-settings&tab=email' ), 'back' => admin_url( 'admin.php?page=wc-settings&tab=email' ), 'createCoupon' => admin_url( 'post-new.php?post_type=shop_coupon' ), ), ); wp_localize_script( $script_name, 'WooCommerceEmailEditor', apply_filters( 'woocommerce_email_editor_script_localization_data', $localization_data ) ); $this->preload_rest_api_data( $post_id, $post_type ); } /** * Preload REST API data for the email editor. * * @param int|string $post_id The post ID. * @param string $post_type The post type. */ private function preload_rest_api_data( $post_id, string $post_type ): void { $email_post_type = $post_type; $user_theme_post_id = $this->user_theme->get_user_theme_post()->ID; $template_slug = get_post_meta( (int) $post_id, '_wp_page_template', true ); $routes = array( "/wp/v2/{$email_post_type}/" . intval( $post_id ) . '?context=edit', "/wp/v2/types/{$email_post_type}?context=edit", '/wp/v2/global-styles/' . intval( $user_theme_post_id ) . '?context=view', // Global email styles. '/wp/v2/block-patterns/patterns', '/wp/v2/templates?context=view', '/wp/v2/block-patterns/categories', '/wp/v2/settings', '/wp/v2/types?context=view', '/wp/v2/taxonomies?context=view', ); if ( is_string( $template_slug ) ) { $routes[] = '/wp/v2/templates/lookup?slug=' . $template_slug; } else { $routes[] = "/wp/v2/{$email_post_type}?context=edit&per_page=30&status=publish,sent"; } // Preload the data for the specified routes. $preload_data = array_reduce( $routes, 'rest_preload_api_request', array() ); // Add inline script to set up preloading middleware. wp_add_inline_script( 'wp-blocks', sprintf( 'wp.apiFetch.use( wp.apiFetch.createPreloadingMiddleware( %s ) );', wp_json_encode( $preload_data, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) ) ); } } email-editor/src/Engine/content-shared.css 0000777 00000001075 15252010675 0014560 0 ustar 00 /* * Styles for both the email editor and renderer. */ /* Automatic padding for blocks with background color */ .email-text-block.has-background, p.has-background, h1.has-background, h2.has-background, h3.has-background, h4.has-background, h5.has-background, h6.has-background { padding: 16px 24px; } /* Specific padding for list elements */ ul.has-background, ol.has-background { padding: 20px 40px; } /* Remove default browser underline from site title link */ .wp-block-site-title a:not(.wp-element-button) { text-decoration: none !important; color: inherit; } email-editor/src/Engine/Renderer/ContentRenderer/class-block-renderer.php 0000777 00000001224 15252010675 0022505 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer; /** * Interface Block_Renderer */ interface Block_Renderer { /** * Renders the block content * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ public function render( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string; } email-editor/src/Engine/Renderer/ContentRenderer/class-rendering-context.php 0000777 00000011041 15252010675 0023244 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; use WP_Theme_JSON; /** * Class Rendering_Context */ class Rendering_Context { /** * Instance of the WP Theme. * * @var WP_Theme_JSON */ private WP_Theme_JSON $theme_json; /** * Email-specific context data. * * This array contains email-specific information that can be used during rendering, * such as: * - 'user_id': The ID of the user receiving the email * - 'recipient_email': The recipient's email address * - Additional context can be added by extensions using the generic get() method * * @var array<string, mixed> */ private array $email_context; /** * Rendering_Context constructor. * * @param WP_Theme_JSON $theme_json Theme Json used in the email. * @param array<string, mixed> $email_context Email-specific context data. */ public function __construct( WP_Theme_JSON $theme_json, array $email_context = array() ) { $this->theme_json = $theme_json; $this->email_context = $email_context; } /** * Returns WP_Theme_JSON instance that should be used during the email rendering. * * @return WP_Theme_JSON */ public function get_theme_json(): WP_Theme_JSON { return $this->theme_json; } /** * Get the email theme styles. * * @return array{ * spacing: array{ * blockGap: string, * padding: array{bottom: string, left: string, right: string, top: string} * }, * color: array{ * background: string, * text: string * }, * typography: array{ * fontFamily: string * } * } */ public function get_theme_styles(): array { $theme = $this->get_theme_json(); return $theme->get_data()['styles'] ?? array(); } /** * Get settings from the theme. * * @return array */ public function get_theme_settings() { return $this->get_theme_json()->get_settings(); } /** * Returns the width of the layout without padding. * * @return string */ public function get_layout_width_without_padding(): string { $styles = $this->get_theme_styles(); $layout_settings = $this->get_theme_settings()['layout'] ?? array(); $width = Styles_Helper::parse_value( $layout_settings['contentSize'] ?? '0px' ); $padding = $styles['spacing']['padding'] ?? array(); $width -= Styles_Helper::parse_value( $padding['left'] ?? '0px' ); $width -= Styles_Helper::parse_value( $padding['right'] ?? '0px' ); return "{$width}px"; } /** * Translate color slug to color. * * @param string $color_slug Color slug. * @return string */ public function translate_slug_to_color( string $color_slug ): string { $settings = $this->get_theme_settings(); $color_definitions = array_merge( $settings['color']['palette']['theme'] ?? array(), $settings['color']['palette']['default'] ?? array() ); foreach ( $color_definitions as $color_definition ) { if ( $color_definition['slug'] === $color_slug ) { return strtolower( $color_definition['color'] ); } } return $color_slug; } /** * Get the email-specific context data. * * @return array<string, mixed> */ public function get_email_context(): array { return $this->email_context; } /** * Get the user ID from the email context. * * @return int|null The user ID if available, null otherwise. */ public function get_user_id(): ?int { return isset( $this->email_context['user_id'] ) && is_numeric( $this->email_context['user_id'] ) ? (int) $this->email_context['user_id'] : null; } /** * Get the recipient email address from the email context. * * @return string|null The email address if available, null otherwise. */ public function get_recipient_email(): ?string { return isset( $this->email_context['recipient_email'] ) && is_string( $this->email_context['recipient_email'] ) ? $this->email_context['recipient_email'] : null; } /** * Get a specific value from the email context. * * This method allows extensions to access custom context data that may be * specific to their implementation (e.g., order IDs, email types, etc.). * * @param string $key The context key. * @param mixed $default_value Default value if key is not found. * @return mixed The context value or default. */ public function get( string $key, $default_value = null ) { return $this->email_context[ $key ] ?? $default_value; } } email-editor/src/Engine/Renderer/ContentRenderer/class-process-manager.php 0000777 00000011206 15252010675 0022676 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors\Highlighting_Postprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors\Postprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors\Variables_Postprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Blocks_Width_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Cleanup_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Spacing_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Typography_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Quote_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors\Border_Style_Postprocessor; /** * Class Process_Manager */ class Process_Manager { /** * List of preprocessors * * @var Preprocessor[] */ private $preprocessors = array(); /** * List of postprocessors * * @var Postprocessor[] */ private $postprocessors = array(); /** * Process_Manager constructor. * * @param Cleanup_Preprocessor $cleanup_preprocessor Cleanup preprocessor. * @param Blocks_Width_Preprocessor $blocks_width_preprocessor Blocks width preprocessor. * @param Typography_Preprocessor $typography_preprocessor Typography preprocessor. * @param Spacing_Preprocessor $spacing_preprocessor Spacing preprocessor. * @param Quote_Preprocessor $quote_preprocessor Quote preprocessor. * @param Highlighting_Postprocessor $highlighting_postprocessor Highlighting postprocessor. * @param Variables_Postprocessor $variables_postprocessor Variables postprocessor. * @param Border_Style_Postprocessor $border_style_postprocessor Border style postprocessor. */ public function __construct( Cleanup_Preprocessor $cleanup_preprocessor, Blocks_Width_Preprocessor $blocks_width_preprocessor, Typography_Preprocessor $typography_preprocessor, Spacing_Preprocessor $spacing_preprocessor, Quote_Preprocessor $quote_preprocessor, Highlighting_Postprocessor $highlighting_postprocessor, Variables_Postprocessor $variables_postprocessor, Border_Style_Postprocessor $border_style_postprocessor ) { $this->register_preprocessor( $cleanup_preprocessor ); $this->register_preprocessor( $blocks_width_preprocessor ); $this->register_preprocessor( $typography_preprocessor ); $this->register_preprocessor( $spacing_preprocessor ); $this->register_preprocessor( $quote_preprocessor ); $this->register_postprocessor( $highlighting_postprocessor ); $this->register_postprocessor( $border_style_postprocessor ); $this->register_postprocessor( $variables_postprocessor ); } /** * Method to preprocess blocks * * @param array $parsed_blocks Parsed blocks. * @param array{contentSize: string, wideSize?: string, allowEditing?: bool, allowCustomContentAndWideSize?: bool} $layout Layout. * @param array{spacing: array{padding: array{bottom: string, left: string, right: string, top: string}, blockGap: string}} $styles Styles. * @return array */ public function preprocess( array $parsed_blocks, array $layout, array $styles ): array { foreach ( $this->preprocessors as $preprocessor ) { $parsed_blocks = $preprocessor->preprocess( $parsed_blocks, $layout, $styles ); } return $parsed_blocks; } /** * Method to postprocess the content * * @param string $html HTML content. * @return string */ public function postprocess( string $html ): string { foreach ( $this->postprocessors as $postprocessor ) { $html = $postprocessor->postprocess( $html ); } return $html; } /** * Register preprocessor * * @param Preprocessor $preprocessor Preprocessor. */ public function register_preprocessor( Preprocessor $preprocessor ): void { $this->preprocessors[] = $preprocessor; } /** * Register postprocessor * * @param Postprocessor $postprocessor Postprocessor. */ public function register_postprocessor( Postprocessor $postprocessor ): void { $this->postprocessors[] = $postprocessor; } } email-editor/src/Engine/Renderer/ContentRenderer/Preprocessors/class-typography-preprocessor.php 0000777 00000012047 15252010675 0027417 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors; use Automattic\WooCommerce\EmailEditor\Engine\Settings_Controller; /** * This preprocessor is responsible for setting default typography values for blocks. */ class Typography_Preprocessor implements Preprocessor { /** * List of styles that should be copied from parent to children. * * @var string[] */ private const TYPOGRAPHY_STYLES = array( 'color', 'font-size', 'text-decoration', ); /** * Injected settings controller * * @var Settings_Controller */ private $settings_controller; /** * Typography_Preprocessor constructor. * * @param Settings_Controller $settings_controller Settings controller. */ public function __construct( Settings_Controller $settings_controller ) { $this->settings_controller = $settings_controller; } /** * Method to preprocess the content before rendering * * @param array $parsed_blocks Parsed blocks of the email. * @param array{contentSize: string} $layout Layout of the email. * @param array{spacing: array{padding: array{bottom: string, left: string, right: string, top: string}, blockGap: string}} $styles Styles of the email. * @return array */ public function preprocess( array $parsed_blocks, array $layout, array $styles ): array { foreach ( $parsed_blocks as $key => $block ) { $block = $this->preprocess_parent( $block ); // Set defaults from theme - this needs to be done on top level blocks only. $block = $this->set_defaults_from_theme( $block ); $block['innerBlocks'] = $this->copy_typography_from_parent( $block['innerBlocks'], $block ); $parsed_blocks[ $key ] = $block; } return $parsed_blocks; } /** * Copy typography styles from parent to children * * @param array $children List of children blocks. * @param array $parent_block Parent block. * @return array */ private function copy_typography_from_parent( array $children, array $parent_block ): array { foreach ( $children as $key => $child ) { $child = $this->preprocess_parent( $child ); $child['email_attrs'] = array_merge( $this->filterStyles( $parent_block['email_attrs'] ), $child['email_attrs'] ); $child['innerBlocks'] = $this->copy_typography_from_parent( $child['innerBlocks'] ?? array(), $child ); $children[ $key ] = $child; } return $children; } /** * Preprocess parent block * * @param array $block Block to preprocess. * @return array */ private function preprocess_parent( array $block ): array { // Build styles that should be copied to children. $email_attrs = array(); if ( isset( $block['attrs']['style']['color']['text'] ) ) { $email_attrs['color'] = $block['attrs']['style']['color']['text']; } if ( isset( $block['attrs']['textColor'] ) && is_string( $block['attrs']['textColor'] ) && ! isset( $email_attrs['color'] ) ) { $email_attrs['color'] = $this->settings_controller->translate_slug_to_color( $block['attrs']['textColor'] ); } // In case the fontSize is set via a slug (small, medium, large, etc.) we translate it to a number // The font size slug is set in $block['attrs']['fontSize'] and value in $block['attrs']['style']['typography']['fontSize']. if ( isset( $block['attrs']['fontSize'] ) && is_string( $block['attrs']['fontSize'] ) ) { $block['attrs']['style']['typography']['fontSize'] = $this->settings_controller->translate_slug_to_font_size( $block['attrs']['fontSize'] ); } // Pass font size to email_attrs. if ( isset( $block['attrs']['style']['typography']['fontSize'] ) ) { $email_attrs['font-size'] = $block['attrs']['style']['typography']['fontSize']; } if ( isset( $block['attrs']['style']['typography']['textDecoration'] ) ) { $email_attrs['text-decoration'] = $block['attrs']['style']['typography']['textDecoration']; } $block['email_attrs'] = array_merge( $email_attrs, $block['email_attrs'] ?? array() ); return $block; } /** * Filter styles to only include typography styles * * @param array $styles List of styles. * @return array */ private function filterStyles( array $styles ): array { return array_intersect_key( $styles, array_flip( self::TYPOGRAPHY_STYLES ) ); } /** * Set default values from theme * * @param array $block Block to set defaults for. * @return array */ private function set_defaults_from_theme( array $block ): array { $theme_data = $this->settings_controller->get_theme()->get_data(); if ( ! ( $block['email_attrs']['color'] ?? '' ) ) { $block['email_attrs']['color'] = $theme_data['styles']['color']['text'] ?? null; } if ( ! ( $block['email_attrs']['font-size'] ?? '' ) ) { $block['email_attrs']['font-size'] = $theme_data['styles']['typography']['fontSize']; } return $block; } } email-editor/src/Engine/Renderer/ContentRenderer/Preprocessors/class-spacing-preprocessor.php 0000777 00000003571 15252010675 0026637 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors; /** * This preprocessor is responsible for setting default spacing values for blocks. * In the early development phase, we are setting only margin-top for blocks that are not first or last in the columns block. */ class Spacing_Preprocessor implements Preprocessor { /** * Preprocesses the parsed blocks. * * @param array $parsed_blocks Parsed blocks. * @param array $layout Layout. * @param array $styles Styles. * @return array */ public function preprocess( array $parsed_blocks, array $layout, array $styles ): array { $parsed_blocks = $this->add_block_gaps( $parsed_blocks, $styles['spacing']['blockGap'] ?? '', null ); return $parsed_blocks; } /** * Adds margin-top to blocks that are not first or last in the columns block. * * @param array $parsed_blocks Parsed blocks. * @param string $gap Gap. * @param array|null $parent_block Parent block. * @return array */ private function add_block_gaps( array $parsed_blocks, string $gap = '', $parent_block = null ): array { foreach ( $parsed_blocks as $key => $block ) { $parent_block_name = $parent_block['blockName'] ?? ''; // Ensure that email_attrs are set. $block['email_attrs'] = $block['email_attrs'] ?? array(); /** * Do not add a gap to: * - first child * - parent block is a buttons block (where buttons are side by side). */ if ( 0 !== $key && $gap && 'core/buttons' !== $parent_block_name ) { $block['email_attrs']['margin-top'] = $gap; } $block['innerBlocks'] = $this->add_block_gaps( $block['innerBlocks'] ?? array(), $gap, $block ); $parsed_blocks[ $key ] = $block; } return $parsed_blocks; } } email-editor/src/Engine/Renderer/ContentRenderer/Preprocessors/interface-preprocessor.php 0000777 00000001677 15252010675 0026055 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors; /** * Interface Preprocessor */ interface Preprocessor { /** * Method to preprocess the content before rendering * * @param array $parsed_blocks Parsed blocks of the email. * @param array{contentSize: string, wideSize?: string, allowEditing?: bool, allowCustomContentAndWideSize?: bool} $layout Layout of the email. * @param array{spacing: array{padding: array{bottom: string, left: string, right: string, top: string}, blockGap: string}} $styles Styles of the email. * @return array */ public function preprocess( array $parsed_blocks, array $layout, array $styles ): array; } email-editor/src/Engine/Renderer/ContentRenderer/Preprocessors/class-quote-preprocessor.php 0000777 00000010312 15252010675 0026337 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors; /** * Class Quote_Preprocessor */ class Quote_Preprocessor implements Preprocessor { /** * Method to preprocess the content before rendering * * @param array $parsed_blocks Parsed blocks of the email. * @param array{contentSize: string} $layout Layout of the email. * @param array{spacing: array{padding: array{bottom: string, left: string, right: string, top: string}, blockGap: string}} $styles Styles of the email. * @return array */ public function preprocess( array $parsed_blocks, array $layout, array $styles ): array { return $this->process_blocks( $parsed_blocks, $styles ); } /** * Recursively process blocks to handle quote block alignment and typography * * @param array $blocks The blocks to process. * @param array $styles The styles from the theme. * @return array The processed blocks. */ private function process_blocks( array $blocks, array $styles ): array { foreach ( $blocks as &$block ) { if ( ! isset( $block['innerBlocks'] ) ) { continue; } if ( 'core/quote' === $block['blockName'] ) { $quote_align = $block['attrs']['textAlign'] ?? null; $quote_typography = $block['attrs']['style']['typography'] ?? array(); // Apply quote's text alignment to its children. $block['innerBlocks'] = $this->apply_alignment_to_children( $block['innerBlocks'], $quote_align ); // Apply quote's typography to its children. $block['innerBlocks'] = $this->apply_typography_to_children( $block['innerBlocks'], $quote_typography, $styles ); } $block['innerBlocks'] = $this->process_blocks( $block['innerBlocks'], $styles ); } return $blocks; } /** * Apply text alignment to child blocks that don't have their own text alignment set * * @param array $blocks The blocks to process. * @param string|null $text_align The text alignment to apply. * @return array The processed blocks. */ private function apply_alignment_to_children( array $blocks, ?string $text_align = null ): array { if ( ! $text_align ) { return $blocks; } foreach ( $blocks as &$block ) { // Only apply alignment if the block doesn't already have one set. if ( ! isset( $block['attrs']['textAlign'] ) && ! isset( $block['attrs']['align'] ) ) { if ( ! isset( $block['attrs'] ) ) { $block['attrs'] = array(); } $block['attrs']['textAlign'] = $text_align; } if ( isset( $block['innerBlocks'] ) ) { $block['innerBlocks'] = $this->apply_alignment_to_children( $block['innerBlocks'], $block['attrs']['textAlign'] ?? $block['attrs']['align'] ); } } return $blocks; } /** * Apply typography styles to immediate paragraph children * * @param array $blocks The blocks to process. * @param array $quote_typography The typography styles from the quote block. * @param array $styles The styles from the theme. * @return array The processed blocks. */ private function apply_typography_to_children( array $blocks, array $quote_typography, array $styles ): array { $default_typography = $styles['blocks']['core/quote']['typography'] ?? array(); $merged_typography = array_merge( $default_typography, $quote_typography ); if ( empty( $merged_typography ) ) { return $blocks; } foreach ( $blocks as &$block ) { if ( 'core/paragraph' === $block['blockName'] ) { if ( ! isset( $block['attrs'] ) ) { $block['attrs'] = array(); } if ( ! isset( $block['attrs']['style'] ) ) { $block['attrs']['style'] = array(); } if ( ! isset( $block['attrs']['style']['typography'] ) ) { $block['attrs']['style']['typography'] = array(); } // Merge typography styles, with block's own styles taking precedence. $block['attrs']['style']['typography'] = array_merge( $merged_typography, $block['attrs']['style']['typography'] ); } } return $blocks; } } email-editor/src/Engine/Renderer/ContentRenderer/Preprocessors/class-blocks-width-preprocessor.php 0000777 00000016661 15252010675 0027611 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors; /** * This class sets the width of the blocks based on the layout width or column count. * The final width in pixels is stored in the email_attrs array because we would like to avoid changing the original attributes. */ class Blocks_Width_Preprocessor implements Preprocessor { /** * Method to preprocess the content before rendering * * @param array $parsed_blocks Parsed blocks of the email. * @param array{contentSize: string} $layout Layout of the email. * @param array{spacing: array{padding: array{bottom: string, left: string, right: string, top: string}, blockGap: string}} $styles Styles of the email. * @return array */ public function preprocess( array $parsed_blocks, array $layout, array $styles ): array { foreach ( $parsed_blocks as $key => $block ) { // Layout width is recalculated for each block because full-width blocks don't exclude padding. $layout_width = $this->parse_number_from_string_with_pixels( $layout['contentSize'] ); $alignment = $block['attrs']['align'] ?? null; // Subtract padding from the block width if it's not full-width. if ( 'full' !== $alignment ) { $layout_width -= $this->parse_number_from_string_with_pixels( $styles['spacing']['padding']['left'] ?? '0px' ); $layout_width -= $this->parse_number_from_string_with_pixels( $styles['spacing']['padding']['right'] ?? '0px' ); } $width_input = $block['attrs']['width'] ?? '100%'; // Currently we support only % and px units in case only the number is provided we assume it's % // because editor saves percent values as a number. $width_input = is_numeric( $width_input ) ? "$width_input%" : $width_input; $width_input = is_string( $width_input ) ? $width_input : '100%'; $width = $this->convert_width_to_pixels( $width_input, $layout_width ); if ( 'core/columns' === $block['blockName'] ) { // Calculate width of the columns based on the layout width and padding. $columns_width = $layout_width; $columns_width -= $this->parse_number_from_string_with_pixels( $block['attrs']['style']['spacing']['padding']['left'] ?? '0px' ); $columns_width -= $this->parse_number_from_string_with_pixels( $block['attrs']['style']['spacing']['padding']['right'] ?? '0px' ); $border_width = $block['attrs']['style']['border']['width'] ?? '0px'; $columns_width -= $this->parse_number_from_string_with_pixels( $block['attrs']['style']['border']['left']['width'] ?? $border_width ); $columns_width -= $this->parse_number_from_string_with_pixels( $block['attrs']['style']['border']['right']['width'] ?? $border_width ); $block['innerBlocks'] = $this->add_missing_column_widths( $block['innerBlocks'], $columns_width ); } // Copy layout styles and update width and padding. $modified_layout = $layout; $modified_layout['contentSize'] = "{$width}px"; $modified_styles = $styles; $modified_styles['spacing']['padding']['left'] = $block['attrs']['style']['spacing']['padding']['left'] ?? '0px'; $modified_styles['spacing']['padding']['right'] = $block['attrs']['style']['spacing']['padding']['right'] ?? '0px'; $block['email_attrs']['width'] = "{$width}px"; $block['innerBlocks'] = $this->preprocess( $block['innerBlocks'], $modified_layout, $modified_styles ); $parsed_blocks[ $key ] = $block; } return $parsed_blocks; } // TODO: We could add support for other units like em, rem, etc. /** * Convert width to pixels * * @param string $current_width Current width. * @param float $layout_width Layout width. * @return float */ private function convert_width_to_pixels( string $current_width, float $layout_width ): float { $width = $layout_width; if ( strpos( $current_width, '%' ) !== false ) { $width = (float) str_replace( '%', '', $current_width ); $width = round( $width / 100 * $layout_width ); } elseif ( strpos( $current_width, 'px' ) !== false ) { $width = $this->parse_number_from_string_with_pixels( $current_width ); } return $width; } /** * Parse number from string with pixels * * @param string $value Value with pixels. * @return float */ private function parse_number_from_string_with_pixels( string $value ): float { return (float) str_replace( 'px', '', $value ); } /** * Add missing column widths * * @param array $columns Columns. * @param float $columns_width Columns width. * @return array */ private function add_missing_column_widths( array $columns, float $columns_width ): array { $columns_count_with_defined_width = 0; $defined_column_width = 0; $columns_count = count( $columns ); foreach ( $columns as $column ) { if ( isset( $column['attrs']['width'] ) && ! empty( $column['attrs']['width'] ) ) { ++$columns_count_with_defined_width; $defined_column_width += $this->convert_width_to_pixels( $column['attrs']['width'], $columns_width ); } else { // When width is not set we need to add padding to the defined column width for better ratio accuracy. $defined_column_width += $this->parse_number_from_string_with_pixels( $column['attrs']['style']['spacing']['padding']['left'] ?? '0px' ); $defined_column_width += $this->parse_number_from_string_with_pixels( $column['attrs']['style']['spacing']['padding']['right'] ?? '0px' ); $border_width = $column['attrs']['style']['border']['width'] ?? '0px'; $defined_column_width += $this->parse_number_from_string_with_pixels( $column['attrs']['style']['border']['left']['width'] ?? $border_width ); $defined_column_width += $this->parse_number_from_string_with_pixels( $column['attrs']['style']['border']['right']['width'] ?? $border_width ); } } if ( $columns_count - $columns_count_with_defined_width > 0 ) { $default_columns_width = round( ( $columns_width - $defined_column_width ) / ( $columns_count - $columns_count_with_defined_width ), 2 ); foreach ( $columns as $key => $column ) { if ( ! isset( $column['attrs']['width'] ) || empty( $column['attrs']['width'] ) ) { // Add padding to the specific column width because it's not included in the default width. $column_width = $default_columns_width; $column_width += $this->parse_number_from_string_with_pixels( $column['attrs']['style']['spacing']['padding']['left'] ?? '0px' ); $column_width += $this->parse_number_from_string_with_pixels( $column['attrs']['style']['spacing']['padding']['right'] ?? '0px' ); $border_width = $column['attrs']['style']['border']['width'] ?? '0px'; $column_width += $this->parse_number_from_string_with_pixels( $column['attrs']['style']['border']['left']['width'] ?? $border_width ); $column_width += $this->parse_number_from_string_with_pixels( $column['attrs']['style']['border']['right']['width'] ?? $border_width ); $columns[ $key ]['attrs']['width'] = "{$column_width}px"; } } } return $columns; } } email-editor/src/Engine/Renderer/ContentRenderer/Preprocessors/class-cleanup-preprocessor.php 0000777 00000002702 15252010675 0026635 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors; /** * Class Cleanup_Preprocessor */ class Cleanup_Preprocessor implements Preprocessor { /** * Method to preprocess the content before rendering * * @param array $parsed_blocks Parsed blocks of the email. * @param array{contentSize: string} $layout Layout of the email. * @param array{spacing: array{padding: array{bottom: string, left: string, right: string, top: string}, blockGap: string}} $styles Styles of the email. * @return array */ public function preprocess( array $parsed_blocks, array $layout, array $styles ): array { foreach ( $parsed_blocks as $key => $block ) { // https://core.trac.wordpress.org/ticket/45312 // \WP_Block_Parser::parse_blocks() sometimes add a block with name null that can cause unexpected spaces in rendered content // This behavior was reported as an issue, but it was closed as won't fix. if ( null === $block['blockName'] && '' === trim( $block['innerHTML'] ?? '' ) ) { unset( $parsed_blocks[ $key ] ); } } return array_values( $parsed_blocks ); } } email-editor/src/Engine/Renderer/ContentRenderer/class-blocks-parser.php 0000777 00000001305 15252010675 0022356 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer; use WP_Block_Parser; /** * Class Blocks_Parser */ class Blocks_Parser extends WP_Block_Parser { /** * List of parsed blocks * * @var \WP_Block_Parser_Block[] */ public $output; /** * Parse the blocks from the document * * @param string $document Document to parse. * @return array[] */ public function parse( $document ) { parent::parse( $document ); return apply_filters( 'woocommerce_email_blocks_renderer_parsed_blocks', $this->output ); } } email-editor/src/Engine/Renderer/ContentRenderer/Postprocessors/interface-postprocessor.php 0000777 00000000732 15252010675 0026442 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors; /** * Interface for postprocessors. */ interface Postprocessor { /** * Postprocess the HTML. * * @param string $html HTML to postprocess. * @return string */ public function postprocess( string $html ): string; } email-editor/src/Engine/Renderer/ContentRenderer/Postprocessors/class-border-style-postprocessor.php0000777 00000020360 15252010675 0030217 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors; /** * Postprocessor that handles border-style declarations to ensure consistent rendering across email clients. * * This postprocessor addresses two main issues: * * 1. Normalize border-style declarations: * When using a uniform border-style declaration with non-uniform border-widths, * some email clients (like Outlook) will incorrectly display borders on all sides * even when the width is 0. For example: * `border-color: #000000; border-style: solid; border-width: 0 1px 0 0;` * would render borders on all sides in Outlook. This postprocessor normalizes * the border-style declarations to only set styles for sides where border-width > 0: * `border-color: currentColor; border-width: 0 1px 0 0; border-right-style: solid;` * * 2. Add fallback border styles: * The block editor provides a default solid style for borders that have a width * but no style specified. This postprocessor adds the same `border-style: solid` * fallback to ensure the email rendering matches what users see in the editor. * * The postprocessor handles all border cases including: * - Shorthand border declarations (border: 1px solid black) * - Individual side declarations (border-top, border-right, etc.) * - Individual property declarations (border-width, border-style, etc.) * - Mixed combinations of the above */ class Border_Style_Postprocessor implements Postprocessor { /** * Postprocess the HTML. * * @param string $html HTML to postprocess. * @return string */ public function postprocess( string $html ): string { $processor = new \WP_HTML_Tag_Processor( $html ); while ( $processor->next_tag() ) { $style = $processor->get_attribute( 'style' ); if ( null !== $style && true !== $style ) { $processed_style = $this->process_style( $style ); if ( $processed_style !== $style ) { $processor->set_attribute( 'style', $processed_style ); } } } return $processor->get_updated_html(); } /** * Processes a style string to ensure border-style is set for borders with width > 0 and removes extra border-style properties. * * @param string $style The style attribute value. * @return string */ private function process_style( string $style ): string { // Parse style into associative array. $styles = array(); foreach ( explode( ';', $style ) as $declaration ) { if ( strpos( $declaration, ':' ) !== false ) { list( $prop, $value ) = array_map( 'trim', explode( ':', $declaration, 2 ) ); $styles[ strtolower( $prop ) ] = $value; } } $should_update_style = false; // Collect border-widths and styles. $border_widths = array(); $border_styles = array(); foreach ( $styles as $prop => $value ) { if ( 'border' === $prop ) { $border_width = $this->extract_width_from_shorthand_value( $value ); if ( $border_width ) { $border_widths['top'] = $border_width; $border_widths['right'] = $border_width; $border_widths['bottom'] = $border_width; $border_widths['left'] = $border_width; } $border_style = $this->extract_style_from_shorthand_value( $value ); if ( $border_style ) { $border_styles['top'] = $border_style; $border_styles['right'] = $border_style; $border_styles['bottom'] = $border_style; $border_styles['left'] = $border_style; } } if ( preg_match( '/^border-(top|right|bottom|left)$/', $prop, $matches ) ) { $border_width = $this->extract_width_from_shorthand_value( $value ); if ( $border_width ) { $border_widths[ $matches[1] ] = $border_width; } $border_style = $this->extract_style_from_shorthand_value( $value ); if ( $border_style ) { $border_styles[ $matches[1] ] = $border_style; } } if ( 'border-width' === $prop ) { $border_widths = array_merge( $border_widths, $this->expand_shorthand_value( $value ) ); } if ( preg_match( '/^border-(top|right|bottom|left)-width$/', $prop, $matches ) ) { $border_widths[ $matches[1] ] = $value; } if ( 'border-style' === $prop ) { $border_styles = array_merge( $border_styles, $this->expand_shorthand_value( $value ) ); // Remove the original border style declaration, as it will be added later. unset( $styles[ $prop ] ); $should_update_style = true; } if ( preg_match( '/^border-(top|right|bottom|left)-style$/', $prop, $matches ) ) { $border_styles[ $matches[1] ] = $value; // Remove the original border style declaration, as it will be added later. unset( $styles[ $prop ] ); $should_update_style = true; } } if ( array_diff( array_keys( $border_widths ), array_keys( $border_styles ) ) ) { $should_update_style = true; } if ( ! $should_update_style ) { return $style; } $border_styles_declarations = array(); foreach ( $border_widths as $side => $value ) { if ( $this->is_nonzero_width( $value ) ) { $border_styles_declarations[ "border-$side-style" ] = isset( $border_styles[ $side ] ) ? $border_styles[ $side ] : 'solid'; } } // If border style declarations for all sides are present and have the same value, use shorthand syntax. if ( 4 === count( $border_styles_declarations ) && 1 === count( array_unique( $border_styles_declarations ) ) ) { $border_styles_declarations = array( 'border-style' => array_values( $border_styles_declarations )[0] ); } $merged_styles = array_merge( $styles, $border_styles_declarations ); $updated_style = ''; foreach ( $merged_styles as $prop => $value ) { if ( '' !== $value ) { $updated_style .= $prop . ': ' . $value . '; '; } } return trim( $updated_style ); } /** * Expands shorthand border width and style values into individual properties. * * @param string $value The shorthand border value. * @return array<string, string> The expanded border values. */ private function expand_shorthand_value( string $value ): array { $values = preg_split( '/\s+/', trim( $value ) ); if ( ! is_array( $values ) ) { return array(); } $count = count( $values ); if ( 4 === $count ) { return array( 'top' => $values[0] ?? '', 'right' => $values[1] ?? '', 'bottom' => $values[2] ?? '', 'left' => $values[3] ?? '', ); } if ( 3 === $count ) { return array( 'top' => $values[0] ?? '', 'right' => $values[1] ?? '', 'bottom' => $values[2] ?? '', 'left' => $values[1] ?? '', ); } if ( 2 === $count ) { return array( 'top' => $values[0] ?? '', 'right' => $values[1] ?? '', 'bottom' => $values[0] ?? '', 'left' => $values[1] ?? '', ); } if ( 1 === $count ) { return array( 'top' => $values[0] ?? '', 'right' => $values[0] ?? '', 'bottom' => $values[0] ?? '', 'left' => $values[0] ?? '', ); } return array(); } /** * Extracts the width from a shorthand value. * * @param string $value The shorthand value. * @return string|null The extracted width or null if no width is found. */ private function extract_width_from_shorthand_value( string $value ): ?string { $parts = preg_split( '/\s+/', trim( $value ) ); if ( ! is_array( $parts ) ) { return null; } foreach ( $parts as $part ) { if ( preg_match( '/^\d+([a-z%]+)?$/', $part ) ) { return $part; } } return null; } /** * Extracts the style from a shorthand value. * * @param string $value The shorthand value. * @return string|null The extracted style or null if no style is found. */ private function extract_style_from_shorthand_value( string $value ): ?string { $parts = preg_split( '/\s+/', trim( $value ) ); if ( ! is_array( $parts ) ) { return null; } foreach ( $parts as $part ) { if ( in_array( $part, array( 'none', 'hidden', 'dotted', 'dashed', 'solid', 'double', 'groove', 'ridge', 'inset', 'outset' ), true ) ) { return $part; } } return null; } /** * Checks if a border width is nonzero. * * @param string $width The width value. * @return bool */ private function is_nonzero_width( string $width ): bool { return preg_match( '/^0([a-z%]+)?$/', trim( $width ) ) ? false : true; } } email-editor/src/Engine/Renderer/ContentRenderer/Postprocessors/class-highlighting-postprocessor.php0000777 00000001274 15252010675 0030254 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors; /** * This postprocessor replaces <mark> tags with <span> tags because mark tags are not supported across all email clients */ class Highlighting_Postprocessor implements Postprocessor { /** * Postprocess the HTML. * * @param string $html HTML to postprocess. * @return string */ public function postprocess( string $html ): string { return str_replace( array( '<mark', '</mark>' ), array( '<span', '</span>' ), $html ); } } email-editor/src/Engine/Renderer/ContentRenderer/Postprocessors/class-variables-postprocessor.php 0000777 00000004100 15252010675 0027546 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors; use Automattic\WooCommerce\EmailEditor\Engine\Theme_Controller; /** * In some case the blocks HTML contains CSS variables. * For example when spacing is set from a preset the inline styles contain var(--wp--preset--spacing--10), var(--wp--preset--spacing--20) etc. * This postprocessor uses variables from theme.json and replaces the CSS variables with their values in final email HTML. */ class Variables_Postprocessor implements Postprocessor { /** * Instance of Theme_Controller. * * @var Theme_Controller Theme controller. */ private Theme_Controller $theme_controller; /** * Constructor. * * @param Theme_Controller $theme_controller Theme controller. */ public function __construct( Theme_Controller $theme_controller ) { $this->theme_controller = $theme_controller; } /** * Postprocess the HTML. * * @param string $html HTML to postprocess. * @return string */ public function postprocess( string $html ): string { $variables = $this->theme_controller->get_variables_values_map(); $replacements = array(); foreach ( $variables as $name => $value ) { $var_pattern = '/' . preg_quote( 'var(' . $name . ')', '/' ) . '/i'; $replacements[ $var_pattern ] = $value; } // We want to replace the CSS variables only in the style attributes to avoid replacing the actual content. $processor = new \WP_HTML_Tag_Processor( $html ); while ( $processor->next_tag() ) { $style = $processor->get_attribute( 'style' ); if ( null !== $style && true !== $style ) { // Replace CSS variables with their values. $processed_style = preg_replace( array_keys( $replacements ), array_values( $replacements ), $style ); if ( null !== $processed_style ) { $processor->set_attribute( 'style', $processed_style ); } } } return $processor->get_updated_html(); } } email-editor/src/Engine/Renderer/ContentRenderer/class-content-renderer.php 0000777 00000030440 15252010675 0023067 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer; use Automattic\WooCommerce\EmailEditor\Engine\Logger\Email_Editor_Logger; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\Css_Inliner; use Automattic\WooCommerce\EmailEditor\Engine\Theme_Controller; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Fallback; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Post_Content; use WP_Block_Template; use WP_Block_Type_Registry; use WP_Post; /** * Class Content_Renderer */ class Content_Renderer { /** * Process manager * * @var Process_Manager */ private Process_Manager $process_manager; /** * Theme controller * * @var Theme_Controller */ private Theme_Controller $theme_controller; const CONTENT_STYLES_FILE = 'content.css'; /** * WordPress Block Type Registry. * * @var WP_Block_Type_Registry */ private WP_Block_Type_Registry $block_type_registry; /** * CSS inliner * * @var Css_Inliner */ private Css_Inliner $css_inliner; /** * Property to store the backup of the current template content. * * @var string|null */ private $backup_template_content; /** * Property to store the backup of the current template ID. * * @var int|null */ private $backup_template_id; /** * Property to store the backup of the current post. * * @var WP_Post|null */ private $backup_post; /** * Property to store the backup of the current query. * * @var \WP_Query|null */ private $backup_query; /** * Fallback renderer that is used when render_email_callback is not set for the rendered blockType. * * @var Fallback */ private Fallback $fallback_renderer; /** * Logger instance. * * @var Email_Editor_Logger */ private Email_Editor_Logger $logger; /** * Backup of the original core/post-content render callback. * * @var callable|null */ private $backup_post_content_callback; /** * Content_Renderer constructor. * * @param Process_Manager $preprocess_manager Preprocess manager. * @param Css_Inliner $css_inliner Css inliner. * @param Theme_Controller $theme_controller Theme controller. * @param Email_Editor_Logger $logger Logger instance. */ public function __construct( Process_Manager $preprocess_manager, Css_Inliner $css_inliner, Theme_Controller $theme_controller, Email_Editor_Logger $logger ) { $this->process_manager = $preprocess_manager; $this->theme_controller = $theme_controller; $this->css_inliner = $css_inliner; $this->logger = $logger; $this->block_type_registry = WP_Block_Type_Registry::get_instance(); $this->fallback_renderer = new Fallback(); } /** * Initialize the content renderer * * @return void */ private function initialize() { add_filter( 'render_block', array( $this, 'render_block' ), 10, 2 ); add_filter( 'block_parser_class', array( $this, 'block_parser' ) ); add_filter( 'woocommerce_email_blocks_renderer_parsed_blocks', array( $this, 'preprocess_parsed_blocks' ) ); // Swap core/post-content render callback for email rendering. // This prevents issues with WordPress's static $seen_ids array when rendering // multiple emails in a single request (e.g., MailPoet batch processing). $post_content_type = $this->block_type_registry->get_registered( 'core/post-content' ); if ( $post_content_type ) { // Save the original callback (may be null or WordPress's default). $this->backup_post_content_callback = $post_content_type->render_callback; // Replace with our stateless renderer. $post_content_renderer = new Post_Content(); $post_content_type->render_callback = array( $post_content_renderer, 'render_stateless' ); } } /** * Render the content * * @param WP_Post $post Post object. * @param WP_Block_Template $template Block template. * @return string */ public function render( WP_Post $post, WP_Block_Template $template ): string { $this->set_template_globals( $post, $template ); $this->initialize(); $rendered_html = get_the_block_template_html(); $this->reset(); return $this->process_manager->postprocess( $this->inline_styles( $rendered_html, $post, $template ) ); } /** * Get block parser class * * @return string */ public function block_parser() { return 'Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Blocks_Parser'; } /** * Preprocess parsed blocks * * @param array $parsed_blocks Parsed blocks. * @return array */ public function preprocess_parsed_blocks( array $parsed_blocks ): array { return $this->process_manager->preprocess( $parsed_blocks, $this->theme_controller->get_layout_settings(), $this->theme_controller->get_styles() ); } /** * Renders block * Translates block's HTML to HTML suitable for email clients. The method is intended as a callback for 'render_block' filter. * * @param string $block_content Block content. * @param array $parsed_block Parsed block. * @return string */ public function render_block( string $block_content, array $parsed_block ): string { /** * Filter the email-specific context data passed to block renderers. * * This allows email sending systems to provide context data such as user ID, * email address, order information, etc., that can be used by blocks during rendering. * * Blocks that need cart product information can derive it from the user_id or recipient_email * using CartCheckoutUtils::get_cart_product_ids_for_user(). * * @since 1.9.0 * * @param array $email_context { * Email-specific context data. * * @type int $user_id The ID of the user receiving the email. * @type string $recipient_email The recipient's email address. * @type int $order_id The order ID (for order-related emails). * @type string $email_type The type of email being rendered. * } */ $email_context = apply_filters( 'woocommerce_email_editor_rendering_email_context', array() ); $context = new Rendering_Context( $this->theme_controller->get_theme(), $email_context ); $block_type = $this->block_type_registry->get_registered( $parsed_block['blockName'] ); try { if ( $block_type && isset( $block_type->render_email_callback ) && is_callable( $block_type->render_email_callback ) ) { return call_user_func( $block_type->render_email_callback, $block_content, $parsed_block, $context ); } } catch ( \Exception $error ) { $this->logger->error( 'Error thrown while rendering block.', array( 'exception' => $error, 'block_name' => $parsed_block['blockName'], 'parsed_block' => $parsed_block, 'message' => $error->getMessage(), ) ); // Returning the original content. return $block_content; } return $this->fallback_renderer->render( $block_content, $parsed_block, $context ); } /** * Set template globals * * @param WP_Post $email_post Post object. * @param WP_Block_Template $template Block template. * @return void */ private function set_template_globals( WP_Post $email_post, WP_Block_Template $template ) { global $_wp_current_template_content, $_wp_current_template_id, $wp_query, $post; // Backup current values of globals. // Because overriding the globals can affect rendering of the page itself, we need to backup the current values. $this->backup_template_content = $_wp_current_template_content; $this->backup_template_id = $_wp_current_template_id; $this->backup_query = $wp_query; $this->backup_post = $post; $_wp_current_template_id = $template->id; $_wp_current_template_content = $template->content; $wp_query = new \WP_Query( array( 'p' => $email_post->ID ) ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- We need to set the query for correct rendering the blocks. $post = $email_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- We need to set the post for correct rendering the blocks. } /** * As we use default WordPress filters, we need to remove them after email rendering * so that we don't interfere with possible post rendering that might happen later. */ private function reset(): void { remove_filter( 'render_block', array( $this, 'render_block' ) ); remove_filter( 'block_parser_class', array( $this, 'block_parser' ) ); remove_filter( 'woocommerce_email_blocks_renderer_parsed_blocks', array( $this, 'preprocess_parsed_blocks' ) ); // Restore the original core/post-content render callback. // Note: We always restore it, even if it was null originally. $post_content_type = $this->block_type_registry->get_registered( 'core/post-content' ); if ( $post_content_type ) { // @phpstan-ignore-next-line -- WordPress core allows null for render_callback despite type definition. $post_content_type->render_callback = $this->backup_post_content_callback; } // Restore globals to their original values. global $_wp_current_template_content, $_wp_current_template_id, $wp_query, $post; $_wp_current_template_content = $this->backup_template_content; $_wp_current_template_id = $this->backup_template_id; $wp_query = $this->backup_query; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Restoring of the query. $post = $this->backup_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Restoring of the post. } /** * Method to inline styles into the HTML * * @param string $html HTML content. * @param WP_Post $post Post object. * @param WP_Block_Template|null $template Block template. * @return string */ private function inline_styles( $html, WP_Post $post, $template = null ) { $styles = (string) file_get_contents( __DIR__ . '/' . self::CONTENT_STYLES_FILE ); $styles .= (string) file_get_contents( __DIR__ . '/../../content-shared.css' ); // Apply default contentWidth to constrained blocks. $layout = $this->theme_controller->get_layout_settings(); $styles .= sprintf( ' .is-layout-constrained > *:not(.alignleft):not(.alignright):not(.alignfull) { max-width: %1$s; margin-left: auto !important; margin-right: auto !important; } .is-layout-constrained > .alignwide { max-width: %2$s; margin-left: auto !important; margin-right: auto !important; } ', $layout['contentSize'], $layout['wideSize'] ); // Get styles from theme. $styles .= $this->theme_controller->get_stylesheet_for_rendering( $post, $template ); $block_support_styles = $this->theme_controller->get_stylesheet_from_context( 'block-supports', array() ); // Get styles from block-supports stylesheet. This includes rules such as layout (contentWidth) that some blocks use. // @see https://github.com/WordPress/WordPress/blob/3c5da9c74344aaf5bf8097f2e2c6a1a781600e03/wp-includes/script-loader.php#L3134 // @internal :where is not supported by emogrifier, so we need to replace it with *. $block_support_styles = str_replace( ':where(:not(.alignleft):not(.alignright):not(.alignfull))', '*:not(.alignleft):not(.alignright):not(.alignfull)', $block_support_styles ); /* * Layout CSS assumes the top level block will have a single DIV wrapper with children. Since our blocks use tables, * we need to adjust this to look for children in the TD element. This may requires more advanced replacement but * this works in the current version of Gutenberg. * Example rule we're targetting: .wp-container-core-group-is-layout-1.wp-container-core-group-is-layout-1 > * */ $block_support_styles = preg_replace( '/group-is-layout-(\d+) >/', 'group-is-layout-$1 > tbody tr td >', $block_support_styles ); $styles .= $block_support_styles; /* * Debugging for content styles. Remember these get inlined. * echo '<pre>'; * var_dump($styles); * echo '</pre>'; */ $styles = '<style>' . wp_strip_all_tags( (string) apply_filters( 'woocommerce_email_content_renderer_styles', $styles, $post ) ) . '</style>'; return $this->css_inliner->from_html( $styles . $html )->inline_css()->render(); } } email-editor/src/Engine/Renderer/ContentRenderer/content.css 0000777 00000002173 15252010675 0020163 0 ustar 00 /** CSS reset for email clients for elements used in email content StyleLint is disabled because some rules contain properties that linter marks as unknown (e.g. mso- prefix), but they are valid for email rendering */ /* stylelint-disable property-no-unknown */ table, td { border-collapse: collapse; mso-table-lspace: 0; mso-table-rspace: 0; } img { border: 0; height: auto; -ms-interpolation-mode: bicubic; line-height: 100%; max-width: 100%; outline: none; text-decoration: none; } p { display: block; margin: 0; } h1, h2, h3, h4, h5, h6 { margin-bottom: 0; margin-top: 0; } /* Ensure border style is set when a block has a border */ .has-border-color { border-style: solid; } /* We want ensure the same design for all email clients */ ul, ol { /* When margin attribute is set to zero, Outlook doesn't render the list properly. As a possible workaround, we can reset only margin for top and bottom */ margin-bottom: 0; margin-top: 0; padding: 0 0 0 40px; } /* Outlook was adding weird spaces around lists in some versions. Resetting vertical margin for list items solved it */ li { margin-bottom: 0; margin-top: 0; } email-editor/src/Engine/Renderer/ContentRenderer/Layout/class-flex-layout-renderer.php 0000777 00000012646 15252010675 0025153 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Layout; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; /** * This class provides functionality to render inner blocks of a block that supports reduced flex layout. */ class Flex_Layout_Renderer { /** * Render inner blocks in flex layout. * * @param array $parsed_block Parsed block. * @param Rendering_Context $rendering_context Rendering context. * @return string */ public function render_inner_blocks_in_layout( array $parsed_block, Rendering_Context $rendering_context ): string { $theme_styles = $rendering_context->get_theme_styles(); $flex_gap = $theme_styles['spacing']['blockGap'] ?? '0px'; $flex_gap_number = Styles_Helper::parse_value( $flex_gap ); $margin_top = $parsed_block['email_attrs']['margin-top'] ?? '0px'; $justify = $parsed_block['attrs']['layout']['justifyContent'] ?? 'left'; $styles = wp_style_engine_get_styles( $parsed_block['attrs']['style'] ?? array() )['css'] ?? ''; $styles .= 'margin-top: ' . $margin_top . ';'; $styles .= 'text-align: ' . $justify; // MS Outlook doesn't support style attribute in divs so we conditionally wrap the buttons in a table and repeat styles. $output_html = sprintf( '<!--[if mso | IE]><table align="%2$s" role="presentation" border="0" cellpadding="0" cellspacing="0" width="100%%"><tr><td style="%1$s" ><![endif]--> <div style="%1$s"><table class="layout-flex-wrapper" style="display:inline-block"><tbody><tr>', esc_attr( $styles ), esc_attr( $justify ) ); $inner_blocks = $this->compute_widths_for_flex_layout( $parsed_block, $flex_gap_number ); foreach ( $inner_blocks as $key => $block ) { $styles = array(); if ( $block['email_attrs']['layout_width'] ?? null ) { $styles['width'] = $block['email_attrs']['layout_width']; } if ( $key > 0 ) { $styles['padding-left'] = $flex_gap; } $output_html .= '<td class="layout-flex-item" style="' . esc_attr( \WP_Style_Engine::compile_css( $styles, '' ) ) . '">' . render_block( $block ) . '</td>'; } $output_html .= '</tr></table></div> <!--[if mso | IE]></td></tr></table><![endif]-->'; return $output_html; } /** * Compute widths for blocks in flex layout. * * @param array $parsed_block Parsed block. * @param float $flex_gap Flex gap. * @return array */ private function compute_widths_for_flex_layout( array $parsed_block, float $flex_gap ): array { // When there is no parent width we can't compute widths so auto width will be used. if ( ! isset( $parsed_block['email_attrs']['width'] ) ) { return $parsed_block['innerBlocks'] ?? array(); } $blocks_count = count( $parsed_block['innerBlocks'] ); $total_used_width = 0; // Total width assuming items without set width would consume proportional width. $parent_width = Styles_Helper::parse_value( $parsed_block['email_attrs']['width'] ); $inner_blocks = $parsed_block['innerBlocks'] ?? array(); foreach ( $inner_blocks as $key => $block ) { $block_width_percent = ( $block['attrs']['width'] ?? 0 ) ? intval( $block['attrs']['width'] ) : 0; $block_width = floor( $parent_width * ( $block_width_percent / 100 ) ); // If width is not set, we assume it's 25% of the parent width. $total_used_width += $block_width ? $block_width : floor( $parent_width * ( 25 / 100 ) ); if ( ! $block_width ) { $inner_blocks[ $key ]['email_attrs']['layout_width'] = null; // Will be rendered as auto. continue; } $inner_blocks[ $key ]['email_attrs']['layout_width'] = $this->get_width_without_gap( $block_width, $flex_gap, $block_width_percent ) . 'px'; } // When there is only one block, or percentage is set reasonably we don't need to adjust and just render as set by user. if ( $blocks_count <= 1 || ( $total_used_width <= $parent_width ) ) { return $inner_blocks; } foreach ( $inner_blocks as $key => $block ) { $proportional_space_overflow = $parent_width / $total_used_width; $block_width = $block['email_attrs']['layout_width'] ? Styles_Helper::parse_value( $block['email_attrs']['layout_width'] ) : 0; $block_proportional_width = $block_width * $proportional_space_overflow; $block_proportional_percentage = ( $block_proportional_width / $parent_width ) * 100; $inner_blocks[ $key ]['email_attrs']['layout_width'] = $block_width ? $this->get_width_without_gap( $block_proportional_width, $flex_gap, $block_proportional_percentage ) . 'px' : null; } return $inner_blocks; } /** * How much of width we will strip to keep some space for the gap * This is computed based on CSS rule used in the editor: * For block with width set to X percent * width: calc(X% - (var(--wp--style--block-gap) * (100 - X)/100))); * * @param float $block_width Block width in pixels. * @param float $flex_gap Flex gap in pixels. * @param float $block_width_percent Block width in percent. * @return int */ private function get_width_without_gap( float $block_width, float $flex_gap, float $block_width_percent ): int { $width_gap_reduction = $flex_gap * ( ( 100 - $block_width_percent ) / 100 ); return intval( floor( $block_width - $width_gap_reduction ) ); } } email-editor/src/Engine/Renderer/template-canvas.css 0000777 00000004154 15252010675 0016475 0 ustar 00 /* Base CSS rules to be applied to all emails */ /* Created based on original MailPoet template for rendering emails */ /* StyleLint is disabled because some rules contain properties that linter marks as unknown (e.g. mso- prefix), but they are valid for email rendering */ /* stylelint-disable property-no-unknown */ body { margin: 0; padding: 0; -webkit-text-size-adjust: 100%; /* From MJMJ - Automatic test adjustment on mobile max to 100% */ -ms-text-size-adjust: 100%; /* From MJMJ - Automatic test adjustment on mobile max to 100% */ word-spacing: normal; } a { text-decoration: none; } .email_layout_wrapper { margin: 0 auto; width: 100%; } .email_content_wrapper { direction: ltr; font-size: inherit; text-align: left; } .email_footer { direction: ltr; text-align: center; } /* https://www.emailonacid.com/blog/article/email-development/tips-for-coding-email-preheaders */ .email_preheader, .email_preheader * { color: #fff; display: none; font-size: 1px; line-height: 1px; max-height: 0; max-width: 0; mso-hide: all; opacity: 0; overflow: hidden; -webkit-text-size-adjust: none; visibility: hidden; } @media screen and (max-width: 660px) { .email-block-column-content { max-width: 100% !important; } .block { display: block; width: 100% !important; } /* Ensure proper width of columns on mobile when we set 100% and a border is set */ .email-block-column { box-sizing: border-box; } /* We set width to some tables e.g. for wrappers of horizontally aligned images and we force width 100% on mobile */ .email-table-with-width { width: 100% !important; } /* Flex Layout */ .layout-flex-wrapper, .layout-flex-wrapper tbody, .layout-flex-wrapper tr { display: block !important; width: 100% !important; } .layout-flex-item { display: block !important; padding-bottom: 8px !important; /* Half of the flex gap between blocks */ padding-left: 0 !important; width: 100% !important; } .layout-flex-item table, .layout-flex-item td { box-sizing: border-box !important; display: block !important; width: 100% !important; } /* Flex Layout End */ } /* stylelint-enable property-no-unknown */ email-editor/src/Engine/Renderer/class-html2text.php 0000777 00000047002 15252010675 0016445 0 ustar 00 <?php /** * HTML to Text Converter class * * This file was extracted from the `soundasleep/html2text` package. * Copyright (c) 2019 Jevon Wright * MIT License * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer; /** * Converts HTML into plain text format suitable for email display * * Features: * - Maintains links with href copied over * - Information in the <head> is lost * - Handles various HTML elements appropriately for text conversion */ class Html2Text { /** * Default options for HTML to text conversion * * @return array<string, bool|string> Default options array. */ public static function default_options(): array { return array( 'ignore_errors' => false, 'drop_links' => false, 'char_set' => 'auto', ); } /** * Converts HTML into plain text format * * @param string $html The input HTML. * @param boolean|array<string, bool|string> $options Conversion options. * @return string The HTML converted to text. * @throws Html2Text_Exception|\InvalidArgumentException If the HTML could not be loaded or invalid options are provided. */ public static function convert( string $html, $options = array() ): string { if ( false === $options || true === $options ) { // Using old style (< 1.0) of passing in options. $options = array( 'ignore_errors' => $options ); } $options = array_merge( static::default_options(), $options ); // Check all options are valid. foreach ( array_keys( $options ) as $key ) { if ( ! in_array( $key, array_keys( static::default_options() ), true ) ) { // Log invalid option for debugging purposes without exposing in exception. // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log -- Security: Logging sensitive data separately from user-facing exception messages. error_log( 'Html2Text: Invalid option provided: ' . htmlspecialchars( (string) $key, ENT_QUOTES, 'UTF-8' ) . '. Valid options are: ' . htmlspecialchars( implode( ',', array_keys( static::default_options() ) ), ENT_QUOTES, 'UTF-8' ) ); // Throw generic error message to avoid exposing user input. throw new \InvalidArgumentException( 'Invalid option provided for html2text conversion.' ); } } $is_office_document = self::is_office_document( $html ); if ( $is_office_document ) { // Remove office namespace. $html = str_replace( array( '<o:p>', '</o:p>' ), '', $html ); } $html = self::fix_newlines( $html ); // Use mb_convert_encoding for legacy versions of php. if ( PHP_MAJOR_VERSION * 10 + PHP_MINOR_VERSION < 81 && mb_detect_encoding( $html, 'UTF-8', true ) ) { $converted = mb_convert_encoding( $html, 'HTML-ENTITIES', 'UTF-8' ); $html = false !== $converted ? $converted : $html; } // Ensure $html is always a string before passing to get_document. if ( ! is_string( $html ) ) { $html = (string) $html; } $doc = self::get_document( $html, $options ); $output = self::iterate_over_node( $doc, null, false, $is_office_document, $options ); // Process output for whitespace/newlines. $output = self::process_whitespace_newlines( $output ); return $output; } /** * Unify newlines * * Converts \r\n to \n, and \r to \n. This means that all newlines * (Unix, Windows, Mac) all become \ns. * * @param string $text Text with any number of \r, \r\n and \n combinations. * @return string The fixed text. */ public static function fix_newlines( string $text ): string { // Replace \r\n to \n. $text = str_replace( "\r\n", "\n", $text ); // Remove \rs. $text = str_replace( "\r", "\n", $text ); return $text; } /** * Get non-breaking space character codes * * @return array<string> Array of nbsp codes. */ public static function nbsp_codes(): array { return array( "\xc2\xa0", "\u00a0", ); } /** * Get zero-width non-joiner character codes * * @return array<string> Array of zwnj codes. */ public static function zwnj_codes(): array { return array( "\xe2\x80\x8c", "\u200c", ); } /** * Remove leading or trailing spaces and excess empty lines from provided multiline text * * @param string $text Multiline text with any number of leading or trailing spaces or excess lines. * @return string The fixed text. */ public static function process_whitespace_newlines( string $text ): string { // Remove excess spaces around tabs. $result = preg_replace( '/ *\t */im', "\t", $text ); $text = null !== $result ? $result : $text; // Remove leading whitespace. $text = ltrim( $text ); // Remove leading spaces on each line. $result = preg_replace( "/\n[ \t]*/im", "\n", $text ); $text = null !== $result ? $result : $text; // Convert non-breaking spaces to regular spaces to prevent output issues, // do it here so they do NOT get removed with other leading spaces, as they // are sometimes used for indentation. $text = self::render_text( $text ); // Remove trailing whitespace. $text = rtrim( $text ); // Remove trailing spaces on each line. $result = preg_replace( "/[ \t]*\n/im", "\n", $text ); $text = null !== $result ? $result : $text; // Unarmor pre blocks. $text = self::fix_newlines( $text ); // Remove unnecessary empty lines. $result = preg_replace( "/\n\n\n*/im", "\n\n", $text ); return null !== $result ? $result : $text; } /** * Can we guess that this HTML is generated by Microsoft Office? * * @param string $html The HTML content. * @return bool True if this appears to be an Office document. */ public static function is_office_document( string $html ): bool { return strpos( $html, 'urn:schemas-microsoft-com:office' ) !== false; } /** * Check if text is whitespace * * @param string $text The text to check. * @return bool True if the text is whitespace. */ public static function is_whitespace( string $text ): bool { return 0 === strlen( trim( self::render_text( $text ), "\n\r\t " ) ); } /** * Parse HTML into a DOMDocument * * @param string $html The input HTML. * @param array<string, bool|string> $options Parsing options. * @return \DOMDocument The parsed document tree. * @throws Html2Text_Exception If the HTML could not be loaded. */ private static function get_document( string $html, array $options ): \DOMDocument { $doc = new \DOMDocument(); $html = trim( $html ); if ( ! $html ) { // DOMDocument doesn't support empty value and throws an error. // Return empty document instead. return $doc; } if ( '<' !== $html[0] ) { // If HTML does not begin with a tag, we put a body tag around it. // If we do not do this, PHP will insert a paragraph tag around // the first block of text for some reason which can mess up // the newlines. See pre.html test for an example. $html = '<body>' . $html . '</body>'; } $header = ''; // Use char sets for modern versions of php. if ( PHP_MAJOR_VERSION * 10 + PHP_MINOR_VERSION >= 81 ) { // Use specified char_set, or auto detect if not set. $char_set = ! empty( $options['char_set'] ) && is_string( $options['char_set'] ) ? $options['char_set'] : 'auto'; if ( 'auto' === $char_set ) { $detected = mb_detect_encoding( $html ); $char_set = false !== $detected ? $detected : 'UTF-8'; } elseif ( strpos( $char_set, ',' ) !== false ) { $encoding_list = explode( ',', $char_set ); $encoding_list = array_map( 'trim', $encoding_list ); $encoding_list = array_filter( $encoding_list, function ( $encoding ) { return ! empty( $encoding ); } ); if ( ! empty( $encoding_list ) ) { // Ensure we have a proper list with consecutive integer keys. $encoding_list = array_values( $encoding_list ); mb_detect_order( $encoding_list ); $detected = mb_detect_encoding( $html ); $char_set = false !== $detected ? $detected : 'UTF-8'; } } // Turn off error detection for Windows-1252 legacy html. if ( strpos( $char_set, '1252' ) !== false ) { $options['ignore_errors'] = true; } $header = '<?xml version="1.0" encoding="' . $char_set . '">'; } if ( ! empty( $options['ignore_errors'] ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $doc->strictErrorChecking = false; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $doc->recover = true; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $doc->xmlStandalone = true; $old_internal_errors = libxml_use_internal_errors( true ); $load_result = $doc->loadHTML( $header . $html, LIBXML_NOWARNING | LIBXML_NOERROR | LIBXML_NONET | LIBXML_PARSEHUGE ); libxml_use_internal_errors( $old_internal_errors ); } else { $load_result = $doc->loadHTML( $header . $html ); } if ( ! $load_result ) { // Log truncated HTML content for debugging purposes (limit to 500 chars to prevent log bloat). $html_preview = strlen( $html ) > 500 ? substr( $html, 0, 500 ) . '...[truncated]' : $html; // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log -- Security: Logging sensitive data separately from user-facing exception messages. error_log( 'Html2Text: Failed to load HTML content: ' . htmlspecialchars( $html_preview, ENT_QUOTES, 'UTF-8' ) ); // Throw a generic error message to avoid exposing sensitive data. throw new Html2Text_Exception( 'Could not load HTML - the content may be malformed.' ); } return $doc; } /** * Replace any special characters with simple text versions * * This prevents output issues: * - Convert non-breaking spaces to regular spaces; and * - Convert zero-width non-joiners to '' (nothing). * * This is to match our goal of rendering documents as they would be rendered * by a browser. * * @param string $text The text to process. * @return string The processed text. */ private static function render_text( string $text ): string { $text = str_replace( self::nbsp_codes(), ' ', $text ); $text = str_replace( self::zwnj_codes(), '', $text ); return $text; } /** * Get the next child name * * @param \DOMNode|null $node The node to check. * @return string|null The next child name. */ private static function next_child_name( ?\DOMNode $node ): ?string { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase if ( null === $node || null === $node->nextSibling ) { return null; } // Get the next child. // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $next_node = $node->nextSibling; while ( null !== $next_node ) { if ( $next_node instanceof \DOMText ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase if ( ! self::is_whitespace( $next_node->wholeText ) ) { break; } } if ( $next_node instanceof \DOMElement ) { break; } // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $next_node = $next_node->nextSibling; } $next_name = null; if ( $next_node instanceof \DOMElement || $next_node instanceof \DOMText ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $next_name = strtolower( $next_node->nodeName ); } return $next_name; } /** * Iterate over a DOM node and convert to text * * @param \DOMNode $node The DOM node. * @param string|null $prev_name Previous node name. * @param bool $in_pre Whether we're in a pre block. * @param bool $is_office_document Whether this is an Office document. * @param array<string, bool|string> $options Conversion options. * @return string The converted text. */ private static function iterate_over_node( \DOMNode $node, ?string $prev_name, bool $in_pre, bool $is_office_document, array $options ): string { if ( $node instanceof \DOMText ) { // Replace whitespace characters with a space (equivalent to \s). if ( $in_pre ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $text = "\n" . trim( self::render_text( $node->wholeText ), "\n\r\t " ) . "\n"; // Remove trailing whitespace only. $result = preg_replace( "/[ \t]*\n/im", "\n", $text ); $text = null !== $result ? $result : $text; // Armor newlines with \r. return str_replace( "\n", "\r", $text ); } // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $text = self::render_text( $node->wholeText ); $result = preg_replace( "/[\\t\\n\\f\\r ]+/im", ' ', $text ); $text = null !== $result ? $result : $text; if ( ! self::is_whitespace( $text ) && ( 'p' === $prev_name || 'div' === $prev_name ) ) { return "\n" . $text; } return $text; } if ( $node instanceof \DOMDocumentType || $node instanceof \DOMProcessingInstruction ) { // Ignore. return ''; } // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $name = strtolower( $node->nodeName ); $next_name = self::next_child_name( $node ); // Start whitespace. switch ( $name ) { case 'hr': $prefix = ''; if ( null !== $prev_name ) { $prefix = "\n"; } return $prefix . "---------------------------------------------------------------\n"; case 'style': case 'head': case 'title': case 'meta': case 'script': // Ignore these tags. return ''; case 'h1': case 'h2': case 'h3': case 'h4': case 'h5': case 'h6': case 'ol': case 'ul': case 'pre': // Add two newlines. $output = "\n\n"; break; case 'td': case 'th': // Add tab char to separate table fields. $output = "\t"; break; case 'p': // Microsoft exchange emails often include HTML which, when passed through // html2text, results in lots of double line returns everywhere. // // To fix this, for any p element with a className of `MsoNormal` (the standard // classname in any Microsoft export or outlook for a paragraph that behaves // like a line return) we skip the first line returns and set the name to br. if ( $is_office_document && $node instanceof \DOMElement && 'MsoNormal' === $node->getAttribute( 'class' ) ) { $output = ''; $name = 'br'; break; } // Add two lines. $output = "\n\n"; break; case 'tr': // Add one line. $output = "\n"; break; case 'div': $output = ''; if ( null !== $prev_name ) { // Add one line. $output .= "\n"; } break; case 'li': $output = '- '; break; default: // Print out contents of unknown tags. $output = ''; break; } // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase if ( $node->childNodes->length > 0 ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $n = $node->childNodes->item( 0 ); $previous_sibling_names = array(); $previous_sibling_name = null; $parts = array(); $trailing_whitespace = 0; while ( null !== $n ) { $text = self::iterate_over_node( $n, $previous_sibling_name, $in_pre || 'pre' === $name, $is_office_document, $options ); // Pass current node name to next child, as previousSibling does not appear to get populated. if ( $n instanceof \DOMDocumentType || $n instanceof \DOMProcessingInstruction || ( $n instanceof \DOMText && self::is_whitespace( $text ) ) ) { // Keep current previousSiblingName, these are invisible. ++$trailing_whitespace; } else { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $previous_sibling_name = strtolower( $n->nodeName ); $previous_sibling_names[] = $previous_sibling_name; $trailing_whitespace = 0; } $node->removeChild( $n ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $n = $node->childNodes->item( 0 ); $parts[] = $text; } // Remove trailing whitespace, important for the br check below. while ( $trailing_whitespace-- > 0 ) { array_pop( $parts ); } // Suppress last br tag inside a node list if follows text. $last_name = array_pop( $previous_sibling_names ); if ( 'br' === $last_name ) { $last_name = array_pop( $previous_sibling_names ); if ( '#text' === $last_name ) { array_pop( $parts ); } } $output .= implode( '', $parts ); } // End whitespace. switch ( $name ) { case 'h1': case 'h2': case 'h3': case 'h4': case 'h5': case 'h6': case 'pre': case 'p': // Add two lines. $output .= "\n\n"; break; case 'br': // Add one line. $output .= "\n"; break; case 'div': break; case 'a': // Links are returned in [text](link) format. $href = $node instanceof \DOMElement ? $node->getAttribute( 'href' ) : ''; $output = trim( $output ); // Remove double [[ ]] s from linking images. if ( '[' === substr( $output, 0, 1 ) && ']' === substr( $output, -1 ) ) { $output = substr( $output, 1, strlen( $output ) - 2 ); // For linking images, the title of the <a> overrides the title of the <img>. if ( $node instanceof \DOMElement && $node->getAttribute( 'title' ) ) { $output = $node->getAttribute( 'title' ); } } // If there is no link text, but a title attr. if ( ! $output && $node instanceof \DOMElement && $node->getAttribute( 'title' ) ) { $output = $node->getAttribute( 'title' ); } if ( ! $href ) { // It doesn't link anywhere. if ( $node instanceof \DOMElement && $node->getAttribute( 'name' ) ) { if ( $options['drop_links'] ) { $output = "$output"; } else { $output = "[$output]"; } } } elseif ( $href === $output || "mailto:$output" === $href || "http://$output" === $href || "https://$output" === $href ) { // Link to the same address: just use link. $output = "$output"; } elseif ( $output ) { // Replace it. if ( $options['drop_links'] ) { $output = "$output"; } else { $output = "[$output]($href)"; } } else { // Empty string. $output = "$href"; } // Does the next node require additional whitespace? switch ( $next_name ) { case 'h1': case 'h2': case 'h3': case 'h4': case 'h5': case 'h6': $output .= "\n"; break; } break; case 'img': if ( $node instanceof \DOMElement && $node->getAttribute( 'title' ) ) { $output = '[' . $node->getAttribute( 'title' ) . ']'; } elseif ( $node instanceof \DOMElement && $node->getAttribute( 'alt' ) ) { $output = '[' . $node->getAttribute( 'alt' ) . ']'; } else { $output = ''; } break; case 'li': $output .= "\n"; break; case 'blockquote': // Process quoted text for whitespace/newlines. $output = self::process_whitespace_newlines( $output ); // Add leading newline. $output = "\n" . $output; // Prepend '> ' at the beginning of all lines. $result = preg_replace( "/\n/im", "\n> ", $output ); $output = null !== $result ? $result : $output; // Replace leading '> >' with '>>'. $result = preg_replace( "/\n> >/im", "\n>>", $output ); $output = null !== $result ? $result : $output; // Add another leading newline and trailing newlines. $output = "\n" . $output . "\n\n"; break; default: // Do nothing. } return $output; } } email-editor/src/Engine/Renderer/template-canvas.php 0000777 00000003632 15252010675 0016474 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); // phpcs:disable Generic.Files.InlineHTML.Found // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped /** * Template file to render the current 'wp_template', specifcally for emails. * * Variables passed to this template: * * @var string $subject The email subject * @var string $pre_header The email pre-header text * @var string $template_html The email template HTML content * @var string $meta_robots Meta robots tag content * @var array{contentSize: string} $layout Layout configuration */ ?><!DOCTYPE html> <html <?php language_attributes(); ?>> <head> <title><?php echo esc_html( $subject ); ?></title> <meta charset="<?php bloginfo( 'charset' ); ?>" /> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="format-detection" content="telephone=no" /> <?php echo $meta_robots; ?> <!-- Forced Styles --> </head> <body> <!--[if mso | IE]><table align="center" role="presentation" border="0" cellpadding="0" cellspacing="0" width="<?php echo esc_attr( $layout['contentSize'] ); ?>" style="width:<?php echo esc_attr( $layout['contentSize'] ); ?>"><tr><td><![endif]--> <div class="email_layout_wrapper" style="max-width: <?php echo esc_attr( $layout['contentSize'] ); ?>"> <table width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation"> <tbody> <tr> <td class="email_preheader" height="1"> <?php echo esc_html( wp_strip_all_tags( $pre_header ) ); ?> </td> </tr> <tr> <td class="email_content_wrapper"> <?php echo $template_html; ?> </td> </tr> </tbody> </table> </div> <!--[if mso | IE]></td></tr></table><![endif]--> </body> </html> email-editor/src/Engine/Renderer/class-html2text-exception.php 0000777 00000001731 15252010675 0020440 0 ustar 00 <?php /** * HTML to Text Exception class * * This file was extracted from the `soundasleep/html2text` package. * Copyright (c) 2019 Jevon Wright * MIT License * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer; /** * Exception thrown when HTML to text conversion fails */ class Html2Text_Exception extends \Exception { /** * Additional information about the error * * @var string */ private string $more_info; /** * Constructor * * @param string $message Error message. * @param string $more_info Additional error information. */ public function __construct( string $message = '', string $more_info = '' ) { parent::__construct( $message ); $this->more_info = $more_info; } /** * Returns additional error information * * @return string Additional error information. */ public function get_more_info(): string { return $this->more_info; } } email-editor/src/Engine/Renderer/interface-css-inliner.php 0000777 00000001403 15252010675 0017566 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer; interface Css_Inliner { /** * Builds a new instance from the given HTML. * * @param string $unprocessed_html raw HTML, must be UTF-encoded, must not be empty. * * @return static */ public function from_html( string $unprocessed_html ): self; /** * Inlines the given CSS into the existing HTML. * * @param string $css the CSS to inline, must be UTF-8-encoded. * * @return $this */ public function inline_css( string $css = '' ): self; /** * Renders the normalized and processed HTML. * * @return string */ public function render(): string; } email-editor/src/Engine/Renderer/class-renderer.php 0000777 00000021472 15252010675 0016323 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Content_Renderer; use Automattic\WooCommerce\EmailEditor\Engine\Templates\Templates; use Automattic\WooCommerce\EmailEditor\Engine\Theme_Controller; use Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags\Personalization_Tags_Registry; use WP_Style_Engine; /** * Class Renderer */ class Renderer { /** * Theme controller * * @var Theme_Controller */ private Theme_Controller $theme_controller; /** * Content renderer * * @var Content_Renderer */ private Content_Renderer $content_renderer; /** * Templates * * @var Templates */ private Templates $templates; /** * Css inliner * * @var Css_Inliner */ private Css_Inliner $css_inliner; /** * Personalization tags registry * * @var Personalization_Tags_Registry */ private Personalization_Tags_Registry $personalization_tags_registry; /** * Map of placeholders to full HTML comment tags for restoration. * * @var array */ private array $personalization_tag_placeholders = array(); const TEMPLATE_FILE = 'template-canvas.php'; const TEMPLATE_STYLES_FILE = 'template-canvas.css'; /** * Renderer constructor. * * @param Content_Renderer $content_renderer Content renderer. * @param Templates $templates Templates. * @param Css_Inliner $css_inliner CSS Inliner. * @param Theme_Controller $theme_controller Theme controller. * @param Personalization_Tags_Registry $personalization_tags_registry Personalization tags registry. */ public function __construct( Content_Renderer $content_renderer, Templates $templates, Css_Inliner $css_inliner, Theme_Controller $theme_controller, Personalization_Tags_Registry $personalization_tags_registry ) { $this->content_renderer = $content_renderer; $this->templates = $templates; $this->theme_controller = $theme_controller; $this->css_inliner = $css_inliner; $this->personalization_tags_registry = $personalization_tags_registry; } /** * Renders the email template * * @param \WP_Post $post Post object. * @param string $subject Email subject. * @param string $pre_header An email preheader or preview text is the short snippet of text that follows the subject line in an inbox. See https://kb.mailpoet.com/article/418-preview-text. * @param string $language Email language. * @param string $meta_robots Optional string. Can be left empty for sending, but you can provide a value (e.g. noindex, nofollow) when you want to display email html in a browser. * @param string $template_slug Optional block template slug used for cases when email doesn't have associated template. * @return array */ public function render( \WP_Post $post, string $subject, string $pre_header, string $language, string $meta_robots = '', string $template_slug = '' ): array { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed if ( ! $template_slug ) { $template_slug = get_page_template_slug( $post ) ? get_page_template_slug( $post ) : 'email-general'; } /** @var \WP_Block_Template $template */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort -- used for phpstan $template = $this->templates->get_block_template( $template_slug ); $email_styles = $this->theme_controller->get_styles(); $template_html = $this->content_renderer->render( $post, $template ); $layout = $this->theme_controller->get_layout_settings(); ob_start(); include self::TEMPLATE_FILE; $rendered_template = (string) ob_get_clean(); $template_styles = WP_Style_Engine::compile_css( array( 'background-color' => $email_styles['color']['background'] ?? 'inherit', 'color' => $email_styles['color']['text'] ?? 'inherit', 'padding-top' => $email_styles['spacing']['padding']['top'] ?? '0px', 'padding-bottom' => $email_styles['spacing']['padding']['bottom'] ?? '0px', 'padding-left' => $email_styles['spacing']['padding']['left'] ?? '0px', 'padding-right' => $email_styles['spacing']['padding']['right'] ?? '0px', 'font-family' => $email_styles['typography']['fontFamily'] ?? 'inherit', 'line-height' => $email_styles['typography']['lineHeight'] ?? '1.5', 'font-size' => $email_styles['typography']['fontSize'] ?? 'inherit', ), 'body, .email_layout_wrapper' ); $template_styles .= '.email_layout_wrapper { box-sizing: border-box;}'; $template_styles .= file_get_contents( __DIR__ . '/' . self::TEMPLATE_STYLES_FILE ); $template_styles = '<style>' . wp_strip_all_tags( (string) apply_filters( 'woocommerce_email_renderer_styles', $template_styles, $post ) ) . '</style>'; $rendered_template = $this->inline_css_styles( $template_styles . $rendered_template ); // This is a workaround to support link :hover in some clients. Ideally we would remove the ability to set :hover // however this is not possible using the color panel from Gutenberg. if ( isset( $email_styles['elements']['link'][':hover']['color']['text'] ) ) { $rendered_template = str_replace( '<!-- Forced Styles -->', '<style>a:hover { color: ' . esc_attr( $email_styles['elements']['link'][':hover']['color']['text'] ) . ' !important; }</style>', $rendered_template ); } return array( 'html' => $rendered_template, 'text' => $this->render_text_version( $rendered_template ), ); } /** * Inlines CSS styles into the HTML * * @param string $template HTML template. * @return string */ private function inline_css_styles( $template ) { return $this->css_inliner->from_html( $template )->inline_css()->render(); } /** * Renders the text version of the email template. * * @param string $template HTML template. * @return string */ private function render_text_version( $template ) { $template = ( mb_detect_encoding( $template, 'UTF-8', true ) ) ? $template : mb_convert_encoding( $template, 'UTF-8', mb_list_encodings() ); // Ensure template is a string before processing. if ( ! is_string( $template ) ) { return ''; } // Preserve personalization tags by temporarily replacing them with unique placeholders. $template = $this->preserve_personalization_tags( $template ); $result = Html2Text::convert( (string) $template, array( 'ignore_errors' => true ) ); if ( ! $result ) { return ''; } // Restore personalization tags from placeholders. $result = $this->restore_personalization_tags( $result ); return $result; } /** * Preserves personalization tags by replacing them with unique placeholders (not inside comments). * * @param string $template HTML template. * @return string */ private function preserve_personalization_tags( string $template ): string { $all_registered_tags = $this->personalization_tags_registry->get_all(); $this->personalization_tag_placeholders = array(); $counter = 0; $base_tokens = array(); // All the tokens used in the email, e.g. [woocommerce/customer-username]. $token_prefixes = array(); // All the used prefixes, e.g. woocommerce, mailpoet, etc. foreach ( $all_registered_tags as $tag ) { $token = $tag->get_token(); // E.g. [woocommerce/customer-username]. $base_tokens[ $token ] = true; // Remove brackets for regex matching, escape for regex. $token_prefixes[] = preg_quote( substr( $token, 1, -1 ), '/' ); } if ( empty( $token_prefixes ) ) { return $template; } // Match all of the code comments that look like a personalization tags. $pattern = '/<!--\[(' . implode( '|', $token_prefixes ) . ')(?:\s+[^\]]*)?\]-->/'; $template = preg_replace_callback( $pattern, function ( $matches ) use ( &$counter, $base_tokens ) { // $matches[1] is the token without brackets, add brackets for lookup. $base_token = '[' . $matches[1] . ']'; if ( isset( $base_tokens[ $base_token ] ) ) { $placeholder = 'PERSONALIZATION_TAG_PLACEHOLDER_' . $counter; $this->personalization_tag_placeholders[ $placeholder ] = $matches[0]; ++$counter; return $placeholder; } return $matches[0]; }, $template ); return $template ?? ''; } /** * Restores personalization tags from placeholders * * @param string $text Text content. * @return string */ private function restore_personalization_tags( string $text ): string { if ( empty( $this->personalization_tag_placeholders ) ) { return $text; } foreach ( $this->personalization_tag_placeholders as $placeholder => $html_comment ) { $text = str_replace( $placeholder, $html_comment, $text ); } return $text; } } email-editor/src/Engine/Logger/class-email-editor-logger-interface.php 0000777 00000004674 15252010675 0021761 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Logger; /** * Interface for email editor loggers. */ interface Email_Editor_Logger_Interface { /** * System is unusable. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function emergency( string $message, array $context = array() ): void; /** * Action must be taken immediately. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function alert( string $message, array $context = array() ): void; /** * Critical conditions. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function critical( string $message, array $context = array() ): void; /** * Runtime errors that do not require immediate action but should typically * be logged and monitored. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function error( string $message, array $context = array() ): void; /** * Exceptional occurrences that are not errors. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function warning( string $message, array $context = array() ): void; /** * Normal but significant events. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function notice( string $message, array $context = array() ): void; /** * Interesting events. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function info( string $message, array $context = array() ): void; /** * Detailed debug information. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function debug( string $message, array $context = array() ): void; /** * Logs with an arbitrary level. * * @param string $level The log level. * @param string $message The log message. * @param array $context The log context. * @return void */ public function log( string $level, string $message, array $context = array() ): void; } email-editor/src/Engine/Logger/class-default-email-editor-logger.php 0000777 00000010143 15252010675 0021431 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Logger; /** * Default implementation of the email editor logger that writes to WordPress debug log. */ class Default_Email_Editor_Logger implements Email_Editor_Logger_Interface { /** * Log levels. */ public const EMERGENCY = 'emergency'; public const ALERT = 'alert'; public const CRITICAL = 'critical'; public const ERROR = 'error'; public const WARNING = 'warning'; public const NOTICE = 'notice'; public const INFO = 'info'; public const DEBUG = 'debug'; /** * Path to the log file. * * @var string */ private $log_file; /** * Constructor. */ public function __construct() { if ( defined( 'WP_DEBUG_LOG' ) ) { if ( true === WP_DEBUG_LOG ) { $this->log_file = WP_CONTENT_DIR . '/debug.log'; } elseif ( is_string( WP_DEBUG_LOG ) && ! empty( WP_DEBUG_LOG ) ) { $this->log_file = WP_DEBUG_LOG; } else { $this->log_file = ''; } } else { $this->log_file = ''; } } /** * System is unusable. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function emergency( string $message, array $context = array() ): void { $this->log( self::EMERGENCY, $message, $context ); } /** * Action must be taken immediately. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function alert( string $message, array $context = array() ): void { $this->log( self::ALERT, $message, $context ); } /** * Critical conditions. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function critical( string $message, array $context = array() ): void { $this->log( self::CRITICAL, $message, $context ); } /** * Runtime errors that do not require immediate action but should typically * be logged and monitored. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function error( string $message, array $context = array() ): void { $this->log( self::ERROR, $message, $context ); } /** * Exceptional occurrences that are not errors. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function warning( string $message, array $context = array() ): void { $this->log( self::WARNING, $message, $context ); } /** * Normal but significant events. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function notice( string $message, array $context = array() ): void { $this->log( self::NOTICE, $message, $context ); } /** * Interesting events. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function info( string $message, array $context = array() ): void { $this->log( self::INFO, $message, $context ); } /** * Detailed debug information. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function debug( string $message, array $context = array() ): void { $this->log( self::DEBUG, $message, $context ); } /** * Logs with an arbitrary level. * * @param string $level The log level. * @param string $message The log message. * @param array $context The log context. * @return void */ public function log( string $level, string $message, array $context = array() ): void { if ( ! $this->log_file ) { return; } $entry = sprintf( '[%s] %s: %s %s', gmdate( 'Y-m-d H:i:s' ), strtoupper( $level ), $message, ! empty( $context ) ? wp_json_encode( $context ) : '' ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log -- This is a logging class, error_log is the intended functionality. error_log( $entry . PHP_EOL, 3, $this->log_file ); } } email-editor/src/Engine/Logger/class-email-editor-logger.php 0000777 00000007104 15252010675 0020012 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\Logger; /** * Email Editor Logger class. * A wrapper that sets the logger to use. If no logger is provided, it defaults to the Default_Email_Editor_Logger. */ class Email_Editor_Logger implements Email_Editor_Logger_Interface { /** * Logger instance to delegate to. * * @var Email_Editor_Logger_Interface */ private Email_Editor_Logger_Interface $logger; /** * Constructor. * * @param Email_Editor_Logger_Interface|null $logger Logger instance. */ public function __construct( ?Email_Editor_Logger_Interface $logger = null ) { $this->logger = $logger ?? new Default_Email_Editor_Logger(); } /** * Set the logger. * * @param Email_Editor_Logger_Interface $logger Logger instance. * @return void */ public function set_logger( Email_Editor_Logger_Interface $logger ): void { $this->logger = $logger; } /** * Adds emergency level log message. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function emergency( string $message, array $context = array() ): void { $this->logger->emergency( $message, $context ); } /** * Adds alert level log message. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function alert( string $message, array $context = array() ): void { $this->logger->alert( $message, $context ); } /** * Adds critical level log message. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function critical( string $message, array $context = array() ): void { $this->logger->critical( $message, $context ); } /** * Adds error level log message. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function error( string $message, array $context = array() ): void { $this->logger->error( $message, $context ); } /** * Adds warning level log message. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function warning( string $message, array $context = array() ): void { $this->logger->warning( $message, $context ); } /** * Adds notice level log message. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function notice( string $message, array $context = array() ): void { $this->logger->notice( $message, $context ); } /** * Adds info level log message. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function info( string $message, array $context = array() ): void { $this->logger->info( $message, $context ); } /** * Adds debug level log message. * * @param string $message The log message. * @param array $context The log context. * @return void */ public function debug( string $message, array $context = array() ): void { $this->logger->debug( $message, $context ); } /** * Logs with an arbitrary level. * * @param string $level The log level. * @param string $message The log message. * @param array $context The log context. * @return void */ public function log( string $level, string $message, array $context = array() ): void { $this->logger->log( $level, $message, $context ); } } email-editor/src/Engine/class-theme-controller.php 0000777 00000026005 15252010675 0016227 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine; use WP_Block_Template; use WP_Post; use WP_Theme_JSON; use WP_Theme_JSON_Resolver; /** * E-mail editor works with own theme.json which defines settings for the editor and styles for the e-mail. * This class is responsible for accessing data defined by the theme.json. */ class Theme_Controller { /** * Core theme loaded from the WordPress core. * * @var WP_Theme_JSON */ private WP_Theme_JSON $core_theme; /** * Base theme loaded from a file in the package directory. * * @var WP_Theme_JSON */ private WP_Theme_JSON $base_theme; /** * User theme contains user custom styles and settings * * @var User_Theme */ private User_Theme $user_theme; /** * Site style sync controller * * @var Site_Style_Sync_Controller */ private Site_Style_Sync_Controller $site_style_sync_controller; /** * Theme_Controller constructor. */ public function __construct() { $this->core_theme = WP_Theme_JSON_Resolver::get_core_data(); $this->base_theme = new WP_Theme_JSON( (array) json_decode( (string) file_get_contents( __DIR__ . '/theme.json' ), true ), 'default' ); $this->user_theme = new User_Theme(); $this->site_style_sync_controller = new Site_Style_Sync_Controller(); } /** * Gets combined theme data from the core and base theme, merged with the user . * * @return WP_Theme_JSON */ public function get_theme(): WP_Theme_JSON { $theme = $this->get_base_theme(); $theme->merge( $this->user_theme->get_theme() ); return $theme; } /** * Gets combined theme data from the core and base theme and some handpicked settings from the site theme. * * @return WP_Theme_JSON */ public function get_base_theme(): WP_Theme_JSON { $theme = new WP_Theme_JSON(); $theme->merge( $this->core_theme ); $theme->merge( $this->base_theme ); // Merge synced styles from current active theme. if ( $this->site_style_sync_controller->is_sync_enabled() ) { /** @var WP_Theme_JSON $site_theme */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort $site_theme = $this->site_style_sync_controller->get_theme(); $theme->merge( $site_theme ); } return apply_filters( 'woocommerce_email_editor_theme_json', $theme ); } /** * Replace preset variables with their values. * * @param array $values Styles array. * @param array $presets Presets array. * @return array */ private function recursive_replace_presets( $values, $presets ) { foreach ( $values as $key => $value ) { if ( is_array( $value ) ) { $values[ $key ] = $this->recursive_replace_presets( $value, $presets ); } elseif ( is_string( $value ) ) { $values[ $key ] = preg_replace( array_keys( $presets ), array_values( $presets ), $value ); } else { $values[ $key ] = $value; } } return $values; } /** * Replace preset variables with their values. * * @param array $styles Styles array. * @return array */ private function recursive_extract_preset_variables( $styles ) { foreach ( $styles as $key => $style_value ) { if ( is_array( $style_value ) ) { $styles[ $key ] = $this->recursive_extract_preset_variables( $style_value ); } elseif ( is_string( $style_value ) && strpos( $style_value, 'var:preset|' ) === 0 ) { /** @var string $style_value */ // phpcs:ignore Generic.Commenting.DocComment.MissingShort $styles[ $key ] = 'var(--wp--' . str_replace( '|', '--', str_replace( 'var:', '', $style_value ) ) . ')'; } else { $styles[ $key ] = $style_value; } } return $styles; } /** * Get styles for the e-mail. * * @return array{ * spacing: array{ * blockGap: string, * padding: array{bottom: string, left: string, right: string, top: string} * }, * color: array{ * background: string * }, * typography: array{ * fontFamily: string * } * } */ public function get_styles(): array { $theme_styles = $this->get_theme()->get_data()['styles']; // Extract preset variables. $theme_styles = $this->recursive_extract_preset_variables( $theme_styles ); // Replace preset values. $variables = $this->get_variables_values_map(); $presets = array(); foreach ( $variables as $name => $value ) { $pattern = '/var\(' . preg_quote( $name, '/' ) . '\)/i'; $presets[ $pattern ] = $value; } /* @phpstan-ignore-next-line Return type defined above. */ return $this->recursive_replace_presets( $theme_styles, $presets ); } /** * Get settings from the theme. * * @return array */ public function get_settings(): array { return $this->get_theme()->get_settings(); } /** * Get layout settings from the theme. * * @return array{contentSize: string, wideSize: string, allowEditing?: bool, allowCustomContentAndWideSize?: bool} */ public function get_layout_settings(): array { return $this->get_theme()->get_settings()['layout']; } /** * Get stylesheet from context. * * @param string $context Context. * @param array $options Options. * @return string */ public function get_stylesheet_from_context( $context, $options = array() ): string { return function_exists( 'gutenberg_style_engine_get_stylesheet_from_context' ) ? gutenberg_style_engine_get_stylesheet_from_context( $context, $options ) : wp_style_engine_get_stylesheet_from_context( $context, $options ); } /** * Get stylesheet for rendering. * * @param WP_Post|null $post Post object. * @param WP_Block_Template|null $template Template object. * @return string */ public function get_stylesheet_for_rendering( ?WP_Post $post = null, $template = null ): string { $email_theme_settings = $this->get_settings(); $css_presets = ''; // Font family classes. foreach ( $email_theme_settings['typography']['fontFamilies']['default'] as $font_family ) { $css_presets .= ".has-{$font_family['slug']}-font-family { font-family: {$font_family['fontFamily']}; } \n"; } // Font size classes. foreach ( $email_theme_settings['typography']['fontSizes']['default'] as $font_size ) { $css_presets .= ".has-{$font_size['slug']}-font-size { font-size: {$font_size['size']}; } \n"; } // Color palette classes. $color_definitions = array_merge( $email_theme_settings['color']['palette']['theme'] ?? array(), $email_theme_settings['color']['palette']['default'] ?? array() ); foreach ( $color_definitions as $color ) { $css_presets .= ".has-{$color['slug']}-color { color: {$color['color']}; } \n"; $css_presets .= ".has-{$color['slug']}-background-color { background-color: {$color['color']}; } \n"; $css_presets .= ".has-{$color['slug']}-border-color { border-color: {$color['color']}; } \n"; } // Block specific styles. $css_blocks = ''; $blocks = $this->get_theme()->get_styles_block_nodes(); foreach ( $blocks as $block_metadata ) { $css_blocks .= $this->get_theme()->get_styles_for_block( $block_metadata ); } // Remove `:root :where(...)` selectors since they are not supported in the CSS inliner. $css_blocks = preg_replace( '/:root\s:where\((.*?)\)/', '$1', $css_blocks ); // Element specific styles. $elements_styles = $this->get_theme()->get_raw_data()['styles']['elements'] ?? array(); // Because the section styles is not a part of the output the `get_styles_block_nodes` method, we need to get it separately. if ( $template && $template->wp_id ) { $template_theme = (array) get_post_meta( $template->wp_id, Email_Editor::WOOCOMMERCE_EMAIL_META_THEME_TYPE, true ); $template_styles = (array) ( $template_theme['styles'] ?? array() ); $template_elements = $template_styles['elements'] ?? array(); $elements_styles = array_replace_recursive( (array) $elements_styles, (array) $template_elements ); } if ( $post ) { $post_theme = (array) get_post_meta( $post->ID, 'woocommerce_email_theme', true ); $post_styles = (array) ( $post_theme['styles'] ?? array() ); $post_elements = $post_styles['elements'] ?? array(); $elements_styles = array_replace_recursive( (array) $elements_styles, (array) $post_elements ); } $css_elements = ''; foreach ( $elements_styles as $key => $elements_style ) { $selector = $key; if ( 'button' === $key ) { $selector = '.wp-block-button'; $css_elements .= wp_style_engine_get_styles( $elements_style, array( 'selector' => '.wp-block-button' ) )['css'] ?? ''; // Add color to link element. $css_elements .= wp_style_engine_get_styles( array( 'color' => array( 'text' => $elements_style['color']['text'] ?? '' ) ), array( 'selector' => '.wp-block-button a' ) )['css'] ?? ''; continue; } switch ( $key ) { case 'heading': $selector = 'h1, h2, h3, h4, h5, h6'; break; case 'link': $selector = 'a:not(.button-link)'; break; } $css_elements .= wp_style_engine_get_styles( $elements_style, array( 'selector' => $selector ) )['css'] ?? ''; } $result = $css_presets . $css_blocks . $css_elements; // Because font-size can by defined by the clamp() function that is not supported in the e-mail clients, we need to replace it to the value. // Regular expression to match clamp() function and capture its max value. $pattern = '/clamp\([^,]+,\s*[^,]+,\s*([^)]+)\)/'; // Replace clamp() with its maximum value. $result = (string) preg_replace( $pattern, '$1', $result ); return $result; } /** * Translate font family slug to font family name. * * @param string $font_size Font size slug. * @return string */ public function translate_slug_to_font_size( string $font_size ): string { $settings = $this->get_settings(); foreach ( $settings['typography']['fontSizes']['default'] as $font_size_definition ) { if ( $font_size_definition['slug'] === $font_size ) { return $font_size_definition['size']; } } return $font_size; } /** * Translate color slug to color. * * @param string $color_slug Color slug. * @return string */ public function translate_slug_to_color( string $color_slug ): string { $settings = $this->get_settings(); $color_definitions = array_merge( $settings['color']['palette']['theme'] ?? array(), $settings['color']['palette']['default'] ?? array() ); foreach ( $color_definitions as $color_definition ) { if ( $color_definition['slug'] === $color_slug ) { return strtolower( $color_definition['color'] ); } } return $color_slug; } /** * Returns the map of CSS variables and their values from the theme. * * @return array */ public function get_variables_values_map(): array { $variables_css = $this->get_theme()->get_stylesheet( array( 'variables' ) ); $map = array(); // Regular expression to match CSS variable definitions. $pattern = '/--(.*?):\s*(.*?);/'; if ( preg_match_all( $pattern, $variables_css, $matches, PREG_SET_ORDER ) ) { foreach ( $matches as $match ) { // '--' . $match[1] is the variable name, $match[2] is the variable value. $map[ '--' . $match[1] ] = $match[2]; } } return $map; } } email-editor/src/Engine/class-dependency-check.php 0000777 00000001455 15252010675 0016137 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine; /** * This class is responsible checking the dependencies of the email editor. */ class Dependency_Check { /** * Minimum WordPress version required for the email editor. */ public const MIN_WP_VERSION = '6.7'; /** * Checks if all dependencies are met. */ public function are_dependencies_met(): bool { if ( ! $this->is_wp_version_compatible() ) { return false; } return true; } /** * Checks if the WordPress version is supported. */ private function is_wp_version_compatible(): bool { return version_compare( get_bloginfo( 'version' ), self::MIN_WP_VERSION, '>=' ); } } email-editor/src/Engine/class-site-style-sync-controller.php 0000777 00000032705 15252010675 0020205 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine; use WP_Theme_JSON; use WP_Theme_JSON_Resolver; use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Styles_Helper; /** * Site Style Sync Controller * * Manages the live synchronization of site styles to email templates. * Converts site theme styles to email-compatible formats while maintaining * visual consistency between the site and emails. */ class Site_Style_Sync_Controller { /** * Current site theme data * * @var WP_Theme_JSON|null */ private ?WP_Theme_JSON $site_theme = null; /** * Email-safe fonts * * @var array */ private $email_safe_fonts = array(); /** * Constructor */ public function __construct() { add_action( 'init', array( $this, 'initialize' ), 20 ); } /** * Initialize the sync controller * * Hook into theme changes to trigger automatic sync * * @return void */ public function initialize(): void { add_action( 'switch_theme', array( $this, 'invalidate_site_theme_cache' ) ); add_action( 'customize_save_after', array( $this, 'invalidate_site_theme_cache' ) ); } /** * Sync site styles to email theme format * * @return array Email-compatible theme data. */ public function sync_site_styles(): array { $site_theme = $this->get_site_theme(); $site_data = $site_theme->get_data(); $synced_data = array( 'version' => 3, 'settings' => $this->sync_settings_data( $site_data['settings'] ?? array() ), 'styles' => $this->sync_styles_data( $site_data['styles'] ?? array() ), ); /** * Filter the synced site style data before applying to email theme * * @param array $synced_data The converted email-compatible theme data. * @param array $site_data The original site theme data. */ $synced_data = apply_filters( 'woocommerce_email_editor_synced_site_styles', $synced_data, $site_data ); return $synced_data; } /** * Getter for site theme. * * @return ?WP_Theme_JSON Synced site theme. */ public function get_theme(): ?WP_Theme_JSON { if ( ! $this->is_sync_enabled() ) { return null; } $synced_data = $this->sync_site_styles(); if ( empty( $synced_data ) || ! isset( $synced_data['version'] ) ) { return null; } return new WP_Theme_JSON( $synced_data, 'theme' ); } /** * Check if site style sync is enabled * * @return bool */ public function is_sync_enabled(): bool { /** * Filter to enable/disable site style sync functionality * * @param bool $enabled Whether site style sync is enabled. */ return apply_filters( 'woocommerce_email_editor_site_style_sync_enabled', true ); } /** * Invalidate cached site theme data * * @return void */ public function invalidate_site_theme_cache(): void { if ( ! $this->is_sync_enabled() ) { return; } $this->site_theme = null; } /** * Get site theme data * * @return WP_Theme_JSON */ private function get_site_theme(): WP_Theme_JSON { if ( null === $this->site_theme ) { // Get only the theme and user customizations (e.g. from site editor). $this->site_theme = new WP_Theme_JSON(); $this->site_theme->merge( WP_Theme_JSON_Resolver::get_theme_data() ); $this->site_theme->merge( WP_Theme_JSON_Resolver::get_user_data() ); if ( isset( $this->site_theme->get_raw_data()['styles'] ) ) { $this->site_theme = WP_Theme_JSON::resolve_variables( $this->site_theme ); } } return $this->site_theme; } /** * Sync settings data from site theme to email-compatible format * * @param array $site_settings Site theme settings. * @return array Email-compatible settings. */ private function sync_settings_data( array $site_settings ): array { $email_settings = array(); // Sync color palette. if ( isset( $site_settings['color']['palette'] ) ) { $email_settings['color']['palette'] = $site_settings['color']['palette']; } return $email_settings; } /** * Sync styles data from site theme to email-compatible format * * @param array $site_styles Site theme styles. * @return array Email-compatible styles. */ private function sync_styles_data( array $site_styles ): array { $email_styles = array(); // Sync color styles. if ( ! empty( $site_styles['color'] ) ) { $email_styles['color'] = $this->convert_color_styles( $site_styles['color'] ); } // Sync typography styles. if ( ! empty( $site_styles['typography'] ) ) { $email_styles['typography'] = $this->convert_typography_styles( $site_styles['typography'] ); } // Sync spacing styles. if ( ! empty( $site_styles['spacing'] ) ) { $email_styles['spacing'] = $this->convert_spacing_styles( $site_styles['spacing'] ); } // Sync element styles. if ( ! empty( $site_styles['elements'] ) ) { $email_styles['elements'] = $this->convert_element_styles( $site_styles['elements'] ); } return $email_styles; } /** * Get email-safe fonts * * @return array Email-safe fonts. */ public function get_email_safe_fonts(): array { if ( empty( $this->email_safe_fonts ) ) { /** * Pull email-safe fonts from theme.json (src/Engine/theme.json). * * @var array{settings?: array{typography?: array{fontFamilies?: array<array{name: string, slug: string, fontFamily: string}>}}} $theme_data */ $theme_data = (array) json_decode( (string) file_get_contents( __DIR__ . '/theme.json' ), true ); $font_families = $theme_data['settings']['typography']['fontFamilies'] ?? array(); if ( ! empty( $font_families ) ) { foreach ( $font_families as $font_family ) { $this->email_safe_fonts[ strtolower( $font_family['slug'] ) ] = $font_family['fontFamily']; } } } return $this->email_safe_fonts; } /** * Convert site color styles to email format * * @param array $color_styles Site color styles. * @return array Email-compatible color styles. */ private function convert_color_styles( array $color_styles ): array { $email_colors = array(); $this->resolve_and_assign( $color_styles, 'background', $email_colors ); $this->resolve_and_assign( $color_styles, 'text', $email_colors ); return $email_colors; } /** * Convert site typography styles to email format * * @param array $typography_styles Site typography styles. * @return array Email-compatible typography styles. */ private function convert_typography_styles( array $typography_styles ): array { $email_typography = array(); // Handle special cases with processors. $this->resolve_and_assign( $typography_styles, 'fontFamily', $email_typography, array( $this, 'convert_to_email_safe_font' ) ); $this->resolve_and_assign( $typography_styles, 'fontSize', $email_typography, array( $this, 'convert_to_px_size' ) ); // Handle compatible properties without processing. $compatible_props = array( 'fontWeight', 'fontStyle', 'lineHeight', 'letterSpacing', 'textTransform', 'textDecoration' ); foreach ( $compatible_props as $prop ) { $this->resolve_and_assign( $typography_styles, $prop, $email_typography ); } return $email_typography; } /** * Convert site spacing styles to email format * * @param array $spacing_styles Site spacing styles. * @return array Email-compatible spacing styles. */ private function convert_spacing_styles( array $spacing_styles ): array { $email_spacing = array(); $this->resolve_and_assign( $spacing_styles, 'padding', $email_spacing, array( $this, 'convert_spacing_values' ) ); $this->resolve_and_assign( $spacing_styles, 'blockGap', $email_spacing, array( $this, 'convert_to_px_size' ) ); // Note: We intentionally skip margin as it's not supported in email renderer. return $email_spacing; } /** * Convert site element styles to email format * * @param array $element_styles Site element styles. * @return array Email-compatible element styles. */ private function convert_element_styles( array $element_styles ): array { $email_elements = array(); // Process supported elements. $supported_elements = array( 'heading', 'button', 'link', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6' ); foreach ( $supported_elements as $element ) { if ( isset( $element_styles[ $element ] ) ) { $email_elements[ $element ] = $this->convert_element_style( $element_styles[ $element ] ); } } return $email_elements; } /** * Convert individual element style to email format * * @param array $element_style Site element style. * @return array Email-compatible element style. */ private function convert_element_style( array $element_style ): array { $email_element = array(); // Convert typography if present. if ( isset( $element_style['typography'] ) ) { $email_element['typography'] = $this->convert_typography_styles( $element_style['typography'] ); } // Convert color if present. if ( isset( $element_style['color'] ) ) { $email_element['color'] = $this->convert_color_styles( $element_style['color'] ); } // Convert spacing if present. if ( isset( $element_style['spacing'] ) ) { $email_element['spacing'] = $this->convert_spacing_styles( $element_style['spacing'] ); } return $email_element; } /** * Resolve and assign a single style property * * @param array $styles The source styles array. * @param string $property The property key to resolve. * @param array $target The target array to assign the value to. * @param callable|null $processor Optional processor function for the resolved value. * @return bool True if the property was resolved and assigned, false otherwise. */ private function resolve_and_assign( array $styles, string $property, array &$target, ?callable $processor = null ): bool { if ( ! isset( $styles[ $property ] ) ) { return false; } $resolved = $this->resolve_style_value( $styles[ $property ] ); if ( ! $resolved ) { return false; } $target[ $property ] = $processor ? $processor( $resolved ) : $resolved; return true; } /** * Styles may contain references to other styles. * This function resolves the reference to the actual value. * https://make.wordpress.org/core/2022/10/11/reference-styles-values-in-theme-json/ * It is not allowed to reference another reference so we don't need to check recursively. * * @param mixed $style_value Style value that might contain a reference. * @return mixed Resolved style value or null when the reference is not found. */ private function resolve_style_value( $style_value ) { // Check if this is a reference array. if ( is_array( $style_value ) && isset( $style_value['ref'] ) ) { $ref = $style_value['ref']; if ( ! is_string( $ref ) || empty( $ref ) ) { return null; } $path = explode( '.', $ref ); return _wp_array_get( $this->get_site_theme()->get_data(), $path, null ); } return $style_value; } /** * Convert font family to email-safe alternative * * @param string $font_family Original font family. * @return string Email-safe font family. */ private function convert_to_email_safe_font( string $font_family ): string { // Get email-safe fonts. $email_safe_fonts = $this->get_email_safe_fonts(); // Map common web fonts to email-safe alternatives. $font_map = array( 'helvetica' => $email_safe_fonts['arial'], // Arial fallback. 'times' => $email_safe_fonts['georgia'], // Georgia fallback. 'courier' => $email_safe_fonts['courier-new'], // Courier New. 'trebuchet' => $email_safe_fonts['trebuchet-ms'], ); $email_safe_fonts = array_merge( $email_safe_fonts, $font_map ); $get_font_family = function ( $font_name ) use ( $email_safe_fonts ) { $font_name_lower = strtolower( $font_name ); // First check for match in the email-safe slug. if ( isset( $email_safe_fonts[ $font_name_lower ] ) ) { return $email_safe_fonts[ $font_name_lower ]; } // If no match in the slug, check for match in the font family name. foreach ( $email_safe_fonts as $safe_font_slug => $safe_font ) { if ( stripos( $safe_font, $font_name_lower ) !== false ) { return $safe_font; } } return null; }; // Check if it's already an email-safe font. $font_family_array = explode( ',', $font_family ); $safe_font_family = $get_font_family( trim( $font_family_array[0] ) ); if ( $safe_font_family ) { return $safe_font_family; } // Default to arial font if no match found. return $email_safe_fonts['arial']; } /** * Convert size value to px format. * * @param string $size Original size value. * @return string Size in px format. */ private function convert_to_px_size( string $size ): string { // Replace clamp() with its average value. if ( stripos( $size, 'clamp(' ) !== false ) { return Styles_Helper::clamp_to_static_px( $size, 'avg' ) ?? $size; } return Styles_Helper::convert_to_px( $size, false ) ?? $size; // Fallback to original value if conversion fails. } /** * Convert spacing values to px format. * * @param string|array $spacing_values Original spacing values. * @return string|array Spacing values in px format. */ private function convert_spacing_values( $spacing_values ) { if ( ! is_string( $spacing_values ) && ! is_array( $spacing_values ) ) { return $spacing_values; } if ( is_string( $spacing_values ) ) { return $this->convert_to_px_size( $spacing_values ); } $px_values = array(); foreach ( $spacing_values as $side => $value ) { if ( is_string( $value ) ) { $px_values[ $side ] = $this->convert_to_px_size( $value ); } else { $px_values[ $side ] = $value; } } return $px_values; } } email-editor/src/Engine/class-send-preview-email.php 0000777 00000013510 15252010675 0016436 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Engine; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\Renderer; /** * Class Send_Preview_Email * * This class is responsible for handling the functionality to send preview emails. * It is part of the email editor integrations utilities. * * @package Automattic\WooCommerce\EmailEditor\Integrations\Utils */ class Send_Preview_Email { /** * Instance of the Renderer class used for rendering the editor emails. * * @var Renderer $renderer */ private Renderer $renderer; /** * Instance of the Personalizer class used for rendering personalization tags. * * @var Personalizer $personalizer */ private Personalizer $personalizer; /** * Send_Preview_Email constructor. * * @param Renderer $renderer renderer instance. * @param Personalizer $personalizer personalizer instance. */ public function __construct( Renderer $renderer, Personalizer $personalizer ) { $this->renderer = $renderer; $this->personalizer = $personalizer; } /** * Sends a preview email. * * @param array $data The data required to send the preview email. * @return bool Returns true if the preview email was sent successfully, false otherwise. * @throws \Exception If the data is invalid. */ public function send_preview_email( $data ): bool { if ( is_bool( $data ) ) { // preview mail already sent. Do not process again. return $data; } $this->validate_data( $data ); $email = $data['email']; $post_id = $data['postId']; $post = $this->fetch_post( $post_id ); $subject = $post->post_title; $email_html_content = $this->render_html( $post ); return $this->send_email( $email, $subject, $email_html_content ); } /** * Renders the HTML content of the post * * @param \WP_Post $post The WordPress post object. * @return string */ public function render_html( $post ): string { $subject = $post->post_title; $language = get_bloginfo( 'language' ); // Add filter to set preview context for block renderers. add_filter( 'woocommerce_email_editor_rendering_email_context', array( $this, 'add_preview_context' ) ); $rendered_data = $this->renderer->render( $post, $subject, __( 'Preview', 'woocommerce' ), $language ); // Remove filter after rendering. remove_filter( 'woocommerce_email_editor_rendering_email_context', array( $this, 'add_preview_context' ) ); $rendered_data = apply_filters( 'woocommerce_email_editor_send_preview_email_rendered_data', $rendered_data, $post ); return $this->set_personalize_content( $rendered_data['html'] ); } /** * Add preview context to email rendering. * * This filter callback adds the is_user_preview flag and current user information * to the rendering context, allowing block renderers to show appropriate preview content. * * @param array $email_context Email context data. * @return array Modified email context with preview flag. */ public function add_preview_context( $email_context ): array { $email_context['is_user_preview'] = true; return $email_context; } /** * Personalize the content. * * @param string $content HTML content. * @return string */ public function set_personalize_content( string $content ): string { $current_user = wp_get_current_user(); $subscriber = ! empty( $current_user->ID ) ? $current_user : null; $personalizer_context = array( 'recipient_email' => $subscriber ? $subscriber->user_email : null, 'is_user_preview' => true, ); $personalizer_context = apply_filters( 'woocommerce_email_editor_send_preview_email_personalizer_context', $personalizer_context ); $this->personalizer->set_context( $personalizer_context ); return $this->personalizer->personalize_content( $content ); } /** * Sends an email preview. * * @param string $to The recipient email address. * @param string $subject The subject of the email. * @param string $body The body content of the email. * @return bool Returns true if the email was sent successfully, false otherwise. */ public function send_email( string $to, string $subject, string $body ): bool { add_filter( 'wp_mail_content_type', array( $this, 'set_mail_content_type' ) ); $result = wp_mail( $to, $subject, $body ); // Reset content-type to avoid conflicts. remove_filter( 'wp_mail_content_type', array( $this, 'set_mail_content_type' ) ); return $result; } /** * Sets the mail content type. Used by $this->send_email. * * @param string $content_type The content type to be set for the mail. * @return string The content type that was set. */ public function set_mail_content_type( string $content_type ): string { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found return 'text/html'; } /** * Validates the provided data array. * * @param array $data The data array to be validated. * * @return void * @throws \InvalidArgumentException If the data is invalid. */ private function validate_data( array $data ) { if ( empty( $data['email'] ) || empty( $data['postId'] ) ) { throw new \InvalidArgumentException( esc_html__( 'Missing required data', 'woocommerce' ) ); } if ( ! is_email( $data['email'] ) ) { throw new \InvalidArgumentException( esc_html__( 'Invalid email', 'woocommerce' ) ); } } /** * Fetches a post_id post object based on the provided post ID. * * @param int $post_id The ID of the post to fetch. * @return \WP_Post The WordPress post object. * @throws \Exception If the post is invalid. */ private function fetch_post( $post_id ): \WP_Post { $post = get_post( intval( $post_id ) ); if ( ! $post instanceof \WP_Post ) { throw new \Exception( esc_html__( 'Invalid post', 'woocommerce' ) ); } return $post; } } email-editor/src/Engine/PersonalizationTags/class-personalization-tag.php 0000777 00000012503 15252010675 0022734 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags; /** * The class represents a personalization tag that contains all necessary information * for replacing the tag with its value and displaying it in the UI. */ class Personalization_Tag { /** * The name of the tag displayed in the UI. * * @var string */ private string $name; /** * The token which is used in HTML_Tag_Processor to replace the tag with its value. * * @var string */ private string $token; /** * The category of the personalization tag for categorization on the UI. * * @var string */ private string $category; /** * The callback function which returns the value of the personalization tag. * * @var callable */ private $callback; /** * The attributes which are used in the Personalization Tag UI. * * @var array */ private array $attributes; /** * The value that is inserted via the UI. When the value is null the token is generated based on $token attribute and $attributes. * * @var string */ private string $value_to_insert; /** * The list of supported post types. * * @var string[] */ private array $post_types; /** * Personalization_Tag constructor. * * Example usage: * $tag = new Personalization_Tag( * 'First Name', * 'user:first_name', * 'User', * function( $context, $args ) { * return $context['user_firstname'] ?? 'user'; * }, * array( default => 'user' ), * 'user:first default="user"' * ); * * @param string $name The name of the tag displayed in the UI. * @param string $token The token used in HTML_Tag_Processor to replace the tag with its value. * @param string $category The category of the personalization tag for categorization on the UI. * @param callable $callback The callback function which returns the value of the personalization tag. * @param array $attributes The attributes which are used in the Personalization Tag UI. * @param string|null $value_to_insert The value that is inserted via the UI. When the value is null the token is generated based on $token attribute and $attributes. * @param string[] $post_types The list of supported post types. */ public function __construct( string $name, string $token, string $category, callable $callback, array $attributes = array(), ?string $value_to_insert = null, array $post_types = array() ) { $this->name = $name; // Because Gutenberg does not wrap the token with square brackets, we need to add them here. $this->token = strpos( $token, '[' ) === 0 ? $token : "[$token]"; $this->category = $category; $this->callback = $callback; $this->attributes = $attributes; // Composing token to insert based on the token and attributes if it is not set. if ( ! $value_to_insert ) { if ( $this->attributes ) { $value_to_insert = substr( $this->token, 0, -1 ) . ' ' . implode( ' ', array_map( function ( $key ) { return $key . '="' . esc_attr( $this->attributes[ $key ] ) . '"'; }, array_keys( $this->attributes ) ) ) . ']'; } else { $value_to_insert = $this->token; } } $this->value_to_insert = $value_to_insert; $this->post_types = $post_types; } /** * Prevents deserialization of this class to avoid callback replacement attacks. * * @param array $data The serialized data. * @return void * @throws \Exception Always throws an exception to prevent deserialization. */ public function __unserialize( array $data ): void { throw new \Exception( 'Deserialization of Personalization_Tag is not allowed for security reasons.' ); } /** * Returns the name of the personalization tag. * * @return string */ public function get_name(): string { return $this->name; } /** * Returns the token of the personalization tag. * * @return string */ public function get_token(): string { return $this->token; } /** * Returns the category of the personalization tag. * * @return string */ public function get_category(): string { return $this->category; } /** * Returns the attributes of the personalization tag. * * @return array */ public function get_attributes(): array { return $this->attributes; } /** * Returns the token to insert via UI in the editor. * * @return string */ public function get_value_to_insert(): string { return $this->value_to_insert; } /** * Returns the list of supported post types. * * @return array|string[] */ public function get_post_types(): array { return $this->post_types; } /** * Returns the callback function of the personalization tag. * * @return callable */ public function get_callback(): callable { return $this->callback; } /** * Executes the callback function for the personalization tag. * * @param mixed $context The context for the personalization tag. * @param array $args The additional arguments for the callback. * @return string The value of the personalization tag. */ public function execute_callback( $context, $args = array() ): string { return call_user_func( $this->callback, ...array_merge( array( $context ), array( $args ) ) ); } } email-editor/src/Engine/PersonalizationTags/class-html-tag-processor.php 0000777 00000002625 15252010675 0022500 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags; use WP_HTML_Tag_Processor; use WP_HTML_Text_Replacement; /** * Class based on WP_HTML_Tag_Processor which is extended to replace * tokens with their values in the email content. * * This class was inspired by a concept from the WordPress core, * which could help us to avoid refactoring in the future. */ class HTML_Tag_Processor extends WP_HTML_Tag_Processor { /** * List of deferred updates which will be replaced after calling flush_updates(). * * @var WP_HTML_Text_Replacement[] */ private $deferred_updates = array(); /** * Replaces the token with the new content. * * @param string $new_content The new content to replace the token. */ public function replace_token( string $new_content ): void { $this->set_bookmark( 'here' ); $here = $this->bookmarks['here']; $this->deferred_updates[] = new WP_HTML_Text_Replacement( $here->start, $here->length, $new_content ); } /** * Flushes the deferred updates to the lexical updates. */ public function flush_updates(): void { foreach ( $this->deferred_updates as $key => $update ) { $this->lexical_updates[] = $update; unset( $this->deferred_updates[ $key ] ); } } } email-editor/src/Engine/PersonalizationTags/class-personalization-tags-registry.php 0000777 00000007050 15252010675 0024766 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare(strict_types = 1); namespace Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags; use Automattic\WooCommerce\EmailEditor\Engine\Logger\Email_Editor_Logger; /** * Registry for personalization tags. */ class Personalization_Tags_Registry { /** * Logger instance. * * @var Email_Editor_Logger */ private Email_Editor_Logger $logger; /** * List of registered personalization tags. * * @var Personalization_Tag[] */ private $tags = array(); /** * Constructor. * * @param Email_Editor_Logger $logger Logger instance. */ public function __construct( Email_Editor_Logger $logger ) { $this->logger = $logger; } /** * Initialize the personalization tags registry. * This method should be called only once. * * @return void */ public function initialize(): void { $this->logger->info( 'Initializing personalization tags registry' ); apply_filters( 'woocommerce_email_editor_register_personalization_tags', $this ); $this->logger->info( 'Personalization tags registry initialized', array( 'tags_count' => count( $this->tags ) ) ); } /** * Register a new personalization instance in the registry. * * @param Personalization_Tag $tag The personalization tag to register. * @return void */ public function register( Personalization_Tag $tag ): void { if ( isset( $this->tags[ $tag->get_token() ] ) ) { $this->logger->warning( 'Personalization tag already registered', array( 'token' => $tag->get_token(), 'name' => $tag->get_name(), 'category' => $tag->get_category(), ) ); return; } $this->tags[ $tag->get_token() ] = $tag; $this->logger->debug( 'Personalization tag registered', array( 'token' => $tag->get_token(), 'name' => $tag->get_name(), 'category' => $tag->get_category(), ) ); } /** * Unregister a personalization tag by its token or tag instance. * * @param string|Personalization_Tag $token_or_tag The token string or Personalization_Tag instance to unregister. * @return Personalization_Tag|null The unregistered tag or null if not found. */ public function unregister( $token_or_tag ): ?Personalization_Tag { // Extract token from the argument. if ( $token_or_tag instanceof Personalization_Tag ) { $token = $token_or_tag->get_token(); } elseif ( is_string( $token_or_tag ) ) { $token = $token_or_tag; } else { $this->logger->warning( 'Invalid argument type for unregister method', array( 'type' => gettype( $token_or_tag ), ) ); return null; } $tag = $this->tags[ $token ] ?? null; if ( $tag ) { unset( $this->tags[ $token ] ); $this->logger->debug( 'Personalization tag unregistered', array( 'token' => $token, 'name' => $tag->get_name(), 'category' => $tag->get_category(), ) ); } return $tag; } /** * Retrieve a personalization tag by its token. * Example: get_by_token( 'user:first_name' ) will return the instance of Personalization_Tag with identical token. * * @param string $token The token of the personalization tag. * @return Personalization_Tag|null The array data or null if not found. */ public function get_by_token( string $token ): ?Personalization_Tag { return $this->tags[ $token ] ?? null; } /** * Retrieve all registered personalization tags. * * @return array List of all registered personalization tags. */ public function get_all() { return $this->tags; } } email-editor/src/Engine/content-editor.css 0000777 00000011357 15252010675 0014604 0 ustar 00 /* * Styles for the email editor. */ /* * Flex layout used for buttons block for email editor. */ .is-layout-email-flex { flex-wrap: nowrap; } :where(body .is-layout-flex) { gap: var(--wp--style--block-gap, 16px); } .is-mobile-preview .is-layout-email-flex { display: block; } .is-mobile-preview .is-layout-email-flex .block-editor-block-list__block { padding: 5px 0; width: 100%; } .is-mobile-preview .is-layout-email-flex .wp-block-button__link { width: 100%; } /* * Email Editor specific styles for vertical gap between blocks in column and group. * This is needed because we disable layout for core/group, core/column and core/columns blocks, and .is-layout-flex is not applied. */ .wp-block-columns:not(.is-not-stacked-on-mobile) > .wp-block-column > .wp-block:first-child, .wp-block-group > .wp-block:first-child { margin-top: 0; } .wp-block-columns:not(.is-not-stacked-on-mobile) > .wp-block-column > .wp-block, .wp-block-group > .wp-block { margin-bottom: var(--wp--style--block-gap, 16px); margin-top: var(--wp--style--block-gap, 16px); } .wp-block-columns:not(.is-not-stacked-on-mobile) > .wp-block-column > .wp-block:not([aria-hidden="true"]):last-of-type, .wp-block-group > .wp-block:not([aria-hidden="true"]):last-of-type { margin-bottom: 0; } /* * Use box sizing border box for columns that have defined a width (they have flex-basis set). */ .wp-block-columns:not(.is-not-stacked-on-mobile) > .wp-block-column[style*='flex-basis'] { box-sizing: border-box; } /* * For the WYSIWYG experience we don't want to display any margins between blocks in the editor */ .wp-block { clear: both; } /* * Image block enhancements */ .wp-block-image figcaption { /* Resetting the margin for images in the editor to avoid unexpected spacing */ margin: 0; } /* * Table block enhancements */ .wp-block-table figcaption { /* Center-align table captions like core WordPress */ text-align: center; } /* Ensure bold formatting shows up in table cells and captions in the editor */ .wp-block-table td strong, .wp-block-table th strong, .wp-block-table figcaption strong { font-weight: bold; } .wp-block-image.alignleft, .wp-block-image.alignright { margin-inline: 0 0; text-align: center; } .wp-block-image.aligncenter { margin-left: auto; margin-right: auto; } .wp-block-image.alignright { margin-left: auto; } /* * Set default padding-left to have consistent default look in editor and in email * This also overrides the default values in browsers for padding-inline-start */ ul, ol { padding-left: 40px; } /* * Override default button border radius which is set in core to 9999px */ .wp-block-button__link { border-radius: 0; } /* * Mobile preview fixes */ .is-mobile-preview figure > div { max-width: 100% !important; height: auto !important; } /* * Reset default margin for blocks in template-mode * This was causing the first block to have a margin-top set to block gap. * We control the gab via different css */ .wp-site-blocks > * { margin-block-start: 0; } /* * Hide the post title. * When user disables the template-lock mode we don't want to show the post title. */ .editor-visual-editor__post-title-wrapper { display: none; } /* * Temporary styles for Rich Text HTML comments from the PR: https://github.com/WordPress/gutenberg/pull/62128/files */ [data-rich-text-comment], [data-rich-text-format-boundary] { border-radius: 2px; } [data-rich-text-comment] { background-color: var( --wp-components-color-accent, var(--wp-admin-theme-color, #3858e9) ); span { color: var(--wp-components-color-accent-inverted, #fff); filter: none; padding: 0 2px; } } /** * Override the default gap for social links block in the editor. * This is needed because we do not want to have a gap between the social links and also for a WYSIWYG experience. */ .wp-block-social-links.is-layout-flex { gap: 16px !important; } /** * Override the default padding for social links block in the editor. * This is needed because we do not want to have a padding for the social links block particularly for a WYSIWYG experience. */ .wp-block-social-links.has-background { padding-left: 0; } /** * Override the default background color for social links block in the editor. * This is mostly for a WYSIWYG experience. These icons don't have a default background color. */ :where(.wp-block-social-links:not(.is-style-logos-only)) .wp-social-link-mail, :where(.wp-block-social-links:not(.is-style-logos-only)) .wp-social-link-feed, :where(.wp-block-social-links:not(.is-style-logos-only)) .wp-social-link-chain { background-color:#000; color:#fff; } /** * Override the default overflow-x for the iframe in the editor. * This is needed because we do want allow scrolling on small screens such as mobile devices. */ .block-editor-iframe__body { overflow-x: auto; } email-editor/src/class-email-editor-container.php 0000777 00000021273 15252010675 0016074 0 ustar 00 <?php /** * Email Editor Container class file. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor; use Automattic\WooCommerce\EmailEditor\Engine\Assets_Manager; use Automattic\WooCommerce\EmailEditor\Engine\Dependency_Check; use Automattic\WooCommerce\EmailEditor\Engine\Email_Api_Controller; use Automattic\WooCommerce\EmailEditor\Engine\Email_Editor; use Automattic\WooCommerce\EmailEditor\Engine\Patterns\Patterns; use Automattic\WooCommerce\EmailEditor\Engine\PersonalizationTags\Personalization_Tags_Registry; use Automattic\WooCommerce\EmailEditor\Engine\Personalizer; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Content_Renderer; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors\Highlighting_Postprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors\Variables_Postprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Blocks_Width_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Cleanup_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Spacing_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Typography_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Preprocessors\Quote_Preprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Postprocessors\Border_Style_Postprocessor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Process_Manager; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\Renderer; use Automattic\WooCommerce\EmailEditor\Engine\Send_Preview_Email; use Automattic\WooCommerce\EmailEditor\Engine\Settings_Controller; use Automattic\WooCommerce\EmailEditor\Engine\Templates\Templates; use Automattic\WooCommerce\EmailEditor\Engine\Templates\Templates_Registry; use Automattic\WooCommerce\EmailEditor\Engine\Theme_Controller; use Automattic\WooCommerce\EmailEditor\Engine\User_Theme; use Automattic\WooCommerce\EmailEditor\Engine\Logger\Email_Editor_Logger; use Automattic\WooCommerce\EmailEditor\Engine\Site_Style_Sync_Controller; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Initializer as CoreInitializer; use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Initializer as WooCommerceInitializer; defined( 'ABSPATH' ) || exit; /** * Main package class. */ class Email_Editor_Container { /** * Init method. * * @return void */ public static function init() { self::container()->get( Bootstrap::class )->init(); } /** * Loads the DI container for the Email editor. * * @internal This uses the Blocks DI container. This container will be replaced * with a different compatible container. * * @param boolean $reset Used to reset the container to a fresh instance. Note: this means all dependencies will be reconstructed. * @return Container */ public static function container( $reset = false ) { static $container; if ( $reset ) { $container = null; } if ( $container ) { return $container; } $container = new Container(); $container->set( CoreInitializer::class, function () { return new CoreInitializer(); } ); $container->set( WooCommerceInitializer::class, function () { return new WooCommerceInitializer(); } ); // Start: Email editor dependencies. $container->set( Theme_Controller::class, function () { return new Theme_Controller(); } ); $container->set( User_Theme::class, function () { return new User_Theme(); } ); $container->set( Settings_Controller::class, function ( $container ) { return new Settings_Controller( $container->get( Theme_Controller::class ) ); } ); $container->set( Templates_Registry::class, function () { return new Templates_Registry(); } ); $container->set( Templates::class, function ( $container ) { return new Templates( $container->get( Templates_Registry::class ) ); } ); $container->set( Patterns::class, function () { return new Patterns(); } ); $container->set( Cleanup_Preprocessor::class, function () { return new Cleanup_Preprocessor(); } ); $container->set( Blocks_Width_Preprocessor::class, function () { return new Blocks_Width_Preprocessor(); } ); $container->set( Typography_Preprocessor::class, function ( $container ) { return new Typography_Preprocessor( $container->get( Settings_Controller::class ) ); } ); $container->set( Spacing_Preprocessor::class, function () { return new Spacing_Preprocessor(); } ); $container->set( Quote_Preprocessor::class, function () { return new Quote_Preprocessor(); } ); $container->set( Highlighting_Postprocessor::class, function () { return new Highlighting_Postprocessor(); } ); $container->set( Variables_Postprocessor::class, function ( $container ) { return new Variables_Postprocessor( $container->get( Theme_Controller::class ) ); } ); $container->set( Border_Style_Postprocessor::class, function () { return new Border_Style_Postprocessor(); } ); $container->set( Assets_Manager::class, function ( $container ) { return new Assets_Manager( $container->get( Settings_Controller::class ), $container->get( Theme_Controller::class ), $container->get( User_Theme::class ), $container->get( Email_Editor_Logger::class ) ); } ); $container->set( Process_Manager::class, function ( $container ) { return new Process_Manager( $container->get( Cleanup_Preprocessor::class ), $container->get( Blocks_Width_Preprocessor::class ), $container->get( Typography_Preprocessor::class ), $container->get( Spacing_Preprocessor::class ), $container->get( Quote_Preprocessor::class ), $container->get( Highlighting_Postprocessor::class ), $container->get( Variables_Postprocessor::class ), $container->get( Border_Style_Postprocessor::class ) ); } ); $container->set( Content_Renderer::class, function ( $container ) { return new Content_Renderer( $container->get( Process_Manager::class ), new Email_Css_Inliner(), $container->get( Theme_Controller::class ), $container->get( Email_Editor_Logger::class ) ); } ); $container->set( Renderer::class, function ( $container ) { return new Renderer( $container->get( Content_Renderer::class ), $container->get( Templates::class ), new Email_Css_Inliner(), $container->get( Theme_Controller::class ), $container->get( Personalization_Tags_Registry::class ), ); } ); $container->set( Personalization_Tags_Registry::class, function ( $container ) { return new Personalization_Tags_Registry( $container->get( Email_Editor_Logger::class ) ); } ); $container->set( Personalizer::class, function ( $container ) { return new Personalizer( $container->get( Personalization_Tags_Registry::class ), ); } ); $container->set( Send_Preview_Email::class, function ( $container ) { return new Send_Preview_Email( $container->get( Renderer::class ), $container->get( Personalizer::class ), ); } ); $container->set( Email_Api_Controller::class, function ( $container ) { return new Email_Api_Controller( $container->get( Personalization_Tags_Registry::class ), ); } ); $container->set( Dependency_Check::class, function () { return new Dependency_Check(); } ); $container->set( Email_Editor_Logger::class, function () { return new Email_Editor_Logger(); } ); $container->set( Site_Style_Sync_Controller::class, function () { return new Site_Style_Sync_Controller(); } ); $container->set( Email_Editor::class, function ( $container ) { return new Email_Editor( $container->get( Email_Api_Controller::class ), $container->get( Templates::class ), $container->get( Patterns::class ), $container->get( Send_Preview_Email::class ), $container->get( Personalization_Tags_Registry::class ), $container->get( Email_Editor_Logger::class ), $container->get( Assets_Manager::class ) ); } ); // End: Email editor dependencies. // Start: Woo dependencies. $container->set( Bootstrap::class, function ( $container ) { return new Bootstrap( $container->get( Email_Editor::class ), $container->get( CoreInitializer::class ), $container->get( WooCommerceInitializer::class ), ); } ); return $container; } } email-editor/src/class-bootstrap.php 0000777 00000005263 15252010675 0013557 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor; use Automattic\WooCommerce\EmailEditor\Engine\Email_Editor; use Automattic\WooCommerce\EmailEditor\Integrations\Core\Initializer as CoreEmailEditorIntegration; use Automattic\WooCommerce\EmailEditor\Integrations\WooCommerce\Initializer as WooCommerceEmailEditorIntegration; /** * Bootstrap class for initializing the Email Editor functionality. */ class Bootstrap { /** * Email editor instance. * * @var Email_Editor */ private $email_editor; /** * Core email editor integration instance. * * @var CoreEmailEditorIntegration */ private $core_email_editor_integration; /** * WooCommerce email editor integration instance. * * @var WooCommerceEmailEditorIntegration */ private $woocommerce_email_editor_integration; /** * Constructor. * * @param Email_Editor $email_editor Email editor instance. * @param CoreEmailEditorIntegration $core_email_editor_integration Core email editor integration instance. * @param WooCommerceEmailEditorIntegration $woocommerce_email_editor_integration WooCommerce email editor integration instance. */ public function __construct( Email_Editor $email_editor, CoreEmailEditorIntegration $core_email_editor_integration, WooCommerceEmailEditorIntegration $woocommerce_email_editor_integration ) { $this->email_editor = $email_editor; $this->core_email_editor_integration = $core_email_editor_integration; $this->woocommerce_email_editor_integration = $woocommerce_email_editor_integration; } /** * Initialize the email editor functionality. */ public function init(): void { add_action( 'init', array( $this, 'initialize', ) ); add_filter( 'woocommerce_email_editor_initialized', array( $this, 'setup_email_editor_integrations', ) ); add_filter( 'block_type_metadata_settings', array( $this->core_email_editor_integration, 'update_block_settings' ), 10, 1 ); if ( class_exists( 'WooCommerce' ) ) { add_filter( 'block_type_metadata_settings', array( $this->woocommerce_email_editor_integration, 'update_block_settings' ), 10, 1 ); } } /** * Initialize the email editor. */ public function initialize(): void { $this->email_editor->initialize(); } /** * Setup email editor integrations. */ public function setup_email_editor_integrations(): bool { $this->core_email_editor_integration->initialize(); return true; // PHPStan expect returning a value from the filter. } } email-editor/src/class-email-css-inliner.php 0000777 00000005407 15252010675 0015055 0 ustar 00 <?php /** * Email CSS Inliner class file. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor; use Automattic\WooCommerce\EmailEditor\Engine\Renderer\Css_Inliner; /** * Class for inlining CSS in HTML emails. */ class Email_Css_Inliner implements Css_Inliner { /** * The CSS inliner instance. * * Runtime type: Pelago\Emogrifier\CssInliner | Automattic\WooCommerce\Vendor\Pelago\Emogrifier\CssInliner * Both classes extend AbstractHtmlProcessor and implement: * - static fromHtml(string $html): static * - inlineCss(string $css = ''): self * - render(): string * * @var object|null */ private $inliner; /** * Creates a new instance from HTML content. * * @param string $unprocessed_html The HTML content to process. * @return self */ public function from_html( string $unprocessed_html ): self { $inliner_class = $this->get_inliner_class(); $that = new self(); $that->inliner = $inliner_class::fromHtml( $unprocessed_html ); return $that; } /** * Inlines the provided CSS. * * @param string $css The CSS to inline. * @return self * @throws \LogicException If from_html() was not called first. */ public function inline_css( string $css = '' ): self { if ( ! isset( $this->inliner ) ) { throw new \LogicException( 'You must call from_html before calling inline_css' ); } /** Ignore PHPStan analysis for dynamic inliner method call. @phpstan-ignore-next-line */ $this->inliner->inlineCss( $css ); return $this; } /** * Renders the HTML with inlined CSS. * * @return string The processed HTML. * @throws \LogicException If from_html() was not called first. */ public function render(): string { if ( ! isset( $this->inliner ) ) { throw new \LogicException( 'You must call from_html before calling render' ); } /** Ignore PHPStan analysis for dynamic inliner method call. @phpstan-ignore-next-line */ return $this->inliner->render(); } /** * Get the inliner class. * * Returns the fully qualified class name for the available CSS inliner. * Runtime return type: 'Pelago\Emogrifier\CssInliner' | 'Automattic\WooCommerce\Vendor\Pelago\Emogrifier\CssInliner' * * @return string Fully qualified class name * @throws \Exception If the inliner class is not found. */ private function get_inliner_class(): string { if ( class_exists( 'Automattic\WooCommerce\Vendor\Pelago\Emogrifier\CssInliner' ) ) { return 'Automattic\WooCommerce\Vendor\Pelago\Emogrifier\CssInliner'; } if ( class_exists( 'Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\CssInliner' ) ) { return 'Automattic\WooCommerce\EmailEditorVendor\Pelago\Emogrifier\CssInliner'; } throw new \Exception( 'CssInliner class not found' ); } } email-editor/src/Validator/Schema/class-null-schema.php 0000777 00000001055 15252010675 0017072 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator\Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema; /** * Represents a schema for a null. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#primitive-types */ class Null_Schema extends Schema { /** * Schema definition. * * @var array */ protected $schema = array( 'type' => 'null', ); } email-editor/src/Validator/Schema/class-boolean-schema.php 0000777 00000001066 15252010675 0017541 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator\Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema; /** * Represents a schema for a boolean. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#primitive-types */ class Boolean_Schema extends Schema { /** * Schema definition. * * @var array */ protected $schema = array( 'type' => 'boolean', ); } email-editor/src/Validator/Schema/class-number-schema.php 0000777 00000003553 15252010675 0017415 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator\Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema; /** * Represents a schema for a number. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#numbers */ class Number_Schema extends Schema { /** * Schema definition. * * @var array */ protected $schema = array( 'type' => 'number', ); /** * Sets the minimum value of the number. * * @param float $value Minimum value of the number. */ public function minimum( float $value ): self { return $this->update_schema_property( 'minimum', $value ) ->unset_schema_property( 'exclusiveMinimum' ); } /** * Sets the exclusiveMinimum property to true. * * @param float $value Minimum value of the number. */ public function exclusiveMinimum( float $value ): self { return $this->update_schema_property( 'minimum', $value ) ->update_schema_property( 'exclusiveMinimum', true ); } /** * Sets the maximum value of the number. * * @param float $value Maximum value of the number. */ public function maximum( float $value ): self { return $this->update_schema_property( 'maximum', $value ) ->unset_schema_property( 'exclusiveMaximum' ); } /** * Sets the exclusiveMaximum property to true. * * @param float $value Maximum value of the number. */ public function exclusiveMaximum( float $value ): self { return $this->update_schema_property( 'maximum', $value ) ->update_schema_property( 'exclusiveMaximum', true ); } /** * Sets the multipleOf property. * * @param float $value Multiple of the number. */ public function multipleOf( float $value ): self { return $this->update_schema_property( 'multipleOf', $value ); } } email-editor/src/Validator/Schema/class-object-schema.php 0000777 00000004710 15252010675 0017367 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator\Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema; /** * Represents a schema for an object. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#objects */ class Object_Schema extends Schema { /** * Schema definition. * * @var array */ protected $schema = array( 'type' => 'object', ); /** * Set the required properties of the object. * * @param array<string, Schema> $properties Required properties. */ public function properties( array $properties ): self { return $this->update_schema_property( 'properties', array_map( function ( Schema $property ) { return $property->to_array(); }, $properties ) ); } /** * Set the required properties of the object. * * @param Schema $schema Schema of the additional properties. */ public function additionalProperties( Schema $schema ): self { return $this->update_schema_property( 'additionalProperties', $schema->to_array() ); } /** * Disables additional properties. */ public function disableAdditionalProperties(): self { return $this->update_schema_property( 'additionalProperties', false ); } /** * Keys of $properties are regular expressions without leading/trailing delimiters. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#patternproperties * * @param array<string, Schema> $properties Regular expressions and their schemas. */ public function patternProperties( array $properties ): self { $pattern_properties = array(); foreach ( $properties as $key => $value ) { $this->validate_pattern( $key ); $pattern_properties[ $key ] = $value->to_array(); } return $this->update_schema_property( 'patternProperties', $pattern_properties ); } /** * Sets the minimum number of properties in the object. * * @param int $value Minimum number of properties in the object. */ public function minProperties( int $value ): self { return $this->update_schema_property( 'minProperties', $value ); } /** * Sets the maximum number of properties in the object. * * @param int $value Maximum number of properties in the object. */ public function maxProperties( int $value ): self { return $this->update_schema_property( 'maxProperties', $value ); } } email-editor/src/Validator/Schema/class-any-of-schema.php 0000777 00000002735 15252010675 0017317 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator\Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema; /** * Represents a schema that allows a value to match any of the given schemas. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#oneof-and-anyof */ class Any_Of_Schema extends Schema { /** * Schema definition. * * @var array[] */ protected $schema = array( 'anyOf' => array(), ); /** * Any_Of_Schema constructor. * * @param Schema[] $schemas List of schemas. */ public function __construct( array $schemas ) { foreach ( $schemas as $schema ) { $this->schema['anyOf'][] = $schema->to_array(); } } /** * Returns the schema as an array. */ public function nullable(): self { $null = array( 'type' => 'null' ); $any_of = $this->schema['anyOf']; $value = in_array( $null, $any_of, true ) ? $any_of : array_merge( $any_of, array( $null ) ); return $this->update_schema_property( 'anyOf', $value ); } /** * Returns the schema as an array. */ public function non_nullable(): self { $null = array( 'type' => 'null' ); $any_of = $this->schema['any_of']; $value = array_filter( $any_of, function ( $item ) use ( $null ) { return $item !== $null; } ); return $this->update_schema_property( 'any_of', $value ); } } email-editor/src/Validator/Schema/class-one-of-schema.php 0000777 00000002731 15252010675 0017305 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator\Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema; /** * Represents a schema that allows a value to match one of the given schemas. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#oneof-and-anyof */ class One_Of_Schema extends Schema { /** * Schema definition. * * @var array */ protected $schema = array( 'oneOf' => array(), ); /** * One_Of_Schema constructor. * * @param Schema[] $schemas List of schemas. */ public function __construct( array $schemas ) { foreach ( $schemas as $schema ) { $this->schema['oneOf'][] = $schema->to_array(); } } /** * Sets the schema as nullable. */ public function nullable(): self { $null = array( 'type' => 'null' ); $one_of = $this->schema['oneOf']; $value = in_array( $null, $one_of, true ) ? $one_of : array_merge( $one_of, array( $null ) ); return $this->update_schema_property( 'oneOf', $value ); } /** * Sets the schema as non-nullable. */ public function non_nullable(): self { $null = array( 'type' => 'null' ); $one_of = $this->schema['one_of']; $value = array_filter( $one_of, function ( $item ) use ( $null ) { return $item !== $null; } ); return $this->update_schema_property( 'one_of', $value ); } } email-editor/src/Validator/Schema/class-string-schema.php 0000777 00000004514 15252010675 0017431 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator\Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema; /** * Represents a schema for a string. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#strings */ class String_Schema extends Schema { /** * Schema definition. * * @var array */ protected $schema = array( 'type' => 'string', ); /** * Set minimum length of the string. * * @param int $value Minimum length. */ public function minLength( int $value ): self { return $this->update_schema_property( 'minLength', $value ); } /** * Set maximum length of the string. * * @param int $value Maximum length. */ public function maxLength( int $value ): self { return $this->update_schema_property( 'maxLength', $value ); } /** * Parameter $pattern is a regular expression without leading/trailing delimiters. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#pattern * * @param string $pattern Regular expression pattern. */ public function pattern( string $pattern ): self { $this->validate_pattern( $pattern ); return $this->update_schema_property( 'pattern', $pattern ); } /** * Set the format of the string according to DateTime. */ public function formatDateTime(): self { return $this->update_schema_property( 'format', 'date-time' ); } /** * Set the format of the string according to email. */ public function formatEmail(): self { return $this->update_schema_property( 'format', 'email' ); } /** * Set the format of the string according to Hex color. */ public function formatHexColor(): self { return $this->update_schema_property( 'format', 'hex-color' ); } /** * Set the format of the string according to IP address. */ public function formatIp(): self { return $this->update_schema_property( 'format', 'ip' ); } /** * Set the format of the string according to uri. */ public function formatUri(): self { return $this->update_schema_property( 'format', 'uri' ); } /** * Set the format of the string according to uuid. */ public function formatUuid(): self { return $this->update_schema_property( 'format', 'uuid' ); } } email-editor/src/Validator/Schema/class-integer-schema.php 0000777 00000003542 15252010675 0017560 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator\Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema; /** * Represents a schema for an integer. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#numbers */ class Integer_Schema extends Schema { /** * Schema definition. * * @var array */ protected $schema = array( 'type' => 'integer', ); /** * Sets the minimum value of the integer. * * @param int $value Minimum value of the integer. */ public function minimum( int $value ): self { return $this->update_schema_property( 'minimum', $value ) ->unset_schema_property( 'exclusiveMinimum' ); } /** * Sets the exclusiveMinimum property to true. * * @param int $value Minimum value of the integer. */ public function exclusiveMinimum( int $value ): self { return $this->update_schema_property( 'minimum', $value ) ->update_schema_property( 'exclusiveMinimum', true ); } /** * Sets the maximum value of the integer. * * @param int $value Maximum value of the integer. */ public function maximum( int $value ): self { return $this->update_schema_property( 'maximum', $value ) ->unset_schema_property( 'exclusiveMaximum' ); } /** * Sets the exclusiveMaximum property to true. * * @param int $value Maximum value of the integer. */ public function exclusiveMaximum( int $value ): self { return $this->update_schema_property( 'maximum', $value ) ->update_schema_property( 'exclusiveMaximum', true ); } /** * Sets the multipleOf property. * * @param int $value Multiple of the integer. */ public function multipleOf( int $value ): self { return $this->update_schema_property( 'multipleOf', $value ); } } email-editor/src/Validator/Schema/class-array-schema.php 0000777 00000002635 15252010675 0017243 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator\Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema; /** * Represents a schema for an array. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#arrays */ class Array_Schema extends Schema { /** * Schema definition. * * @var array */ protected $schema = array( 'type' => 'array', ); /** * Sets the schema for the items in the array. * * @param Schema $schema Schema for the items in the array. */ public function items( Schema $schema ): self { return $this->update_schema_property( 'items', $schema->to_array() ); } /** * Sets the minimum number of items in the array. * * @param int $value Minimum number of items in the array. */ public function minItems( int $value ): self { return $this->update_schema_property( 'minItems', $value ); } /** * Sets the maximum number of items in the array. * * @param int $value Maximum number of items in the array. */ public function maxItems( int $value ): self { return $this->update_schema_property( 'maxItems', $value ); } /** * Sets the uniqueItems property to true. */ public function uniqueItems(): self { return $this->update_schema_property( 'uniqueItems', true ); } } email-editor/src/Validator/class-builder.php 0000777 00000005241 15252010675 0015111 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator; use Automattic\WooCommerce\EmailEditor\Validator\Schema\Any_Of_Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema\Array_Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema\Boolean_Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema\Integer_Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema\Null_Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema\Number_Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema\Object_Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema\One_Of_Schema; use Automattic\WooCommerce\EmailEditor\Validator\Schema\String_Schema; /** * Builder for creating schema objects. * See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/ */ class Builder { /** * Creates a schema for a string. */ public static function string(): String_Schema { return new String_Schema(); } /** * Creates a schema for a number. */ public static function number(): Number_Schema { return new Number_Schema(); } /** * Creates a schema for an integer. */ public static function integer(): Integer_Schema { return new Integer_Schema(); } /** * Creates a schema for a boolean. */ public static function boolean(): Boolean_Schema { return new Boolean_Schema(); } /** * Creates a schema for null. */ public static function null(): Null_Schema { return new Null_Schema(); } /** * Creates a schema for an array. * * @param Schema|null $items Schema of the items in the array. */ public static function array( ?Schema $items = null ): Array_Schema { $array = new Array_Schema(); return $items ? $array->items( $items ) : $array; } /** * Creates a schema for an object. * * @param array<string, Schema>|null $properties Properties of the object. */ public static function object( ?array $properties = null ): Object_Schema { $object = new Object_Schema(); return null === $properties ? $object : $object->properties( $properties ); } /** * Creates a schema that allows a value to match one of the given schemas. * * @param Schema[] $schemas List of schemas. */ public static function one_of( array $schemas ): One_Of_Schema { return new One_Of_Schema( $schemas ); } /** * Creates a schema that allows a value to match any of the given schemas. * * @param Schema[] $schemas List of schemas. */ public static function any_of( array $schemas ): Any_Of_Schema { return new Any_Of_Schema( $schemas ); } } email-editor/src/Validator/class-validator.php 0000777 00000017374 15252010675 0015462 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator; use JsonSerializable; use stdClass; use WP_Error; /** * Validates and sanitizes values based on a schema. */ class Validator { /** * Strict validation & sanitization implementation. * It only coerces int to float (e.g. 5 to 5.0). * * @param Schema $schema The schema to validate against. * @param mixed $value The value to validate. * @param string $param_name The parameter name. * @return mixed */ public function validate( Schema $schema, $value, string $param_name = 'value' ) { return $this->validate_schema_array( $schema->to_array(), $value, $param_name ); } /** * Strict validation & sanitization implementation. * It only coerces int to float (e.g. 5 to 5.0). * * @param array $schema The array must follow the format, which is returned from Schema::toArray(). * @param mixed $value The value to validate. * @param string $param_name The parameter name. * @return mixed * @throws Validation_Exception If the value does not match the schema. */ public function validate_schema_array( array $schema, $value, string $param_name = 'value' ) { $result = $this->validate_and_sanitize_value_from_schema( $value, $schema, $param_name ); if ( $result instanceof WP_Error ) { throw Validation_Exception::create_from_wp_error( $result ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped } return $result; } /** * Mirrors rest_validate_value_from_schema() and rest_sanitize_value_from_schema(). * * @param mixed $value The value to validate. * @param array $schema The schema to validate against. * @param string $param_name The parameter name. * @return mixed|WP_Error */ private function validate_and_sanitize_value_from_schema( $value, array $schema, string $param_name ) { // nullable. $full_type = $schema['type'] ?? null; if ( is_array( $full_type ) && in_array( 'null', $full_type, true ) && null === $value ) { return null; } // anyOf, oneOf. if ( isset( $schema['anyOf'] ) ) { return $this->validate_and_sanitize_any_of( $value, $schema, $param_name ); } elseif ( isset( $schema['oneOf'] ) ) { return $this->validate_and_sanitize_one_of( $value, $schema, $param_name ); } // make types strict. $type = is_array( $full_type ) ? $full_type[0] : $full_type; switch ( $type ) { case 'number': if ( ! is_float( $value ) && ! is_int( $value ) ) { return $this->get_type_error( $param_name, $full_type ); } break; case 'integer': if ( ! is_int( $value ) ) { return $this->get_type_error( $param_name, $full_type ); } break; case 'boolean': if ( ! is_bool( $value ) ) { return $this->get_type_error( $param_name, $full_type ); } break; case 'array': if ( ! is_array( $value ) ) { return $this->get_type_error( $param_name, $full_type ); } if ( isset( $schema['items'] ) ) { foreach ( $value as $i => $v ) { $result = $this->validate_and_sanitize_value_from_schema( $v, $schema['items'], $param_name . '[' . $i . ']' ); if ( is_wp_error( $result ) ) { return $result; } } } break; case 'object': if ( ! is_array( $value ) && ! $value instanceof stdClass && ! $value instanceof JsonSerializable ) { return $this->get_type_error( $param_name, $full_type ); } // ensure string keys. $value = (array) ( $value instanceof JsonSerializable ? $value->jsonSerialize() : $value ); if ( count( array_filter( array_keys( $value ), 'is_string' ) ) !== count( $value ) ) { return $this->get_type_error( $param_name, $full_type ); } // validate object properties. foreach ( $value as $k => $v ) { if ( isset( $schema['properties'][ $k ] ) ) { $result = $this->validate_and_sanitize_value_from_schema( $v, $schema['properties'][ $k ], $param_name . '[' . $k . ']' ); if ( is_wp_error( $result ) ) { return $result; } continue; } $pattern_property_schema = rest_find_matching_pattern_property_schema( $k, $schema ); if ( $pattern_property_schema ) { $result = $this->validate_and_sanitize_value_from_schema( $v, $pattern_property_schema, $param_name . '[' . $k . ']' ); if ( is_wp_error( $result ) ) { return $result; } continue; } if ( isset( $schema['additionalProperties'] ) && is_array( $schema['additionalProperties'] ) ) { $result = $this->validate_and_sanitize_value_from_schema( $v, $schema['additionalProperties'], $param_name . '[' . $k . ']' ); if ( is_wp_error( $result ) ) { return $result; } } } break; } $result = rest_validate_value_from_schema( $value, $schema, $param_name ); if ( is_wp_error( $result ) ) { return $result; } return rest_sanitize_value_from_schema( $value, $schema, $param_name ); } /** * Mirrors rest_find_any_matching_schema(). * * @param mixed $value The value to validate. * @param array $any_of_schema The schema to validate against. * @param string $param_name The parameter name. * @return mixed|WP_Error */ private function validate_and_sanitize_any_of( $value, array $any_of_schema, string $param_name ) { $errors = array(); foreach ( $any_of_schema['anyOf'] as $index => $schema ) { $result = $this->validate_and_sanitize_value_from_schema( $value, $schema, $param_name ); if ( ! is_wp_error( $result ) ) { return $result; } $errors[] = array( 'error_object' => $result, 'schema' => $schema, 'index' => $index, ); } /* @phpstan-ignore-next-line Wrong annotation for parameter in WP. */ return rest_get_combining_operation_error( $value, $param_name, $errors ); } /** * Mirrors rest_find_one_matching_schema(). * * @param mixed $value The value to validate. * @param array $one_of_schema The schema to validate against. * @param string $param_name The parameter name. * @return mixed|WP_Error */ private function validate_and_sanitize_one_of( $value, array $one_of_schema, string $param_name ) { $matching_schemas = array(); $errors = array(); $data = null; foreach ( $one_of_schema['oneOf'] as $index => $schema ) { $result = $this->validate_and_sanitize_value_from_schema( $value, $schema, $param_name ); if ( is_wp_error( $result ) ) { $errors[] = array( 'error_object' => $result, 'schema' => $schema, 'index' => $index, ); } else { $data = $result; $matching_schemas[ $index ] = $schema; } } if ( ! $matching_schemas ) { /* @phpstan-ignore-next-line Wrong annotation for parameter in WP. */ return rest_get_combining_operation_error( $value, $param_name, $errors ); } if ( count( $matching_schemas ) > 1 ) { // reuse WP method to generate detailed error. $invalid_schema = array( 'type' => array() ); $one_of = array_replace( array_fill( 0, count( $one_of_schema['oneOf'] ), $invalid_schema ), $matching_schemas ); return rest_find_one_matching_schema( $value, array( 'oneOf' => $one_of ), $param_name ); } return $data; } /** * Returns a WP_Error for a type mismatch. * * @param string $param The parameter name. * @param string|string[] $type The expected type. */ private function get_type_error( string $param, $type ): WP_Error { $type = is_array( $type ) ? $type : array( $type ); return new WP_Error( 'rest_invalid_type', // translators: %1$s is the current parameter and %2$s a comma-separated list of the allowed types. sprintf( __( '%1$s is not of type %2$s.', 'woocommerce' ), $param, implode( ',', $type ) ), array( 'param' => $param ) ); } } email-editor/src/Validator/class-schema.php 0000777 00000010201 15252010675 0014713 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator; use function wp_json_encode; use function rest_get_allowed_schema_keywords; /** * Represents abastract schema. */ abstract class Schema { /** * Schema definition. * * @var array */ protected $schema = array(); /** * Sets the schema as nullable. * * @return static */ public function nullable() { $type = $this->schema['type'] ?? array( 'null' ); return $this->update_schema_property( 'type', is_array( $type ) ? $type : array( $type, 'null' ) ); } /** * Sets the schema as non-nullable. * * @return static */ public function non_nullable() { $type = $this->schema['type'] ?? null; return null === $type ? $this->unset_schema_property( 'type' ) : $this->update_schema_property( 'type', is_array( $type ) ? $type[0] : $type ); } /** * Sets the schema as required. * * @return static */ public function required() { return $this->update_schema_property( 'required', true ); } /** * Unsets the required property. * * @return static */ public function optional() { return $this->unset_schema_property( 'required' ); } /** * Set the title of the schema. * * @param string $title Title. * @return static */ public function title( string $title ) { return $this->update_schema_property( 'title', $title ); } /** * Set the description of the schema. * * @param string $description Description. * @return static */ public function description( string $description ) { return $this->update_schema_property( 'description', $description ); } /** * Set the default value. * * @param mixed $default_value Default value. * @return static */ public function default( $default_value ) { return $this->update_schema_property( 'default', $default_value ); } /** * Set the field name and value. * * @param string $name Name of the field. * @param mixed $value Value of the field. * @return static * @throws \Exception When the field name is reserved. */ public function field( string $name, $value ) { if ( in_array( $name, $this->get_reserved_keywords(), true ) ) { throw new \Exception( \esc_html( "Field name '$name' is reserved" ) ); } return $this->update_schema_property( $name, $value ); } /** * Returns the schema as an array. */ public function to_array(): array { return $this->schema; } /** * Returns the schema as a JSON string. * * @throws \Exception When the schema cannot be converted to JSON. */ public function to_string(): string { $json = wp_json_encode( $this->schema, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_PRESERVE_ZERO_FRACTION ); $error = json_last_error(); if ( $error || false === $json ) { throw new \Exception( \esc_html( json_last_error_msg() ), 0 ); } return $json; } /** * Updates the schema property. * * @param string $name Property name. * @param mixed $value Property value. * @return static */ protected function update_schema_property( string $name, $value ) { $clone = clone $this; $clone->schema[ $name ] = $value; return $clone; } /** * Unsets the schema property. * * @param string $name Property name. * @return static */ protected function unset_schema_property( string $name ) { $clone = clone $this; unset( $clone->schema[ $name ] ); return $clone; } /** * Returns reserved keywords. * * @return string[] */ protected function get_reserved_keywords(): array { return rest_get_allowed_schema_keywords(); } /** * Validates the regular expression pattern. * * @param string $pattern Regular expression pattern. * @throws \Exception When the pattern is invalid. */ protected function validate_pattern( string $pattern ): void { $escaped = str_replace( '#', '\\#', $pattern ); $regex = "#$escaped#u"; if ( @preg_match( $regex, '' ) === false ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged throw new \Exception( \esc_html( "Invalid regular expression '$regex'" ) ); } } } email-editor/src/Validator/class-validation-exception.php 0000777 00000001653 15252010675 0017614 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package. * * @package Automattic\WooCommerce\EmailEditor */ declare( strict_types = 1 ); namespace Automattic\WooCommerce\EmailEditor\Validator; use Automattic\WooCommerce\EmailEditor\UnexpectedValueException; use WP_Error; /** * Exception thrown when validation fails. */ class Validation_Exception extends UnexpectedValueException { /** * WP_Error instance. * * @var WP_Error */ protected $wp_error; /** * Creates a new instance of the exception. * * @param WP_Error $wp_error WP_Error instance. */ public static function create_from_wp_error( WP_Error $wp_error ): self { $exception = self::create() ->withMessage( $wp_error->get_error_message() ); $exception->wp_error = $wp_error; return $exception; } /** * Returns the WP_Error instance. */ public function get_wp_error(): WP_Error { return $this->wp_error; } } email-editor/license.txt 0000777 00000044470 15252010675 0011325 0 ustar 00 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. 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, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA This program incorporates work covered by the following copyright and permission notices: html2text is Copyright (c) 2019 Jevon Wright https://github.com/soundasleep/html2text html2text is released under the MIT License https://github.com/soundasleep/html2text/blob/83502b6f8f1aaef8e2e238897199d64f284b4af3/LICENSE.md =================================== GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. email-editor/email-editor.php 0000777 00000001240 15252010675 0012212 0 ustar 00 <?php /** * This file is part of the WooCommerce Email Editor package * * @package Automattic\WooCommerce\EmailEditor */ /** * Plugin Name: Email Editor * Plugin URI: https://woocommerce.com/ * Description: An empty email-editor definition file to setup wp-env test env. * Version: 0.0.1 * Author: Automattic * Author URI: https://woocommerce.com * Requires at least: 6.7 * Requires PHP: 7.4 */ $autoload_entry_point = __DIR__ . '/vendor/autoload.php'; if ( file_exists( $autoload_entry_point ) ) { require_once $autoload_entry_point; } // When the package is distributed as part of WooCommerce core, it will provide autoloading of necessary dependencies. action-scheduler/license.txt 0000777 00000104515 15252010675 0012200 0 ustar 00 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. 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 <https://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/licenses/why-not-lgpl.html>. action-scheduler/functions.php 0000777 00000046416 15252010675 0012543 0 ustar 00 <?php /** * General API functions for scheduling actions * * @package ActionScheduler. */ /** * Enqueue an action to run one time, as soon as possible * * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @param bool $unique Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. * @param int $priority Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. * * @return int The action ID. Zero if there was an error scheduling the action. */ function as_enqueue_async_action( $hook, $args = array(), $group = '', $unique = false, $priority = 10 ) { if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) { return 0; } /** * Provides an opportunity to short-circuit the default process for enqueuing async * actions. * * Returning a value other than null from the filter will short-circuit the normal * process. The expectation in such a scenario is that callbacks will return an integer * representing the enqueued action ID (enqueued using some alternative process) or else * zero. * * @param int|null $pre_option The value to return instead of the option value. * @param string $hook Action hook. * @param array $args Action arguments. * @param string $group Action group. * @param int $priority Action priority. * @param bool $unique Unique action. */ $pre = apply_filters( 'pre_as_enqueue_async_action', null, $hook, $args, $group, $priority, $unique ); if ( null !== $pre ) { return is_int( $pre ) ? $pre : 0; } return ActionScheduler::factory()->create( array( 'type' => 'async', 'hook' => $hook, 'arguments' => $args, 'group' => $group, 'unique' => $unique, 'priority' => $priority, ) ); } /** * Schedule an action to run one time * * @param int $timestamp When the job will run. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @param bool $unique Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. * @param int $priority Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. * * @return int The action ID. Zero if there was an error scheduling the action. */ function as_schedule_single_action( $timestamp, $hook, $args = array(), $group = '', $unique = false, $priority = 10 ) { if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) { return 0; } /** * Provides an opportunity to short-circuit the default process for enqueuing single * actions. * * Returning a value other than null from the filter will short-circuit the normal * process. The expectation in such a scenario is that callbacks will return an integer * representing the scheduled action ID (scheduled using some alternative process) or else * zero. * * @param int|null $pre_option The value to return instead of the option value. * @param int $timestamp When the action will run. * @param string $hook Action hook. * @param array $args Action arguments. * @param string $group Action group. * @param int $priorities Action priority. * @param bool $unique Unique action. */ $pre = apply_filters( 'pre_as_schedule_single_action', null, $timestamp, $hook, $args, $group, $priority, $unique ); if ( null !== $pre ) { return is_int( $pre ) ? $pre : 0; } return ActionScheduler::factory()->create( array( 'type' => 'single', 'hook' => $hook, 'arguments' => $args, 'when' => $timestamp, 'group' => $group, 'unique' => $unique, 'priority' => $priority, ) ); } /** * Schedule a recurring action * * @param int $timestamp When the first instance of the job will run. * @param int $interval_in_seconds How long to wait between runs. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @param bool $unique Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. * @param int $priority Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. * * @return int The action ID. Zero if there was an error scheduling the action. */ function as_schedule_recurring_action( $timestamp, $interval_in_seconds, $hook, $args = array(), $group = '', $unique = false, $priority = 10 ) { if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) { return 0; } $interval = (int) $interval_in_seconds; // We expect an integer and allow it to be passed using float and string types, but otherwise // should reject unexpected values. // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison if ( ! is_numeric( $interval_in_seconds ) || $interval_in_seconds != $interval ) { _doing_it_wrong( __METHOD__, sprintf( /* translators: 1: provided value 2: provided type. */ esc_html__( 'An integer was expected but "%1$s" (%2$s) was received.', 'woocommerce' ), esc_html( $interval_in_seconds ), esc_html( gettype( $interval_in_seconds ) ) ), '3.6.0' ); return 0; } /** * Provides an opportunity to short-circuit the default process for enqueuing recurring * actions. * * Returning a value other than null from the filter will short-circuit the normal * process. The expectation in such a scenario is that callbacks will return an integer * representing the scheduled action ID (scheduled using some alternative process) or else * zero. * * @param int|null $pre_option The value to return instead of the option value. * @param int $timestamp When the action will run. * @param int $interval_in_seconds How long to wait between runs. * @param string $hook Action hook. * @param array $args Action arguments. * @param string $group Action group. * @param int $priority Action priority. * @param bool $unique Unique action. */ $pre = apply_filters( 'pre_as_schedule_recurring_action', null, $timestamp, $interval_in_seconds, $hook, $args, $group, $priority, $unique ); if ( null !== $pre ) { return is_int( $pre ) ? $pre : 0; } return ActionScheduler::factory()->create( array( 'type' => 'recurring', 'hook' => $hook, 'arguments' => $args, 'when' => $timestamp, 'pattern' => $interval_in_seconds, 'group' => $group, 'unique' => $unique, 'priority' => $priority, ) ); } /** * Schedule an action that recurs on a cron-like schedule. * * @param int $timestamp The first instance of the action will be scheduled * to run at a time calculated after this timestamp matching the cron * expression. This can be used to delay the first instance of the action. * @param string $schedule A cron-link schedule string. * @see http://en.wikipedia.org/wiki/Cron * * * * * * * * ┬ ┬ ┬ ┬ ┬ ┬ * | | | | | | * | | | | | + year [optional] * | | | | +----- day of week (0 - 7) (Sunday=0 or 7) * | | | +---------- month (1 - 12) * | | +--------------- day of month (1 - 31) * | +-------------------- hour (0 - 23) * +------------------------- min (0 - 59) * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @param bool $unique Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. * @param int $priority Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. * * @return int The action ID. Zero if there was an error scheduling the action. */ function as_schedule_cron_action( $timestamp, $schedule, $hook, $args = array(), $group = '', $unique = false, $priority = 10 ) { if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) { return 0; } /** * Provides an opportunity to short-circuit the default process for enqueuing cron * actions. * * Returning a value other than null from the filter will short-circuit the normal * process. The expectation in such a scenario is that callbacks will return an integer * representing the scheduled action ID (scheduled using some alternative process) or else * zero. * * @param int|null $pre_option The value to return instead of the option value. * @param int $timestamp When the action will run. * @param string $schedule Cron-like schedule string. * @param string $hook Action hook. * @param array $args Action arguments. * @param string $group Action group. * @param int $priority Action priority. * @param bool $unique Unique action. */ $pre = apply_filters( 'pre_as_schedule_cron_action', null, $timestamp, $schedule, $hook, $args, $group, $priority, $unique ); if ( null !== $pre ) { return is_int( $pre ) ? $pre : 0; } return ActionScheduler::factory()->create( array( 'type' => 'cron', 'hook' => $hook, 'arguments' => $args, 'when' => $timestamp, 'pattern' => $schedule, 'group' => $group, 'unique' => $unique, 'priority' => $priority, ) ); } /** * Cancel the next occurrence of a scheduled action. * * While only the next instance of a recurring or cron action is unscheduled by this method, that will also prevent * all future instances of that recurring or cron action from being run. Recurring and cron actions are scheduled in * a sequence instead of all being scheduled at once. Each successive occurrence of a recurring action is scheduled * only after the former action is run. If the next instance is never run, because it's unscheduled by this function, * then the following instance will never be scheduled (or exist), which is effectively the same as being unscheduled * by this method also. * * @param string $hook The hook that the job will trigger. * @param array $args Args that would have been passed to the job. * @param string $group The group the job is assigned to. * * @return int|null The scheduled action ID if a scheduled action was found, or null if no matching action found. */ function as_unschedule_action( $hook, $args = array(), $group = '' ) { if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) { return 0; } $params = array( 'hook' => $hook, 'status' => ActionScheduler_Store::STATUS_PENDING, 'orderby' => 'date', 'order' => 'ASC', 'group' => $group, ); if ( is_array( $args ) ) { $params['args'] = $args; } $action_id = ActionScheduler::store()->query_action( $params ); if ( $action_id ) { try { ActionScheduler::store()->cancel_action( $action_id ); } catch ( Exception $exception ) { ActionScheduler::logger()->log( $action_id, sprintf( /* translators: %1$s is the name of the hook to be cancelled, %2$s is the exception message. */ __( 'Caught exception while cancelling action "%1$s": %2$s', 'woocommerce' ), $hook, $exception->getMessage() ) ); $action_id = null; } } return $action_id; } /** * Cancel all occurrences of a scheduled action. * * @param string $hook The hook that the job will trigger. * @param array $args Args that would have been passed to the job. * @param string $group The group the job is assigned to. */ function as_unschedule_all_actions( $hook, $args = array(), $group = '' ) { if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) { return; } if ( empty( $args ) ) { if ( ! empty( $hook ) && empty( $group ) ) { ActionScheduler_Store::instance()->cancel_actions_by_hook( $hook ); return; } if ( ! empty( $group ) && empty( $hook ) ) { ActionScheduler_Store::instance()->cancel_actions_by_group( $group ); return; } } do { $unscheduled_action = as_unschedule_action( $hook, $args, $group ); } while ( ! empty( $unscheduled_action ) ); } /** * Check if there is an existing action in the queue with a given hook, args and group combination. * * An action in the queue could be pending, in-progress or async. If the is pending for a time in * future, its scheduled date will be returned as a timestamp. If it is currently being run, or an * async action sitting in the queue waiting to be processed, in which case boolean true will be * returned. Or there may be no async, in-progress or pending action for this hook, in which case, * boolean false will be the return value. * * @param string $hook Name of the hook to search for. * @param array $args Arguments of the action to be searched. * @param string $group Group of the action to be searched. * * @return int|bool The timestamp for the next occurrence of a pending scheduled action, true for an async or in-progress action or false if there is no matching action. */ function as_next_scheduled_action( $hook, $args = null, $group = '' ) { if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) { return false; } $params = array( 'hook' => $hook, 'orderby' => 'date', 'order' => 'ASC', 'group' => $group, ); if ( is_array( $args ) ) { $params['args'] = $args; } $params['status'] = ActionScheduler_Store::STATUS_RUNNING; $action_id = ActionScheduler::store()->query_action( $params ); if ( $action_id ) { return true; } $params['status'] = ActionScheduler_Store::STATUS_PENDING; $action_id = ActionScheduler::store()->query_action( $params ); if ( null === $action_id ) { return false; } $action = ActionScheduler::store()->fetch_action( $action_id ); $scheduled_date = $action->get_schedule()->get_date(); if ( $scheduled_date ) { return (int) $scheduled_date->format( 'U' ); } elseif ( null === $scheduled_date ) { // pending async action with NullSchedule. return true; } return false; } /** * Check if there is a scheduled action in the queue but more efficiently than as_next_scheduled_action(). * * It's recommended to use this function when you need to know whether a specific action is currently scheduled * (pending or in-progress). * * @since 3.3.0 * * @param string $hook The hook of the action. * @param array $args Args that have been passed to the action. Null will matches any args. * @param string $group The group the job is assigned to. * * @return bool True if a matching action is pending or in-progress, false otherwise. */ function as_has_scheduled_action( $hook, $args = null, $group = '' ) { if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) { return false; } $query_args = array( 'hook' => $hook, 'status' => array( ActionScheduler_Store::STATUS_RUNNING, ActionScheduler_Store::STATUS_PENDING ), 'group' => $group, 'orderby' => 'none', ); if ( null !== $args ) { $query_args['args'] = $args; } $action_id = ActionScheduler::store()->query_action( $query_args ); return null !== $action_id; } /** * Find scheduled actions * * @param array $args Possible arguments, with their default values. * 'hook' => '' - the name of the action that will be triggered. * 'args' => NULL - the args array that will be passed with the action. * 'date' => NULL - the scheduled date of the action. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. * 'date_compare' => '<=' - operator for testing "date". accepted values are '!=', '>', '>=', '<', '<=', '='. * 'modified' => NULL - the date the action was last updated. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. * 'modified_compare' => '<=' - operator for testing "modified". accepted values are '!=', '>', '>=', '<', '<=', '='. * 'group' => '' - the group the action belongs to. * 'status' => '' - ActionScheduler_Store::STATUS_COMPLETE or ActionScheduler_Store::STATUS_PENDING. * 'claimed' => NULL - TRUE to find claimed actions, FALSE to find unclaimed actions, a string to find a specific claim ID. * 'per_page' => 5 - Number of results to return. * 'offset' => 0. * 'orderby' => 'date' - accepted values are 'hook', 'group', 'modified', 'date' or 'none'. * 'order' => 'ASC'. * * @param string $return_format OBJECT, ARRAY_A, or ids. * * @return array */ function as_get_scheduled_actions( $args = array(), $return_format = OBJECT ) { if ( ! ActionScheduler::is_initialized( __FUNCTION__ ) ) { return array(); } $store = ActionScheduler::store(); foreach ( array( 'date', 'modified' ) as $key ) { if ( isset( $args[ $key ] ) ) { $args[ $key ] = as_get_datetime_object( $args[ $key ] ); } } $ids = $store->query_actions( $args ); if ( 'ids' === $return_format || 'int' === $return_format ) { return $ids; } $actions = array(); foreach ( $ids as $action_id ) { $actions[ $action_id ] = $store->fetch_action( $action_id ); } if ( ARRAY_A === $return_format ) { foreach ( $actions as $action_id => $action_object ) { $actions[ $action_id ] = get_object_vars( $action_object ); } } return $actions; } /** * Helper function to create an instance of DateTime based on a given * string and timezone. By default, will return the current date/time * in the UTC timezone. * * Needed because new DateTime() called without an explicit timezone * will create a date/time in PHP's timezone, but we need to have * assurance that a date/time uses the right timezone (which we almost * always want to be UTC), which means we need to always include the * timezone when instantiating datetimes rather than leaving it up to * the PHP default. * * @param mixed $date_string A date/time string. Valid formats are explained in http://php.net/manual/en/datetime.formats.php. * @param string $timezone A timezone identifier, like UTC or Europe/Lisbon. The list of valid identifiers is available http://php.net/manual/en/timezones.php. * * @return ActionScheduler_DateTime */ function as_get_datetime_object( $date_string = null, $timezone = 'UTC' ) { if ( is_object( $date_string ) && $date_string instanceof DateTime ) { $date = new ActionScheduler_DateTime( $date_string->format( 'Y-m-d H:i:s' ), new DateTimeZone( $timezone ) ); } elseif ( is_numeric( $date_string ) ) { $date = new ActionScheduler_DateTime( '@' . $date_string, new DateTimeZone( $timezone ) ); } else { $date = new ActionScheduler_DateTime( null === $date_string ? 'now' : $date_string, new DateTimeZone( $timezone ) ); } return $date; } /** * Check if a specific feature is supported by the current version of Action Scheduler. * * @since 3.9.3 * * @param string $feature The feature to check support for. * * @return bool True if the feature is supported, false otherwise. */ function as_supports( string $feature ): bool { $supported_features = array( 'ensure_recurring_actions_hook' ); return in_array( $feature, $supported_features, true ); } action-scheduler/classes/ActionScheduler_AsyncRequest_QueueRunner.php 0000777 00000004163 15252010675 0022301 0 ustar 00 <?php defined( 'ABSPATH' ) || exit; /** * ActionScheduler_AsyncRequest_QueueRunner class. */ class ActionScheduler_AsyncRequest_QueueRunner extends WP_Async_Request { /** * Data store for querying actions * * @var ActionScheduler_Store */ protected $store; /** * Prefix for ajax hooks * * @var string */ protected $prefix = 'as'; /** * Action for ajax hooks * * @var string */ protected $action = 'async_request_queue_runner'; /** * Initiate new async request. * * @param ActionScheduler_Store $store Store object. */ public function __construct( ActionScheduler_Store $store ) { parent::__construct(); $this->store = $store; } /** * Handle async requests * * Run a queue, and maybe dispatch another async request to run another queue * if there are still pending actions after completing a queue in this request. */ protected function handle() { do_action( 'action_scheduler_run_queue', 'Async Request' ); // run a queue in the same way as WP Cron, but declare the Async Request context. $sleep_seconds = $this->get_sleep_seconds(); if ( $sleep_seconds ) { sleep( $sleep_seconds ); } $this->maybe_dispatch(); } /** * If the async request runner is needed and allowed to run, dispatch a request. */ public function maybe_dispatch() { if ( ! $this->allow() ) { return; } $this->dispatch(); ActionScheduler_QueueRunner::instance()->unhook_dispatch_async_request(); } /** * Only allow async requests when needed. * * Also allow 3rd party code to disable running actions via async requests. */ protected function allow() { if ( ! has_action( 'action_scheduler_run_queue' ) || ActionScheduler::runner()->has_maximum_concurrent_batches() || ! $this->store->has_pending_actions_due() ) { $allow = false; } else { $allow = true; } return apply_filters( 'action_scheduler_allow_async_request_runner', $allow ); } /** * Chaining async requests can crash MySQL. A brief sleep call in PHP prevents that. */ protected function get_sleep_seconds() { return apply_filters( 'action_scheduler_async_request_sleep_seconds', 5, $this ); } } action-scheduler/classes/ActionScheduler_SystemInformation.php 0000777 00000004701 15252010675 0021005 0 ustar 00 <?php /** * Provides information about active and registered instances of Action Scheduler. */ class ActionScheduler_SystemInformation { /** * Returns information about the plugin or theme which contains the current active version * of Action Scheduler. * * If this cannot be determined, or if Action Scheduler is being loaded via some other * method, then it will return an empty array. Otherwise, if populated, the array will * look like the following: * * [ * 'type' => 'plugin', # or 'theme' * 'name' => 'Name', * ] * * @return array */ public static function active_source(): array { $plugins = get_plugins(); $plugin_files = array_keys( $plugins ); foreach ( $plugin_files as $plugin_file ) { $plugin_path = trailingslashit( WP_PLUGIN_DIR ) . dirname( $plugin_file ); $plugin_file = trailingslashit( WP_PLUGIN_DIR ) . $plugin_file; if ( 0 !== strpos( dirname( __DIR__ ), $plugin_path ) ) { continue; } $plugin_data = get_plugin_data( $plugin_file ); if ( ! is_array( $plugin_data ) || empty( $plugin_data['Name'] ) ) { continue; } return array( 'type' => 'plugin', 'name' => $plugin_data['Name'], ); } $themes = (array) search_theme_directories(); foreach ( $themes as $slug => $data ) { $needle = trailingslashit( $data['theme_root'] ) . $slug . '/'; if ( 0 !== strpos( __FILE__, $needle ) ) { continue; } $theme = wp_get_theme( $slug ); if ( ! is_object( $theme ) || ! is_a( $theme, \WP_Theme::class ) ) { continue; } return array( 'type' => 'theme', // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase 'name' => $theme->Name, ); } return array(); } /** * Returns the directory path for the currently active installation of Action Scheduler. * * @return string */ public static function active_source_path(): string { return trailingslashit( dirname( __DIR__ ) ); } /** * Get registered sources. * * It is not always possible to obtain this information. For instance, if earlier versions (<=3.9.0) of * Action Scheduler register themselves first, then the necessary data about registered sources will * not be available. * * @return array<string, string> */ public static function get_sources() { $versions = ActionScheduler_Versions::instance(); return method_exists( $versions, 'get_sources' ) ? $versions->get_sources() : array(); } } action-scheduler/classes/ActionScheduler_OptionLock.php 0000777 00000007754 15252010675 0017407 0 ustar 00 <?php /** * Provide a way to set simple transient locks to block behaviour * for up-to a given duration. * * Class ActionScheduler_OptionLock * * @since 3.0.0 */ class ActionScheduler_OptionLock extends ActionScheduler_Lock { /** * Set a lock using options for a given amount of time (60 seconds by default). * * Using an autoloaded option avoids running database queries or other resource intensive tasks * on frequently triggered hooks, like 'init' or 'shutdown'. * * For example, ActionScheduler_QueueRunner->maybe_dispatch_async_request() uses a lock to avoid * calling ActionScheduler_QueueRunner->has_maximum_concurrent_batches() every time the 'shutdown', * hook is triggered, because that method calls ActionScheduler_QueueRunner->store->get_claim_count() * to find the current number of claims in the database. * * @param string $lock_type A string to identify different lock types. * @bool True if lock value has changed, false if not or if set failed. */ public function set( $lock_type ) { global $wpdb; $lock_key = $this->get_key( $lock_type ); $existing_lock_value = $this->get_existing_lock( $lock_type ); $new_lock_value = $this->new_lock_value( $lock_type ); // The lock may not exist yet, or may have been deleted. if ( empty( $existing_lock_value ) ) { return (bool) $wpdb->insert( $wpdb->options, array( 'option_name' => $lock_key, 'option_value' => $new_lock_value, 'autoload' => 'no', ) ); } if ( $this->get_expiration_from( $existing_lock_value ) >= time() ) { return false; } // Otherwise, try to obtain the lock. return (bool) $wpdb->update( $wpdb->options, array( 'option_value' => $new_lock_value ), array( 'option_name' => $lock_key, 'option_value' => $existing_lock_value, ) ); } /** * If a lock is set, return the timestamp it was set to expiry. * * @param string $lock_type A string to identify different lock types. * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire. */ public function get_expiration( $lock_type ) { return $this->get_expiration_from( $this->get_existing_lock( $lock_type ) ); } /** * Given the lock string, derives the lock expiration timestamp (or false if it cannot be determined). * * @param string $lock_value String containing a timestamp, or pipe-separated combination of unique value and timestamp. * * @return false|int */ private function get_expiration_from( $lock_value ) { $lock_string = explode( '|', $lock_value ); // Old style lock? if ( count( $lock_string ) === 1 && is_numeric( $lock_string[0] ) ) { return (int) $lock_string[0]; } // New style lock? if ( count( $lock_string ) === 2 && is_numeric( $lock_string[1] ) ) { return (int) $lock_string[1]; } return false; } /** * Get the key to use for storing the lock in the transient * * @param string $lock_type A string to identify different lock types. * @return string */ protected function get_key( $lock_type ) { return sprintf( 'action_scheduler_lock_%s', $lock_type ); } /** * Supplies the existing lock value, or an empty string if not set. * * @param string $lock_type A string to identify different lock types. * * @return string */ private function get_existing_lock( $lock_type ) { global $wpdb; // Now grab the existing lock value, if there is one. return (string) $wpdb->get_var( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s", $this->get_key( $lock_type ) ) ); } /** * Supplies a lock value consisting of a unique value and the current timestamp, which are separated by a pipe * character. * * Example: (string) "649de012e6b262.09774912|1688068114" * * @param string $lock_type A string to identify different lock types. * * @return string */ private function new_lock_value( $lock_type ) { return uniqid( '', true ) . '|' . ( time() + $this->get_duration( $lock_type ) ); } } action-scheduler/classes/ActionScheduler_DateTime.php 0000777 00000004014 15252010675 0017004 0 ustar 00 <?php /** * ActionScheduler DateTime class. * * This is a custom extension to DateTime that */ class ActionScheduler_DateTime extends DateTime { /** * UTC offset. * * Only used when a timezone is not set. When a timezone string is * used, this will be set to 0. * * @var int */ protected $utcOffset = 0; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.PropertyNotSnakeCase /** * Get the unix timestamp of the current object. * * Missing in PHP 5.2 so just here so it can be supported consistently. * * @return int */ #[\ReturnTypeWillChange] public function getTimestamp() { return method_exists( 'DateTime', 'getTimestamp' ) ? parent::getTimestamp() : $this->format( 'U' ); } /** * Set the UTC offset. * * This represents a fixed offset instead of a timezone setting. * * @param string|int $offset UTC offset value. */ public function setUtcOffset( $offset ) { $this->utcOffset = intval( $offset ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase } /** * Returns the timezone offset. * * @return int * @link http://php.net/manual/en/datetime.getoffset.php */ #[\ReturnTypeWillChange] public function getOffset() { return $this->utcOffset ? $this->utcOffset : parent::getOffset(); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase } /** * Set the TimeZone associated with the DateTime * * @param DateTimeZone $timezone Timezone object. * * @return static * @link http://php.net/manual/en/datetime.settimezone.php */ #[\ReturnTypeWillChange] public function setTimezone( $timezone ) { $this->utcOffset = 0; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase parent::setTimezone( $timezone ); return $this; } /** * Get the timestamp with the WordPress timezone offset added or subtracted. * * @since 3.0.0 * @return int */ public function getOffsetTimestamp() { return $this->getTimestamp() + $this->getOffset(); } } action-scheduler/classes/data-stores/ActionScheduler_wpCommentLogger.php 0000777 00000017033 15252010675 0022654 0 ustar 00 <?php /** * Class ActionScheduler_wpCommentLogger */ class ActionScheduler_wpCommentLogger extends ActionScheduler_Logger { const AGENT = 'ActionScheduler'; const TYPE = 'action_log'; /** * Create log entry. * * @param string $action_id Action ID. * @param string $message Action log's message. * @param DateTime|null $date Action log's timestamp. * * @return string The log entry ID */ public function log( $action_id, $message, ?DateTime $date = null ) { if ( empty( $date ) ) { $date = as_get_datetime_object(); } else { $date = as_get_datetime_object( clone $date ); } $comment_id = $this->create_wp_comment( $action_id, $message, $date ); return $comment_id; } /** * Create comment. * * @param int $action_id Action ID. * @param string $message Action log's message. * @param DateTime $date Action log entry's timestamp. */ protected function create_wp_comment( $action_id, $message, DateTime $date ) { $comment_date_gmt = $date->format( 'Y-m-d H:i:s' ); ActionScheduler_TimezoneHelper::set_local_timezone( $date ); $comment_data = array( 'comment_post_ID' => $action_id, 'comment_date' => $date->format( 'Y-m-d H:i:s' ), 'comment_date_gmt' => $comment_date_gmt, 'comment_author' => self::AGENT, 'comment_content' => $message, 'comment_agent' => self::AGENT, 'comment_type' => self::TYPE, ); return wp_insert_comment( $comment_data ); } /** * Get single log entry for action. * * @param string $entry_id Entry ID. * * @return ActionScheduler_LogEntry */ public function get_entry( $entry_id ) { $comment = $this->get_comment( $entry_id ); if ( empty( $comment ) || self::TYPE !== $comment->comment_type ) { return new ActionScheduler_NullLogEntry(); } $date = as_get_datetime_object( $comment->comment_date_gmt ); ActionScheduler_TimezoneHelper::set_local_timezone( $date ); return new ActionScheduler_LogEntry( $comment->comment_post_ID, $comment->comment_content, $date ); } /** * Get action's logs. * * @param string $action_id Action ID. * * @return ActionScheduler_LogEntry[] */ public function get_logs( $action_id ) { $status = 'all'; $logs = array(); if ( get_post_status( $action_id ) === 'trash' ) { $status = 'post-trashed'; } $comments = get_comments( array( 'post_id' => $action_id, 'orderby' => 'comment_date_gmt', 'order' => 'ASC', 'type' => self::TYPE, 'status' => $status, ) ); foreach ( $comments as $c ) { $entry = $this->get_entry( $c ); if ( ! empty( $entry ) ) { $logs[] = $entry; } } return $logs; } /** * Get comment. * * @param int $comment_id Comment ID. */ protected function get_comment( $comment_id ) { return get_comment( $comment_id ); } /** * Filter comment queries. * * @param WP_Comment_Query $query Comment query object. */ public function filter_comment_queries( $query ) { foreach ( array( 'ID', 'parent', 'post_author', 'post_name', 'post_parent', 'type', 'post_type', 'post_id', 'post_ID' ) as $key ) { if ( ! empty( $query->query_vars[ $key ] ) ) { return; // don't slow down queries that wouldn't include action_log comments anyway. } } $query->query_vars['action_log_filter'] = true; add_filter( 'comments_clauses', array( $this, 'filter_comment_query_clauses' ), 10, 2 ); } /** * Filter comment queries. * * @param array $clauses Query's clauses. * @param WP_Comment_Query $query Query object. * * @return array */ public function filter_comment_query_clauses( $clauses, $query ) { if ( ! empty( $query->query_vars['action_log_filter'] ) ) { $clauses['where'] .= $this->get_where_clause(); } return $clauses; } /** * Make sure Action Scheduler logs are excluded from comment feeds, which use WP_Query, not * the WP_Comment_Query class handled by @see self::filter_comment_queries(). * * @param string $where Query's `where` clause. * @param WP_Query $query Query object. * * @return string */ public function filter_comment_feed( $where, $query ) { if ( is_comment_feed() ) { $where .= $this->get_where_clause(); } return $where; } /** * Return a SQL clause to exclude Action Scheduler comments. * * @return string */ protected function get_where_clause() { global $wpdb; return sprintf( " AND {$wpdb->comments}.comment_type != '%s'", self::TYPE ); } /** * Remove action log entries from wp_count_comments() * * @param array $stats Comment count. * @param int $post_id Post ID. * * @return object */ public function filter_comment_count( $stats, $post_id ) { global $wpdb; if ( 0 === $post_id ) { $stats = $this->get_comment_count(); } return $stats; } /** * Retrieve the comment counts from our cache, or the database if the cached version isn't set. * * @return object */ protected function get_comment_count() { global $wpdb; $stats = get_transient( 'as_comment_count' ); if ( ! $stats ) { $stats = array(); $count = $wpdb->get_results( "SELECT comment_approved, COUNT( * ) AS num_comments FROM {$wpdb->comments} WHERE comment_type NOT IN('order_note','action_log') GROUP BY comment_approved", ARRAY_A ); $total = 0; $stats = array(); $approved = array( '0' => 'moderated', '1' => 'approved', 'spam' => 'spam', 'trash' => 'trash', 'post-trashed' => 'post-trashed', ); foreach ( (array) $count as $row ) { // Don't count post-trashed toward totals. if ( 'post-trashed' !== $row['comment_approved'] && 'trash' !== $row['comment_approved'] ) { $total += $row['num_comments']; } if ( isset( $approved[ $row['comment_approved'] ] ) ) { $stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments']; } } $stats['total_comments'] = $total; $stats['all'] = $total; foreach ( $approved as $key ) { if ( empty( $stats[ $key ] ) ) { $stats[ $key ] = 0; } } $stats = (object) $stats; set_transient( 'as_comment_count', $stats ); } return $stats; } /** * Delete comment count cache whenever there is new comment or the status of a comment changes. Cache * will be regenerated next time ActionScheduler_wpCommentLogger::filter_comment_count() is called. */ public function delete_comment_count_cache() { delete_transient( 'as_comment_count' ); } /** * Initialize. * * @codeCoverageIgnore */ public function init() { add_action( 'action_scheduler_before_process_queue', array( $this, 'disable_comment_counting' ), 10, 0 ); add_action( 'action_scheduler_after_process_queue', array( $this, 'enable_comment_counting' ), 10, 0 ); parent::init(); add_action( 'pre_get_comments', array( $this, 'filter_comment_queries' ), 10, 1 ); add_action( 'wp_count_comments', array( $this, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs. add_action( 'comment_feed_where', array( $this, 'filter_comment_feed' ), 10, 2 ); // Delete comments count cache whenever there is a new comment or a comment status changes. add_action( 'wp_insert_comment', array( $this, 'delete_comment_count_cache' ) ); add_action( 'wp_set_comment_status', array( $this, 'delete_comment_count_cache' ) ); } /** * Defer comment counting. */ public function disable_comment_counting() { wp_defer_comment_counting( true ); } /** * Enable comment counting. */ public function enable_comment_counting() { wp_defer_comment_counting( false ); } } action-scheduler/classes/data-stores/ActionScheduler_DBStore.php 0000777 00000120167 15252010675 0021050 0 ustar 00 <?php /** * Class ActionScheduler_DBStore * * Action data table data store. * * @since 3.0.0 */ class ActionScheduler_DBStore extends ActionScheduler_Store { /** * Used to share information about the before_date property of claims internally. * * This is used in preference to passing the same information as a method param * for backwards-compatibility reasons. * * @var DateTime|null */ private $claim_before_date = null; /** * Maximum length of args. * * @var int */ protected static $max_args_length = 8000; /** * Maximum length of index. * * @var int */ protected static $max_index_length = 191; /** * List of claim filters. * * @var array */ protected $claim_filters = array( 'group' => '', 'hooks' => '', 'exclude-groups' => '', ); /** * Initialize the data store * * @codeCoverageIgnore */ public function init() { $table_maker = new ActionScheduler_StoreSchema(); $table_maker->init(); $table_maker->register_tables(); } /** * Save an action, checks if this is a unique action before actually saving. * * @param ActionScheduler_Action $action Action object. * @param DateTime|null $scheduled_date Optional schedule date. Default null. * * @return int Action ID. * @throws RuntimeException Throws exception when saving the action fails. */ public function save_unique_action( ActionScheduler_Action $action, ?DateTime $scheduled_date = null ) { return $this->save_action_to_db( $action, $scheduled_date, true ); } /** * Save an action. Can save duplicate action as well, prefer using `save_unique_action` instead. * * @param ActionScheduler_Action $action Action object. * @param DateTime|null $scheduled_date Optional schedule date. Default null. * * @return int Action ID. * @throws RuntimeException Throws exception when saving the action fails. */ public function save_action( ActionScheduler_Action $action, ?DateTime $scheduled_date = null ) { return $this->save_action_to_db( $action, $scheduled_date, false ); } /** * Save an action. * * @param ActionScheduler_Action $action Action object. * @param ?DateTime $date Optional schedule date. Default null. * @param bool $unique Whether the action should be unique. * * @return int Action ID. * @throws \RuntimeException Throws exception when saving the action fails. */ private function save_action_to_db( ActionScheduler_Action $action, ?DateTime $date = null, $unique = false ) { global $wpdb; try { $this->validate_action( $action ); $data = array( 'hook' => $action->get_hook(), 'status' => ( $action->is_finished() ? self::STATUS_COMPLETE : self::STATUS_PENDING ), 'scheduled_date_gmt' => $this->get_scheduled_date_string( $action, $date ), 'scheduled_date_local' => $this->get_scheduled_date_string_local( $action, $date ), 'schedule' => serialize( $action->get_schedule() ), // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize 'group_id' => current( $this->get_group_ids( $action->get_group() ) ), 'priority' => $action->get_priority(), ); $args = wp_json_encode( $action->get_args() ); if ( strlen( $args ) <= static::$max_index_length ) { $data['args'] = $args; } else { $data['args'] = $this->hash_args( $args ); $data['extended_args'] = $args; } $insert_sql = $this->build_insert_sql( $data, $unique ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- $insert_sql should be already prepared. $wpdb->query( $insert_sql ); $action_id = $wpdb->insert_id; if ( is_wp_error( $action_id ) ) { throw new \RuntimeException( $action_id->get_error_message() ); } elseif ( empty( $action_id ) ) { if ( $unique ) { return 0; } throw new \RuntimeException( $wpdb->last_error ? $wpdb->last_error : __( 'Database error.', 'woocommerce' ) ); } do_action( 'action_scheduler_stored_action', $action_id ); return $action_id; } catch ( \Exception $e ) { /* translators: %s: error message */ throw new \RuntimeException( sprintf( __( 'Error saving action: %s', 'woocommerce' ), $e->getMessage() ), 0 ); } } /** * Helper function to build insert query. * * @param array $data Row data for action. * @param bool $unique Whether the action should be unique. * * @return string Insert query. */ private function build_insert_sql( array $data, $unique ) { global $wpdb; $columns = array_keys( $data ); $values = array_values( $data ); $placeholders = array_map( array( $this, 'get_placeholder_for_column' ), $columns ); $table_name = ! empty( $wpdb->actionscheduler_actions ) ? $wpdb->actionscheduler_actions : $wpdb->prefix . 'actionscheduler_actions'; $column_sql = '`' . implode( '`, `', $columns ) . '`'; $placeholder_sql = implode( ', ', $placeholders ); $where_clause = $this->build_where_clause_for_insert( $data, $table_name, $unique ); // phpcs:disable WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare -- $column_sql and $where_clause are already prepared. $placeholder_sql is hardcoded. $insert_query = $wpdb->prepare( " INSERT INTO $table_name ( $column_sql ) SELECT $placeholder_sql FROM DUAL WHERE ( $where_clause ) IS NULL", $values ); // phpcs:enable return $insert_query; } /** * Helper method to build where clause for action insert statement. * * @param array $data Row data for action. * @param string $table_name Action table name. * @param bool $unique Where action should be unique. * * @return string Where clause to be used with insert. */ private function build_where_clause_for_insert( $data, $table_name, $unique ) { global $wpdb; if ( ! $unique ) { return 'SELECT NULL FROM DUAL'; } $pending_statuses = array( ActionScheduler_Store::STATUS_PENDING, ActionScheduler_Store::STATUS_RUNNING, ); $pending_status_placeholders = implode( ', ', array_fill( 0, count( $pending_statuses ), '%s' ) ); // phpcs:disable WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- $pending_status_placeholders is hardcoded. $where_clause = $wpdb->prepare( " SELECT action_id FROM $table_name WHERE status IN ( $pending_status_placeholders ) AND hook = %s AND `group_id` = %d ", array_merge( $pending_statuses, array( $data['hook'], $data['group_id'], ) ) ); // phpcs:enable return "$where_clause" . ' LIMIT 1'; } /** * Helper method to get $wpdb->prepare placeholder for a given column name. * * @param string $column_name Name of column in actions table. * * @return string Placeholder to use for given column. */ private function get_placeholder_for_column( $column_name ) { $string_columns = array( 'hook', 'status', 'scheduled_date_gmt', 'scheduled_date_local', 'args', 'schedule', 'last_attempt_gmt', 'last_attempt_local', 'extended_args', ); return in_array( $column_name, $string_columns, true ) ? '%s' : '%d'; } /** * Generate a hash from json_encoded $args using MD5 as this isn't for security. * * @param string $args JSON encoded action args. * @return string */ protected function hash_args( $args ) { return md5( $args ); } /** * Get action args query param value from action args. * * @param array $args Action args. * @return string */ protected function get_args_for_query( $args ) { $encoded = wp_json_encode( $args ); if ( strlen( $encoded ) <= static::$max_index_length ) { return $encoded; } return $this->hash_args( $encoded ); } /** * Get a group's ID based on its name/slug. * * @param string|array $slugs The string name of a group, or names for several groups. * @param bool $create_if_not_exists Whether to create the group if it does not already exist. Default, true - create the group. * * @return array The group IDs, if they exist or were successfully created. May be empty. */ protected function get_group_ids( $slugs, $create_if_not_exists = true ) { $slugs = (array) $slugs; $group_ids = array(); if ( empty( $slugs ) ) { return array(); } /** * Global. * * @var \wpdb $wpdb */ global $wpdb; foreach ( $slugs as $slug ) { $group_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT group_id FROM {$wpdb->actionscheduler_groups} WHERE slug=%s", $slug ) ); if ( empty( $group_id ) && $create_if_not_exists ) { $group_id = $this->create_group( $slug ); } if ( $group_id ) { $group_ids[] = $group_id; } } return $group_ids; } /** * Create an action group. * * @param string $slug Group slug. * * @return int Group ID. */ protected function create_group( $slug ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $wpdb->insert( $wpdb->actionscheduler_groups, array( 'slug' => $slug ) ); return (int) $wpdb->insert_id; } /** * Retrieve an action. * * @param int $action_id Action ID. * * @return ActionScheduler_Action */ public function fetch_action( $action_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $data = $wpdb->get_row( $wpdb->prepare( "SELECT a.*, g.slug AS `group` FROM {$wpdb->actionscheduler_actions} a LEFT JOIN {$wpdb->actionscheduler_groups} g ON a.group_id=g.group_id WHERE a.action_id=%d", $action_id ) ); if ( empty( $data ) ) { return $this->get_null_action(); } if ( ! empty( $data->extended_args ) ) { $data->args = $data->extended_args; unset( $data->extended_args ); } // Convert NULL dates to zero dates. $date_fields = array( 'scheduled_date_gmt', 'scheduled_date_local', 'last_attempt_gmt', 'last_attempt_gmt', ); foreach ( $date_fields as $date_field ) { if ( is_null( $data->$date_field ) ) { $data->$date_field = ActionScheduler_StoreSchema::DEFAULT_DATE; } } try { $action = $this->make_action_from_db_record( $data ); } catch ( ActionScheduler_InvalidActionException $exception ) { do_action( 'action_scheduler_failed_fetch_action', $action_id, $exception ); return $this->get_null_action(); } return $action; } /** * Create a null action. * * @return ActionScheduler_NullAction */ protected function get_null_action() { return new ActionScheduler_NullAction(); } /** * Create an action from a database record. * * @param object $data Action database record. * * @return ActionScheduler_Action|ActionScheduler_CanceledAction|ActionScheduler_FinishedAction */ protected function make_action_from_db_record( $data ) { $hook = $data->hook; $args = json_decode( $data->args, true ); $schedule = unserialize( $data->schedule ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize $this->validate_args( $args, $data->action_id ); $this->validate_schedule( $schedule, $data->action_id ); if ( empty( $schedule ) ) { $schedule = new ActionScheduler_NullSchedule(); } $group = $data->group ? $data->group : ''; return ActionScheduler::factory()->get_stored_action( $data->status, $data->hook, $args, $schedule, $group, $data->priority ); } /** * Returns the SQL statement to query (or count) actions. * * @since 3.3.0 $query['status'] accepts array of statuses instead of a single status. * * @param array $query Filtering options. * @param string $select_or_count Whether the SQL should select and return the IDs or just the row count. * * @return string SQL statement already properly escaped. * @throws \InvalidArgumentException If the query is invalid. * @throws \RuntimeException When "unknown partial args matching value". */ protected function get_query_actions_sql( array $query, $select_or_count = 'select' ) { if ( ! in_array( $select_or_count, array( 'select', 'count' ), true ) ) { throw new InvalidArgumentException( __( 'Invalid value for select or count parameter. Cannot query actions.', 'woocommerce' ) ); } $query = wp_parse_args( $query, array( 'hook' => '', 'args' => null, 'partial_args_matching' => 'off', // can be 'like' or 'json'. 'date' => null, 'date_compare' => '<=', 'modified' => null, 'modified_compare' => '<=', 'group' => '', 'status' => '', 'claimed' => null, 'per_page' => 5, 'offset' => 0, 'orderby' => 'date', 'order' => 'ASC', ) ); /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $db_server_info = is_callable( array( $wpdb, 'db_server_info' ) ) ? $wpdb->db_server_info() : $wpdb->db_version(); if ( false !== strpos( $db_server_info, 'MariaDB' ) ) { $supports_json = version_compare( PHP_VERSION_ID >= 80016 ? $wpdb->db_version() : preg_replace( '/[^0-9.].*/', '', str_replace( '5.5.5-', '', $db_server_info ) ), '10.2', '>=' ); } else { $supports_json = version_compare( $wpdb->db_version(), '5.7', '>=' ); } $sql = ( 'count' === $select_or_count ) ? 'SELECT count(a.action_id)' : 'SELECT a.action_id'; $sql .= " FROM {$wpdb->actionscheduler_actions} a"; $sql_params = array(); if ( ! empty( $query['group'] ) || 'group' === $query['orderby'] ) { $sql .= " LEFT JOIN {$wpdb->actionscheduler_groups} g ON g.group_id=a.group_id"; } $sql .= ' WHERE 1=1'; if ( ! empty( $query['group'] ) ) { $sql .= ' AND g.slug=%s'; $sql_params[] = $query['group']; } if ( ! empty( $query['hook'] ) ) { $sql .= ' AND a.hook=%s'; $sql_params[] = $query['hook']; } if ( ! is_null( $query['args'] ) ) { switch ( $query['partial_args_matching'] ) { case 'json': if ( ! $supports_json ) { throw new \RuntimeException( __( 'JSON partial matching not supported in your environment. Please check your MySQL/MariaDB version.', 'woocommerce' ) ); } $supported_types = array( 'integer' => '%d', 'boolean' => '%s', 'double' => '%f', 'string' => '%s', ); foreach ( $query['args'] as $key => $value ) { $value_type = gettype( $value ); if ( 'boolean' === $value_type ) { $value = $value ? 'true' : 'false'; } $placeholder = isset( $supported_types[ $value_type ] ) ? $supported_types[ $value_type ] : false; if ( ! $placeholder ) { throw new \RuntimeException( sprintf( /* translators: %s: provided value type */ __( 'The value type for the JSON partial matching is not supported. Must be either integer, boolean, double or string. %s type provided.', 'woocommerce' ), $value_type ) ); } $sql .= ' AND JSON_EXTRACT(a.args, %s)=' . $placeholder; $sql_params[] = '$.' . $key; $sql_params[] = $value; } break; case 'like': foreach ( $query['args'] as $key => $value ) { $sql .= ' AND a.args LIKE %s'; $json_partial = $wpdb->esc_like( trim( wp_json_encode( array( $key => $value ) ), '{}' ) ); $sql_params[] = "%{$json_partial}%"; } break; case 'off': $sql .= ' AND a.args=%s'; $sql_params[] = $this->get_args_for_query( $query['args'] ); break; default: throw new \RuntimeException( __( 'Unknown partial args matching value.', 'woocommerce' ) ); } } if ( $query['status'] ) { $statuses = (array) $query['status']; $placeholders = array_fill( 0, count( $statuses ), '%s' ); $sql .= ' AND a.status IN (' . join( ', ', $placeholders ) . ')'; $sql_params = array_merge( $sql_params, array_values( $statuses ) ); } if ( $query['date'] instanceof \DateTime ) { $date = clone $query['date']; $date->setTimezone( new \DateTimeZone( 'UTC' ) ); $date_string = $date->format( 'Y-m-d H:i:s' ); $comparator = $this->validate_sql_comparator( $query['date_compare'] ); $sql .= " AND a.scheduled_date_gmt $comparator %s"; $sql_params[] = $date_string; } if ( $query['modified'] instanceof \DateTime ) { $modified = clone $query['modified']; $modified->setTimezone( new \DateTimeZone( 'UTC' ) ); $date_string = $modified->format( 'Y-m-d H:i:s' ); $comparator = $this->validate_sql_comparator( $query['modified_compare'] ); $sql .= " AND a.last_attempt_gmt $comparator %s"; $sql_params[] = $date_string; } if ( true === $query['claimed'] ) { $sql .= ' AND a.claim_id != 0'; } elseif ( false === $query['claimed'] ) { $sql .= ' AND a.claim_id = 0'; } elseif ( ! is_null( $query['claimed'] ) ) { $sql .= ' AND a.claim_id = %d'; $sql_params[] = $query['claimed']; } if ( ! empty( $query['search'] ) ) { $sql .= ' AND (a.hook LIKE %s OR (a.extended_args IS NULL AND a.args LIKE %s) OR a.extended_args LIKE %s'; for ( $i = 0; $i < 3; $i++ ) { $sql_params[] = sprintf( '%%%s%%', $query['search'] ); } $search_claim_id = (int) $query['search']; if ( $search_claim_id ) { $sql .= ' OR a.claim_id = %d'; $sql_params[] = $search_claim_id; } $sql .= ')'; } if ( 'select' === $select_or_count ) { if ( 'ASC' === strtoupper( $query['order'] ) ) { $order = 'ASC'; } else { $order = 'DESC'; } switch ( $query['orderby'] ) { case 'hook': $sql .= " ORDER BY a.hook $order"; break; case 'group': $sql .= " ORDER BY g.slug $order"; break; case 'modified': $sql .= " ORDER BY a.last_attempt_gmt $order"; break; case 'none': break; case 'action_id': $sql .= " ORDER BY a.action_id $order"; break; case 'date': default: $sql .= " ORDER BY a.scheduled_date_gmt $order"; break; } if ( $query['per_page'] > 0 ) { $sql .= ' LIMIT %d, %d'; $sql_params[] = $query['offset']; $sql_params[] = $query['per_page']; } } if ( ! empty( $sql_params ) ) { $sql = $wpdb->prepare( $sql, $sql_params ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared } return $sql; } /** * Query for action count or list of action IDs. * * @since 3.3.0 $query['status'] accepts array of statuses instead of a single status. * * @see ActionScheduler_Store::query_actions for $query arg usage. * * @param array $query Query filtering options. * @param string $query_type Whether to select or count the results. Defaults to select. * * @return string|array|null The IDs of actions matching the query. Null on failure. */ public function query_actions( $query = array(), $query_type = 'select' ) { /** * Global. * * @var wpdb $wpdb */ global $wpdb; $sql = $this->get_query_actions_sql( $query, $query_type ); return ( 'count' === $query_type ) ? $wpdb->get_var( $sql ) : $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.NoSql, WordPress.DB.DirectDatabaseQuery.NoCaching } /** * Get a count of all actions in the store, grouped by status. * * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status. */ public function action_counts() { global $wpdb; $sql = "SELECT a.status, count(a.status) as 'count'"; $sql .= " FROM {$wpdb->actionscheduler_actions} a"; $sql .= ' GROUP BY a.status'; $actions_count_by_status = array(); $action_stati_and_labels = $this->get_status_labels(); foreach ( $wpdb->get_results( $sql ) as $action_data ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared // Ignore any actions with invalid status. if ( array_key_exists( $action_data->status, $action_stati_and_labels ) ) { $actions_count_by_status[ $action_data->status ] = $action_data->count; } } return $actions_count_by_status; } /** * Cancel an action. * * @param int $action_id Action ID. * * @return void * @throws \InvalidArgumentException If the action update failed. */ public function cancel_action( $action_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $updated = $wpdb->update( $wpdb->actionscheduler_actions, array( 'status' => self::STATUS_CANCELED ), array( 'action_id' => $action_id ), array( '%s' ), array( '%d' ) ); if ( false === $updated ) { /* translators: %s: action ID */ throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s: we were unable to cancel this action. It may may have been deleted by another process.', 'woocommerce' ), $action_id ) ); } do_action( 'action_scheduler_canceled_action', $action_id ); } /** * Cancel pending actions by hook. * * @since 3.0.0 * * @param string $hook Hook name. * * @return void */ public function cancel_actions_by_hook( $hook ) { $this->bulk_cancel_actions( array( 'hook' => $hook ) ); } /** * Cancel pending actions by group. * * @param string $group Group slug. * * @return void */ public function cancel_actions_by_group( $group ) { $this->bulk_cancel_actions( array( 'group' => $group ) ); } /** * Bulk cancel actions. * * @since 3.0.0 * * @param array $query_args Query parameters. */ protected function bulk_cancel_actions( $query_args ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; if ( ! is_array( $query_args ) ) { return; } // Don't cancel actions that are already canceled. if ( isset( $query_args['status'] ) && self::STATUS_CANCELED === $query_args['status'] ) { return; } $action_ids = true; $query_args = wp_parse_args( $query_args, array( 'per_page' => 1000, 'status' => self::STATUS_PENDING, 'orderby' => 'none', ) ); while ( $action_ids ) { $action_ids = $this->query_actions( $query_args ); if ( empty( $action_ids ) ) { break; } $format = array_fill( 0, count( $action_ids ), '%d' ); $query_in = '(' . implode( ',', $format ) . ')'; $parameters = $action_ids; array_unshift( $parameters, self::STATUS_CANCELED ); $wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->actionscheduler_actions} SET status = %s WHERE action_id IN {$query_in}", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared $parameters ) ); do_action( 'action_scheduler_bulk_cancel_actions', $action_ids ); } } /** * Delete an action. * * @param int $action_id Action ID. * @throws \InvalidArgumentException If the action deletion failed. */ public function delete_action( $action_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $deleted = $wpdb->delete( $wpdb->actionscheduler_actions, array( 'action_id' => $action_id ), array( '%d' ) ); if ( empty( $deleted ) ) { /* translators: %s is the action ID */ throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s: we were unable to delete this action. It may may have been deleted by another process.', 'woocommerce' ), $action_id ) ); } do_action( 'action_scheduler_deleted_action', $action_id ); } /** * Get the schedule date for an action. * * @param string $action_id Action ID. * * @return \DateTime The local date the action is scheduled to run, or the date that it ran. */ public function get_date( $action_id ) { $date = $this->get_date_gmt( $action_id ); ActionScheduler_TimezoneHelper::set_local_timezone( $date ); return $date; } /** * Get the GMT schedule date for an action. * * @param int $action_id Action ID. * * @throws \InvalidArgumentException If action cannot be identified. * @return \DateTime The GMT date the action is scheduled to run, or the date that it ran. */ protected function get_date_gmt( $action_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $record = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d", $action_id ) ); if ( empty( $record ) ) { /* translators: %s is the action ID */ throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s: we were unable to determine the date of this action. It may may have been deleted by another process.', 'woocommerce' ), $action_id ) ); } if ( self::STATUS_PENDING === $record->status ) { return as_get_datetime_object( $record->scheduled_date_gmt ); } else { return as_get_datetime_object( $record->last_attempt_gmt ); } } /** * Stake a claim on actions. * * @param int $max_actions Maximum number of action to include in claim. * @param DateTime|null $before_date Jobs must be schedule before this date. Defaults to now. * @param array $hooks Hooks to filter for. * @param string $group Group to filter for. * * @return ActionScheduler_ActionClaim */ public function stake_claim( $max_actions = 10, ?DateTime $before_date = null, $hooks = array(), $group = '' ) { $claim_id = $this->generate_claim_id(); $this->claim_before_date = $before_date; $this->claim_actions( $claim_id, $max_actions, $before_date, $hooks, $group ); $action_ids = $this->find_actions_by_claim_id( $claim_id ); $this->claim_before_date = null; return new ActionScheduler_ActionClaim( $claim_id, $action_ids ); } /** * Generate a new action claim. * * @return int Claim ID. */ protected function generate_claim_id() { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $now = as_get_datetime_object(); $wpdb->insert( $wpdb->actionscheduler_claims, array( 'date_created_gmt' => $now->format( 'Y-m-d H:i:s' ) ) ); return $wpdb->insert_id; } /** * Set a claim filter. * * @param string $filter_name Claim filter name. * @param mixed $filter_values Values to filter. * @return void */ public function set_claim_filter( $filter_name, $filter_values ) { if ( isset( $this->claim_filters[ $filter_name ] ) ) { $this->claim_filters[ $filter_name ] = $filter_values; } } /** * Get the claim filter value. * * @param string $filter_name Claim filter name. * @return mixed */ public function get_claim_filter( $filter_name ) { if ( isset( $this->claim_filters[ $filter_name ] ) ) { return $this->claim_filters[ $filter_name ]; } return ''; } /** * Mark actions claimed. * * @param string $claim_id Claim Id. * @param int $limit Number of action to include in claim. * @param DateTime|null $before_date Should use UTC timezone. * @param array $hooks Hooks to filter for. * @param string $group Group to filter for. * * @return int The number of actions that were claimed. * @throws \InvalidArgumentException Throws InvalidArgumentException if group doesn't exist. * @throws \RuntimeException Throws RuntimeException if unable to claim action. */ protected function claim_actions( $claim_id, $limit, ?DateTime $before_date = null, $hooks = array(), $group = '' ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $now = as_get_datetime_object(); $date = is_null( $before_date ) ? $now : clone $before_date; // Set claim filters. if ( ! empty( $hooks ) ) { $this->set_claim_filter( 'hooks', $hooks ); } else { $hooks = $this->get_claim_filter( 'hooks' ); } if ( ! empty( $group ) ) { $this->set_claim_filter( 'group', $group ); } else { $group = $this->get_claim_filter( 'group' ); } $where = 'WHERE claim_id = 0 AND scheduled_date_gmt <= %s AND status=%s'; $where_params = array( $date->format( 'Y-m-d H:i:s' ), self::STATUS_PENDING, ); if ( ! empty( $hooks ) ) { $placeholders = array_fill( 0, count( $hooks ), '%s' ); $where .= ' AND hook IN (' . join( ', ', $placeholders ) . ')'; $where_params = array_merge( $where_params, array_values( $hooks ) ); } $group_operator = 'IN'; if ( empty( $group ) ) { $group = $this->get_claim_filter( 'exclude-groups' ); $group_operator = 'NOT IN'; } if ( ! empty( $group ) ) { $group_ids = $this->get_group_ids( $group, false ); // throw exception if no matching group(s) found, this matches ActionScheduler_wpPostStore's behaviour. if ( empty( $group_ids ) ) { throw new InvalidArgumentException( sprintf( /* translators: %s: group name(s) */ _n( 'The group "%s" does not exist.', 'The groups "%s" do not exist.', is_array( $group ) ? count( $group ) : 1, 'woocommerce' ), $group ) ); } $id_list = implode( ',', array_map( 'intval', $group_ids ) ); $where .= " AND group_id {$group_operator} ( $id_list )"; } /** * Sets the order-by clause used in the action claim query. * * @param string $order_by_sql * @param string $claim_id Claim Id. * @param array $hooks Hooks to filter for. * * @since 3.8.3 Made $claim_id and $hooks available. * @since 3.4.0 */ $order = apply_filters( 'action_scheduler_claim_actions_order_by', 'ORDER BY priority ASC, attempts ASC, scheduled_date_gmt ASC, action_id ASC', $claim_id, $hooks ); $skip_locked = $this->db_supports_skip_locked() ? ' SKIP LOCKED' : ''; // Selecting the action_ids that we plan to claim, while skipping any locked rows to avoid deadlocking. $select_sql = $wpdb->prepare( "SELECT action_id from {$wpdb->actionscheduler_actions} {$where} {$order} LIMIT %d FOR UPDATE{$skip_locked}", array_merge( $where_params, array( $limit ) ) ); // Now place it into an UPDATE statement by joining the result sets, allowing for the SKIP LOCKED behavior to take effect. $update_sql = "UPDATE {$wpdb->actionscheduler_actions} t1 JOIN ( $select_sql ) t2 ON t1.action_id = t2.action_id SET claim_id=%d, last_attempt_gmt=%s, last_attempt_local=%s"; $update_params = array( $claim_id, $now->format( 'Y-m-d H:i:s' ), current_time( 'mysql' ), ); $rows_affected = $wpdb->query( $wpdb->prepare( $update_sql, $update_params ) ); if ( false === $rows_affected ) { $error = empty( $wpdb->last_error ) ? _x( 'unknown', 'database error', 'woocommerce' ) : $wpdb->last_error; throw new \RuntimeException( sprintf( /* translators: %s database error. */ __( 'Unable to claim actions. Database error: %s.', 'woocommerce' ), $error ) ); } return (int) $rows_affected; } /** * Determines whether the database supports using SKIP LOCKED. This logic mimicks the $wpdb::has_cap() logic. * * SKIP_LOCKED support was added to MariaDB in 10.6.0 and to MySQL in 8.0.1 * * @return bool */ private function db_supports_skip_locked() { global $wpdb; $db_version = $wpdb->db_version(); $db_server_info = $wpdb->db_server_info(); $is_mariadb = ( false !== strpos( $db_server_info, 'MariaDB' ) ); if ( $is_mariadb && '5.5.5' === $db_version && PHP_VERSION_ID < 80016 // PHP 8.0.15 or older. ) { /* * Account for MariaDB version being prefixed with '5.5.5-' on older PHP versions. */ $db_server_info = preg_replace( '/^5\.5\.5-(.*)/', '$1', $db_server_info ); $db_version = preg_replace( '/[^0-9.].*/', '', $db_server_info ); } $is_supported = ( $is_mariadb && version_compare( $db_version, '10.6.0', '>=' ) ) || ( ! $is_mariadb && version_compare( $db_version, '8.0.1', '>=' ) ); /** * Filter whether the database supports the SKIP LOCKED modifier for queries. * * @param bool $is_supported Whether SKIP LOCKED is supported. * * @since 3.9.3 */ return apply_filters( 'action_scheduler_db_supports_skip_locked', $is_supported ); } /** * Get the number of active claims. * * @return int */ public function get_claim_count() { global $wpdb; $sql = "SELECT COUNT(DISTINCT claim_id) FROM {$wpdb->actionscheduler_actions} WHERE claim_id != 0 AND status IN ( %s, %s)"; $sql = $wpdb->prepare( $sql, array( self::STATUS_PENDING, self::STATUS_RUNNING ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared return (int) $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared } /** * Return an action's claim ID, as stored in the claim_id column. * * @param string $action_id Action ID. * @return mixed */ public function get_claim_id( $action_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $sql = "SELECT claim_id FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d"; $sql = $wpdb->prepare( $sql, $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared return (int) $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared } /** * Retrieve the action IDs of action in a claim. * * @param int $claim_id Claim ID. * @return int[] */ public function find_actions_by_claim_id( $claim_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $action_ids = array(); $before_date = isset( $this->claim_before_date ) ? $this->claim_before_date : as_get_datetime_object(); $cut_off = $before_date->format( 'Y-m-d H:i:s' ); $sql = $wpdb->prepare( "SELECT action_id, scheduled_date_gmt FROM {$wpdb->actionscheduler_actions} WHERE claim_id = %d ORDER BY priority ASC, attempts ASC, scheduled_date_gmt ASC, action_id ASC", $claim_id ); // Verify that the scheduled date for each action is within the expected bounds (in some unusual // cases, we cannot depend on MySQL to honor all of the WHERE conditions we specify). foreach ( $wpdb->get_results( $sql ) as $claimed_action ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared if ( $claimed_action->scheduled_date_gmt <= $cut_off ) { $action_ids[] = absint( $claimed_action->action_id ); } } return $action_ids; } /** * Release pending actions from a claim and delete the claim. * * @param ActionScheduler_ActionClaim $claim Claim object. * @throws \RuntimeException When unable to release actions from claim. */ public function release_claim( ActionScheduler_ActionClaim $claim ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; if ( 0 === intval( $claim->get_id() ) ) { // Verify that the claim_id is valid before attempting to release it. return; } /** * Deadlock warning: This function modifies actions to release them from claims that have been processed. Earlier, we used to it in a atomic query, i.e. we would update all actions belonging to a particular claim_id with claim_id = 0. * While this was functionally correct, it would cause deadlock, since this update query will hold a lock on the claim_id_.. index on the action table. * This allowed the possibility of a race condition, where the claimer query is also running at the same time, then the claimer query will also try to acquire a lock on the claim_id_.. index, and in this case if claim release query has already progressed to the point of acquiring the lock, but have not updated yet, it would cause a deadlock. * * We resolve this by getting all the actions_id that we want to release claim from in a separate query, and then releasing the claim on each of them. This way, our lock is acquired on the action_id index instead of the claim_id index. Note that the lock on claim_id will still be acquired, but it will only when we actually make the update, rather than when we select the actions. * * We only release pending actions in order for them to be claimed by another process. */ $action_ids = $wpdb->get_col( $wpdb->prepare( "SELECT action_id FROM {$wpdb->actionscheduler_actions} WHERE claim_id = %d AND status = %s", $claim->get_id(), self::STATUS_PENDING ) ); $row_updates = 0; if ( count( $action_ids ) > 0 ) { $action_id_string = implode( ',', array_map( 'absint', $action_ids ) ); $row_updates = $wpdb->query( "UPDATE {$wpdb->actionscheduler_actions} SET claim_id = 0 WHERE action_id IN ({$action_id_string})" ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared } $wpdb->delete( $wpdb->actionscheduler_claims, array( 'claim_id' => $claim->get_id() ), array( '%d' ) ); if ( $row_updates < count( $action_ids ) ) { throw new RuntimeException( sprintf( // translators: %d is an id. __( 'Unable to release actions from claim id %d.', 'woocommerce' ), $claim->get_id() ) ); } } /** * Remove the claim from an action. * * @param int $action_id Action ID. * * @return void */ public function unclaim_action( $action_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $wpdb->update( $wpdb->actionscheduler_actions, array( 'claim_id' => 0 ), array( 'action_id' => $action_id ), array( '%s' ), array( '%d' ) ); } /** * Mark an action as failed. * * @param int $action_id Action ID. * @throws \InvalidArgumentException Throw an exception if action was not updated. */ public function mark_failure( $action_id ) { /** * Global. * @var \wpdb $wpdb */ global $wpdb; $updated = $wpdb->update( $wpdb->actionscheduler_actions, array( 'status' => self::STATUS_FAILED ), array( 'action_id' => $action_id ), array( '%s' ), array( '%d' ) ); if ( empty( $updated ) ) { /* translators: %s is the action ID */ throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s: we were unable to mark this action as having failed. It may may have been deleted by another process.', 'woocommerce' ), $action_id ) ); } } /** * Add execution message to action log. * * @throws Exception If the action status cannot be updated to self::STATUS_RUNNING ('in-progress'). * * @param int $action_id Action ID. * * @return void */ public function log_execution( $action_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $sql = "UPDATE {$wpdb->actionscheduler_actions} SET attempts = attempts+1, status=%s, last_attempt_gmt = %s, last_attempt_local = %s WHERE action_id = %d"; $sql = $wpdb->prepare( $sql, self::STATUS_RUNNING, current_time( 'mysql', true ), current_time( 'mysql' ), $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared $status_updated = $wpdb->query( $sql ); if ( ! $status_updated ) { throw new Exception( sprintf( /* translators: 1: action ID. 2: status slug. */ __( 'Unable to update the status of action %1$d to %2$s.', 'woocommerce' ), $action_id, self::STATUS_RUNNING ) ); } } /** * Mark an action as complete. * * @param int $action_id Action ID. * * @return void * @throws \InvalidArgumentException Throw an exception if action was not updated. */ public function mark_complete( $action_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $updated = $wpdb->update( $wpdb->actionscheduler_actions, array( 'status' => self::STATUS_COMPLETE, 'last_attempt_gmt' => current_time( 'mysql', true ), 'last_attempt_local' => current_time( 'mysql' ), ), array( 'action_id' => $action_id ), array( '%s' ), array( '%d' ) ); if ( empty( $updated ) ) { /* translators: %s is the action ID */ throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s: we were unable to mark this action as having completed. It may may have been deleted by another process.', 'woocommerce' ), $action_id ) ); } /** * Fires after a scheduled action has been completed. * * @since 3.4.2 * * @param int $action_id Action ID. */ do_action( 'action_scheduler_completed_action', $action_id ); } /** * Get an action's status. * * @param int $action_id Action ID. * * @return string * @throws \InvalidArgumentException Throw an exception if not status was found for action_id. * @throws \RuntimeException Throw an exception if action status could not be retrieved. */ public function get_status( $action_id ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $sql = "SELECT status FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d"; $sql = $wpdb->prepare( $sql, $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared $status = $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared if ( is_null( $status ) ) { throw new \InvalidArgumentException( __( 'Invalid action ID. No status found.', 'woocommerce' ) ); } elseif ( empty( $status ) ) { throw new \RuntimeException( __( 'Unknown status found for action.', 'woocommerce' ) ); } else { return $status; } } } action-scheduler/classes/data-stores/ActionScheduler_wpPostStore_PostStatusRegistrar.php 0000777 00000003456 15252010675 0026154 0 ustar 00 <?php /** * Class ActionScheduler_wpPostStore_PostStatusRegistrar * * @codeCoverageIgnore */ class ActionScheduler_wpPostStore_PostStatusRegistrar { /** * Registrar. */ public function register() { register_post_status( ActionScheduler_Store::STATUS_RUNNING, array_merge( $this->post_status_args(), $this->post_status_running_labels() ) ); register_post_status( ActionScheduler_Store::STATUS_FAILED, array_merge( $this->post_status_args(), $this->post_status_failed_labels() ) ); } /** * Build the args array for the post type definition * * @return array */ protected function post_status_args() { $args = array( 'public' => false, 'exclude_from_search' => false, 'show_in_admin_all_list' => true, 'show_in_admin_status_list' => true, ); return apply_filters( 'action_scheduler_post_status_args', $args ); } /** * Build the args array for the post type definition * * @return array */ protected function post_status_failed_labels() { $labels = array( 'label' => _x( 'Failed', 'post', 'woocommerce' ), /* translators: %s: count */ 'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'woocommerce' ), ); return apply_filters( 'action_scheduler_post_status_failed_labels', $labels ); } /** * Build the args array for the post type definition * * @return array */ protected function post_status_running_labels() { $labels = array( 'label' => _x( 'In-Progress', 'post', 'woocommerce' ), /* translators: %s: count */ 'label_count' => _n_noop( 'In-Progress <span class="count">(%s)</span>', 'In-Progress <span class="count">(%s)</span>', 'woocommerce' ), ); return apply_filters( 'action_scheduler_post_status_running_labels', $labels ); } } action-scheduler/classes/data-stores/ActionScheduler_wpPostStore_TaxonomyRegistrar.php 0000777 00000001365 15252010675 0025636 0 ustar 00 <?php /** * Class ActionScheduler_wpPostStore_TaxonomyRegistrar * * @codeCoverageIgnore */ class ActionScheduler_wpPostStore_TaxonomyRegistrar { /** * Registrar. */ public function register() { register_taxonomy( ActionScheduler_wpPostStore::GROUP_TAXONOMY, ActionScheduler_wpPostStore::POST_TYPE, $this->taxonomy_args() ); } /** * Get taxonomy arguments. */ protected function taxonomy_args() { $args = array( 'label' => __( 'Action Group', 'woocommerce' ), 'public' => false, 'hierarchical' => false, 'show_admin_column' => true, 'query_var' => false, 'rewrite' => false, ); $args = apply_filters( 'action_scheduler_taxonomy_args', $args ); return $args; } } action-scheduler/classes/data-stores/ActionScheduler_wpPostStore_PostTypeRegistrar.php 0000777 00000003576 15252010675 0025615 0 ustar 00 <?php /** * Class ActionScheduler_wpPostStore_PostTypeRegistrar * * @codeCoverageIgnore */ class ActionScheduler_wpPostStore_PostTypeRegistrar { /** * Registrar. */ public function register() { register_post_type( ActionScheduler_wpPostStore::POST_TYPE, $this->post_type_args() ); } /** * Build the args array for the post type definition * * @return array */ protected function post_type_args() { $args = array( 'label' => __( 'Scheduled Actions', 'woocommerce' ), 'description' => __( 'Scheduled actions are hooks triggered on a certain date and time.', 'woocommerce' ), 'public' => false, 'map_meta_cap' => true, 'hierarchical' => false, 'supports' => array( 'title', 'editor', 'comments' ), 'rewrite' => false, 'query_var' => false, 'can_export' => true, 'ep_mask' => EP_NONE, 'labels' => array( 'name' => __( 'Scheduled Actions', 'woocommerce' ), 'singular_name' => __( 'Scheduled Action', 'woocommerce' ), 'menu_name' => _x( 'Scheduled Actions', 'Admin menu name', 'woocommerce' ), 'add_new' => __( 'Add', 'woocommerce' ), 'add_new_item' => __( 'Add New Scheduled Action', 'woocommerce' ), 'edit' => __( 'Edit', 'woocommerce' ), 'edit_item' => __( 'Edit Scheduled Action', 'woocommerce' ), 'new_item' => __( 'New Scheduled Action', 'woocommerce' ), 'view' => __( 'View Action', 'woocommerce' ), 'view_item' => __( 'View Action', 'woocommerce' ), 'search_items' => __( 'Search Scheduled Actions', 'woocommerce' ), 'not_found' => __( 'No actions found', 'woocommerce' ), 'not_found_in_trash' => __( 'No actions found in trash', 'woocommerce' ), ), ); $args = apply_filters( 'action_scheduler_post_type_args', $args ); return $args; } } action-scheduler/classes/data-stores/ActionScheduler_DBLogger.php 0000777 00000010613 15252010675 0021165 0 ustar 00 <?php /** * Class ActionScheduler_DBLogger * * Action logs data table data store. * * @since 3.0.0 */ class ActionScheduler_DBLogger extends ActionScheduler_Logger { /** * Add a record to an action log. * * @param int $action_id Action ID. * @param string $message Message to be saved in the log entry. * @param DateTime|null $date Timestamp of the log entry. * * @return int The log entry ID. */ public function log( $action_id, $message, ?DateTime $date = null ) { if ( empty( $date ) ) { $date = as_get_datetime_object(); } else { $date = clone $date; } $date_gmt = $date->format( 'Y-m-d H:i:s' ); ActionScheduler_TimezoneHelper::set_local_timezone( $date ); $date_local = $date->format( 'Y-m-d H:i:s' ); /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort global $wpdb; $wpdb->insert( $wpdb->actionscheduler_logs, array( 'action_id' => $action_id, 'message' => $message, 'log_date_gmt' => $date_gmt, 'log_date_local' => $date_local, ), array( '%d', '%s', '%s', '%s' ) ); return $wpdb->insert_id; } /** * Retrieve an action log entry. * * @param int $entry_id Log entry ID. * * @return ActionScheduler_LogEntry */ public function get_entry( $entry_id ) { /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort global $wpdb; $entry = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE log_id=%d", $entry_id ) ); return $this->create_entry_from_db_record( $entry ); } /** * Create an action log entry from a database record. * * @param object $record Log entry database record object. * * @return ActionScheduler_LogEntry */ private function create_entry_from_db_record( $record ) { if ( empty( $record ) ) { return new ActionScheduler_NullLogEntry(); } if ( is_null( $record->log_date_gmt ) ) { $date = as_get_datetime_object( ActionScheduler_StoreSchema::DEFAULT_DATE ); } else { $date = as_get_datetime_object( $record->log_date_gmt ); } return new ActionScheduler_LogEntry( $record->action_id, $record->message, $date ); } /** * Retrieve an action's log entries from the database. * * @param int $action_id Action ID. * * @return ActionScheduler_LogEntry[] */ public function get_logs( $action_id ) { /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort global $wpdb; $records = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE action_id=%d", $action_id ) ); return array_map( array( $this, 'create_entry_from_db_record' ), $records ); } /** * Initialize the data store. * * @codeCoverageIgnore */ public function init() { $table_maker = new ActionScheduler_LoggerSchema(); $table_maker->init(); $table_maker->register_tables(); parent::init(); add_action( 'action_scheduler_deleted_action', array( $this, 'clear_deleted_action_logs' ), 10, 1 ); } /** * Delete the action logs for an action. * * @param int $action_id Action ID. */ public function clear_deleted_action_logs( $action_id ) { /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort global $wpdb; $wpdb->delete( $wpdb->actionscheduler_logs, array( 'action_id' => $action_id ), array( '%d' ) ); } /** * Bulk add cancel action log entries. * * @param array $action_ids List of action ID. */ public function bulk_log_cancel_actions( $action_ids ) { if ( empty( $action_ids ) ) { return; } /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort global $wpdb; $date = as_get_datetime_object(); $date_gmt = $date->format( 'Y-m-d H:i:s' ); ActionScheduler_TimezoneHelper::set_local_timezone( $date ); $date_local = $date->format( 'Y-m-d H:i:s' ); $message = __( 'action canceled', 'woocommerce' ); $format = '(%d, ' . $wpdb->prepare( '%s, %s, %s', $message, $date_gmt, $date_local ) . ')'; $sql_query = "INSERT {$wpdb->actionscheduler_logs} (action_id, message, log_date_gmt, log_date_local) VALUES "; $value_rows = array(); foreach ( $action_ids as $action_id ) { $value_rows[] = $wpdb->prepare( $format, $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared } $sql_query .= implode( ',', $value_rows ); $wpdb->query( $sql_query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared } } action-scheduler/classes/data-stores/ActionScheduler_wpPostStore.php 0000777 00000107300 15252010675 0022051 0 ustar 00 <?php /** * Class ActionScheduler_wpPostStore */ class ActionScheduler_wpPostStore extends ActionScheduler_Store { const POST_TYPE = 'scheduled-action'; const GROUP_TAXONOMY = 'action-group'; const SCHEDULE_META_KEY = '_action_manager_schedule'; const DEPENDENCIES_MET = 'as-post-store-dependencies-met'; /** * Used to share information about the before_date property of claims internally. * * This is used in preference to passing the same information as a method param * for backwards-compatibility reasons. * * @var DateTime|null */ private $claim_before_date = null; /** * Local Timezone. * * @var DateTimeZone */ protected $local_timezone = null; /** * Save action. * * @param ActionScheduler_Action $action Scheduled Action. * @param DateTime|null $scheduled_date Scheduled Date. * * @throws RuntimeException Throws an exception if the action could not be saved. * @return int */ public function save_action( ActionScheduler_Action $action, ?DateTime $scheduled_date = null ) { try { $this->validate_action( $action ); $post_array = $this->create_post_array( $action, $scheduled_date ); $post_id = $this->save_post_array( $post_array ); $this->save_post_schedule( $post_id, $action->get_schedule() ); $this->save_action_group( $post_id, $action->get_group() ); do_action( 'action_scheduler_stored_action', $post_id ); return $post_id; } catch ( Exception $e ) { /* translators: %s: action error message */ throw new RuntimeException( sprintf( __( 'Error saving action: %s', 'woocommerce' ), $e->getMessage() ), 0 ); } } /** * Create post array. * * @param ActionScheduler_Action $action Scheduled Action. * @param DateTime|null $scheduled_date Scheduled Date. * * @return array Returns an array of post data. */ protected function create_post_array( ActionScheduler_Action $action, ?DateTime $scheduled_date = null ) { $post = array( 'post_type' => self::POST_TYPE, 'post_title' => $action->get_hook(), 'post_content' => wp_json_encode( $action->get_args() ), 'post_status' => ( $action->is_finished() ? 'publish' : 'pending' ), 'post_date_gmt' => $this->get_scheduled_date_string( $action, $scheduled_date ), 'post_date' => $this->get_scheduled_date_string_local( $action, $scheduled_date ), ); return $post; } /** * Save post array. * * @param array $post_array Post array. * @return int Returns the post ID. * @throws RuntimeException Throws an exception if the action could not be saved. */ protected function save_post_array( $post_array ) { add_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10, 1 ); add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10, 5 ); $has_kses = false !== has_filter( 'content_save_pre', 'wp_filter_post_kses' ); if ( $has_kses ) { // Prevent KSES from corrupting JSON in post_content. kses_remove_filters(); } $post_id = wp_insert_post( $post_array ); if ( $has_kses ) { kses_init_filters(); } remove_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10 ); remove_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10 ); if ( is_wp_error( $post_id ) || empty( $post_id ) ) { throw new RuntimeException( __( 'Unable to save action.', 'woocommerce' ) ); } return $post_id; } /** * Filter insert post data. * * @param array $postdata Post data to filter. * * @return array */ public function filter_insert_post_data( $postdata ) { if ( self::POST_TYPE === $postdata['post_type'] ) { $postdata['post_author'] = 0; if ( 'future' === $postdata['post_status'] ) { $postdata['post_status'] = 'publish'; } } return $postdata; } /** * Create a (probably unique) post name for scheduled actions in a more performant manner than wp_unique_post_slug(). * * When an action's post status is transitioned to something other than 'draft', 'pending' or 'auto-draft, like 'publish' * or 'failed' or 'trash', WordPress will find a unique slug (stored in post_name column) using the wp_unique_post_slug() * function. This is done to ensure URL uniqueness. The approach taken by wp_unique_post_slug() is to iterate over existing * post_name values that match, and append a number 1 greater than the largest. This makes sense when manually creating a * post from the Edit Post screen. It becomes a bottleneck when automatically processing thousands of actions, with a * database containing thousands of related post_name values. * * WordPress 5.1 introduces the 'pre_wp_unique_post_slug' filter for plugins to address this issue. * * We can short-circuit WordPress's wp_unique_post_slug() approach using the 'pre_wp_unique_post_slug' filter. This * method is available to be used as a callback on that filter. It provides a more scalable approach to generating a * post_name/slug that is probably unique. Because Action Scheduler never actually uses the post_name field, or an * action's slug, being probably unique is good enough. * * For more backstory on this issue, see: * - https://github.com/woocommerce/action-scheduler/issues/44 and * - https://core.trac.wordpress.org/ticket/21112 * * @param string $override_slug Short-circuit return value. * @param string $slug The desired slug (post_name). * @param int $post_ID Post ID. * @param string $post_status The post status. * @param string $post_type Post type. * @return string */ public function set_unique_post_slug( $override_slug, $slug, $post_ID, $post_status, $post_type ) { if ( self::POST_TYPE === $post_type ) { $override_slug = uniqid( self::POST_TYPE . '-', true ) . '-' . wp_generate_password( 32, false ); } return $override_slug; } /** * Save post schedule. * * @param int $post_id Post ID of the scheduled action. * @param string $schedule Schedule to save. * * @return void */ protected function save_post_schedule( $post_id, $schedule ) { update_post_meta( $post_id, self::SCHEDULE_META_KEY, $schedule ); } /** * Save action group. * * @param int $post_id Post ID. * @param string $group Group to save. * @return void */ protected function save_action_group( $post_id, $group ) { if ( empty( $group ) ) { wp_set_object_terms( $post_id, array(), self::GROUP_TAXONOMY, false ); } else { wp_set_object_terms( $post_id, array( $group ), self::GROUP_TAXONOMY, false ); } } /** * Fetch actions. * * @param int $action_id Action ID. * @return object */ public function fetch_action( $action_id ) { $post = $this->get_post( $action_id ); if ( empty( $post ) || self::POST_TYPE !== $post->post_type ) { return $this->get_null_action(); } try { $action = $this->make_action_from_post( $post ); } catch ( ActionScheduler_InvalidActionException $exception ) { do_action( 'action_scheduler_failed_fetch_action', $post->ID, $exception ); return $this->get_null_action(); } return $action; } /** * Get post. * * @param string $action_id - Action ID. * @return WP_Post|null */ protected function get_post( $action_id ) { if ( empty( $action_id ) ) { return null; } return get_post( $action_id ); } /** * Get NULL action. * * @return ActionScheduler_NullAction */ protected function get_null_action() { return new ActionScheduler_NullAction(); } /** * Make action from post. * * @param WP_Post $post Post object. * @return WP_Post */ protected function make_action_from_post( $post ) { $hook = $post->post_title; $args = json_decode( $post->post_content, true ); $this->validate_args( $args, $post->ID ); $schedule = get_post_meta( $post->ID, self::SCHEDULE_META_KEY, true ); $this->validate_schedule( $schedule, $post->ID ); $group = wp_get_object_terms( $post->ID, self::GROUP_TAXONOMY, array( 'fields' => 'names' ) ); $group = empty( $group ) ? '' : reset( $group ); return ActionScheduler::factory()->get_stored_action( $this->get_action_status_by_post_status( $post->post_status ), $hook, $args, $schedule, $group ); } /** * Get action status by post status. * * @param string $post_status Post status. * * @throws InvalidArgumentException Throw InvalidArgumentException if $post_status not in known status fields returned by $this->get_status_labels(). * @return string */ protected function get_action_status_by_post_status( $post_status ) { switch ( $post_status ) { case 'publish': $action_status = self::STATUS_COMPLETE; break; case 'trash': $action_status = self::STATUS_CANCELED; break; default: if ( ! array_key_exists( $post_status, $this->get_status_labels() ) ) { throw new InvalidArgumentException( sprintf( 'Invalid post status: "%s". No matching action status available.', $post_status ) ); } $action_status = $post_status; break; } return $action_status; } /** * Get post status by action status. * * @param string $action_status Action status. * * @throws InvalidArgumentException Throws InvalidArgumentException if $post_status not in known status fields returned by $this->get_status_labels(). * @return string */ protected function get_post_status_by_action_status( $action_status ) { switch ( $action_status ) { case self::STATUS_COMPLETE: $post_status = 'publish'; break; case self::STATUS_CANCELED: $post_status = 'trash'; break; default: if ( ! array_key_exists( $action_status, $this->get_status_labels() ) ) { throw new InvalidArgumentException( sprintf( 'Invalid action status: "%s".', $action_status ) ); } $post_status = $action_status; break; } return $post_status; } /** * Returns the SQL statement to query (or count) actions. * * @param array $query - Filtering options. * @param string $select_or_count - Whether the SQL should select and return the IDs or just the row count. * * @throws InvalidArgumentException - Throw InvalidArgumentException if $select_or_count not count or select. * @return string SQL statement. The returned SQL is already properly escaped. */ protected function get_query_actions_sql( array $query, $select_or_count = 'select' ) { if ( ! in_array( $select_or_count, array( 'select', 'count' ), true ) ) { throw new InvalidArgumentException( __( 'Invalid schedule. Cannot save action.', 'woocommerce' ) ); } $query = wp_parse_args( $query, array( 'hook' => '', 'args' => null, 'date' => null, 'date_compare' => '<=', 'modified' => null, 'modified_compare' => '<=', 'group' => '', 'status' => '', 'claimed' => null, 'per_page' => 5, 'offset' => 0, 'orderby' => 'date', 'order' => 'ASC', 'search' => '', ) ); /** * Global wpdb object. * * @var wpdb $wpdb */ global $wpdb; $sql = ( 'count' === $select_or_count ) ? 'SELECT count(p.ID)' : 'SELECT p.ID '; $sql .= "FROM {$wpdb->posts} p"; $sql_params = array(); if ( empty( $query['group'] ) && 'group' === $query['orderby'] ) { $sql .= " LEFT JOIN {$wpdb->term_relationships} tr ON tr.object_id=p.ID"; $sql .= " LEFT JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id=tt.term_taxonomy_id"; $sql .= " LEFT JOIN {$wpdb->terms} t ON tt.term_id=t.term_id"; } elseif ( ! empty( $query['group'] ) ) { $sql .= " INNER JOIN {$wpdb->term_relationships} tr ON tr.object_id=p.ID"; $sql .= " INNER JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id=tt.term_taxonomy_id"; $sql .= " INNER JOIN {$wpdb->terms} t ON tt.term_id=t.term_id"; $sql .= ' AND t.slug=%s'; $sql_params[] = $query['group']; } $sql .= ' WHERE post_type=%s'; $sql_params[] = self::POST_TYPE; if ( $query['hook'] ) { $sql .= ' AND p.post_title=%s'; $sql_params[] = $query['hook']; } if ( ! is_null( $query['args'] ) ) { $sql .= ' AND p.post_content=%s'; $sql_params[] = wp_json_encode( $query['args'] ); } if ( $query['status'] ) { $post_statuses = array_map( array( $this, 'get_post_status_by_action_status' ), (array) $query['status'] ); $placeholders = array_fill( 0, count( $post_statuses ), '%s' ); $sql .= ' AND p.post_status IN (' . join( ', ', $placeholders ) . ')'; $sql_params = array_merge( $sql_params, array_values( $post_statuses ) ); } if ( $query['date'] instanceof DateTime ) { $date = clone $query['date']; $date->setTimezone( new DateTimeZone( 'UTC' ) ); $date_string = $date->format( 'Y-m-d H:i:s' ); $comparator = $this->validate_sql_comparator( $query['date_compare'] ); $sql .= " AND p.post_date_gmt $comparator %s"; $sql_params[] = $date_string; } if ( $query['modified'] instanceof DateTime ) { $modified = clone $query['modified']; $modified->setTimezone( new DateTimeZone( 'UTC' ) ); $date_string = $modified->format( 'Y-m-d H:i:s' ); $comparator = $this->validate_sql_comparator( $query['modified_compare'] ); $sql .= " AND p.post_modified_gmt $comparator %s"; $sql_params[] = $date_string; } if ( true === $query['claimed'] ) { $sql .= " AND p.post_password != ''"; } elseif ( false === $query['claimed'] ) { $sql .= " AND p.post_password = ''"; } elseif ( ! is_null( $query['claimed'] ) ) { $sql .= ' AND p.post_password = %s'; $sql_params[] = $query['claimed']; } if ( ! empty( $query['search'] ) ) { $sql .= ' AND (p.post_title LIKE %s OR p.post_content LIKE %s OR p.post_password LIKE %s)'; for ( $i = 0; $i < 3; $i++ ) { $sql_params[] = sprintf( '%%%s%%', $query['search'] ); } } if ( 'select' === $select_or_count ) { switch ( $query['orderby'] ) { case 'hook': $orderby = 'p.post_title'; break; case 'group': $orderby = 't.name'; break; case 'status': $orderby = 'p.post_status'; break; case 'modified': $orderby = 'p.post_modified'; break; case 'claim_id': $orderby = 'p.post_password'; break; case 'schedule': case 'date': default: $orderby = 'p.post_date_gmt'; break; } if ( 'ASC' === strtoupper( $query['order'] ) ) { $order = 'ASC'; } else { $order = 'DESC'; } $sql .= " ORDER BY $orderby $order"; if ( $query['per_page'] > 0 ) { $sql .= ' LIMIT %d, %d'; $sql_params[] = $query['offset']; $sql_params[] = $query['per_page']; } } return $wpdb->prepare( $sql, $sql_params ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared } /** * Query for action count or list of action IDs. * * @since 3.3.0 $query['status'] accepts array of statuses instead of a single status. * * @see ActionScheduler_Store::query_actions for $query arg usage. * * @param array $query Query filtering options. * @param string $query_type Whether to select or count the results. Defaults to select. * * @return string|array|null The IDs of actions matching the query. Null on failure. */ public function query_actions( $query = array(), $query_type = 'select' ) { /** * Global $wpdb object. * * @var wpdb $wpdb */ global $wpdb; $sql = $this->get_query_actions_sql( $query, $query_type ); return ( 'count' === $query_type ) ? $wpdb->get_var( $sql ) : $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.PreparedSQL.NotPrepared } /** * Get a count of all actions in the store, grouped by status * * @return array */ public function action_counts() { $action_counts_by_status = array(); $action_stati_and_labels = $this->get_status_labels(); $posts_count_by_status = (array) wp_count_posts( self::POST_TYPE, 'readable' ); foreach ( $posts_count_by_status as $post_status_name => $count ) { try { $action_status_name = $this->get_action_status_by_post_status( $post_status_name ); } catch ( Exception $e ) { // Ignore any post statuses that aren't for actions. continue; } if ( array_key_exists( $action_status_name, $action_stati_and_labels ) ) { $action_counts_by_status[ $action_status_name ] = $count; } } return $action_counts_by_status; } /** * Cancel action. * * @param int $action_id Action ID. * * @throws InvalidArgumentException If $action_id is not identified. */ public function cancel_action( $action_id ) { $post = get_post( $action_id ); if ( empty( $post ) || ( self::POST_TYPE !== $post->post_type ) ) { /* translators: %s is the action ID */ throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s: we were unable to cancel this action. It may may have been deleted by another process.', 'woocommerce' ), $action_id ) ); } do_action( 'action_scheduler_canceled_action', $action_id ); add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10, 5 ); wp_trash_post( $action_id ); remove_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10 ); } /** * Delete action. * * @param int $action_id Action ID. * @return void * @throws InvalidArgumentException If action is not identified. */ public function delete_action( $action_id ) { $post = get_post( $action_id ); if ( empty( $post ) || ( self::POST_TYPE !== $post->post_type ) ) { /* translators: %s is the action ID */ throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s: we were unable to delete this action. It may may have been deleted by another process.', 'woocommerce' ), $action_id ) ); } do_action( 'action_scheduler_deleted_action', $action_id ); wp_delete_post( $action_id, true ); } /** * Get date for claim id. * * @param int $action_id Action ID. * @return ActionScheduler_DateTime The date the action is schedule to run, or the date that it ran. */ public function get_date( $action_id ) { $next = $this->get_date_gmt( $action_id ); return ActionScheduler_TimezoneHelper::set_local_timezone( $next ); } /** * Get Date GMT. * * @param int $action_id Action ID. * * @throws InvalidArgumentException If $action_id is not identified. * @return ActionScheduler_DateTime The date the action is schedule to run, or the date that it ran. */ public function get_date_gmt( $action_id ) { $post = get_post( $action_id ); if ( empty( $post ) || ( self::POST_TYPE !== $post->post_type ) ) { /* translators: %s is the action ID */ throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s: we were unable to determine the date of this action. It may may have been deleted by another process.', 'woocommerce' ), $action_id ) ); } if ( 'publish' === $post->post_status ) { return as_get_datetime_object( $post->post_modified_gmt ); } else { return as_get_datetime_object( $post->post_date_gmt ); } } /** * Stake claim. * * @param int $max_actions Maximum number of actions. * @param DateTime|null $before_date Jobs must be schedule before this date. Defaults to now. * @param array $hooks Claim only actions with a hook or hooks. * @param string $group Claim only actions in the given group. * * @return ActionScheduler_ActionClaim * @throws RuntimeException When there is an error staking a claim. * @throws InvalidArgumentException When the given group is not valid. */ public function stake_claim( $max_actions = 10, ?DateTime $before_date = null, $hooks = array(), $group = '' ) { $this->claim_before_date = $before_date; $claim_id = $this->generate_claim_id(); $this->claim_actions( $claim_id, $max_actions, $before_date, $hooks, $group ); $action_ids = $this->find_actions_by_claim_id( $claim_id ); $this->claim_before_date = null; return new ActionScheduler_ActionClaim( $claim_id, $action_ids ); } /** * Get claim count. * * @return int */ public function get_claim_count() { global $wpdb; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching return $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(DISTINCT post_password) FROM {$wpdb->posts} WHERE post_password != '' AND post_type = %s AND post_status IN ('in-progress','pending')", array( self::POST_TYPE ) ) ); } /** * Generate claim id. * * @return string */ protected function generate_claim_id() { $claim_id = md5( microtime( true ) . wp_rand( 0, 1000 ) ); return substr( $claim_id, 0, 20 ); // to fit in db field with 20 char limit. } /** * Claim actions. * * @param string $claim_id Claim ID. * @param int $limit Limit. * @param DateTime|null $before_date Should use UTC timezone. * @param array $hooks Claim only actions with a hook or hooks. * @param string $group Claim only actions in the given group. * * @return int The number of actions that were claimed. * @throws RuntimeException When there is a database error. */ protected function claim_actions( $claim_id, $limit, ?DateTime $before_date = null, $hooks = array(), $group = '' ) { // Set up initial variables. $date = null === $before_date ? as_get_datetime_object() : clone $before_date; $limit_ids = ! empty( $group ); $ids = $limit_ids ? $this->get_actions_by_group( $group, $limit, $date ) : array(); // If limiting by IDs and no posts found, then return early since we have nothing to update. if ( $limit_ids && 0 === count( $ids ) ) { return 0; } /** * Global wpdb object. * * @var wpdb $wpdb */ global $wpdb; /* * Build up custom query to update the affected posts. Parameters are built as a separate array * to make it easier to identify where they are in the query. * * We can't use $wpdb->update() here because of the "ID IN ..." clause. */ $update = "UPDATE {$wpdb->posts} SET post_password = %s, post_modified_gmt = %s, post_modified = %s"; $params = array( $claim_id, current_time( 'mysql', true ), current_time( 'mysql' ), ); // Build initial WHERE clause. $where = "WHERE post_type = %s AND post_status = %s AND post_password = ''"; $params[] = self::POST_TYPE; $params[] = ActionScheduler_Store::STATUS_PENDING; if ( ! empty( $hooks ) ) { $placeholders = array_fill( 0, count( $hooks ), '%s' ); $where .= ' AND post_title IN (' . join( ', ', $placeholders ) . ')'; $params = array_merge( $params, array_values( $hooks ) ); } /* * Add the IDs to the WHERE clause. IDs not escaped because they came directly from a prior DB query. * * If we're not limiting by IDs, then include the post_date_gmt clause. */ if ( $limit_ids ) { $where .= ' AND ID IN (' . join( ',', $ids ) . ')'; } else { $where .= ' AND post_date_gmt <= %s'; $params[] = $date->format( 'Y-m-d H:i:s' ); } // Add the ORDER BY clause and,ms limit. $order = 'ORDER BY menu_order ASC, post_date_gmt ASC, ID ASC LIMIT %d'; $params[] = $limit; // Run the query and gather results. $rows_affected = $wpdb->query( $wpdb->prepare( "{$update} {$where} {$order}", $params ) ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare if ( false === $rows_affected ) { throw new RuntimeException( __( 'Unable to claim actions. Database error.', 'woocommerce' ) ); } return (int) $rows_affected; } /** * Get IDs of actions within a certain group and up to a certain date/time. * * @param string $group The group to use in finding actions. * @param int $limit The number of actions to retrieve. * @param DateTime $date DateTime object representing cutoff time for actions. Actions retrieved will be * up to and including this DateTime. * * @return array IDs of actions in the appropriate group and before the appropriate time. * @throws InvalidArgumentException When the group does not exist. */ protected function get_actions_by_group( $group, $limit, DateTime $date ) { // Ensure the group exists before continuing. if ( ! term_exists( $group, self::GROUP_TAXONOMY ) ) { /* translators: %s is the group name */ throw new InvalidArgumentException( sprintf( __( 'The group "%s" does not exist.', 'woocommerce' ), $group ) ); } // Set up a query for post IDs to use later. $query = new WP_Query(); $query_args = array( 'fields' => 'ids', 'post_type' => self::POST_TYPE, 'post_status' => ActionScheduler_Store::STATUS_PENDING, 'has_password' => false, 'posts_per_page' => $limit * 3, 'suppress_filters' => true, // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.SuppressFilters_suppress_filters 'no_found_rows' => true, 'orderby' => array( 'menu_order' => 'ASC', 'date' => 'ASC', 'ID' => 'ASC', ), 'date_query' => array( 'column' => 'post_date_gmt', 'before' => $date->format( 'Y-m-d H:i' ), 'inclusive' => true, ), 'tax_query' => array( // phpcs:ignore WordPress.DB.SlowDBQuery array( 'taxonomy' => self::GROUP_TAXONOMY, 'field' => 'slug', 'terms' => $group, 'include_children' => false, ), ), ); return $query->query( $query_args ); } /** * Find actions by claim ID. * * @param string $claim_id Claim ID. * @return array */ public function find_actions_by_claim_id( $claim_id ) { /** * Global wpdb object. * * @var wpdb $wpdb */ global $wpdb; $action_ids = array(); $before_date = isset( $this->claim_before_date ) ? $this->claim_before_date : as_get_datetime_object(); $cut_off = $before_date->format( 'Y-m-d H:i:s' ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching $results = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_date_gmt FROM {$wpdb->posts} WHERE post_type = %s AND post_password = %s", array( self::POST_TYPE, $claim_id, ) ) ); // Verify that the scheduled date for each action is within the expected bounds (in some unusual // cases, we cannot depend on MySQL to honor all of the WHERE conditions we specify). foreach ( $results as $claimed_action ) { if ( $claimed_action->post_date_gmt <= $cut_off ) { $action_ids[] = absint( $claimed_action->ID ); } } return $action_ids; } /** * Release pending actions from a claim. * * @param ActionScheduler_ActionClaim $claim Claim object to release. * @return void * @throws RuntimeException When the claim is not unlocked. */ public function release_claim( ActionScheduler_ActionClaim $claim ) { /** * Global wpdb object. * * @var wpdb $wpdb */ global $wpdb; $claim_id = $claim->get_id(); if ( trim( $claim_id ) === '' ) { // Verify that the claim_id is valid before attempting to release it. return; } // Only attempt to release pending actions to be claimed again. Running and complete actions are no longer relevant outside of admin/analytics. // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching $action_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID, post_date_gmt FROM {$wpdb->posts} WHERE post_type = %s AND post_password = %s AND post_status = %s", self::POST_TYPE, $claim_id, self::STATUS_PENDING ) ); if ( empty( $action_ids ) ) { return; // nothing to do. } $action_id_string = implode( ',', array_map( 'intval', $action_ids ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching $result = $wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->posts} SET post_password = '' WHERE ID IN ($action_id_string) AND post_password = %s", //phpcs:ignore array( $claim->get_id(), ) ) ); if ( false === $result ) { /* translators: %s: claim ID */ throw new RuntimeException( sprintf( __( 'Unable to unlock claim %s. Database error.', 'woocommerce' ), $claim->get_id() ) ); } } /** * Unclaim action. * * @param string $action_id Action ID. * @throws RuntimeException When unable to unlock claim on action ID. */ public function unclaim_action( $action_id ) { /** * Global wpdb object. * * @var wpdb $wpdb */ global $wpdb; //phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching $result = $wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->posts} SET post_password = '' WHERE ID = %d AND post_type = %s", $action_id, self::POST_TYPE ) ); if ( false === $result ) { /* translators: %s: action ID */ throw new RuntimeException( sprintf( __( 'Unable to unlock claim on action %s. Database error.', 'woocommerce' ), $action_id ) ); } } /** * Mark failure on action. * * @param int $action_id Action ID. * * @return void * @throws RuntimeException When unable to mark failure on action ID. */ public function mark_failure( $action_id ) { /** * Global wpdb object. * * @var wpdb $wpdb */ global $wpdb; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching $result = $wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->posts} SET post_status = %s WHERE ID = %d AND post_type = %s", self::STATUS_FAILED, $action_id, self::POST_TYPE ) ); if ( false === $result ) { /* translators: %s: action ID */ throw new RuntimeException( sprintf( __( 'Unable to mark failure on action %s. Database error.', 'woocommerce' ), $action_id ) ); } } /** * Return an action's claim ID, as stored in the post password column * * @param int $action_id Action ID. * @return mixed */ public function get_claim_id( $action_id ) { return $this->get_post_column( $action_id, 'post_password' ); } /** * Return an action's status, as stored in the post status column * * @param int $action_id Action ID. * * @return mixed * @throws InvalidArgumentException When the action ID is invalid. */ public function get_status( $action_id ) { $status = $this->get_post_column( $action_id, 'post_status' ); if ( null === $status ) { throw new InvalidArgumentException( __( 'Invalid action ID. No status found.', 'woocommerce' ) ); } return $this->get_action_status_by_post_status( $status ); } /** * Get post column * * @param string $action_id Action ID. * @param string $column_name Column Name. * * @return string|null */ private function get_post_column( $action_id, $column_name ) { /** * Global wpdb object. * * @var wpdb $wpdb */ global $wpdb; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching return $wpdb->get_var( $wpdb->prepare( "SELECT {$column_name} FROM {$wpdb->posts} WHERE ID=%d AND post_type=%s", // phpcs:ignore $action_id, self::POST_TYPE ) ); } /** * Log Execution. * * @throws Exception If the action status cannot be updated to self::STATUS_RUNNING ('in-progress'). * * @param string $action_id Action ID. */ public function log_execution( $action_id ) { /** * Global wpdb object. * * @var wpdb $wpdb */ global $wpdb; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching $status_updated = $wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->posts} SET menu_order = menu_order+1, post_status=%s, post_modified_gmt = %s, post_modified = %s WHERE ID = %d AND post_type = %s", self::STATUS_RUNNING, current_time( 'mysql', true ), current_time( 'mysql' ), $action_id, self::POST_TYPE ) ); if ( ! $status_updated ) { throw new Exception( sprintf( /* translators: 1: action ID. 2: status slug. */ __( 'Unable to update the status of action %1$d to %2$s.', 'woocommerce' ), $action_id, self::STATUS_RUNNING ) ); } } /** * Record that an action was completed. * * @param string $action_id ID of the completed action. * * @throws InvalidArgumentException When the action ID is invalid. * @throws RuntimeException When there was an error executing the action. */ public function mark_complete( $action_id ) { $post = get_post( $action_id ); if ( empty( $post ) || ( self::POST_TYPE !== $post->post_type ) ) { /* translators: %s is the action ID */ throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s: we were unable to mark this action as having completed. It may may have been deleted by another process.', 'woocommerce' ), $action_id ) ); } add_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10, 1 ); add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10, 5 ); $result = wp_update_post( array( 'ID' => $action_id, 'post_status' => 'publish', ), true ); remove_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10 ); remove_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10 ); if ( is_wp_error( $result ) ) { throw new RuntimeException( $result->get_error_message() ); } /** * Fires after a scheduled action has been completed. * * @since 3.4.2 * * @param int $action_id Action ID. */ do_action( 'action_scheduler_completed_action', $action_id ); } /** * Mark action as migrated when there is an error deleting the action. * * @param int $action_id Action ID. */ public function mark_migrated( $action_id ) { wp_update_post( array( 'ID' => $action_id, 'post_status' => 'migrated', ) ); } /** * Determine whether the post store can be migrated. * * @param [type] $setting - Setting value. * @return bool */ public function migration_dependencies_met( $setting ) { global $wpdb; $dependencies_met = get_transient( self::DEPENDENCIES_MET ); if ( empty( $dependencies_met ) ) { $maximum_args_length = apply_filters( 'action_scheduler_maximum_args_length', 191 ); $found_action = $wpdb->get_var( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE post_type = %s AND CHAR_LENGTH(post_content) > %d LIMIT 1", $maximum_args_length, self::POST_TYPE ) ); $dependencies_met = $found_action ? 'no' : 'yes'; set_transient( self::DEPENDENCIES_MET, $dependencies_met, DAY_IN_SECONDS ); } return 'yes' === $dependencies_met ? $setting : false; } /** * InnoDB indexes have a maximum size of 767 bytes by default, which is only 191 characters with utf8mb4. * * Previously, AS wasn't concerned about args length, as we used the (unindex) post_content column. However, * as we prepare to move to custom tables, and can use an indexed VARCHAR column instead, we want to warn * developers of this impending requirement. * * @param ActionScheduler_Action $action Action object. */ protected function validate_action( ActionScheduler_Action $action ) { try { parent::validate_action( $action ); } catch ( Exception $e ) { /* translators: %s is the error message */ $message = sprintf( __( '%s Support for strings longer than this will be removed in a future version.', 'woocommerce' ), $e->getMessage() ); _doing_it_wrong( 'ActionScheduler_Action::$args', esc_html( $message ), '2.1.0' ); } } /** * (@codeCoverageIgnore) */ public function init() { add_filter( 'action_scheduler_migration_dependencies_met', array( $this, 'migration_dependencies_met' ) ); $post_type_registrar = new ActionScheduler_wpPostStore_PostTypeRegistrar(); $post_type_registrar->register(); $post_status_registrar = new ActionScheduler_wpPostStore_PostStatusRegistrar(); $post_status_registrar->register(); $taxonomy_registrar = new ActionScheduler_wpPostStore_TaxonomyRegistrar(); $taxonomy_registrar->register(); } } action-scheduler/classes/data-stores/ActionScheduler_HybridStore.php 0000777 00000030606 15252010675 0022002 0 ustar 00 <?php use ActionScheduler_Store as Store; use Action_Scheduler\Migration\Runner; use Action_Scheduler\Migration\Config; use Action_Scheduler\Migration\Controller; /** * Class ActionScheduler_HybridStore * * A wrapper around multiple stores that fetches data from both. * * @since 3.0.0 */ class ActionScheduler_HybridStore extends Store { const DEMARKATION_OPTION = 'action_scheduler_hybrid_store_demarkation'; /** * Primary store instance. * * @var ActionScheduler_Store */ private $primary_store; /** * Secondary store instance. * * @var ActionScheduler_Store */ private $secondary_store; /** * Runner instance. * * @var Action_Scheduler\Migration\Runner */ private $migration_runner; /** * The dividing line between IDs of actions created * by the primary and secondary stores. * * @var int * * Methods that accept an action ID will compare the ID against * this to determine which store will contain that ID. In almost * all cases, the ID should come from the primary store, but if * client code is bypassing the API functions and fetching IDs * from elsewhere, then there is a chance that an unmigrated ID * might be requested. */ private $demarkation_id = 0; /** * ActionScheduler_HybridStore constructor. * * @param Config|null $config Migration config object. */ public function __construct( ?Config $config = null ) { $this->demarkation_id = (int) get_option( self::DEMARKATION_OPTION, 0 ); if ( empty( $config ) ) { $config = Controller::instance()->get_migration_config_object(); } $this->primary_store = $config->get_destination_store(); $this->secondary_store = $config->get_source_store(); $this->migration_runner = new Runner( $config ); } /** * Initialize the table data store tables. * * @codeCoverageIgnore */ public function init() { add_action( 'action_scheduler/created_table', array( $this, 'set_autoincrement' ), 10, 2 ); $this->primary_store->init(); $this->secondary_store->init(); remove_action( 'action_scheduler/created_table', array( $this, 'set_autoincrement' ), 10 ); } /** * When the actions table is created, set its autoincrement * value to be one higher than the posts table to ensure that * there are no ID collisions. * * @param string $table_name Table name. * @param string $table_suffix Suffix of table name. * * @return void * @codeCoverageIgnore */ public function set_autoincrement( $table_name, $table_suffix ) { if ( ActionScheduler_StoreSchema::ACTIONS_TABLE === $table_suffix ) { if ( empty( $this->demarkation_id ) ) { $this->demarkation_id = $this->set_demarkation_id(); } /** * Global. * * @var \wpdb $wpdb */ global $wpdb; /** * A default date of '0000-00-00 00:00:00' is invalid in MySQL 5.7 when configured with * sql_mode including both STRICT_TRANS_TABLES and NO_ZERO_DATE. */ $default_date = new DateTime( 'tomorrow' ); $null_action = new ActionScheduler_NullAction(); $date_gmt = $this->get_scheduled_date_string( $null_action, $default_date ); $date_local = $this->get_scheduled_date_string_local( $null_action, $default_date ); $row_count = $wpdb->insert( $wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE}, array( 'action_id' => $this->demarkation_id, 'hook' => '', 'status' => '', 'scheduled_date_gmt' => $date_gmt, 'scheduled_date_local' => $date_local, 'last_attempt_gmt' => $date_gmt, 'last_attempt_local' => $date_local, ) ); if ( $row_count > 0 ) { $wpdb->delete( $wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE}, array( 'action_id' => $this->demarkation_id ) ); } } } /** * Store the demarkation id in WP options. * * @param int $id The ID to set as the demarkation point between the two stores * Leave null to use the next ID from the WP posts table. * * @return int The new ID. * * @codeCoverageIgnore */ private function set_demarkation_id( $id = null ) { if ( empty( $id ) ) { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $id = (int) $wpdb->get_var( "SELECT MAX(ID) FROM $wpdb->posts" ); $id++; } update_option( self::DEMARKATION_OPTION, $id ); return $id; } /** * Find the first matching action from the secondary store. * If it exists, migrate it to the primary store immediately. * After it migrates, the secondary store will logically contain * the next matching action, so return the result thence. * * @param string $hook Action's hook. * @param array $params Action's arguments. * * @return string */ public function find_action( $hook, $params = array() ) { $found_unmigrated_action = $this->secondary_store->find_action( $hook, $params ); if ( ! empty( $found_unmigrated_action ) ) { $this->migrate( array( $found_unmigrated_action ) ); } return $this->primary_store->find_action( $hook, $params ); } /** * Find actions matching the query in the secondary source first. * If any are found, migrate them immediately. Then the secondary * store will contain the canonical results. * * @param array $query Query arguments. * @param string $query_type Whether to select or count the results. Default, select. * * @return int[] */ public function query_actions( $query = array(), $query_type = 'select' ) { $found_unmigrated_actions = $this->secondary_store->query_actions( $query, 'select' ); if ( ! empty( $found_unmigrated_actions ) ) { $this->migrate( $found_unmigrated_actions ); } return $this->primary_store->query_actions( $query, $query_type ); } /** * Get a count of all actions in the store, grouped by status * * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status. */ public function action_counts() { $unmigrated_actions_count = $this->secondary_store->action_counts(); $migrated_actions_count = $this->primary_store->action_counts(); $actions_count_by_status = array(); foreach ( $this->get_status_labels() as $status_key => $status_label ) { $count = 0; if ( isset( $unmigrated_actions_count[ $status_key ] ) ) { $count += $unmigrated_actions_count[ $status_key ]; } if ( isset( $migrated_actions_count[ $status_key ] ) ) { $count += $migrated_actions_count[ $status_key ]; } $actions_count_by_status[ $status_key ] = $count; } $actions_count_by_status = array_filter( $actions_count_by_status ); return $actions_count_by_status; } /** * If any actions would have been claimed by the secondary store, * migrate them immediately, then ask the primary store for the * canonical claim. * * @param int $max_actions Maximum number of actions to claim. * @param null|DateTime $before_date Latest timestamp of actions to claim. * @param string[] $hooks Hook of actions to claim. * @param string $group Group of actions to claim. * * @return ActionScheduler_ActionClaim */ public function stake_claim( $max_actions = 10, ?DateTime $before_date = null, $hooks = array(), $group = '' ) { $claim = $this->secondary_store->stake_claim( $max_actions, $before_date, $hooks, $group ); $claimed_actions = $claim->get_actions(); if ( ! empty( $claimed_actions ) ) { $this->migrate( $claimed_actions ); } $this->secondary_store->release_claim( $claim ); return $this->primary_store->stake_claim( $max_actions, $before_date, $hooks, $group ); } /** * Migrate a list of actions to the table data store. * * @param array $action_ids List of action IDs. */ private function migrate( $action_ids ) { $this->migration_runner->migrate_actions( $action_ids ); } /** * Save an action to the primary store. * * @param ActionScheduler_Action $action Action object to be saved. * @param DateTime|null $date Optional. Schedule date. Default null. * * @return int The action ID */ public function save_action( ActionScheduler_Action $action, ?DateTime $date = null ) { return $this->primary_store->save_action( $action, $date ); } /** * Retrieve an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function fetch_action( $action_id ) { $store = $this->get_store_from_action_id( $action_id, true ); if ( $store ) { return $store->fetch_action( $action_id ); } else { return new ActionScheduler_NullAction(); } } /** * Cancel an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function cancel_action( $action_id ) { $store = $this->get_store_from_action_id( $action_id ); if ( $store ) { $store->cancel_action( $action_id ); } } /** * Delete an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function delete_action( $action_id ) { $store = $this->get_store_from_action_id( $action_id ); if ( $store ) { $store->delete_action( $action_id ); } } /** * Get the schedule date an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function get_date( $action_id ) { $store = $this->get_store_from_action_id( $action_id ); if ( $store ) { return $store->get_date( $action_id ); } else { return null; } } /** * Mark an existing action as failed whether migrated or not. * * @param int $action_id Action ID. */ public function mark_failure( $action_id ) { $store = $this->get_store_from_action_id( $action_id ); if ( $store ) { $store->mark_failure( $action_id ); } } /** * Log the execution of an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function log_execution( $action_id ) { $store = $this->get_store_from_action_id( $action_id ); if ( $store ) { $store->log_execution( $action_id ); } } /** * Mark an existing action complete whether migrated or not. * * @param int $action_id Action ID. */ public function mark_complete( $action_id ) { $store = $this->get_store_from_action_id( $action_id ); if ( $store ) { $store->mark_complete( $action_id ); } } /** * Get an existing action status whether migrated or not. * * @param int $action_id Action ID. */ public function get_status( $action_id ) { $store = $this->get_store_from_action_id( $action_id ); if ( $store ) { return $store->get_status( $action_id ); } return null; } /** * Return which store an action is stored in. * * @param int $action_id ID of the action. * @param bool $primary_first Optional flag indicating search the primary store first. * @return ActionScheduler_Store */ protected function get_store_from_action_id( $action_id, $primary_first = false ) { if ( $primary_first ) { $stores = array( $this->primary_store, $this->secondary_store, ); } elseif ( $action_id < $this->demarkation_id ) { $stores = array( $this->secondary_store, $this->primary_store, ); } else { $stores = array( $this->primary_store, ); } foreach ( $stores as $store ) { $action = $store->fetch_action( $action_id ); if ( ! is_a( $action, 'ActionScheduler_NullAction' ) ) { return $store; } } return null; } /** * * * * * * * * * * * * * * * * * * * * * * * * * * * * All claim-related functions should operate solely * on the primary store. * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /** * Get the claim count from the table data store. */ public function get_claim_count() { return $this->primary_store->get_claim_count(); } /** * Retrieve the claim ID for an action from the table data store. * * @param int $action_id Action ID. */ public function get_claim_id( $action_id ) { return $this->primary_store->get_claim_id( $action_id ); } /** * Release a claim in the table data store on any pending actions. * * @param ActionScheduler_ActionClaim $claim Claim object. */ public function release_claim( ActionScheduler_ActionClaim $claim ) { $this->primary_store->release_claim( $claim ); } /** * Release claims on an action in the table data store. * * @param int $action_id Action ID. */ public function unclaim_action( $action_id ) { $this->primary_store->unclaim_action( $action_id ); } /** * Retrieve a list of action IDs by claim. * * @param int $claim_id Claim ID. */ public function find_actions_by_claim_id( $claim_id ) { return $this->primary_store->find_actions_by_claim_id( $claim_id ); } } action-scheduler/classes/ActionScheduler_AdminView.php 0000777 00000024374 15252010675 0017206 0 ustar 00 <?php /** * Class ActionScheduler_AdminView * * @codeCoverageIgnore */ class ActionScheduler_AdminView extends ActionScheduler_AdminView_Deprecated { /** * Instance. * * @var null|self */ private static $admin_view = null; /** * Screen ID. * * @var string */ private static $screen_id = 'tools_page_action-scheduler'; /** * ActionScheduler_ListTable instance. * * @var ActionScheduler_ListTable */ protected $list_table; /** * Get instance. * * @return ActionScheduler_AdminView * @codeCoverageIgnore */ public static function instance() { if ( empty( self::$admin_view ) ) { $class = apply_filters( 'action_scheduler_admin_view_class', 'ActionScheduler_AdminView' ); self::$admin_view = new $class(); } return self::$admin_view; } /** * Initialize. * * @codeCoverageIgnore */ public function init() { if ( is_admin() && ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) ) { if ( class_exists( 'WooCommerce' ) ) { add_action( 'woocommerce_admin_status_content_action-scheduler', array( $this, 'render_admin_ui' ) ); add_action( 'woocommerce_system_status_report', array( $this, 'system_status_report' ) ); add_filter( 'woocommerce_admin_status_tabs', array( $this, 'register_system_status_tab' ) ); } add_action( 'admin_menu', array( $this, 'register_menu' ) ); add_action( 'admin_notices', array( $this, 'maybe_check_pastdue_actions' ) ); add_action( 'current_screen', array( $this, 'add_help_tabs' ) ); } } /** * Print system status report. */ public function system_status_report() { $table = new ActionScheduler_wcSystemStatus( ActionScheduler::store() ); $table->render(); } /** * Registers action-scheduler into WooCommerce > System status. * * @param array $tabs An associative array of tab key => label. * @return array $tabs An associative array of tab key => label, including Action Scheduler's tabs */ public function register_system_status_tab( array $tabs ) { $tabs['action-scheduler'] = __( 'Scheduled Actions', 'woocommerce' ); return $tabs; } /** * Include Action Scheduler's administration under the Tools menu. * * A menu under the Tools menu is important for backward compatibility (as that's * where it started), and also provides more convenient access than the WooCommerce * System Status page, and for sites where WooCommerce isn't active. */ public function register_menu() { $hook_suffix = add_submenu_page( 'tools.php', __( 'Scheduled Actions', 'woocommerce' ), __( 'Scheduled Actions', 'woocommerce' ), 'manage_options', 'action-scheduler', array( $this, 'render_admin_ui' ) ); add_action( 'load-' . $hook_suffix, array( $this, 'process_admin_ui' ) ); } /** * Triggers processing of any pending actions. */ public function process_admin_ui() { $this->get_list_table(); } /** * Renders the Admin UI */ public function render_admin_ui() { $table = $this->get_list_table(); $table->display_page(); } /** * Get the admin UI object and process any requested actions. * * @return ActionScheduler_ListTable */ protected function get_list_table() { if ( null === $this->list_table ) { $this->list_table = new ActionScheduler_ListTable( ActionScheduler::store(), ActionScheduler::logger(), ActionScheduler::runner() ); $this->list_table->process_actions(); } return $this->list_table; } /** * Action: admin_notices * * Maybe check past-due actions, and print notice. * * @uses $this->check_pastdue_actions() */ public function maybe_check_pastdue_actions() { // Filter to prevent checking actions (ex: inappropriate user). if ( ! apply_filters( 'action_scheduler_check_pastdue_actions', current_user_can( 'manage_options' ) ) ) { return; } // Get last check transient. $last_check = get_transient( 'action_scheduler_last_pastdue_actions_check' ); // If transient exists, we're within interval, so bail. if ( ! empty( $last_check ) ) { return; } // Perform the check. $this->check_pastdue_actions(); } /** * Check past-due actions, and print notice. */ protected function check_pastdue_actions() { // Set thresholds. $threshold_seconds = (int) apply_filters( 'action_scheduler_pastdue_actions_seconds', DAY_IN_SECONDS ); $threshold_min = (int) apply_filters( 'action_scheduler_pastdue_actions_min', 1 ); // Set fallback value for past-due actions count. $num_pastdue_actions = 0; // Allow third-parties to preempt the default check logic. $check = apply_filters( 'action_scheduler_pastdue_actions_check_pre', null ); // If no third-party preempted and there are no past-due actions, return early. if ( ! is_null( $check ) ) { return; } // Scheduled actions query arguments. $query_args = array( 'date' => as_get_datetime_object( time() - $threshold_seconds ), 'status' => ActionScheduler_Store::STATUS_PENDING, 'per_page' => $threshold_min, ); // If no third-party preempted, run default check. if ( is_null( $check ) ) { $store = ActionScheduler_Store::instance(); $num_pastdue_actions = (int) $store->query_actions( $query_args, 'count' ); // Check if past-due actions count is greater than or equal to threshold. $check = ( $num_pastdue_actions >= $threshold_min ); $check = (bool) apply_filters( 'action_scheduler_pastdue_actions_check', $check, $num_pastdue_actions, $threshold_seconds, $threshold_min ); } // If check failed, set transient and abort. if ( ! boolval( $check ) ) { $interval = apply_filters( 'action_scheduler_pastdue_actions_check_interval', round( $threshold_seconds / 4 ), $threshold_seconds ); set_transient( 'action_scheduler_last_pastdue_actions_check', time(), $interval ); return; } $actions_url = add_query_arg( array( 'page' => 'action-scheduler', 'status' => 'past-due', 'order' => 'asc', ), admin_url( 'tools.php' ) ); // Print notice. echo '<div class="notice notice-warning"><p>'; printf( wp_kses( // translators: 1) is the number of affected actions, 2) is a link to an admin screen. _n( '<strong>Action Scheduler:</strong> %1$d <a href="%2$s">past-due action</a> found; something may be wrong. <a href="https://actionscheduler.org/faq/#my-site-has-past-due-actions-what-can-i-do" target="_blank">Read documentation »</a>', '<strong>Action Scheduler:</strong> %1$d <a href="%2$s">past-due actions</a> found; something may be wrong. <a href="https://actionscheduler.org/faq/#my-site-has-past-due-actions-what-can-i-do" target="_blank">Read documentation »</a>', $num_pastdue_actions, 'woocommerce' ), array( 'strong' => array(), 'a' => array( 'href' => true, 'target' => true, ), ) ), absint( $num_pastdue_actions ), esc_attr( esc_url( $actions_url ) ) ); echo '</p></div>'; // Facilitate third-parties to evaluate and print notices. do_action( 'action_scheduler_pastdue_actions_extra_notices', $query_args ); } /** * Provide more information about the screen and its data in the help tab. */ public function add_help_tabs() { $screen = get_current_screen(); if ( ! $screen || self::$screen_id !== $screen->id ) { return; } $as_version = ActionScheduler_Versions::instance()->latest_version(); $as_source = ActionScheduler_SystemInformation::active_source(); $as_source_path = ActionScheduler_SystemInformation::active_source_path(); $as_source_markup = sprintf( '<code>%s</code>', esc_html( $as_source_path ) ); if ( ! empty( $as_source ) ) { $as_source_markup = sprintf( '%s: <abbr title="%s">%s</abbr>', ucfirst( $as_source['type'] ), esc_attr( $as_source_path ), esc_html( $as_source['name'] ) ); } $screen->add_help_tab( array( 'id' => 'action_scheduler_about', 'title' => __( 'About', 'woocommerce' ), 'content' => // translators: %s is the Action Scheduler version. '<h2>' . sprintf( __( 'About Action Scheduler %s', 'woocommerce' ), $as_version ) . '</h2>' . '<p>' . __( 'Action Scheduler is a scalable, traceable job queue for background processing large sets of actions. Action Scheduler works by triggering an action hook to run at some time in the future. Scheduled actions can also be scheduled to run on a recurring schedule.', 'woocommerce' ) . '</p>' . '<h3>' . esc_html__( 'Source', 'woocommerce' ) . '</h3>' . '<p>' . esc_html__( 'Action Scheduler is currently being loaded from the following location. This can be useful when debugging, or if requested by the support team.', 'woocommerce' ) . '</p>' . '<p>' . $as_source_markup . '</p>' . '<h3>' . esc_html__( 'WP CLI', 'woocommerce' ) . '</h3>' . '<p>' . sprintf( /* translators: %1$s is WP CLI command (not translatable) */ esc_html__( 'WP CLI commands are available: execute %1$s for a list of available commands.', 'woocommerce' ), '<code>wp help action-scheduler</code>' ) . '</p>', ) ); $screen->add_help_tab( array( 'id' => 'action_scheduler_columns', 'title' => __( 'Columns', 'woocommerce' ), 'content' => '<h2>' . __( 'Scheduled Action Columns', 'woocommerce' ) . '</h2>' . '<ul>' . sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Hook', 'woocommerce' ), __( 'Name of the action hook that will be triggered.', 'woocommerce' ) ) . sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Status', 'woocommerce' ), __( 'Action statuses are Pending, Complete, Canceled, Failed', 'woocommerce' ) ) . sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Arguments', 'woocommerce' ), __( 'Optional data array passed to the action hook.', 'woocommerce' ) ) . sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Group', 'woocommerce' ), __( 'Optional action group.', 'woocommerce' ) ) . sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Recurrence', 'woocommerce' ), __( 'The action\'s schedule frequency.', 'woocommerce' ) ) . sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Scheduled', 'woocommerce' ), __( 'The date/time the action is/was scheduled to run.', 'woocommerce' ) ) . sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Log', 'woocommerce' ), __( 'Activity log for the action.', 'woocommerce' ) ) . '</ul>', ) ); } } action-scheduler/classes/ActionScheduler_WPCommentCleaner.php 0000777 00000010647 15252010675 0020464 0 ustar 00 <?php /** * Class ActionScheduler_WPCommentCleaner * * @since 3.0.0 */ class ActionScheduler_WPCommentCleaner { /** * Post migration hook used to cleanup the WP comment table. * * @var string */ protected static $cleanup_hook = 'action_scheduler/cleanup_wp_comment_logs'; /** * An instance of the ActionScheduler_wpCommentLogger class to interact with the comments table. * * This instance should only be used as an interface. It should not be initialized. * * @var ActionScheduler_wpCommentLogger */ protected static $wp_comment_logger = null; /** * The key used to store the cached value of whether there are logs in the WP comment table. * * @var string */ protected static $has_logs_option_key = 'as_has_wp_comment_logs'; /** * Initialize the class and attach callbacks. */ public static function init() { if ( empty( self::$wp_comment_logger ) ) { self::$wp_comment_logger = new ActionScheduler_wpCommentLogger(); } add_action( self::$cleanup_hook, array( __CLASS__, 'delete_all_action_comments' ) ); // While there are orphaned logs left in the comments table, we need to attach the callbacks which filter comment counts. add_action( 'pre_get_comments', array( self::$wp_comment_logger, 'filter_comment_queries' ), 10, 1 ); add_action( 'wp_count_comments', array( self::$wp_comment_logger, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs. add_action( 'comment_feed_where', array( self::$wp_comment_logger, 'filter_comment_feed' ), 10, 2 ); // Action Scheduler may be displayed as a Tools screen or WooCommerce > Status administration screen. add_action( 'load-tools_page_action-scheduler', array( __CLASS__, 'register_admin_notice' ) ); add_action( 'load-woocommerce_page_wc-status', array( __CLASS__, 'register_admin_notice' ) ); } /** * Determines if there are log entries in the wp comments table. * * Uses the flag set on migration completion set by @see self::maybe_schedule_cleanup(). * * @return boolean Whether there are scheduled action comments in the comments table. */ public static function has_logs() { return 'yes' === get_option( self::$has_logs_option_key ); } /** * Schedules the WP Post comment table cleanup to run in 6 months if it's not already scheduled. * Attached to the migration complete hook 'action_scheduler/migration_complete'. */ public static function maybe_schedule_cleanup() { $has_logs = 'no'; $args = array( 'type' => ActionScheduler_wpCommentLogger::TYPE, 'number' => 1, 'fields' => 'ids', ); if ( (bool) get_comments( $args ) ) { $has_logs = 'yes'; if ( ! as_next_scheduled_action( self::$cleanup_hook ) ) { as_schedule_single_action( gmdate( 'U' ) + ( 6 * MONTH_IN_SECONDS ), self::$cleanup_hook ); } } update_option( self::$has_logs_option_key, $has_logs, true ); } /** * Delete all action comments from the WP Comments table. */ public static function delete_all_action_comments() { global $wpdb; $wpdb->delete( $wpdb->comments, array( 'comment_type' => ActionScheduler_wpCommentLogger::TYPE, 'comment_agent' => ActionScheduler_wpCommentLogger::AGENT, ) ); update_option( self::$has_logs_option_key, 'no', true ); } /** * Registers admin notices about the orphaned action logs. */ public static function register_admin_notice() { add_action( 'admin_notices', array( __CLASS__, 'print_admin_notice' ) ); } /** * Prints details about the orphaned action logs and includes information on where to learn more. */ public static function print_admin_notice() { $next_cleanup_message = ''; $next_scheduled_cleanup_hook = as_next_scheduled_action( self::$cleanup_hook ); if ( $next_scheduled_cleanup_hook ) { /* translators: %s: date interval */ $next_cleanup_message = sprintf( __( 'This data will be deleted in %s.', 'woocommerce' ), human_time_diff( gmdate( 'U' ), $next_scheduled_cleanup_hook ) ); } $notice = sprintf( /* translators: 1: next cleanup message 2: github issue URL */ __( 'Action Scheduler has migrated data to custom tables; however, orphaned log entries exist in the WordPress Comments table. %1$s <a href="%2$s">Learn more »</a>', 'woocommerce' ), $next_cleanup_message, 'https://github.com/woocommerce/action-scheduler/issues/368' ); echo '<div class="notice notice-warning"><p>' . wp_kses_post( $notice ) . '</p></div>'; } } action-scheduler/classes/ActionScheduler_ActionFactory.php 0000777 00000037645 15252010675 0020075 0 ustar 00 <?php /** * Class ActionScheduler_ActionFactory */ class ActionScheduler_ActionFactory { /** * Return stored actions for given params. * * @param string $status The action's status in the data store. * @param string $hook The hook to trigger when this action runs. * @param array $args Args to pass to callbacks when the hook is triggered. * @param ActionScheduler_Schedule|null $schedule The action's schedule. * @param string $group A group to put the action in. * phpcs:ignore Squiz.Commenting.FunctionComment.ExtraParamComment * @param int $priority The action priority. * * @return ActionScheduler_Action An instance of the stored action. */ public function get_stored_action( $status, $hook, array $args = array(), ?ActionScheduler_Schedule $schedule = null, $group = '' ) { // The 6th parameter ($priority) is not formally declared in the method signature to maintain compatibility with // third-party subclasses created before this param was added. $priority = func_num_args() >= 6 ? (int) func_get_arg( 5 ) : 10; switch ( $status ) { case ActionScheduler_Store::STATUS_PENDING: $action_class = 'ActionScheduler_Action'; break; case ActionScheduler_Store::STATUS_CANCELED: $action_class = 'ActionScheduler_CanceledAction'; if ( ! is_null( $schedule ) && ! is_a( $schedule, 'ActionScheduler_CanceledSchedule' ) && ! is_a( $schedule, 'ActionScheduler_NullSchedule' ) ) { $schedule = new ActionScheduler_CanceledSchedule( $schedule->get_date() ); } break; default: $action_class = 'ActionScheduler_FinishedAction'; break; } $action_class = apply_filters( 'action_scheduler_stored_action_class', $action_class, $status, $hook, $args, $schedule, $group ); $action = new $action_class( $hook, $args, $schedule, $group ); $action->set_priority( $priority ); /** * Allow 3rd party code to change the instantiated action for a given hook, args, schedule and group. * * @param ActionScheduler_Action $action The instantiated action. * @param string $hook The instantiated action's hook. * @param array $args The instantiated action's args. * @param ActionScheduler_Schedule $schedule The instantiated action's schedule. * @param string $group The instantiated action's group. * @param int $priority The action priority. */ return apply_filters( 'action_scheduler_stored_action_instance', $action, $hook, $args, $schedule, $group, $priority ); } /** * Enqueue an action to run one time, as soon as possible (rather a specific scheduled time). * * This method creates a new action using the NullSchedule. In practice, this results in an action scheduled to * execute "now". Therefore, it will generally run as soon as possible but is not prioritized ahead of other actions * that are already past-due. * * @param string $hook The hook to trigger when this action runs. * @param array $args Args to pass when the hook is triggered. * @param string $group A group to put the action in. * * @return int The ID of the stored action. */ public function async( $hook, $args = array(), $group = '' ) { return $this->async_unique( $hook, $args, $group, false ); } /** * Same as async, but also supports $unique param. * * @param string $hook The hook to trigger when this action runs. * @param array $args Args to pass when the hook is triggered. * @param string $group A group to put the action in. * @param bool $unique Whether to ensure the action is unique. * * @return int The ID of the stored action. */ public function async_unique( $hook, $args = array(), $group = '', $unique = true ) { $schedule = new ActionScheduler_NullSchedule(); $action = new ActionScheduler_Action( $hook, $args, $schedule, $group ); return $unique ? $this->store_unique_action( $action, $unique ) : $this->store( $action ); } /** * Create single action. * * @param string $hook The hook to trigger when this action runs. * @param array $args Args to pass when the hook is triggered. * @param int $when Unix timestamp when the action will run. * @param string $group A group to put the action in. * * @return int The ID of the stored action. */ public function single( $hook, $args = array(), $when = null, $group = '' ) { return $this->single_unique( $hook, $args, $when, $group, false ); } /** * Create single action only if there is no pending or running action with same name and params. * * @param string $hook The hook to trigger when this action runs. * @param array $args Args to pass when the hook is triggered. * @param int $when Unix timestamp when the action will run. * @param string $group A group to put the action in. * @param bool $unique Whether action scheduled should be unique. * * @return int The ID of the stored action. */ public function single_unique( $hook, $args = array(), $when = null, $group = '', $unique = true ) { $date = as_get_datetime_object( $when ); $schedule = new ActionScheduler_SimpleSchedule( $date ); $action = new ActionScheduler_Action( $hook, $args, $schedule, $group ); return $unique ? $this->store_unique_action( $action ) : $this->store( $action ); } /** * Create the first instance of an action recurring on a given interval. * * @param string $hook The hook to trigger when this action runs. * @param array $args Args to pass when the hook is triggered. * @param int $first Unix timestamp for the first run. * @param int $interval Seconds between runs. * @param string $group A group to put the action in. * * @return int The ID of the stored action. */ public function recurring( $hook, $args = array(), $first = null, $interval = null, $group = '' ) { return $this->recurring_unique( $hook, $args, $first, $interval, $group, false ); } /** * Create the first instance of an action recurring on a given interval only if there is no pending or running action with same name and params. * * @param string $hook The hook to trigger when this action runs. * @param array $args Args to pass when the hook is triggered. * @param int $first Unix timestamp for the first run. * @param int $interval Seconds between runs. * @param string $group A group to put the action in. * @param bool $unique Whether action scheduled should be unique. * * @return int The ID of the stored action. */ public function recurring_unique( $hook, $args = array(), $first = null, $interval = null, $group = '', $unique = true ) { if ( empty( $interval ) ) { return $this->single_unique( $hook, $args, $first, $group, $unique ); } $date = as_get_datetime_object( $first ); $schedule = new ActionScheduler_IntervalSchedule( $date, $interval ); $action = new ActionScheduler_Action( $hook, $args, $schedule, $group ); return $unique ? $this->store_unique_action( $action ) : $this->store( $action ); } /** * Create the first instance of an action recurring on a Cron schedule. * * @param string $hook The hook to trigger when this action runs. * @param array $args Args to pass when the hook is triggered. * @param int $base_timestamp The first instance of the action will be scheduled * to run at a time calculated after this timestamp matching the cron * expression. This can be used to delay the first instance of the action. * @param int $schedule A cron definition string. * @param string $group A group to put the action in. * * @return int The ID of the stored action. */ public function cron( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '' ) { return $this->cron_unique( $hook, $args, $base_timestamp, $schedule, $group, false ); } /** * Create the first instance of an action recurring on a Cron schedule only if there is no pending or running action with same name and params. * * @param string $hook The hook to trigger when this action runs. * @param array $args Args to pass when the hook is triggered. * @param int $base_timestamp The first instance of the action will be scheduled * to run at a time calculated after this timestamp matching the cron * expression. This can be used to delay the first instance of the action. * @param int $schedule A cron definition string. * @param string $group A group to put the action in. * @param bool $unique Whether action scheduled should be unique. * * @return int The ID of the stored action. **/ public function cron_unique( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '', $unique = true ) { if ( empty( $schedule ) ) { return $this->single_unique( $hook, $args, $base_timestamp, $group, $unique ); } $date = as_get_datetime_object( $base_timestamp ); $cron = CronExpression::factory( $schedule ); $schedule = new ActionScheduler_CronSchedule( $date, $cron ); $action = new ActionScheduler_Action( $hook, $args, $schedule, $group ); return $unique ? $this->store_unique_action( $action ) : $this->store( $action ); } /** * Create a successive instance of a recurring or cron action. * * Importantly, the action will be rescheduled to run based on the current date/time. * That means when the action is scheduled to run in the past, the next scheduled date * will be pushed forward. For example, if a recurring action set to run every hour * was scheduled to run 5 seconds ago, it will be next scheduled for 1 hour in the * future, which is 1 hour and 5 seconds from when it was last scheduled to run. * * Alternatively, if the action is scheduled to run in the future, and is run early, * likely via manual intervention, then its schedule will change based on the time now. * For example, if a recurring action set to run every day, and is run 12 hours early, * it will run again in 24 hours, not 36 hours. * * This slippage is less of an issue with Cron actions, as the specific run time can * be set for them to run, e.g. 1am each day. In those cases, and entire period would * need to be missed before there was any change is scheduled, e.g. in the case of an * action scheduled for 1am each day, the action would need to run an entire day late. * * @param ActionScheduler_Action $action The existing action. * * @return string The ID of the stored action * @throws InvalidArgumentException If $action is not a recurring action. */ public function repeat( $action ) { $schedule = $action->get_schedule(); $next = $schedule->get_next( as_get_datetime_object() ); if ( is_null( $next ) || ! $schedule->is_recurring() ) { throw new InvalidArgumentException( __( 'Invalid action - must be a recurring action.', 'woocommerce' ) ); } $schedule_class = get_class( $schedule ); $new_schedule = new $schedule( $next, $schedule->get_recurrence(), $schedule->get_first_date() ); $new_action = new ActionScheduler_Action( $action->get_hook(), $action->get_args(), $new_schedule, $action->get_group() ); $new_action->set_priority( $action->get_priority() ); return $this->store( $new_action ); } /** * Creates a scheduled action. * * This general purpose method can be used in place of specific methods such as async(), * async_unique(), single() or single_unique(), etc. * * @internal Not intended for public use, should not be overridden by subclasses. * * @param array $options { * Describes the action we wish to schedule. * * @type string $type Must be one of 'async', 'cron', 'recurring', or 'single'. * @type string $hook The hook to be executed. * @type array $arguments Arguments to be passed to the callback. * @type string $group The action group. * @type bool $unique If the action should be unique. * @type int $when Timestamp. Indicates when the action, or first instance of the action in the case * of recurring or cron actions, becomes due. * @type int|string $pattern Recurrence pattern. This is either an interval in seconds for recurring actions * or a cron expression for cron actions. * @type int $priority Lower values means higher priority. Should be in the range 0-255. * } * * @return int The action ID. Zero if there was an error scheduling the action. */ public function create( array $options = array() ) { $defaults = array( 'type' => 'single', 'hook' => '', 'arguments' => array(), 'group' => '', 'unique' => false, 'when' => time(), 'pattern' => null, 'priority' => 10, ); $options = array_merge( $defaults, $options ); // Cron/recurring actions without a pattern are treated as single actions (this gives calling code the ability // to use functions like as_schedule_recurring_action() to schedule recurring as well as single actions). if ( ( 'cron' === $options['type'] || 'recurring' === $options['type'] ) && empty( $options['pattern'] ) ) { $options['type'] = 'single'; } switch ( $options['type'] ) { case 'async': $schedule = new ActionScheduler_NullSchedule(); break; case 'cron': $date = as_get_datetime_object( $options['when'] ); $cron = CronExpression::factory( $options['pattern'] ); $schedule = new ActionScheduler_CronSchedule( $date, $cron ); break; case 'recurring': $date = as_get_datetime_object( $options['when'] ); $schedule = new ActionScheduler_IntervalSchedule( $date, $options['pattern'] ); break; case 'single': $date = as_get_datetime_object( $options['when'] ); $schedule = new ActionScheduler_SimpleSchedule( $date ); break; default: // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log error_log( "Unknown action type '{$options['type']}' specified when trying to create an action for '{$options['hook']}'." ); return 0; } $action = new ActionScheduler_Action( $options['hook'], $options['arguments'], $schedule, $options['group'] ); $action->set_priority( $options['priority'] ); $action_id = 0; try { $action_id = $options['unique'] ? $this->store_unique_action( $action ) : $this->store( $action ); } catch ( Exception $e ) { // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log error_log( sprintf( /* translators: %1$s is the name of the hook to be enqueued, %2$s is the exception message. */ __( 'Caught exception while enqueuing action "%1$s": %2$s', 'woocommerce' ), $options['hook'], $e->getMessage() ) ); } return $action_id; } /** * Save action to database. * * @param ActionScheduler_Action $action Action object to save. * * @return int The ID of the stored action */ protected function store( ActionScheduler_Action $action ) { $store = ActionScheduler_Store::instance(); return $store->save_action( $action ); } /** * Store action if it's unique. * * @param ActionScheduler_Action $action Action object to store. * * @return int ID of the created action. Will be 0 if action was not created. */ protected function store_unique_action( ActionScheduler_Action $action ) { $store = ActionScheduler_Store::instance(); if ( method_exists( $store, 'save_unique_action' ) ) { return $store->save_unique_action( $action ); } else { /** * Fallback to non-unique action if the store doesn't support unique actions. * We try to save the action as unique, accepting that there might be a race condition. * This is likely still better than giving up on unique actions entirely. */ $existing_action_id = (int) $store->find_action( $action->get_hook(), array( 'args' => $action->get_args(), 'status' => ActionScheduler_Store::STATUS_PENDING, 'group' => $action->get_group(), ) ); if ( $existing_action_id > 0 ) { return 0; } return $store->save_action( $action ); } } } action-scheduler/classes/actions/ActionScheduler_NullAction.php 0000777 00000001131 15252010675 0021015 0 ustar 00 <?php /** * Class ActionScheduler_NullAction */ class ActionScheduler_NullAction extends ActionScheduler_Action { /** * Construct. * * @param string $hook Action hook. * @param mixed[] $args Action arguments. * @param null|ActionScheduler_Schedule $schedule Action schedule. */ public function __construct( $hook = '', array $args = array(), ?ActionScheduler_Schedule $schedule = null ) { $this->set_schedule( new ActionScheduler_NullSchedule() ); } /** * Execute action. */ public function execute() { // don't execute. } } action-scheduler/classes/actions/ActionScheduler_CanceledAction.php 0000777 00000001563 15252010675 0021612 0 ustar 00 <?php /** * Class ActionScheduler_CanceledAction * * Stored action which was canceled and therefore acts like a finished action but should always return a null schedule, * regardless of schedule passed to its constructor. */ class ActionScheduler_CanceledAction extends ActionScheduler_FinishedAction { /** * Construct. * * @param string $hook Action's hook. * @param array $args Action's arguments. * @param null|ActionScheduler_Schedule $schedule Action's schedule. * @param string $group Action's group. */ public function __construct( $hook, array $args = array(), ?ActionScheduler_Schedule $schedule = null, $group = '' ) { parent::__construct( $hook, $args, $schedule, $group ); if ( is_null( $schedule ) ) { $this->set_schedule( new ActionScheduler_NullSchedule() ); } } } action-scheduler/classes/actions/ActionScheduler_FinishedAction.php 0000777 00000000450 15252010675 0021637 0 ustar 00 <?php /** * Class ActionScheduler_FinishedAction */ class ActionScheduler_FinishedAction extends ActionScheduler_Action { /** * Execute action. */ public function execute() { // don't execute. } /** * Get finished state. */ public function is_finished() { return true; } } action-scheduler/classes/actions/ActionScheduler_Action.php 0000777 00000007503 15252010675 0020173 0 ustar 00 <?php /** * Class ActionScheduler_Action */ class ActionScheduler_Action { /** * Action's hook. * * @var string */ protected $hook = ''; /** * Action's args. * * @var array<string, mixed> */ protected $args = array(); /** * Action's schedule. * * @var ActionScheduler_Schedule */ protected $schedule = null; /** * Action's group. * * @var string */ protected $group = ''; /** * Priorities are conceptually similar to those used for regular WordPress actions. * Like those, a lower priority takes precedence over a higher priority and the default * is 10. * * Unlike regular WordPress actions, the priority of a scheduled action is strictly an * integer and should be kept within the bounds 0-255 (anything outside the bounds will * be brought back into the acceptable range). * * @var int */ protected $priority = 10; /** * Construct. * * @param string $hook Action's hook. * @param mixed[] $args Action's arguments. * @param null|ActionScheduler_Schedule $schedule Action's schedule. * @param string $group Action's group. */ public function __construct( $hook, array $args = array(), ?ActionScheduler_Schedule $schedule = null, $group = '' ) { $schedule = empty( $schedule ) ? new ActionScheduler_NullSchedule() : $schedule; $this->set_hook( $hook ); $this->set_schedule( $schedule ); $this->set_args( $args ); $this->set_group( $group ); } /** * Executes the action. * * If no callbacks are registered, an exception will be thrown and the action will not be * fired. This is useful to help detect cases where the code responsible for setting up * a scheduled action no longer exists. * * @throws Exception If no callbacks are registered for this action. */ public function execute() { $hook = $this->get_hook(); if ( ! has_action( $hook ) ) { throw new Exception( sprintf( /* translators: 1: action hook. */ __( 'Scheduled action for %1$s will not be executed as no callbacks are registered.', 'woocommerce' ), $hook ) ); } do_action_ref_array( $hook, array_values( $this->get_args() ) ); } /** * Set action's hook. * * @param string $hook Action's hook. */ protected function set_hook( $hook ) { $this->hook = $hook; } /** * Get action's hook. */ public function get_hook() { return $this->hook; } /** * Set action's schedule. * * @param ActionScheduler_Schedule $schedule Action's schedule. */ protected function set_schedule( ActionScheduler_Schedule $schedule ) { $this->schedule = $schedule; } /** * Action's schedule. * * @return ActionScheduler_Schedule */ public function get_schedule() { return $this->schedule; } /** * Set action's args. * * @param mixed[] $args Action's arguments. */ protected function set_args( array $args ) { $this->args = $args; } /** * Get action's args. */ public function get_args() { return $this->args; } /** * Section action's group. * * @param string $group Action's group. */ protected function set_group( $group ) { $this->group = $group; } /** * Action's group. * * @return string */ public function get_group() { return $this->group; } /** * Action has not finished. * * @return bool */ public function is_finished() { return false; } /** * Sets the priority of the action. * * @param int $priority Priority level (lower is higher priority). Should be in the range 0-255. * * @return void */ public function set_priority( $priority ) { if ( $priority < 0 ) { $priority = 0; } elseif ( $priority > 255 ) { $priority = 255; } $this->priority = (int) $priority; } /** * Gets the action priority. * * @return int */ public function get_priority() { return $this->priority; } } action-scheduler/classes/ActionScheduler_DataController.php 0000777 00000013177 15252010675 0020237 0 ustar 00 <?php use Action_Scheduler\Migration\Controller; /** * Class ActionScheduler_DataController * * The main plugin/initialization class for the data stores. * * Responsible for hooking everything up with WordPress. * * @package Action_Scheduler * * @since 3.0.0 */ class ActionScheduler_DataController { /** Action data store class name. */ const DATASTORE_CLASS = 'ActionScheduler_DBStore'; /** Logger data store class name. */ const LOGGER_CLASS = 'ActionScheduler_DBLogger'; /** Migration status option name. */ const STATUS_FLAG = 'action_scheduler_migration_status'; /** Migration status option value. */ const STATUS_COMPLETE = 'complete'; /** Migration minimum required PHP version. */ const MIN_PHP_VERSION = '5.5'; /** * Instance. * * @var ActionScheduler_DataController */ private static $instance; /** * Sleep time in seconds. * * @var int */ private static $sleep_time = 0; /** * Tick count required for freeing memory. * * @var int */ private static $free_ticks = 50; /** * Get a flag indicating whether the migration environment dependencies are met. * * @return bool */ public static function dependencies_met() { $php_support = version_compare( PHP_VERSION, self::MIN_PHP_VERSION, '>=' ); return $php_support && apply_filters( 'action_scheduler_migration_dependencies_met', true ); } /** * Get a flag indicating whether the migration is complete. * * @return bool Whether the flag has been set marking the migration as complete */ public static function is_migration_complete() { return get_option( self::STATUS_FLAG ) === self::STATUS_COMPLETE; } /** * Mark the migration as complete. */ public static function mark_migration_complete() { update_option( self::STATUS_FLAG, self::STATUS_COMPLETE ); } /** * Unmark migration when a plugin is de-activated. Will not work in case of silent activation, for example in an update. * We do this to mitigate the bug of lost actions which happens if there was an AS 2.x to AS 3.x migration in the past, but that plugin is now * deactivated and the site was running on AS 2.x again. */ public static function mark_migration_incomplete() { delete_option( self::STATUS_FLAG ); } /** * Set the action store class name. * * @param string $class Classname of the store class. * * @return string */ public static function set_store_class( $class ) { return self::DATASTORE_CLASS; } /** * Set the action logger class name. * * @param string $class Classname of the logger class. * * @return string */ public static function set_logger_class( $class ) { return self::LOGGER_CLASS; } /** * Set the sleep time in seconds. * * @param integer $sleep_time The number of seconds to pause before resuming operation. */ public static function set_sleep_time( $sleep_time ) { self::$sleep_time = (int) $sleep_time; } /** * Set the tick count required for freeing memory. * * @param integer $free_ticks The number of ticks to free memory on. */ public static function set_free_ticks( $free_ticks ) { self::$free_ticks = (int) $free_ticks; } /** * Free memory if conditions are met. * * @param int $ticks Current tick count. */ public static function maybe_free_memory( $ticks ) { if ( self::$free_ticks && 0 === $ticks % self::$free_ticks ) { self::free_memory(); } } /** * Reduce memory footprint by clearing the database query and object caches. */ public static function free_memory() { if ( 0 < self::$sleep_time ) { /* translators: %d: amount of time */ \WP_CLI::warning( sprintf( _n( 'Stopped the insanity for %d second', 'Stopped the insanity for %d seconds', self::$sleep_time, 'woocommerce' ), self::$sleep_time ) ); sleep( self::$sleep_time ); } \WP_CLI::warning( __( 'Attempting to reduce used memory...', 'woocommerce' ) ); /** * Globals. * * @var $wpdb \wpdb * @var $wp_object_cache \WP_Object_Cache */ global $wpdb, $wp_object_cache; $wpdb->queries = array(); if ( ! is_a( $wp_object_cache, 'WP_Object_Cache' ) ) { return; } // Not all drop-ins support these props, however, there may be existing installations that rely on these being cleared. if ( property_exists( $wp_object_cache, 'group_ops' ) ) { $wp_object_cache->group_ops = array(); } if ( property_exists( $wp_object_cache, 'stats' ) ) { $wp_object_cache->stats = array(); } if ( property_exists( $wp_object_cache, 'memcache_debug' ) ) { $wp_object_cache->memcache_debug = array(); } if ( property_exists( $wp_object_cache, 'cache' ) ) { $wp_object_cache->cache = array(); } if ( is_callable( array( $wp_object_cache, '__remoteset' ) ) ) { call_user_func( array( $wp_object_cache, '__remoteset' ) ); // important! } } /** * Connect to table datastores if migration is complete. * Otherwise, proceed with the migration if the dependencies have been met. */ public static function init() { if ( self::is_migration_complete() ) { add_filter( 'action_scheduler_store_class', array( 'ActionScheduler_DataController', 'set_store_class' ), 100 ); add_filter( 'action_scheduler_logger_class', array( 'ActionScheduler_DataController', 'set_logger_class' ), 100 ); add_action( 'deactivate_plugin', array( 'ActionScheduler_DataController', 'mark_migration_incomplete' ) ); } elseif ( self::dependencies_met() ) { Controller::init(); } add_action( 'action_scheduler/progress_tick', array( 'ActionScheduler_DataController', 'maybe_free_memory' ) ); } /** * Singleton factory. */ public static function instance() { if ( ! isset( self::$instance ) ) { self::$instance = new static(); } return self::$instance; } } action-scheduler/classes/ActionScheduler_QueueRunner.php 0000777 00000022763 15252010675 0017601 0 ustar 00 <?php /** * Class ActionScheduler_QueueRunner */ class ActionScheduler_QueueRunner extends ActionScheduler_Abstract_QueueRunner { const WP_CRON_HOOK = 'action_scheduler_run_queue'; const WP_CRON_SCHEDULE = 'every_minute'; /** * ActionScheduler_AsyncRequest_QueueRunner instance. * * @var ActionScheduler_AsyncRequest_QueueRunner */ protected $async_request; /** * ActionScheduler_QueueRunner instance. * * @var ActionScheduler_QueueRunner */ private static $runner = null; /** * Number of processed actions. * * @var int */ private $processed_actions_count = 0; /** * Get instance. * * @return ActionScheduler_QueueRunner * @codeCoverageIgnore */ public static function instance() { if ( empty( self::$runner ) ) { $class = apply_filters( 'action_scheduler_queue_runner_class', 'ActionScheduler_QueueRunner' ); self::$runner = new $class(); } return self::$runner; } /** * ActionScheduler_QueueRunner constructor. * * @param ActionScheduler_Store|null $store Store object. * @param ActionScheduler_FatalErrorMonitor|null $monitor Monitor object. * @param ActionScheduler_QueueCleaner|null $cleaner Cleaner object. * @param ActionScheduler_AsyncRequest_QueueRunner|null $async_request Async request runner object. */ public function __construct( ?ActionScheduler_Store $store = null, ?ActionScheduler_FatalErrorMonitor $monitor = null, ?ActionScheduler_QueueCleaner $cleaner = null, ?ActionScheduler_AsyncRequest_QueueRunner $async_request = null ) { parent::__construct( $store, $monitor, $cleaner ); if ( is_null( $async_request ) ) { $async_request = new ActionScheduler_AsyncRequest_QueueRunner( $this->store ); } $this->async_request = $async_request; } /** * Initialize. * * @codeCoverageIgnore */ public function init() { add_filter( 'cron_schedules', array( self::instance(), 'add_wp_cron_schedule' ) ); // phpcs:ignore WordPress.WP.CronInterval.CronSchedulesInterval // Check for and remove any WP Cron hook scheduled by Action Scheduler < 3.0.0, which didn't include the $context param. $next_timestamp = wp_next_scheduled( self::WP_CRON_HOOK ); if ( $next_timestamp ) { wp_unschedule_event( $next_timestamp, self::WP_CRON_HOOK ); } $cron_context = array( 'WP Cron' ); if ( ! wp_next_scheduled( self::WP_CRON_HOOK, $cron_context ) ) { $schedule = apply_filters( 'action_scheduler_run_schedule', self::WP_CRON_SCHEDULE ); wp_schedule_event( time(), $schedule, self::WP_CRON_HOOK, $cron_context ); } add_action( self::WP_CRON_HOOK, array( self::instance(), 'run' ) ); $this->hook_dispatch_async_request(); } /** * Hook check for dispatching an async request. */ public function hook_dispatch_async_request() { add_action( 'shutdown', array( $this, 'maybe_dispatch_async_request' ) ); } /** * Unhook check for dispatching an async request. */ public function unhook_dispatch_async_request() { remove_action( 'shutdown', array( $this, 'maybe_dispatch_async_request' ) ); } /** * Check if we should dispatch an async request to process actions. * * This method is attached to 'shutdown', so is called frequently. To avoid slowing down * the site, it mitigates the work performed in each request by: * 1. checking if it's in the admin context and then * 2. haven't run on the 'shutdown' hook within the lock time (60 seconds by default) * 3. haven't exceeded the number of allowed batches. * * The order of these checks is important, because they run from a check on a value: * 1. in memory - is_admin() maps to $GLOBALS or the WP_ADMIN constant * 2. in memory - transients use autoloaded options by default * 3. from a database query - has_maximum_concurrent_batches() run the query * $this->store->get_claim_count() to find the current number of claims in the DB. * * If all of these conditions are met, then we request an async runner check whether it * should dispatch a request to process pending actions. */ public function maybe_dispatch_async_request() { // Only start an async queue at most once every 60 seconds. if ( is_admin() && ! ActionScheduler::lock()->is_locked( 'async-request-runner' ) && ActionScheduler::lock()->set( 'async-request-runner' ) ) { $this->async_request->maybe_dispatch(); } } /** * Process actions in the queue. Attached to self::WP_CRON_HOOK i.e. 'action_scheduler_run_queue' * * The $context param of this method defaults to 'WP Cron', because prior to Action Scheduler 3.0.0 * that was the only context in which this method was run, and the self::WP_CRON_HOOK hook had no context * passed along with it. New code calling this method directly, or by triggering the self::WP_CRON_HOOK, * should set a context as the first parameter. For an example of this, refer to the code seen in * * @see ActionScheduler_AsyncRequest_QueueRunner::handle() * * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron' * Generally, this should be capitalised and not localised as it's a proper noun. * @return int The number of actions processed. */ public function run( $context = 'WP Cron' ) { ActionScheduler_Compatibility::raise_memory_limit(); ActionScheduler_Compatibility::raise_time_limit( $this->get_time_limit() ); do_action( 'action_scheduler_before_process_queue' ); $this->run_cleanup(); $this->processed_actions_count = 0; if ( false === $this->has_maximum_concurrent_batches() ) { do { $batch_size = apply_filters( 'action_scheduler_queue_runner_batch_size', 25 ); $processed_actions_in_batch = $this->do_batch( $batch_size, $context ); $this->processed_actions_count += $processed_actions_in_batch; } while ( $processed_actions_in_batch > 0 && ! $this->batch_limits_exceeded( $this->processed_actions_count ) ); // keep going until we run out of actions, time, or memory. } do_action( 'action_scheduler_after_process_queue' ); return $this->processed_actions_count; } /** * Process a batch of actions pending in the queue. * * Actions are processed by claiming a set of pending actions then processing each one until either the batch * size is completed, or memory or time limits are reached, defined by @see $this->batch_limits_exceeded(). * * @param int $size The maximum number of actions to process in the batch. * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron' * Generally, this should be capitalised and not localised as it's a proper noun. * @return int The number of actions processed. */ protected function do_batch( $size = 100, $context = '' ) { $claim = $this->store->stake_claim( $size ); $this->monitor->attach( $claim ); $processed_actions = 0; foreach ( $claim->get_actions() as $action_id ) { // bail if we lost the claim. if ( ! in_array( $action_id, $this->store->find_actions_by_claim_id( $claim->get_id() ), true ) ) { break; } $this->process_action( $action_id, $context ); $processed_actions++; if ( $this->batch_limits_exceeded( $processed_actions + $this->processed_actions_count ) ) { break; } } $this->store->release_claim( $claim ); $this->monitor->detach(); $this->clear_caches(); return $processed_actions; } /** * Flush the cache if possible (intended for use after a batch of actions has been processed). * * This is useful because running large batches can eat up memory and because invalid data can accrue in the * runtime cache, which may lead to unexpected results. */ protected function clear_caches() { /* * Calling wp_cache_flush_runtime() lets us clear the runtime cache without invalidating the external object * cache, so we will always prefer this method (as compared to calling wp_cache_flush()) when it is available. * * However, this function was only introduced in WordPress 6.0. Additionally, the preferred way of detecting if * it is supported changed in WordPress 6.1 so we use two different methods to decide if we should utilize it. */ $flushing_runtime_cache_explicitly_supported = function_exists( 'wp_cache_supports' ) && wp_cache_supports( 'flush_runtime' ); $flushing_runtime_cache_implicitly_supported = ! function_exists( 'wp_cache_supports' ) && function_exists( 'wp_cache_flush_runtime' ); if ( $flushing_runtime_cache_explicitly_supported || $flushing_runtime_cache_implicitly_supported ) { wp_cache_flush_runtime(); } elseif ( ! wp_using_ext_object_cache() /** * When an external object cache is in use, and when wp_cache_flush_runtime() is not available, then * normally the cache will not be flushed after processing a batch of actions (to avoid a performance * penalty for other processes). * * This filter makes it possible to override this behavior and always flush the cache, even if an external * object cache is in use. * * @since 1.0 * * @param bool $flush_cache If the cache should be flushed. */ || apply_filters( 'action_scheduler_queue_runner_flush_cache', false ) ) { wp_cache_flush(); } } /** * Add schedule to WP cron. * * @param array<string, array<string, int|string>> $schedules Schedules. * @return array<string, array<string, int|string>> */ public function add_wp_cron_schedule( $schedules ) { $schedules['every_minute'] = array( 'interval' => 60, // in seconds. 'display' => __( 'Every minute', 'woocommerce' ), ); return $schedules; } } action-scheduler/classes/ActionScheduler_Exception.php 0000777 00000000317 15252010675 0017250 0 ustar 00 <?php /** * ActionScheduler Exception Interface. * * Facilitates catching Exceptions unique to Action Scheduler. * * @package ActionScheduler * @since 2.1.0 */ interface ActionScheduler_Exception {} action-scheduler/classes/ActionScheduler_ListTable.php 0000777 00000051675 15252010675 0017212 0 ustar 00 <?php /** * Implements the admin view of the actions. * * @codeCoverageIgnore */ class ActionScheduler_ListTable extends ActionScheduler_Abstract_ListTable { /** * The package name. * * @var string */ protected $package = 'action-scheduler'; /** * Columns to show (name => label). * * @var array */ protected $columns = array(); /** * Actions (name => label). * * @var array */ protected $row_actions = array(); /** * The active data stores * * @var ActionScheduler_Store */ protected $store; /** * A logger to use for getting action logs to display * * @var ActionScheduler_Logger */ protected $logger; /** * A ActionScheduler_QueueRunner runner instance (or child class) * * @var ActionScheduler_QueueRunner */ protected $runner; /** * Bulk actions. The key of the array is the method name of the implementation. * Example: bulk_<key>(array $ids, string $sql_in). * * See the comments in the parent class for further details * * @var array */ protected $bulk_actions = array(); /** * Flag variable to render our notifications, if any, once. * * @var bool */ protected static $did_notification = false; /** * Array of seconds for common time periods, like week or month, alongside an internationalised string representation, i.e. "Day" or "Days" * * @var array */ private static $time_periods; /** * Sets the current data store object into `store->action` and initialises the object. * * @param ActionScheduler_Store $store Store object. * @param ActionScheduler_Logger $logger Logger object. * @param ActionScheduler_QueueRunner $runner Runner object. */ public function __construct( ActionScheduler_Store $store, ActionScheduler_Logger $logger, ActionScheduler_QueueRunner $runner ) { $this->store = $store; $this->logger = $logger; $this->runner = $runner; $this->table_header = __( 'Scheduled Actions', 'woocommerce' ); $this->bulk_actions = array( 'delete' => __( 'Delete', 'woocommerce' ), ); $this->columns = array( 'hook' => __( 'Hook', 'woocommerce' ), 'status' => __( 'Status', 'woocommerce' ), 'args' => __( 'Arguments', 'woocommerce' ), 'group' => __( 'Group', 'woocommerce' ), 'recurrence' => __( 'Recurrence', 'woocommerce' ), 'schedule' => __( 'Scheduled Date', 'woocommerce' ), 'log_entries' => __( 'Log', 'woocommerce' ), ); $this->sort_by = array( 'schedule', 'hook', 'group', ); $this->search_by = array( 'hook', 'args', 'claim_id', ); $request_status = $this->get_request_status(); if ( empty( $request_status ) ) { $this->sort_by[] = 'status'; } elseif ( in_array( $request_status, array( 'in-progress', 'failed' ), true ) ) { $this->columns += array( 'claim_id' => __( 'Claim ID', 'woocommerce' ) ); $this->sort_by[] = 'claim_id'; } $this->row_actions = array( 'hook' => array( 'run' => array( 'name' => __( 'Run', 'woocommerce' ), 'desc' => __( 'Process the action now as if it were run as part of a queue', 'woocommerce' ), ), 'cancel' => array( 'name' => __( 'Cancel', 'woocommerce' ), 'desc' => __( 'Cancel the action now to avoid it being run in future', 'woocommerce' ), 'class' => 'cancel trash', ), ), ); self::$time_periods = array( array( 'seconds' => YEAR_IN_SECONDS, /* translators: %s: amount of time */ 'names' => _n_noop( '%s year', '%s years', 'woocommerce' ), ), array( 'seconds' => MONTH_IN_SECONDS, /* translators: %s: amount of time */ 'names' => _n_noop( '%s month', '%s months', 'woocommerce' ), ), array( 'seconds' => WEEK_IN_SECONDS, /* translators: %s: amount of time */ 'names' => _n_noop( '%s week', '%s weeks', 'woocommerce' ), ), array( 'seconds' => DAY_IN_SECONDS, /* translators: %s: amount of time */ 'names' => _n_noop( '%s day', '%s days', 'woocommerce' ), ), array( 'seconds' => HOUR_IN_SECONDS, /* translators: %s: amount of time */ 'names' => _n_noop( '%s hour', '%s hours', 'woocommerce' ), ), array( 'seconds' => MINUTE_IN_SECONDS, /* translators: %s: amount of time */ 'names' => _n_noop( '%s minute', '%s minutes', 'woocommerce' ), ), array( 'seconds' => 1, /* translators: %s: amount of time */ 'names' => _n_noop( '%s second', '%s seconds', 'woocommerce' ), ), ); parent::__construct( array( 'singular' => 'action-scheduler', 'plural' => 'action-scheduler', 'ajax' => false, ) ); add_screen_option( 'per_page', array( 'default' => $this->items_per_page, ) ); add_filter( 'set_screen_option_' . $this->get_per_page_option_name(), array( $this, 'set_items_per_page_option' ), 10, 3 ); set_screen_options(); } /** * Handles setting the items_per_page option for this screen. * * @param mixed $status Default false (to skip saving the current option). * @param string $option Screen option name. * @param int $value Screen option value. * @return int */ public function set_items_per_page_option( $status, $option, $value ) { return $value; } /** * Convert an interval of seconds into a two part human friendly string. * * The WordPress human_time_diff() function only calculates the time difference to one degree, meaning * even if an action is 1 day and 11 hours away, it will display "1 day". This function goes one step * further to display two degrees of accuracy. * * Inspired by the Crontrol::interval() function by Edward Dale: https://wordpress.org/plugins/wp-crontrol/ * * @param int $interval A interval in seconds. * @param int $periods_to_include Depth of time periods to include, e.g. for an interval of 70, and $periods_to_include of 2, both minutes and seconds would be included. With a value of 1, only minutes would be included. * @return string A human friendly string representation of the interval. */ private static function human_interval( $interval, $periods_to_include = 2 ) { if ( $interval <= 0 ) { return __( 'Now!', 'woocommerce' ); } $output = ''; $num_time_periods = count( self::$time_periods ); for ( $time_period_index = 0, $periods_included = 0, $seconds_remaining = $interval; $time_period_index < $num_time_periods && $seconds_remaining > 0 && $periods_included < $periods_to_include; $time_period_index++ ) { $periods_in_interval = floor( $seconds_remaining / self::$time_periods[ $time_period_index ]['seconds'] ); if ( $periods_in_interval > 0 ) { if ( ! empty( $output ) ) { $output .= ' '; } $output .= sprintf( translate_nooped_plural( self::$time_periods[ $time_period_index ]['names'], $periods_in_interval, 'action-scheduler' ), $periods_in_interval ); $seconds_remaining -= $periods_in_interval * self::$time_periods[ $time_period_index ]['seconds']; $periods_included++; } } return $output; } /** * Returns the recurrence of an action or 'Non-repeating'. The output is human readable. * * @param ActionScheduler_Action $action Action object. * * @return string */ protected function get_recurrence( $action ) { $schedule = $action->get_schedule(); if ( $schedule->is_recurring() && method_exists( $schedule, 'get_recurrence' ) ) { $recurrence = $schedule->get_recurrence(); if ( is_numeric( $recurrence ) ) { /* translators: %s: time interval */ return sprintf( __( 'Every %s', 'woocommerce' ), self::human_interval( $recurrence ) ); } else { return $recurrence; } } return __( 'Non-repeating', 'woocommerce' ); } /** * Serializes the argument of an action to render it in a human friendly format. * * @param array $row The array representation of the current row of the table. * * @return string */ public function column_args( array $row ) { if ( empty( $row['args'] ) ) { return apply_filters( 'action_scheduler_list_table_column_args', '', $row ); } $row_html = '<ul>'; foreach ( $row['args'] as $key => $value ) { $row_html .= sprintf( '<li><code>%s => %s</code></li>', esc_html( var_export( $key, true ) ), esc_html( var_export( $value, true ) ) ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export } $row_html .= '</ul>'; return apply_filters( 'action_scheduler_list_table_column_args', $row_html, $row ); } /** * Prints the logs entries inline. We do so to avoid loading Javascript and other hacks to show it in a modal. * * @param array $row Action array. * @return string */ public function column_log_entries( array $row ) { $log_entries_html = '<ol>'; $timezone = new DateTimezone( 'UTC' ); foreach ( $row['log_entries'] as $log_entry ) { $log_entries_html .= $this->get_log_entry_html( $log_entry, $timezone ); } $log_entries_html .= '</ol>'; return $log_entries_html; } /** * Prints the logs entries inline. We do so to avoid loading Javascript and other hacks to show it in a modal. * * @param ActionScheduler_LogEntry $log_entry Log entry object. * @param DateTimezone $timezone Timestamp. * @return string */ protected function get_log_entry_html( ActionScheduler_LogEntry $log_entry, DateTimezone $timezone ) { $date = $log_entry->get_date(); $date->setTimezone( $timezone ); return sprintf( '<li><strong>%s</strong><br/>%s</li>', esc_html( $date->format( 'Y-m-d H:i:s O' ) ), esc_html( $log_entry->get_message() ) ); } /** * Only display row actions for pending actions. * * @param array $row Row to render. * @param string $column_name Current row. * * @return string */ protected function maybe_render_actions( $row, $column_name ) { if ( 'pending' === strtolower( $row['status_name'] ) ) { return parent::maybe_render_actions( $row, $column_name ); } return ''; } /** * Renders admin notifications * * Notifications: * 1. When the maximum number of tasks are being executed simultaneously. * 2. Notifications when a task is manually executed. * 3. Tables are missing. */ public function display_admin_notices() { global $wpdb; if ( ( is_a( $this->store, 'ActionScheduler_HybridStore' ) || is_a( $this->store, 'ActionScheduler_DBStore' ) ) && apply_filters( 'action_scheduler_enable_recreate_data_store', true ) ) { $table_list = array( 'actionscheduler_actions', 'actionscheduler_logs', 'actionscheduler_groups', 'actionscheduler_claims', ); $found_tables = $wpdb->get_col( "SHOW TABLES LIKE '{$wpdb->prefix}actionscheduler%'" ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared foreach ( $table_list as $table_name ) { if ( ! in_array( $wpdb->prefix . $table_name, $found_tables, true ) ) { $this->admin_notices[] = array( 'class' => 'error', 'message' => __( 'It appears one or more database tables were missing. Attempting to re-create the missing table(s).', 'woocommerce' ), ); $this->recreate_tables(); parent::display_admin_notices(); return; } } } if ( $this->runner->has_maximum_concurrent_batches() ) { $claim_count = $this->store->get_claim_count(); $this->admin_notices[] = array( 'class' => 'updated', 'message' => sprintf( /* translators: %s: amount of claims */ _n( 'Maximum simultaneous queues already in progress (%s queue). No additional queues will begin processing until the current queues are complete.', 'Maximum simultaneous queues already in progress (%s queues). No additional queues will begin processing until the current queues are complete.', $claim_count, 'woocommerce' ), $claim_count ), ); } elseif ( $this->store->has_pending_actions_due() ) { $async_request_lock_expiration = ActionScheduler::lock()->get_expiration( 'async-request-runner' ); // No lock set or lock expired. if ( false === $async_request_lock_expiration || $async_request_lock_expiration < time() ) { $in_progress_url = add_query_arg( 'status', 'in-progress', remove_query_arg( 'status' ) ); /* translators: %s: process URL */ $async_request_message = sprintf( __( 'A new queue has begun processing. <a href="%s">View actions in-progress »</a>', 'woocommerce' ), esc_url( $in_progress_url ) ); } else { /* translators: %d: seconds */ $async_request_message = sprintf( __( 'The next queue will begin processing in approximately %d seconds.', 'woocommerce' ), $async_request_lock_expiration - time() ); } $this->admin_notices[] = array( 'class' => 'notice notice-info', 'message' => $async_request_message, ); } $notification = get_transient( 'action_scheduler_admin_notice' ); if ( is_array( $notification ) ) { delete_transient( 'action_scheduler_admin_notice' ); $action = $this->store->fetch_action( $notification['action_id'] ); $action_hook_html = '<strong><code>' . $action->get_hook() . '</code></strong>'; if ( 1 === absint( $notification['success'] ) ) { $class = 'updated'; switch ( $notification['row_action_type'] ) { case 'run': /* translators: %s: action HTML */ $action_message_html = sprintf( __( 'Successfully executed action: %s', 'woocommerce' ), $action_hook_html ); break; case 'cancel': /* translators: %s: action HTML */ $action_message_html = sprintf( __( 'Successfully canceled action: %s', 'woocommerce' ), $action_hook_html ); break; default: /* translators: %s: action HTML */ $action_message_html = sprintf( __( 'Successfully processed change for action: %s', 'woocommerce' ), $action_hook_html ); break; } } else { $class = 'error'; /* translators: 1: action HTML 2: action ID 3: error message */ $action_message_html = sprintf( __( 'Could not process change for action: "%1$s" (ID: %2$d). Error: %3$s', 'woocommerce' ), $action_hook_html, esc_html( $notification['action_id'] ), esc_html( $notification['error_message'] ) ); } $action_message_html = apply_filters( 'action_scheduler_admin_notice_html', $action_message_html, $action, $notification ); $this->admin_notices[] = array( 'class' => $class, 'message' => $action_message_html, ); } parent::display_admin_notices(); } /** * Prints the scheduled date in a human friendly format. * * @param array $row The array representation of the current row of the table. * * @return string */ public function column_schedule( $row ) { return $this->get_schedule_display_string( $row['schedule'] ); } /** * Get the scheduled date in a human friendly format. * * @param ActionScheduler_Schedule $schedule Action's schedule. * @return string */ protected function get_schedule_display_string( ActionScheduler_Schedule $schedule ) { $schedule_display_string = ''; if ( is_a( $schedule, 'ActionScheduler_NullSchedule' ) ) { return __( 'async', 'woocommerce' ); } if ( ! method_exists( $schedule, 'get_date' ) || ! $schedule->get_date() ) { return '0000-00-00 00:00:00'; } $next_timestamp = $schedule->get_date()->getTimestamp(); $schedule_display_string .= $schedule->get_date()->format( 'Y-m-d H:i:s O' ); $schedule_display_string .= '<br/>'; if ( gmdate( 'U' ) > $next_timestamp ) { /* translators: %s: date interval */ $schedule_display_string .= sprintf( __( ' (%s ago)', 'woocommerce' ), self::human_interval( gmdate( 'U' ) - $next_timestamp ) ); } else { /* translators: %s: date interval */ $schedule_display_string .= sprintf( __( ' (%s)', 'woocommerce' ), self::human_interval( $next_timestamp - gmdate( 'U' ) ) ); } return $schedule_display_string; } /** * Bulk delete. * * Deletes actions based on their ID. This is the handler for the bulk delete. It assumes the data * properly validated by the callee and it will delete the actions without any extra validation. * * @param int[] $ids Action IDs. * @param string $ids_sql Inherited and unused. */ protected function bulk_delete( array $ids, $ids_sql ) { foreach ( $ids as $id ) { try { $this->store->delete_action( $id ); } catch ( Exception $e ) { // A possible reason for an exception would include a scenario where the same action is deleted by a // concurrent request. // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log error_log( sprintf( /* translators: 1: action ID 2: exception message. */ __( 'Action Scheduler was unable to delete action %1$d. Reason: %2$s', 'woocommerce' ), $id, $e->getMessage() ) ); } } } /** * Implements the logic behind running an action. ActionScheduler_Abstract_ListTable validates the request and their * parameters are valid. * * @param int $action_id Action ID. */ protected function row_action_cancel( $action_id ) { $this->process_row_action( $action_id, 'cancel' ); } /** * Implements the logic behind running an action. ActionScheduler_Abstract_ListTable validates the request and their * parameters are valid. * * @param int $action_id Action ID. */ protected function row_action_run( $action_id ) { $this->process_row_action( $action_id, 'run' ); } /** * Force the data store schema updates. */ protected function recreate_tables() { if ( is_a( $this->store, 'ActionScheduler_HybridStore' ) ) { $store = $this->store; } else { $store = new ActionScheduler_HybridStore(); } add_action( 'action_scheduler/created_table', array( $store, 'set_autoincrement' ), 10, 2 ); $store_schema = new ActionScheduler_StoreSchema(); $logger_schema = new ActionScheduler_LoggerSchema(); $store_schema->register_tables( true ); $logger_schema->register_tables( true ); remove_action( 'action_scheduler/created_table', array( $store, 'set_autoincrement' ), 10 ); } /** * Implements the logic behind processing an action once an action link is clicked on the list table. * * @param int $action_id Action ID. * @param string $row_action_type The type of action to perform on the action. */ protected function process_row_action( $action_id, $row_action_type ) { try { switch ( $row_action_type ) { case 'run': $this->runner->process_action( $action_id, 'Admin List Table' ); break; case 'cancel': $this->store->cancel_action( $action_id ); break; } $success = 1; $error_message = ''; } catch ( Exception $e ) { $success = 0; $error_message = $e->getMessage(); } set_transient( 'action_scheduler_admin_notice', compact( 'action_id', 'success', 'error_message', 'row_action_type' ), 30 ); } /** * {@inheritDoc} */ public function prepare_items() { $this->prepare_column_headers(); $per_page = $this->get_items_per_page( $this->get_per_page_option_name(), $this->items_per_page ); $query = array( 'per_page' => $per_page, 'offset' => $this->get_items_offset(), 'status' => $this->get_request_status(), 'orderby' => $this->get_request_orderby(), 'order' => $this->get_request_order(), 'search' => $this->get_request_search_query(), ); /** * Change query arguments to query for past-due actions. * Past-due actions have the 'pending' status and are in the past. * This is needed because registering 'past-due' as a status is overkill. */ if ( 'past-due' === $this->get_request_status() ) { $query['status'] = ActionScheduler_Store::STATUS_PENDING; $query['date'] = as_get_datetime_object(); } $this->items = array(); $total_items = $this->store->query_actions( $query, 'count' ); $status_labels = $this->store->get_status_labels(); foreach ( $this->store->query_actions( $query ) as $action_id ) { try { $action = $this->store->fetch_action( $action_id ); } catch ( Exception $e ) { continue; } if ( is_a( $action, 'ActionScheduler_NullAction' ) ) { continue; } $this->items[ $action_id ] = array( 'ID' => $action_id, 'hook' => $action->get_hook(), 'status_name' => $this->store->get_status( $action_id ), 'status' => $status_labels[ $this->store->get_status( $action_id ) ], 'args' => $action->get_args(), 'group' => $action->get_group(), 'log_entries' => $this->logger->get_logs( $action_id ), 'claim_id' => $this->store->get_claim_id( $action_id ), 'recurrence' => $this->get_recurrence( $action ), 'schedule' => $action->get_schedule(), ); } $this->set_pagination_args( array( 'total_items' => $total_items, 'per_page' => $per_page, 'total_pages' => ceil( $total_items / $per_page ), ) ); } /** * Prints the available statuses so the user can click to filter. */ protected function display_filter_by_status() { $this->status_counts = $this->store->action_counts() + $this->store->extra_action_counts(); parent::display_filter_by_status(); } /** * Get the text to display in the search box on the list table. */ protected function get_search_box_button_text() { return __( 'Search hook, args and claim ID', 'woocommerce' ); } /** * {@inheritDoc} */ protected function get_per_page_option_name() { return str_replace( '-', '_', $this->screen->id ) . '_per_page'; } } action-scheduler/classes/ActionScheduler_InvalidActionException.php 0000777 00000002705 15252010675 0021720 0 ustar 00 <?php /** * InvalidAction Exception. * * Used for identifying actions that are invalid in some way. * * @package ActionScheduler */ class ActionScheduler_InvalidActionException extends \InvalidArgumentException implements ActionScheduler_Exception { /** * Create a new exception when the action's schedule cannot be fetched. * * @param string $action_id The action ID with bad args. * @param mixed $schedule Passed schedule. * @return static */ public static function from_schedule( $action_id, $schedule ) { $message = sprintf( /* translators: 1: action ID 2: schedule */ __( 'Action [%1$s] has an invalid schedule: %2$s', 'woocommerce' ), $action_id, var_export( $schedule, true ) // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export ); return new static( $message ); } /** * Create a new exception when the action's args cannot be decoded to an array. * * @param string $action_id The action ID with bad args. * @param mixed $args Passed arguments. * @return static */ public static function from_decoding_args( $action_id, $args = array() ) { $message = sprintf( /* translators: 1: action ID 2: arguments */ __( 'Action [%1$s] has invalid arguments. It cannot be JSON decoded to an array. $args = %2$s', 'woocommerce' ), $action_id, var_export( $args, true ) // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export ); return new static( $message ); } } action-scheduler/classes/ActionScheduler_RecurringActionScheduler.php 0000777 00000006063 15252010675 0022253 0 ustar 00 <?php /** * Class ActionScheduler_RecurringActionScheduler * * This class ensures that the `action_scheduler_ensure_recurring_actions` hook is triggered on a daily interval. This * simplifies the process for other plugins to register their recurring actions without requiring each plugin to query * or schedule actions independently on every request. */ class ActionScheduler_RecurringActionScheduler { /** * @var string The hook of the scheduled recurring action that is run to trigger the * `action_scheduler_ensure_recurring_actions` hook that plugins should use. We can't directly have the * scheduled action hook be the hook plugins should use because the actions will show as failed if no plugin * was actively hooked into it. */ private const RUN_SCHEDULED_RECURRING_ACTIONS_HOOK = 'action_scheduler_run_recurring_actions_schedule_hook'; /** * Initialize the instance. Should only be run on a single instance per request. * * @return void */ public function init(): void { add_action( self::RUN_SCHEDULED_RECURRING_ACTIONS_HOOK, array( $this, 'run_recurring_scheduler_hook' ) ); if ( is_admin() && ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) ) { add_action( 'action_scheduler_init', array( $this, 'schedule_recurring_scheduler_hook' ) ); } } /** * Schedule the recurring `action_scheduler_ensure_recurring_actions` action if not already scheduled. * * @return void */ public function schedule_recurring_scheduler_hook(): void { if ( false === wp_cache_get( 'as_is_ensure_recurring_actions_scheduled' ) ) { if ( ! as_has_scheduled_action( self::RUN_SCHEDULED_RECURRING_ACTIONS_HOOK ) ) { as_schedule_recurring_action( time(), DAY_IN_SECONDS, self::RUN_SCHEDULED_RECURRING_ACTIONS_HOOK, [], 'ActionScheduler', true, 20 ); } wp_cache_set( 'as_is_ensure_recurring_actions_scheduled', true, HOUR_IN_SECONDS ); } } /** * Trigger the hook to allow other plugins to schedule their recurring actions. * * @return void */ public function run_recurring_scheduler_hook(): void { /** * Fires to allow extensions to verify and ensure their recurring actions are scheduled. * * This action is scheduled to trigger once every 24 hrs for the purpose of having 3rd party plugins verify that * any previously scheduled recurring actions are still scheduled. Because recurring actions could stop getting * rescheduled by default due to excessive failures, database issues, or other interruptions, extensions can use * this hook to check for the existence of their recurring actions and reschedule them if necessary. * * Example usage: * * add_action('action_scheduler_ensure_recurring_actions', function() { * // Check if the recurring action is scheduled, and reschedule if missing. * if ( ! as_has_scheduled_action('my_recurring_action') ) { * as_schedule_recurring_action( time(), HOUR_IN_SECONDS, 'my_recurring_action' ); * } * }); * * @since 3.9.3 */ do_action( 'action_scheduler_ensure_recurring_actions' ); } } action-scheduler/classes/schedules/ActionScheduler_NullSchedule.php 0000777 00000001305 15252010675 0021656 0 ustar 00 <?php /** * Class ActionScheduler_NullSchedule */ class ActionScheduler_NullSchedule extends ActionScheduler_SimpleSchedule { /** * DateTime instance. * * @var DateTime|null */ protected $scheduled_date; /** * Make the $date param optional and default to null. * * @param null|DateTime $date The date & time to run the action. */ public function __construct( ?DateTime $date = null ) { $this->scheduled_date = null; } /** * This schedule has no scheduled DateTime, so we need to override the parent __sleep(). * * @return array */ public function __sleep() { return array(); } /** * Wakeup. */ public function __wakeup() { $this->scheduled_date = null; } } action-scheduler/classes/schedules/ActionScheduler_SimpleSchedule.php 0000777 00000004477 15252010675 0022212 0 ustar 00 <?php /** * Class ActionScheduler_SimpleSchedule */ class ActionScheduler_SimpleSchedule extends ActionScheduler_Abstract_Schedule { /** * Deprecated property @see $this->__wakeup() for details. * * @var null|DateTime */ private $timestamp = null; /** * Calculate when this schedule should start after a given date & time using * the number of seconds between recurrences. * * @param DateTime $after Timestamp. * * @return DateTime|null */ public function calculate_next( DateTime $after ) { return null; } /** * Schedule is not recurring. * * @return bool */ public function is_recurring() { return false; } /** * Serialize schedule with data required prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, schedules used different property names to refer * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To guard against the * scheduled date for single actions always being seen as "now" if downgrading to * Action Scheduler < 3.0.0, we need to also store the data with the old property names * so if it's unserialized in AS < 3.0, the schedule doesn't end up with a null recurrence. * * @return array */ public function __sleep() { $sleep_params = parent::__sleep(); $this->timestamp = $this->scheduled_timestamp; return array_merge( $sleep_params, array( 'timestamp', ) ); } /** * Unserialize recurring schedules serialized/stored prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, schedules used different property names to refer * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To maintain backward * compatibility with schedules serialized and stored prior to 3.0, we need to correctly * map the old property names with matching visibility. */ public function __wakeup() { if ( is_null( $this->scheduled_timestamp ) && ! is_null( $this->timestamp ) ) { $this->scheduled_timestamp = $this->timestamp; unset( $this->timestamp ); } parent::__wakeup(); } } action-scheduler/classes/schedules/ActionScheduler_Schedule.php 0000777 00000000710 15252010675 0021022 0 ustar 00 <?php /** * Class ActionScheduler_Schedule */ interface ActionScheduler_Schedule { /** * Get the date & time this schedule was created to run, or calculate when it should be run * after a given date & time. * * @param null|DateTime $after Timestamp. * @return DateTime|null */ public function next( ?DateTime $after = null ); /** * Identify the schedule as (not) recurring. * * @return bool */ public function is_recurring(); } action-scheduler/classes/schedules/ActionScheduler_IntervalSchedule.php 0000777 00000005111 15252010675 0022527 0 ustar 00 <?php /** * Class ActionScheduler_IntervalSchedule */ class ActionScheduler_IntervalSchedule extends ActionScheduler_Abstract_RecurringSchedule implements ActionScheduler_Schedule { /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $start_timestamp = null; /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $interval_in_seconds = null; /** * Calculate when this schedule should start after a given date & time using * the number of seconds between recurrences. * * @param DateTime $after Timestamp. * @return DateTime */ protected function calculate_next( DateTime $after ) { $after->modify( '+' . (int) $this->get_recurrence() . ' seconds' ); return $after; } /** * Schedule interval in seconds. * * @return int */ public function interval_in_seconds() { _deprecated_function( __METHOD__, '3.0.0', '(int)ActionScheduler_Abstract_RecurringSchedule::get_recurrence()' ); return (int) $this->get_recurrence(); } /** * Serialize interval schedules with data required prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, recurring schedules used different property names to * refer to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To guard against the * possibility of infinite loops if downgrading to Action Scheduler < 3.0.0, we need to * also store the data with the old property names so if it's unserialized in AS < 3.0, * the schedule doesn't end up with a null/false/0 recurrence. * * @return array */ public function __sleep() { $sleep_params = parent::__sleep(); $this->start_timestamp = $this->scheduled_timestamp; $this->interval_in_seconds = $this->recurrence; return array_merge( $sleep_params, array( 'start_timestamp', 'interval_in_seconds', ) ); } /** * Unserialize interval schedules serialized/stored prior to AS 3.0.0 * * For more background, @see ActionScheduler_Abstract_RecurringSchedule::__wakeup(). */ public function __wakeup() { if ( is_null( $this->scheduled_timestamp ) && ! is_null( $this->start_timestamp ) ) { $this->scheduled_timestamp = $this->start_timestamp; unset( $this->start_timestamp ); } if ( is_null( $this->recurrence ) && ! is_null( $this->interval_in_seconds ) ) { $this->recurrence = $this->interval_in_seconds; unset( $this->interval_in_seconds ); } parent::__wakeup(); } } action-scheduler/classes/schedules/ActionScheduler_CanceledSchedule.php 0000777 00000003157 15252010675 0022451 0 ustar 00 <?php /** * Class ActionScheduler_SimpleSchedule */ class ActionScheduler_CanceledSchedule extends ActionScheduler_SimpleSchedule { /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $timestamp = null; /** * Calculate when the next instance of this schedule would run based on a given date & time. * * @param DateTime $after Timestamp. * * @return DateTime|null */ public function calculate_next( DateTime $after ) { return null; } /** * Cancelled actions should never have a next schedule, even if get_next() * is called with $after < $this->scheduled_date. * * @param DateTime $after Timestamp. * @return DateTime|null */ public function get_next( DateTime $after ) { return null; } /** * Action is not recurring. * * @return bool */ public function is_recurring() { return false; } /** * Unserialize recurring schedules serialized/stored prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, schedules used different property names to refer * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To maintain backward * compatibility with schedules serialized and stored prior to 3.0, we need to correctly * map the old property names with matching visibility. */ public function __wakeup() { if ( ! is_null( $this->timestamp ) ) { $this->scheduled_timestamp = $this->timestamp; unset( $this->timestamp ); } parent::__wakeup(); } } action-scheduler/classes/schedules/ActionScheduler_CronSchedule.php 0000777 00000007367 15252010675 0021663 0 ustar 00 <?php /** * Class ActionScheduler_CronSchedule */ class ActionScheduler_CronSchedule extends ActionScheduler_Abstract_RecurringSchedule implements ActionScheduler_Schedule { /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $start_timestamp = null; /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $cron = null; /** * Wrapper for parent constructor to accept a cron expression string and map it to a CronExpression for this * objects $recurrence property. * * @param DateTime $start The date & time to run the action at or after. If $start aligns with the CronSchedule passed via $recurrence, it will be used. If it does not align, the first matching date after it will be used. * @param CronExpression|string $recurrence The CronExpression used to calculate the schedule's next instance. * @param DateTime|null $first (Optional) The date & time the first instance of this interval schedule ran. Default null, meaning this is the first instance. */ public function __construct( DateTime $start, $recurrence, ?DateTime $first = null ) { if ( ! is_a( $recurrence, 'CronExpression' ) ) { $recurrence = CronExpression::factory( $recurrence ); } // For backward compatibility, we need to make sure the date is set to the first matching cron date, not whatever date is passed in. Importantly, by passing true as the 3rd param, if $start matches the cron expression, then it will be used. This was previously handled in the now deprecated next() method. $date = $recurrence->getNextRunDate( $start, 0, true ); // parent::__construct() will set this to $date by default, but that may be different to $start now. $first = empty( $first ) ? $start : $first; parent::__construct( $date, $recurrence, $first ); } /** * Calculate when an instance of this schedule would start based on a given * date & time using its the CronExpression. * * @param DateTime $after Timestamp. * @return DateTime */ protected function calculate_next( DateTime $after ) { return $this->recurrence->getNextRunDate( $after, 0, false ); } /** * Get the schedule's recurrence. * * @return string */ public function get_recurrence() { return strval( $this->recurrence ); } /** * Serialize cron schedules with data required prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, recurring schedules used different property names to * refer to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To guard against the * possibility of infinite loops if downgrading to Action Scheduler < 3.0.0, we need to * also store the data with the old property names so if it's unserialized in AS < 3.0, * the schedule doesn't end up with a null recurrence. * * @return array */ public function __sleep() { $sleep_params = parent::__sleep(); $this->start_timestamp = $this->scheduled_timestamp; $this->cron = $this->recurrence; return array_merge( $sleep_params, array( 'start_timestamp', 'cron', ) ); } /** * Unserialize cron schedules serialized/stored prior to AS 3.0.0 * * For more background, @see ActionScheduler_Abstract_RecurringSchedule::__wakeup(). */ public function __wakeup() { if ( is_null( $this->scheduled_timestamp ) && ! is_null( $this->start_timestamp ) ) { $this->scheduled_timestamp = $this->start_timestamp; unset( $this->start_timestamp ); } if ( is_null( $this->recurrence ) && ! is_null( $this->cron ) ) { $this->recurrence = $this->cron; unset( $this->cron ); } parent::__wakeup(); } } action-scheduler/classes/abstracts/ActionScheduler_Abstract_ListTable.php 0000777 00000061026 15252010675 0023012 0 ustar 00 <?php if ( ! class_exists( 'WP_List_Table' ) ) { require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; } /** * Action Scheduler Abstract List Table class * * This abstract class enhances WP_List_Table making it ready to use. * * By extending this class we can focus on describing how our table looks like, * which columns needs to be shown, filter, ordered by and more and forget about the details. * * This class supports: * - Bulk actions * - Search * - Sortable columns * - Automatic translations of the columns * * @codeCoverageIgnore * @since 2.0.0 */ abstract class ActionScheduler_Abstract_ListTable extends WP_List_Table { /** * The table name * * @var string */ protected $table_name; /** * Package name, used to get options from WP_List_Table::get_items_per_page. * * @var string */ protected $package; /** * How many items do we render per page? * * @var int */ protected $items_per_page = 10; /** * Enables search in this table listing. If this array * is empty it means the listing is not searchable. * * @var array */ protected $search_by = array(); /** * Columns to show in the table listing. It is a key => value pair. The * key must much the table column name and the value is the label, which is * automatically translated. * * @var array */ protected $columns = array(); /** * Defines the row-actions. It expects an array where the key * is the column name and the value is an array of actions. * * The array of actions are key => value, where key is the method name * (with the prefix row_action_<key>) and the value is the label * and title. * * @var array */ protected $row_actions = array(); /** * The Primary key of our table * * @var string */ protected $ID = 'ID'; /** * Enables sorting, it expects an array * of columns (the column names are the values) * * @var array */ protected $sort_by = array(); /** * The default sort order * * @var string */ protected $filter_by = array(); /** * The status name => count combinations for this table's items. Used to display status filters. * * @var array */ protected $status_counts = array(); /** * Notices to display when loading the table. Array of arrays of form array( 'class' => {updated|error}, 'message' => 'This is the notice text display.' ). * * @var array */ protected $admin_notices = array(); /** * Localised string displayed in the <h1> element above the able. * * @var string */ protected $table_header; /** * Enables bulk actions. It must be an array where the key is the action name * and the value is the label (which is translated automatically). It is important * to notice that it will check that the method exists (`bulk_$name`) and will throw * an exception if it does not exists. * * This class will automatically check if the current request has a bulk action, will do the * validations and afterwards will execute the bulk method, with two arguments. The first argument * is the array with primary keys, the second argument is a string with a list of the primary keys, * escaped and ready to use (with `IN`). * * @var array */ protected $bulk_actions = array(); /** * Makes translation easier, it basically just wraps * `_x` with some default (the package name). * * @param string $text The new text to translate. * @param string $context The context of the text. * @return string|void The translated text. * * @deprecated 3.0.0 Use `_x()` instead. */ protected function translate( $text, $context = '' ) { return $text; } /** * Reads `$this->bulk_actions` and returns an array that WP_List_Table understands. It * also validates that the bulk method handler exists. It throws an exception because * this is a library meant for developers and missing a bulk method is a development-time error. * * @return array * * @throws RuntimeException Throws RuntimeException when the bulk action does not have a callback method. */ protected function get_bulk_actions() { $actions = array(); foreach ( $this->bulk_actions as $action => $label ) { if ( ! is_callable( array( $this, 'bulk_' . $action ) ) ) { throw new RuntimeException( "The bulk action $action does not have a callback method" ); } $actions[ $action ] = $label; } return $actions; } /** * Checks if the current request has a bulk action. If that is the case it will validate and will * execute the bulk method handler. Regardless if the action is valid or not it will redirect to * the previous page removing the current arguments that makes this request a bulk action. */ protected function process_bulk_action() { global $wpdb; // Detect when a bulk action is being triggered. $action = $this->current_action(); if ( ! $action ) { return; } check_admin_referer( 'bulk-' . $this->_args['plural'] ); $method = 'bulk_' . $action; if ( array_key_exists( $action, $this->bulk_actions ) && is_callable( array( $this, $method ) ) && ! empty( $_GET['ID'] ) && is_array( $_GET['ID'] ) ) { $ids_sql = '(' . implode( ',', array_fill( 0, count( $_GET['ID'] ), '%s' ) ) . ')'; $id = array_map( 'absint', $_GET['ID'] ); $this->$method( $id, $wpdb->prepare( $ids_sql, $id ) ); //phpcs:ignore WordPress.DB.PreparedSQL } if ( isset( $_SERVER['REQUEST_URI'] ) ) { wp_safe_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce', 'ID', 'action', 'action2' ), esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) ); exit; } } /** * Default code for deleting entries. * validated already by process_bulk_action() * * @param array $ids ids of the items to delete. * @param string $ids_sql the sql for the ids. * @return void */ protected function bulk_delete( array $ids, $ids_sql ) { $store = ActionScheduler::store(); foreach ( $ids as $action_id ) { $store->delete( $action_id ); } } /** * Prepares the _column_headers property which is used by WP_Table_List at rendering. * It merges the columns and the sortable columns. */ protected function prepare_column_headers() { $this->_column_headers = array( $this->get_columns(), get_hidden_columns( $this->screen ), $this->get_sortable_columns(), ); } /** * Reads $this->sort_by and returns the columns name in a format that WP_Table_List * expects */ public function get_sortable_columns() { $sort_by = array(); foreach ( $this->sort_by as $column ) { $sort_by[ $column ] = array( $column, true ); } return $sort_by; } /** * Returns the columns names for rendering. It adds a checkbox for selecting everything * as the first column */ public function get_columns() { $columns = array_merge( array( 'cb' => '<input type="checkbox" />' ), $this->columns ); return $columns; } /** * Get prepared LIMIT clause for items query * * @global wpdb $wpdb * * @return string Prepared LIMIT clause for items query. */ protected function get_items_query_limit() { global $wpdb; $per_page = $this->get_items_per_page( $this->get_per_page_option_name(), $this->items_per_page ); return $wpdb->prepare( 'LIMIT %d', $per_page ); } /** * Returns the number of items to offset/skip for this current view. * * @return int */ protected function get_items_offset() { $per_page = $this->get_items_per_page( $this->get_per_page_option_name(), $this->items_per_page ); $current_page = $this->get_pagenum(); if ( 1 < $current_page ) { $offset = $per_page * ( $current_page - 1 ); } else { $offset = 0; } return $offset; } /** * Get prepared OFFSET clause for items query * * @global wpdb $wpdb * * @return string Prepared OFFSET clause for items query. */ protected function get_items_query_offset() { global $wpdb; return $wpdb->prepare( 'OFFSET %d', $this->get_items_offset() ); } /** * Prepares the ORDER BY sql statement. It uses `$this->sort_by` to know which * columns are sortable. This requests validates the orderby $_GET parameter is a valid * column and sortable. It will also use order (ASC|DESC) using DESC by default. */ protected function get_items_query_order() { if ( empty( $this->sort_by ) ) { return ''; } $orderby = esc_sql( $this->get_request_orderby() ); $order = esc_sql( $this->get_request_order() ); return "ORDER BY {$orderby} {$order}"; } /** * Querystring arguments to persist between form submissions. * * @since 3.7.3 * * @return string[] */ protected function get_request_query_args_to_persist() { return array_merge( $this->sort_by, array( 'page', 'status', 'tab', ) ); } /** * Return the sortable column specified for this request to order the results by, if any. * * @return string */ protected function get_request_orderby() { $valid_sortable_columns = array_values( $this->sort_by ); if ( ! empty( $_GET['orderby'] ) && in_array( $_GET['orderby'], $valid_sortable_columns, true ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended $orderby = sanitize_text_field( wp_unslash( $_GET['orderby'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended } else { $orderby = $valid_sortable_columns[0]; } return $orderby; } /** * Return the sortable column order specified for this request. * * @return string */ protected function get_request_order() { if ( ! empty( $_GET['order'] ) && 'desc' === strtolower( sanitize_text_field( wp_unslash( $_GET['order'] ) ) ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended $order = 'DESC'; } else { $order = 'ASC'; } return $order; } /** * Return the status filter for this request, if any. * * @return string */ protected function get_request_status() { $status = ( ! empty( $_GET['status'] ) ) ? sanitize_text_field( wp_unslash( $_GET['status'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended return $status; } /** * Return the search filter for this request, if any. * * @return string */ protected function get_request_search_query() { $search_query = ( ! empty( $_GET['s'] ) ) ? sanitize_text_field( wp_unslash( $_GET['s'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended return $search_query; } /** * Process and return the columns name. This is meant for using with SQL, this means it * always includes the primary key. * * @return array */ protected function get_table_columns() { $columns = array_keys( $this->columns ); if ( ! in_array( $this->ID, $columns, true ) ) { $columns[] = $this->ID; } return $columns; } /** * Check if the current request is doing a "full text" search. If that is the case * prepares the SQL to search texts using LIKE. * * If the current request does not have any search or if this list table does not support * that feature it will return an empty string. * * @return string */ protected function get_items_query_search() { global $wpdb; if ( empty( $_GET['s'] ) || empty( $this->search_by ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended return ''; } $search_string = sanitize_text_field( wp_unslash( $_GET['s'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended $filter = array(); foreach ( $this->search_by as $column ) { $wild = '%'; $sql_like = $wild . $wpdb->esc_like( $search_string ) . $wild; $filter[] = $wpdb->prepare( '`' . $column . '` LIKE %s', $sql_like ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.DB.PreparedSQL.NotPrepared } return implode( ' OR ', $filter ); } /** * Prepares the SQL to filter rows by the options defined at `$this->filter_by`. Before trusting * any data sent by the user it validates that it is a valid option. */ protected function get_items_query_filters() { global $wpdb; if ( ! $this->filter_by || empty( $_GET['filter_by'] ) || ! is_array( $_GET['filter_by'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended return ''; } $filter = array(); foreach ( $this->filter_by as $column => $options ) { if ( empty( $_GET['filter_by'][ $column ] ) || empty( $options[ $_GET['filter_by'][ $column ] ] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended continue; } $filter[] = $wpdb->prepare( "`$column` = %s", sanitize_text_field( wp_unslash( $_GET['filter_by'][ $column ] ) ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.DB.PreparedSQL.InterpolatedNotPrepared } return implode( ' AND ', $filter ); } /** * Prepares the data to feed WP_Table_List. * * This has the core for selecting, sorting and filtering data. To keep the code simple * its logic is split among many methods (get_items_query_*). * * Beside populating the items this function will also count all the records that matches * the filtering criteria and will do fill the pagination variables. */ public function prepare_items() { global $wpdb; $this->process_bulk_action(); $this->process_row_actions(); if ( ! empty( $_REQUEST['_wp_http_referer'] && ! empty( $_SERVER['REQUEST_URI'] ) ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended // _wp_http_referer is used only on bulk actions, we remove it to keep the $_GET shorter wp_safe_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) ); exit; } $this->prepare_column_headers(); $limit = $this->get_items_query_limit(); $offset = $this->get_items_query_offset(); $order = $this->get_items_query_order(); $where = array_filter( array( $this->get_items_query_search(), $this->get_items_query_filters(), ) ); $columns = '`' . implode( '`, `', $this->get_table_columns() ) . '`'; if ( ! empty( $where ) ) { $where = 'WHERE (' . implode( ') AND (', $where ) . ')'; } else { $where = ''; } $sql = "SELECT $columns FROM {$this->table_name} {$where} {$order} {$limit} {$offset}"; $this->set_items( $wpdb->get_results( $sql, ARRAY_A ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared $query_count = "SELECT COUNT({$this->ID}) FROM {$this->table_name} {$where}"; $total_items = $wpdb->get_var( $query_count ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared $per_page = $this->get_items_per_page( $this->get_per_page_option_name(), $this->items_per_page ); $this->set_pagination_args( array( 'total_items' => $total_items, 'per_page' => $per_page, 'total_pages' => ceil( $total_items / $per_page ), ) ); } /** * Display the table. * * @param string $which The name of the table. */ public function extra_tablenav( $which ) { if ( ! $this->filter_by || 'top' !== $which ) { return; } echo '<div class="alignleft actions">'; foreach ( $this->filter_by as $id => $options ) { $default = ! empty( $_GET['filter_by'][ $id ] ) ? sanitize_text_field( wp_unslash( $_GET['filter_by'][ $id ] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended if ( empty( $options[ $default ] ) ) { $default = ''; } echo '<select name="filter_by[' . esc_attr( $id ) . ']" class="first" id="filter-by-' . esc_attr( $id ) . '">'; foreach ( $options as $value => $label ) { echo '<option value="' . esc_attr( $value ) . '" ' . esc_html( $value === $default ? 'selected' : '' ) . '>' . esc_html( $label ) . '</option>'; } echo '</select>'; } submit_button( esc_html__( 'Filter', 'woocommerce' ), '', 'filter_action', false, array( 'id' => 'post-query-submit' ) ); echo '</div>'; } /** * Set the data for displaying. It will attempt to unserialize (There is a chance that some columns * are serialized). This can be override in child classes for further data transformation. * * @param array $items Items array. */ protected function set_items( array $items ) { $this->items = array(); foreach ( $items as $item ) { $this->items[ $item[ $this->ID ] ] = array_map( 'maybe_unserialize', $item ); } } /** * Renders the checkbox for each row, this is the first column and it is named ID regardless * of how the primary key is named (to keep the code simpler). The bulk actions will do the proper * name transformation though using `$this->ID`. * * @param array $row The row to render. */ public function column_cb( $row ) { return '<input name="ID[]" type="checkbox" value="' . esc_attr( $row[ $this->ID ] ) . '" />'; } /** * Renders the row-actions. * * This method renders the action menu, it reads the definition from the $row_actions property, * and it checks that the row action method exists before rendering it. * * @param array $row Row to be rendered. * @param string $column_name Column name. * @return string */ protected function maybe_render_actions( $row, $column_name ) { if ( empty( $this->row_actions[ $column_name ] ) ) { return; } $row_id = $row[ $this->ID ]; $actions = '<div class="row-actions">'; $action_count = 0; foreach ( $this->row_actions[ $column_name ] as $action_key => $action ) { $action_count++; if ( ! method_exists( $this, 'row_action_' . $action_key ) ) { continue; } $action_link = ! empty( $action['link'] ) ? $action['link'] : add_query_arg( array( 'row_action' => $action_key, 'row_id' => $row_id, 'nonce' => wp_create_nonce( $action_key . '::' . $row_id ), ) ); $span_class = ! empty( $action['class'] ) ? $action['class'] : $action_key; $separator = ( $action_count < count( $this->row_actions[ $column_name ] ) ) ? ' | ' : ''; $actions .= sprintf( '<span class="%s">', esc_attr( $span_class ) ); $actions .= sprintf( '<a href="%1$s" title="%2$s">%3$s</a>', esc_url( $action_link ), esc_attr( $action['desc'] ), esc_html( $action['name'] ) ); $actions .= sprintf( '%s</span>', $separator ); } $actions .= '</div>'; return $actions; } /** * Process the bulk actions. * * @return void */ protected function process_row_actions() { $parameters = array( 'row_action', 'row_id', 'nonce' ); foreach ( $parameters as $parameter ) { if ( empty( $_REQUEST[ $parameter ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended return; } } $action = sanitize_text_field( wp_unslash( $_REQUEST['row_action'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotValidated $row_id = sanitize_text_field( wp_unslash( $_REQUEST['row_id'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotValidated $nonce = sanitize_text_field( wp_unslash( $_REQUEST['nonce'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotValidated $method = 'row_action_' . $action; // phpcs:ignore WordPress.Security.NonceVerification.Recommended if ( wp_verify_nonce( $nonce, $action . '::' . $row_id ) && method_exists( $this, $method ) ) { $this->$method( sanitize_text_field( wp_unslash( $row_id ) ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended } if ( isset( $_SERVER['REQUEST_URI'] ) ) { wp_safe_redirect( remove_query_arg( array( 'row_id', 'row_action', 'nonce' ), esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) ); exit; } } /** * Default column formatting, it will escape everything for security. * * @param array $item The item array. * @param string $column_name Column name to display. * * @return string */ public function column_default( $item, $column_name ) { $column_html = esc_html( $item[ $column_name ] ); $column_html .= $this->maybe_render_actions( $item, $column_name ); return $column_html; } /** * Display the table heading and search query, if any */ protected function display_header() { echo '<h1 class="wp-heading-inline">' . esc_attr( $this->table_header ) . '</h1>'; if ( $this->get_request_search_query() ) { /* translators: %s: search query */ echo '<span class="subtitle">' . esc_attr( sprintf( __( 'Search results for "%s"', 'woocommerce' ), $this->get_request_search_query() ) ) . '</span>'; } echo '<hr class="wp-header-end">'; } /** * Display the table heading and search query, if any */ protected function display_admin_notices() { foreach ( $this->admin_notices as $notice ) { echo '<div id="message" class="' . esc_attr( $notice['class'] ) . '">'; echo ' <p>' . wp_kses_post( $notice['message'] ) . '</p>'; echo '</div>'; } } /** * Prints the available statuses so the user can click to filter. */ protected function display_filter_by_status() { $status_list_items = array(); $request_status = $this->get_request_status(); // Helper to set 'all' filter when not set on status counts passed in. if ( ! isset( $this->status_counts['all'] ) ) { $all_count = array_sum( $this->status_counts ); if ( isset( $this->status_counts['past-due'] ) ) { $all_count -= $this->status_counts['past-due']; } $this->status_counts = array( 'all' => $all_count ) + $this->status_counts; } // Translated status labels. $status_labels = ActionScheduler_Store::instance()->get_status_labels(); $status_labels['all'] = esc_html_x( 'All', 'status labels', 'woocommerce' ); $status_labels['past-due'] = esc_html_x( 'Past-due', 'status labels', 'woocommerce' ); foreach ( $this->status_counts as $status_slug => $count ) { if ( 0 === $count ) { continue; } if ( $status_slug === $request_status || ( empty( $request_status ) && 'all' === $status_slug ) ) { $status_list_item = '<li class="%1$s"><a href="%2$s" class="current">%3$s</a> (%4$d)</li>'; } else { $status_list_item = '<li class="%1$s"><a href="%2$s">%3$s</a> (%4$d)</li>'; } $status_name = isset( $status_labels[ $status_slug ] ) ? $status_labels[ $status_slug ] : ucfirst( $status_slug ); $status_filter_url = ( 'all' === $status_slug ) ? remove_query_arg( 'status' ) : add_query_arg( 'status', $status_slug ); $status_filter_url = remove_query_arg( array( 'paged', 's' ), $status_filter_url ); $status_list_items[] = sprintf( $status_list_item, esc_attr( $status_slug ), esc_url( $status_filter_url ), esc_html( $status_name ), absint( $count ) ); } if ( $status_list_items ) { echo '<ul class="subsubsub">'; echo implode( " | \n", $status_list_items ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped echo '</ul>'; } } /** * Renders the table list, we override the original class to render the table inside a form * and to render any needed HTML (like the search box). By doing so the callee of a function can simple * forget about any extra HTML. */ protected function display_table() { echo '<form id="' . esc_attr( $this->_args['plural'] ) . '-filter" method="get">'; foreach ( $this->get_request_query_args_to_persist() as $arg ) { $arg_value = isset( $_GET[ $arg ] ) ? sanitize_text_field( wp_unslash( $_GET[ $arg ] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended if ( ! $arg_value ) { continue; } echo '<input type="hidden" name="' . esc_attr( $arg ) . '" value="' . esc_attr( $arg_value ) . '" />'; } if ( ! empty( $this->search_by ) ) { echo $this->search_box( $this->get_search_box_button_text(), 'plugin' ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } parent::display(); echo '</form>'; } /** * Process any pending actions. */ public function process_actions() { $this->process_bulk_action(); $this->process_row_actions(); if ( ! empty( $_REQUEST['_wp_http_referer'] ) && ! empty( $_SERVER['REQUEST_URI'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended // _wp_http_referer is used only on bulk actions, we remove it to keep the $_GET shorter wp_safe_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) ); exit; } } /** * Render the list table page, including header, notices, status filters and table. */ public function display_page() { $this->prepare_items(); echo '<div class="wrap">'; $this->display_header(); $this->display_admin_notices(); $this->display_filter_by_status(); $this->display_table(); echo '</div>'; } /** * Get the text to display in the search box on the list table. */ protected function get_search_box_placeholder() { return esc_html__( 'Search', 'woocommerce' ); } /** * Gets the screen per_page option name. * * @return string */ protected function get_per_page_option_name() { return $this->package . '_items_per_page'; } } action-scheduler/classes/abstracts/ActionScheduler_Abstract_Schedule.php 0000777 00000003547 15252010675 0022667 0 ustar 00 <?php /** * Class ActionScheduler_Abstract_Schedule */ abstract class ActionScheduler_Abstract_Schedule extends ActionScheduler_Schedule_Deprecated { /** * The date & time the schedule is set to run. * * @var DateTime */ private $scheduled_date = null; /** * Timestamp equivalent of @see $this->scheduled_date * * @var int */ protected $scheduled_timestamp = null; /** * Construct. * * @param DateTime $date The date & time to run the action. */ public function __construct( DateTime $date ) { $this->scheduled_date = $date; } /** * Check if a schedule should recur. * * @return bool */ abstract public function is_recurring(); /** * Calculate when the next instance of this schedule would run based on a given date & time. * * @param DateTime $after Start timestamp. * @return DateTime */ abstract protected function calculate_next( DateTime $after ); /** * Get the next date & time when this schedule should run after a given date & time. * * @param DateTime $after Start timestamp. * @return DateTime|null */ public function get_next( DateTime $after ) { $after = clone $after; if ( $after > $this->scheduled_date ) { $after = $this->calculate_next( $after ); return $after; } return clone $this->scheduled_date; } /** * Get the date & time the schedule is set to run. * * @return DateTime|null */ public function get_date() { return $this->scheduled_date; } /** * For PHP 5.2 compat, because DateTime objects can't be serialized * * @return array */ public function __sleep() { $this->scheduled_timestamp = $this->scheduled_date->getTimestamp(); return array( 'scheduled_timestamp', ); } /** * Wakeup. */ public function __wakeup() { $this->scheduled_date = as_get_datetime_object( $this->scheduled_timestamp ); unset( $this->scheduled_timestamp ); } } action-scheduler/classes/abstracts/ActionScheduler_Logger.php 0000777 00000017405 15252010675 0020525 0 ustar 00 <?php /** * Class ActionScheduler_Logger * * @codeCoverageIgnore */ abstract class ActionScheduler_Logger { /** * Instance. * * @var null|self */ private static $logger = null; /** * Get instance. * * @return ActionScheduler_Logger */ public static function instance() { if ( empty( self::$logger ) ) { $class = apply_filters( 'action_scheduler_logger_class', 'ActionScheduler_wpCommentLogger' ); self::$logger = new $class(); } return self::$logger; } /** * Create log entry. * * @param string $action_id Action ID. * @param string $message Log message. * @param DateTime|null $date Log date. * * @return string The log entry ID */ abstract public function log( $action_id, $message, ?DateTime $date = null ); /** * Get action's log entry. * * @param string $entry_id Entry ID. * * @return ActionScheduler_LogEntry */ abstract public function get_entry( $entry_id ); /** * Get action's logs. * * @param string $action_id Action ID. * * @return ActionScheduler_LogEntry[] */ abstract public function get_logs( $action_id ); /** * Initialize. * * @codeCoverageIgnore */ public function init() { $this->hook_stored_action(); add_action( 'action_scheduler_canceled_action', array( $this, 'log_canceled_action' ), 10, 1 ); add_action( 'action_scheduler_begin_execute', array( $this, 'log_started_action' ), 10, 2 ); add_action( 'action_scheduler_after_execute', array( $this, 'log_completed_action' ), 10, 3 ); add_action( 'action_scheduler_failed_execution', array( $this, 'log_failed_action' ), 10, 3 ); add_action( 'action_scheduler_failed_action', array( $this, 'log_timed_out_action' ), 10, 2 ); add_action( 'action_scheduler_unexpected_shutdown', array( $this, 'log_unexpected_shutdown' ), 10, 2 ); add_action( 'action_scheduler_reset_action', array( $this, 'log_reset_action' ), 10, 1 ); add_action( 'action_scheduler_execution_ignored', array( $this, 'log_ignored_action' ), 10, 2 ); add_action( 'action_scheduler_failed_fetch_action', array( $this, 'log_failed_fetch_action' ), 10, 2 ); add_action( 'action_scheduler_failed_to_schedule_next_instance', array( $this, 'log_failed_schedule_next_instance' ), 10, 2 ); add_action( 'action_scheduler_bulk_cancel_actions', array( $this, 'bulk_log_cancel_actions' ), 10, 1 ); } /** * Register callback for storing action. */ public function hook_stored_action() { add_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) ); } /** * Unhook callback for storing action. */ public function unhook_stored_action() { remove_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) ); } /** * Log action stored. * * @param int $action_id Action ID. */ public function log_stored_action( $action_id ) { $this->log( $action_id, __( 'action created', 'woocommerce' ) ); } /** * Log action cancellation. * * @param int $action_id Action ID. */ public function log_canceled_action( $action_id ) { $this->log( $action_id, __( 'action canceled', 'woocommerce' ) ); } /** * Log action start. * * @param int $action_id Action ID. * @param string $context Action execution context. */ public function log_started_action( $action_id, $context = '' ) { if ( ! empty( $context ) ) { /* translators: %s: context */ $message = sprintf( __( 'action started via %s', 'woocommerce' ), $context ); } else { $message = __( 'action started', 'woocommerce' ); } $this->log( $action_id, $message ); } /** * Log action completion. * * @param int $action_id Action ID. * @param null|ActionScheduler_Action $action Action. * @param string $context Action execution context. */ public function log_completed_action( $action_id, $action = null, $context = '' ) { if ( ! empty( $context ) ) { /* translators: %s: context */ $message = sprintf( __( 'action complete via %s', 'woocommerce' ), $context ); } else { $message = __( 'action complete', 'woocommerce' ); } $this->log( $action_id, $message ); } /** * Log action failure. * * @param int $action_id Action ID. * @param Exception $exception Exception. * @param string $context Action execution context. */ public function log_failed_action( $action_id, Exception $exception, $context = '' ) { if ( ! empty( $context ) ) { /* translators: 1: context 2: exception message */ $message = sprintf( __( 'action failed via %1$s: %2$s', 'woocommerce' ), $context, $exception->getMessage() ); } else { /* translators: %s: exception message */ $message = sprintf( __( 'action failed: %s', 'woocommerce' ), $exception->getMessage() ); } $this->log( $action_id, $message ); } /** * Log action timeout. * * @param int $action_id Action ID. * @param string $timeout Timeout. */ public function log_timed_out_action( $action_id, $timeout ) { /* translators: %s: amount of time */ $this->log( $action_id, sprintf( __( 'action marked as failed after %s seconds. Unknown error occurred. Check server, PHP and database error logs to diagnose cause.', 'woocommerce' ), $timeout ) ); } /** * Log unexpected shutdown. * * @param int $action_id Action ID. * @param mixed[] $error Error. */ public function log_unexpected_shutdown( $action_id, $error ) { if ( ! empty( $error ) ) { /* translators: 1: error message 2: filename 3: line */ $this->log( $action_id, sprintf( __( 'unexpected shutdown: PHP Fatal error %1$s in %2$s on line %3$s', 'woocommerce' ), $error['message'], $error['file'], $error['line'] ) ); } } /** * Log action reset. * * @param int $action_id Action ID. */ public function log_reset_action( $action_id ) { $this->log( $action_id, __( 'action reset', 'woocommerce' ) ); } /** * Log ignored action. * * @param int $action_id Action ID. * @param string $context Action execution context. */ public function log_ignored_action( $action_id, $context = '' ) { if ( ! empty( $context ) ) { /* translators: %s: context */ $message = sprintf( __( 'action ignored via %s', 'woocommerce' ), $context ); } else { $message = __( 'action ignored', 'woocommerce' ); } $this->log( $action_id, $message ); } /** * Log the failure of fetching the action. * * @param string $action_id Action ID. * @param null|Exception $exception The exception which occurred when fetching the action. NULL by default for backward compatibility. */ public function log_failed_fetch_action( $action_id, ?Exception $exception = null ) { if ( ! is_null( $exception ) ) { /* translators: %s: exception message */ $log_message = sprintf( __( 'There was a failure fetching this action: %s', 'woocommerce' ), $exception->getMessage() ); } else { $log_message = __( 'There was a failure fetching this action', 'woocommerce' ); } $this->log( $action_id, $log_message ); } /** * Log the failure of scheduling the action's next instance. * * @param int $action_id Action ID. * @param Exception $exception Exception object. */ public function log_failed_schedule_next_instance( $action_id, Exception $exception ) { /* translators: %s: exception message */ $this->log( $action_id, sprintf( __( 'There was a failure scheduling the next instance of this action: %s', 'woocommerce' ), $exception->getMessage() ) ); } /** * Bulk add cancel action log entries. * * Implemented here for backward compatibility. Should be implemented in parent loggers * for more performant bulk logging. * * @param array $action_ids List of action ID. */ public function bulk_log_cancel_actions( $action_ids ) { if ( empty( $action_ids ) ) { return; } foreach ( $action_ids as $action_id ) { $this->log_canceled_action( $action_id ); } } } action-scheduler/classes/abstracts/ActionScheduler_TimezoneHelper.php 0000777 00000011415 15252010675 0022233 0 ustar 00 <?php /** * Class ActionScheduler_TimezoneHelper */ abstract class ActionScheduler_TimezoneHelper { /** * DateTimeZone object. * * @var null|DateTimeZone */ private static $local_timezone = null; /** * Set a DateTime's timezone to the WordPress site's timezone, or a UTC offset * if no timezone string is available. * * @since 2.1.0 * * @param DateTime $date Timestamp. * @return ActionScheduler_DateTime */ public static function set_local_timezone( DateTime $date ) { // Accept a DateTime for easier backward compatibility, even though we require methods on ActionScheduler_DateTime. if ( ! is_a( $date, 'ActionScheduler_DateTime' ) ) { $date = as_get_datetime_object( $date->format( 'U' ) ); } if ( get_option( 'timezone_string' ) ) { $date->setTimezone( new DateTimeZone( self::get_local_timezone_string() ) ); } else { $date->setUtcOffset( self::get_local_timezone_offset() ); } return $date; } /** * Helper to retrieve the timezone string for a site until a WP core method exists * (see https://core.trac.wordpress.org/ticket/24730). * * Adapted from wc_timezone_string() and https://secure.php.net/manual/en/function.timezone-name-from-abbr.php#89155. * * If no timezone string is set, and its not possible to match the UTC offset set for the site to a timezone * string, then an empty string will be returned, and the UTC offset should be used to set a DateTime's * timezone. * * @since 2.1.0 * @param bool $reset Unused. * @return string PHP timezone string for the site or empty if no timezone string is available. */ protected static function get_local_timezone_string( $reset = false ) { // If site timezone string exists, return it. $timezone = get_option( 'timezone_string' ); if ( $timezone ) { return $timezone; } // Get UTC offset, if it isn't set then return UTC. $utc_offset = intval( get_option( 'gmt_offset', 0 ) ); if ( 0 === $utc_offset ) { return 'UTC'; } // Adjust UTC offset from hours to seconds. $utc_offset *= 3600; // Attempt to guess the timezone string from the UTC offset. $timezone = timezone_name_from_abbr( '', $utc_offset ); if ( $timezone ) { return $timezone; } // Last try, guess timezone string manually. foreach ( timezone_abbreviations_list() as $abbr ) { foreach ( $abbr as $city ) { if ( (bool) date( 'I' ) === (bool) $city['dst'] && $city['timezone_id'] && intval( $city['offset'] ) === $utc_offset ) { // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date -- we are actually interested in the runtime timezone. return $city['timezone_id']; } } } // No timezone string. return ''; } /** * Get timezone offset in seconds. * * @since 2.1.0 * @return float */ protected static function get_local_timezone_offset() { $timezone = get_option( 'timezone_string' ); if ( $timezone ) { $timezone_object = new DateTimeZone( $timezone ); return $timezone_object->getOffset( new DateTime( 'now' ) ); } else { return floatval( get_option( 'gmt_offset', 0 ) ) * HOUR_IN_SECONDS; } } /** * Get local timezone. * * @param bool $reset Toggle to discard stored value. * @deprecated 2.1.0 */ public static function get_local_timezone( $reset = false ) { _deprecated_function( __FUNCTION__, '2.1.0', 'ActionScheduler_TimezoneHelper::set_local_timezone()' ); if ( $reset ) { self::$local_timezone = null; } if ( ! isset( self::$local_timezone ) ) { $tzstring = get_option( 'timezone_string' ); if ( empty( $tzstring ) ) { $gmt_offset = absint( get_option( 'gmt_offset' ) ); if ( 0 === $gmt_offset ) { $tzstring = 'UTC'; } else { $gmt_offset *= HOUR_IN_SECONDS; $tzstring = timezone_name_from_abbr( '', $gmt_offset, 1 ); // If there's no timezone string, try again with no DST. if ( false === $tzstring ) { $tzstring = timezone_name_from_abbr( '', $gmt_offset, 0 ); } // Try mapping to the first abbreviation we can find. if ( false === $tzstring ) { $is_dst = date( 'I' ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date -- we are actually interested in the runtime timezone. foreach ( timezone_abbreviations_list() as $abbr ) { foreach ( $abbr as $city ) { if ( $city['dst'] === $is_dst && $city['offset'] === $gmt_offset ) { // If there's no valid timezone ID, keep looking. if ( is_null( $city['timezone_id'] ) ) { continue; } $tzstring = $city['timezone_id']; break 2; } } } } // If we still have no valid string, then fall back to UTC. if ( false === $tzstring ) { $tzstring = 'UTC'; } } } self::$local_timezone = new DateTimeZone( $tzstring ); } return self::$local_timezone; } } action-scheduler/classes/abstracts/ActionScheduler_Lock.php 0000777 00000003437 15252010675 0020176 0 ustar 00 <?php /** * Abstract class for setting a basic lock to throttle some action. * * Class ActionScheduler_Lock */ abstract class ActionScheduler_Lock { /** * Instance. * * @var ActionScheduler_Lock */ private static $locker = null; /** * Duration of lock. * * @var int */ protected static $lock_duration = MINUTE_IN_SECONDS; /** * Check if a lock is set for a given lock type. * * @param string $lock_type A string to identify different lock types. * @return bool */ public function is_locked( $lock_type ) { return ( $this->get_expiration( $lock_type ) >= time() ); } /** * Set a lock. * * To prevent race conditions, implementations should avoid setting the lock if the lock is already held. * * @param string $lock_type A string to identify different lock types. * @return bool */ abstract public function set( $lock_type ); /** * If a lock is set, return the timestamp it was set to expiry. * * @param string $lock_type A string to identify different lock types. * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire. */ abstract public function get_expiration( $lock_type ); /** * Get the amount of time to set for a given lock. 60 seconds by default. * * @param string $lock_type A string to identify different lock types. * @return int */ protected function get_duration( $lock_type ) { return apply_filters( 'action_scheduler_lock_duration', self::$lock_duration, $lock_type ); } /** * Get instance. * * @return ActionScheduler_Lock */ public static function instance() { if ( empty( self::$locker ) ) { $class = apply_filters( 'action_scheduler_lock_class', 'ActionScheduler_OptionLock' ); self::$locker = new $class(); } return self::$locker; } } action-scheduler/classes/abstracts/ActionScheduler.php 0000777 00000026210 15252010675 0017220 0 ustar 00 <?php use Action_Scheduler\WP_CLI\Migration_Command; use Action_Scheduler\Migration\Controller; /** * Class ActionScheduler * * @codeCoverageIgnore */ abstract class ActionScheduler { /** * Plugin file path. * * @var string */ private static $plugin_file = ''; /** * ActionScheduler_ActionFactory instance. * * @var ActionScheduler_ActionFactory */ private static $factory = null; /** * Data store is initialized. * * @var bool */ private static $data_store_initialized = false; /** * Factory. */ public static function factory() { if ( ! isset( self::$factory ) ) { self::$factory = new ActionScheduler_ActionFactory(); } return self::$factory; } /** * Get Store instance. */ public static function store() { return ActionScheduler_Store::instance(); } /** * Get Lock instance. */ public static function lock() { return ActionScheduler_Lock::instance(); } /** * Get Logger instance. */ public static function logger() { return ActionScheduler_Logger::instance(); } /** * Get QueueRunner instance. */ public static function runner() { return ActionScheduler_QueueRunner::instance(); } /** * Get AdminView instance. */ public static function admin_view() { return ActionScheduler_AdminView::instance(); } /** * Get the absolute system path to the plugin directory, or a file therein * * @static * @param string $path Path relative to plugin directory. * @return string */ public static function plugin_path( $path ) { $base = dirname( self::$plugin_file ); if ( $path ) { return trailingslashit( $base ) . $path; } else { return untrailingslashit( $base ); } } /** * Get the absolute URL to the plugin directory, or a file therein * * @static * @param string $path Path relative to plugin directory. * @return string */ public static function plugin_url( $path ) { return plugins_url( $path, self::$plugin_file ); } /** * Autoload. * * @param string $class Class name. */ public static function autoload( $class ) { $d = DIRECTORY_SEPARATOR; $classes_dir = self::plugin_path( 'classes' . $d ); $separator = strrpos( $class, '\\' ); if ( false !== $separator ) { if ( 0 !== strpos( $class, 'Action_Scheduler' ) ) { return; } $class = substr( $class, $separator + 1 ); } if ( 'Deprecated' === substr( $class, -10 ) ) { $dir = self::plugin_path( 'deprecated' . $d ); } elseif ( self::is_class_abstract( $class ) ) { $dir = $classes_dir . 'abstracts' . $d; } elseif ( self::is_class_migration( $class ) ) { $dir = $classes_dir . 'migration' . $d; } elseif ( 'Schedule' === substr( $class, -8 ) ) { $dir = $classes_dir . 'schedules' . $d; } elseif ( 'Action' === substr( $class, -6 ) ) { $dir = $classes_dir . 'actions' . $d; } elseif ( 'Schema' === substr( $class, -6 ) ) { $dir = $classes_dir . 'schema' . $d; } elseif ( strpos( $class, 'ActionScheduler' ) === 0 ) { $segments = explode( '_', $class ); $type = isset( $segments[1] ) ? $segments[1] : ''; switch ( $type ) { case 'WPCLI': $dir = $classes_dir . 'WP_CLI' . $d; break; case 'DBLogger': case 'DBStore': case 'HybridStore': case 'wpPostStore': case 'wpCommentLogger': $dir = $classes_dir . 'data-stores' . $d; break; default: $dir = $classes_dir; break; } } elseif ( self::is_class_cli( $class ) ) { $dir = $classes_dir . 'WP_CLI' . $d; } elseif ( strpos( $class, 'CronExpression' ) === 0 ) { $dir = self::plugin_path( 'lib' . $d . 'cron-expression' . $d ); } elseif ( strpos( $class, 'WP_Async_Request' ) === 0 ) { $dir = self::plugin_path( 'lib' . $d ); } else { return; } if ( file_exists( $dir . "{$class}.php" ) ) { include $dir . "{$class}.php"; return; } } /** * Initialize the plugin * * @static * @param string $plugin_file Plugin file path. */ public static function init( $plugin_file ) { self::$plugin_file = $plugin_file; spl_autoload_register( array( __CLASS__, 'autoload' ) ); /** * Fires in the early stages of Action Scheduler init hook. */ do_action( 'action_scheduler_pre_init' ); require_once self::plugin_path( 'functions.php' ); ActionScheduler_DataController::init(); $store = self::store(); $logger = self::logger(); $runner = self::runner(); $admin_view = self::admin_view(); $recurring_action_scheduler = new ActionScheduler_RecurringActionScheduler(); // Ensure initialization on plugin activation. if ( ! did_action( 'init' ) ) { // phpcs:ignore Squiz.PHP.CommentedOutCode add_action( 'init', array( $admin_view, 'init' ), 0, 0 ); // run before $store::init(). add_action( 'init', array( $store, 'init' ), 1, 0 ); add_action( 'init', array( $logger, 'init' ), 1, 0 ); add_action( 'init', array( $runner, 'init' ), 1, 0 ); add_action( 'init', array( $recurring_action_scheduler, 'init' ), 1, 0 ); add_action( 'init', /** * Runs after the active store's init() method has been called. * * It would probably be preferable to have $store->init() (or it's parent method) set this itself, * once it has initialized, however that would cause problems in cases where a custom data store is in * use and it has not yet been updated to follow that same logic. */ function () { self::$data_store_initialized = true; /** * Fires when Action Scheduler is ready: it is safe to use the procedural API after this point. * * @since 3.5.5 */ do_action( 'action_scheduler_init' ); }, 1 ); } else { $admin_view->init(); $store->init(); $logger->init(); $runner->init(); $recurring_action_scheduler->init(); self::$data_store_initialized = true; /** * Fires when Action Scheduler is ready: it is safe to use the procedural API after this point. * * @since 3.5.5 */ do_action( 'action_scheduler_init' ); } if ( apply_filters( 'action_scheduler_load_deprecated_functions', true ) ) { require_once self::plugin_path( 'deprecated/functions.php' ); } if ( defined( 'WP_CLI' ) && WP_CLI ) { WP_CLI::add_command( 'action-scheduler', 'ActionScheduler_WPCLI_Scheduler_command' ); WP_CLI::add_command( 'action-scheduler', 'ActionScheduler_WPCLI_Clean_Command' ); WP_CLI::add_command( 'action-scheduler action', '\Action_Scheduler\WP_CLI\Action_Command' ); WP_CLI::add_command( 'action-scheduler', '\Action_Scheduler\WP_CLI\System_Command' ); if ( ! ActionScheduler_DataController::is_migration_complete() && Controller::instance()->allow_migration() ) { $command = new Migration_Command(); $command->register(); } } /** * Handle WP comment cleanup after migration. */ if ( is_a( $logger, 'ActionScheduler_DBLogger' ) && ActionScheduler_DataController::is_migration_complete() && ActionScheduler_WPCommentCleaner::has_logs() ) { ActionScheduler_WPCommentCleaner::init(); } add_action( 'action_scheduler/migration_complete', 'ActionScheduler_WPCommentCleaner::maybe_schedule_cleanup' ); } /** * Check whether the AS data store has been initialized. * * @param string $function_name The name of the function being called. Optional. Default `null`. * @return bool */ public static function is_initialized( $function_name = null ) { if ( ! self::$data_store_initialized && ! empty( $function_name ) ) { $message = sprintf( /* translators: %s function name. */ __( '%s() was called before the Action Scheduler data store was initialized', 'woocommerce' ), esc_attr( $function_name ) ); _doing_it_wrong( esc_html( $function_name ), esc_html( $message ), '3.1.6' ); } return self::$data_store_initialized; } /** * Determine if the class is one of our abstract classes. * * @since 3.0.0 * * @param string $class The class name. * * @return bool */ protected static function is_class_abstract( $class ) { static $abstracts = array( 'ActionScheduler' => true, 'ActionScheduler_Abstract_ListTable' => true, 'ActionScheduler_Abstract_QueueRunner' => true, 'ActionScheduler_Abstract_Schedule' => true, 'ActionScheduler_Abstract_RecurringSchedule' => true, 'ActionScheduler_Lock' => true, 'ActionScheduler_Logger' => true, 'ActionScheduler_Abstract_Schema' => true, 'ActionScheduler_Store' => true, 'ActionScheduler_TimezoneHelper' => true, 'ActionScheduler_WPCLI_Command' => true, ); return isset( $abstracts[ $class ] ) && $abstracts[ $class ]; } /** * Determine if the class is one of our migration classes. * * @since 3.0.0 * * @param string $class The class name. * * @return bool */ protected static function is_class_migration( $class ) { static $migration_segments = array( 'ActionMigrator' => true, 'BatchFetcher' => true, 'DBStoreMigrator' => true, 'DryRun' => true, 'LogMigrator' => true, 'Config' => true, 'Controller' => true, 'Runner' => true, 'Scheduler' => true, ); $segments = explode( '_', $class ); $segment = isset( $segments[1] ) ? $segments[1] : $class; return isset( $migration_segments[ $segment ] ) && $migration_segments[ $segment ]; } /** * Determine if the class is one of our WP CLI classes. * * @since 3.0.0 * * @param string $class The class name. * * @return bool */ protected static function is_class_cli( $class ) { static $cli_segments = array( 'QueueRunner' => true, 'Command' => true, 'ProgressBar' => true, '\Action_Scheduler\WP_CLI\Action_Command' => true, '\Action_Scheduler\WP_CLI\System_Command' => true, ); $segments = explode( '_', $class ); $segment = isset( $segments[1] ) ? $segments[1] : $class; return isset( $cli_segments[ $segment ] ) && $cli_segments[ $segment ]; } /** * Clone. */ final public function __clone() { trigger_error( 'Singleton. No cloning allowed!', E_USER_ERROR ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error } /** * Wakeup. */ final public function __wakeup() { trigger_error( 'Singleton. No serialization allowed!', E_USER_ERROR ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error } /** * Construct. */ final private function __construct() {} /** Deprecated **/ /** * Get DateTime object. * * @param null|string $when Date/time string. * @param string $timezone Timezone string. */ public static function get_datetime_object( $when = null, $timezone = 'UTC' ) { _deprecated_function( __METHOD__, '2.0', 'wcs_add_months()' ); return as_get_datetime_object( $when, $timezone ); } /** * Issue deprecated warning if an Action Scheduler function is called in the shutdown hook. * * @param string $function_name The name of the function being called. * @deprecated 3.1.6. */ public static function check_shutdown_hook( $function_name ) { _deprecated_function( __FUNCTION__, '3.1.6' ); } } action-scheduler/classes/abstracts/ActionScheduler_WPCLI_Command.php 0000777 00000004066 15252010675 0021621 0 ustar 00 <?php /** * Abstract for WP-CLI commands. */ abstract class ActionScheduler_WPCLI_Command extends \WP_CLI_Command { const DATE_FORMAT = 'Y-m-d H:i:s O'; /** * Keyed arguments. * * @var string[] */ protected $args; /** * Positional arguments. * * @var array<string, string> */ protected $assoc_args; /** * Construct. * * @param string[] $args Positional arguments. * @param array<string, string> $assoc_args Keyed arguments. * @throws \Exception When loading a CLI command file outside of WP CLI context. */ public function __construct( array $args, array $assoc_args ) { if ( ! defined( 'WP_CLI' ) || ! constant( 'WP_CLI' ) ) { /* translators: %s php class name */ throw new \Exception( sprintf( __( 'The %s class can only be run within WP CLI.', 'woocommerce' ), get_class( $this ) ) ); } $this->args = $args; $this->assoc_args = $assoc_args; } /** * Execute command. */ abstract public function execute(); /** * Get the scheduled date in a human friendly format. * * @see ActionScheduler_ListTable::get_schedule_display_string() * @param ActionScheduler_Schedule $schedule Schedule. * @return string */ protected function get_schedule_display_string( ActionScheduler_Schedule $schedule ) { $schedule_display_string = ''; if ( ! $schedule->get_date() ) { return '0000-00-00 00:00:00'; } $next_timestamp = $schedule->get_date()->getTimestamp(); $schedule_display_string .= $schedule->get_date()->format( static::DATE_FORMAT ); return $schedule_display_string; } /** * Transforms arguments with '__' from CSV into expected arrays. * * @see \WP_CLI\CommandWithDBObject::process_csv_arguments_to_arrays() * @link https://github.com/wp-cli/entity-command/blob/c270cc9a2367cb8f5845f26a6b5e203397c91392/src/WP_CLI/CommandWithDBObject.php#L99 * @return void */ protected function process_csv_arguments_to_arrays() { foreach ( $this->assoc_args as $k => $v ) { if ( false !== strpos( $k, '__' ) ) { $this->assoc_args[ $k ] = explode( ',', $v ); } } } } action-scheduler/classes/abstracts/ActionScheduler_Store.php 0000777 00000034033 15252010675 0020376 0 ustar 00 <?php /** * Class ActionScheduler_Store * * @codeCoverageIgnore */ abstract class ActionScheduler_Store extends ActionScheduler_Store_Deprecated { const STATUS_COMPLETE = 'complete'; const STATUS_PENDING = 'pending'; const STATUS_RUNNING = 'in-progress'; const STATUS_FAILED = 'failed'; const STATUS_CANCELED = 'canceled'; const DEFAULT_CLASS = 'ActionScheduler_wpPostStore'; /** * ActionScheduler_Store instance. * * @var ActionScheduler_Store */ private static $store = null; /** * Maximum length of args. * * @var int */ protected static $max_args_length = 191; /** * Save action. * * @param ActionScheduler_Action $action Action to save. * @param null|DateTime $scheduled_date Optional Date of the first instance * to store. Otherwise uses the first date of the action's * schedule. * * @return int The action ID */ abstract public function save_action( ActionScheduler_Action $action, ?DateTime $scheduled_date = null ); /** * Get action. * * @param string $action_id Action ID. * * @return ActionScheduler_Action */ abstract public function fetch_action( $action_id ); /** * Find an action. * * Note: the query ordering changes based on the passed 'status' value. * * @param string $hook Action hook. * @param array $params Parameters of the action to find. * * @return string|null ID of the next action matching the criteria or NULL if not found. */ public function find_action( $hook, $params = array() ) { $params = wp_parse_args( $params, array( 'args' => null, 'status' => self::STATUS_PENDING, 'group' => '', ) ); // These params are fixed for this method. $params['hook'] = $hook; $params['orderby'] = 'date'; $params['per_page'] = 1; if ( ! empty( $params['status'] ) ) { if ( self::STATUS_PENDING === $params['status'] ) { $params['order'] = 'ASC'; // Find the next action that matches. } else { $params['order'] = 'DESC'; // Find the most recent action that matches. } } $results = $this->query_actions( $params ); return empty( $results ) ? null : $results[0]; } /** * Query for action count or list of action IDs. * * @since 3.3.0 $query['status'] accepts array of statuses instead of a single status. * * @param array $query { * Query filtering options. * * @type string $hook The name of the actions. Optional. * @type string|array $status The status or statuses of the actions. Optional. * @type array $args The args array of the actions. Optional. * @type DateTime $date The scheduled date of the action. Used in UTC timezone. Optional. * @type string $date_compare Operator for selecting by $date param. Accepted values are '!=', '>', '>=', '<', '<=', '='. Defaults to '<='. * @type DateTime $modified The last modified date of the action. Used in UTC timezone. Optional. * @type string $modified_compare Operator for comparing $modified param. Accepted values are '!=', '>', '>=', '<', '<=', '='. Defaults to '<='. * @type string $group The group the action belongs to. Optional. * @type bool|int $claimed TRUE to find claimed actions, FALSE to find unclaimed actions, an int to find a specific claim ID. Optional. * @type int $per_page Number of results to return. Defaults to 5. * @type int $offset The query pagination offset. Defaults to 0. * @type int $orderby Accepted values are 'hook', 'group', 'modified', 'date' or 'none'. Defaults to 'date'. * @type string $order Accepted values are 'ASC' or 'DESC'. Defaults to 'ASC'. * } * @param string $query_type Whether to select or count the results. Default, select. * * @return string|array|null The IDs of actions matching the query. Null on failure. */ abstract public function query_actions( $query = array(), $query_type = 'select' ); /** * Run query to get a single action ID. * * @since 3.3.0 * * @see ActionScheduler_Store::query_actions for $query arg usage but 'per_page' and 'offset' can't be used. * * @param array $query Query parameters. * * @return int|null */ public function query_action( $query ) { $query['per_page'] = 1; $query['offset'] = 0; $results = $this->query_actions( $query ); if ( empty( $results ) ) { return null; } else { return (int) $results[0]; } } /** * Get a count of all actions in the store, grouped by status * * @return array */ abstract public function action_counts(); /** * Get additional action counts. * * - add past-due actions * * @return array */ public function extra_action_counts() { $extra_actions = array(); $pastdue_action_counts = (int) $this->query_actions( array( 'status' => self::STATUS_PENDING, 'date' => as_get_datetime_object(), ), 'count' ); if ( $pastdue_action_counts ) { $extra_actions['past-due'] = $pastdue_action_counts; } /** * Allows 3rd party code to add extra action counts (used in filters in the list table). * * @since 3.5.0 * @param $extra_actions array Array with format action_count_identifier => action count. */ return apply_filters( 'action_scheduler_extra_action_counts', $extra_actions ); } /** * Cancel action. * * @param string $action_id Action ID. */ abstract public function cancel_action( $action_id ); /** * Delete action. * * @param string $action_id Action ID. */ abstract public function delete_action( $action_id ); /** * Get action's schedule or run timestamp. * * @param string $action_id Action ID. * * @return DateTime The date the action is schedule to run, or the date that it ran. */ abstract public function get_date( $action_id ); /** * Make a claim. * * @param int $max_actions Maximum number of actions to claim. * @param DateTime|null $before_date Claim only actions schedule before the given date. Defaults to now. * @param array $hooks Claim only actions with a hook or hooks. * @param string $group Claim only actions in the given group. * * @return ActionScheduler_ActionClaim */ abstract public function stake_claim( $max_actions = 10, ?DateTime $before_date = null, $hooks = array(), $group = '' ); /** * Get claim count. * * @return int */ abstract public function get_claim_count(); /** * Release the claim. * * @param ActionScheduler_ActionClaim $claim Claim object. */ abstract public function release_claim( ActionScheduler_ActionClaim $claim ); /** * Un-claim the action. * * @param string $action_id Action ID. */ abstract public function unclaim_action( $action_id ); /** * Mark action as failed. * * @param string $action_id Action ID. */ abstract public function mark_failure( $action_id ); /** * Log action's execution. * * @param string $action_id Actoin ID. */ abstract public function log_execution( $action_id ); /** * Mark action as complete. * * @param string $action_id Action ID. */ abstract public function mark_complete( $action_id ); /** * Get action's status. * * @param string $action_id Action ID. * @return string */ abstract public function get_status( $action_id ); /** * Get action's claim ID. * * @param string $action_id Action ID. * @return mixed */ abstract public function get_claim_id( $action_id ); /** * Find actions by claim ID. * * @param string $claim_id Claim ID. * @return array */ abstract public function find_actions_by_claim_id( $claim_id ); /** * Validate SQL operator. * * @param string $comparison_operator Operator. * @return string */ protected function validate_sql_comparator( $comparison_operator ) { if ( in_array( $comparison_operator, array( '!=', '>', '>=', '<', '<=', '=' ), true ) ) { return $comparison_operator; } return '='; } /** * Get the time MySQL formatted date/time string for an action's (next) scheduled date. * * @param ActionScheduler_Action $action Action. * @param null|DateTime $scheduled_date Action's schedule date (optional). * @return string */ protected function get_scheduled_date_string( ActionScheduler_Action $action, ?DateTime $scheduled_date = null ) { $next = is_null( $scheduled_date ) ? $action->get_schedule()->get_date() : $scheduled_date; if ( ! $next ) { $next = date_create(); } $next->setTimezone( new DateTimeZone( 'UTC' ) ); return $next->format( 'Y-m-d H:i:s' ); } /** * Get the time MySQL formatted date/time string for an action's (next) scheduled date. * * @param ActionScheduler_Action|null $action Action. * @param null|DateTime $scheduled_date Action's scheduled date (optional). * @return string */ protected function get_scheduled_date_string_local( ActionScheduler_Action $action, ?DateTime $scheduled_date = null ) { $next = is_null( $scheduled_date ) ? $action->get_schedule()->get_date() : $scheduled_date; if ( ! $next ) { $next = date_create(); } ActionScheduler_TimezoneHelper::set_local_timezone( $next ); return $next->format( 'Y-m-d H:i:s' ); } /** * Validate that we could decode action arguments. * * @param mixed $args The decoded arguments. * @param int $action_id The action ID. * * @throws ActionScheduler_InvalidActionException When the decoded arguments are invalid. */ protected function validate_args( $args, $action_id ) { // Ensure we have an array of args. if ( ! is_array( $args ) ) { throw ActionScheduler_InvalidActionException::from_decoding_args( $action_id ); } // Validate JSON decoding if possible. if ( function_exists( 'json_last_error' ) && JSON_ERROR_NONE !== json_last_error() ) { throw ActionScheduler_InvalidActionException::from_decoding_args( $action_id, $args ); } } /** * Validate a ActionScheduler_Schedule object. * * @param mixed $schedule The unserialized ActionScheduler_Schedule object. * @param int $action_id The action ID. * * @throws ActionScheduler_InvalidActionException When the schedule is invalid. */ protected function validate_schedule( $schedule, $action_id ) { if ( empty( $schedule ) || ! is_a( $schedule, 'ActionScheduler_Schedule' ) ) { throw ActionScheduler_InvalidActionException::from_schedule( $action_id, $schedule ); } } /** * InnoDB indexes have a maximum size of 767 bytes by default, which is only 191 characters with utf8mb4. * * Previously, AS wasn't concerned about args length, as we used the (unindex) post_content column. However, * with custom tables, we use an indexed VARCHAR column instead. * * @param ActionScheduler_Action $action Action to be validated. * @throws InvalidArgumentException When json encoded args is too long. */ protected function validate_action( ActionScheduler_Action $action ) { if ( strlen( wp_json_encode( $action->get_args() ) ) > static::$max_args_length ) { // translators: %d is a number (maximum length of action arguments). throw new InvalidArgumentException( sprintf( __( 'ActionScheduler_Action::$args too long. To ensure the args column can be indexed, action args should not be more than %d characters when encoded as JSON.', 'woocommerce' ), static::$max_args_length ) ); } } /** * Cancel pending actions by hook. * * @since 3.0.0 * * @param string $hook Hook name. * * @return void */ public function cancel_actions_by_hook( $hook ) { $action_ids = true; while ( ! empty( $action_ids ) ) { $action_ids = $this->query_actions( array( 'hook' => $hook, 'status' => self::STATUS_PENDING, 'per_page' => 1000, 'orderby' => 'none', ) ); $this->bulk_cancel_actions( $action_ids ); } } /** * Cancel pending actions by group. * * @since 3.0.0 * * @param string $group Group slug. * * @return void */ public function cancel_actions_by_group( $group ) { $action_ids = true; while ( ! empty( $action_ids ) ) { $action_ids = $this->query_actions( array( 'group' => $group, 'status' => self::STATUS_PENDING, 'per_page' => 1000, 'orderby' => 'none', ) ); $this->bulk_cancel_actions( $action_ids ); } } /** * Cancel a set of action IDs. * * @since 3.0.0 * * @param int[] $action_ids List of action IDs. * * @return void */ private function bulk_cancel_actions( $action_ids ) { foreach ( $action_ids as $action_id ) { $this->cancel_action( $action_id ); } do_action( 'action_scheduler_bulk_cancel_actions', $action_ids ); } /** * Get status labels. * * @return array<string, string> */ public function get_status_labels() { return array( self::STATUS_COMPLETE => __( 'Complete', 'woocommerce' ), self::STATUS_PENDING => __( 'Pending', 'woocommerce' ), self::STATUS_RUNNING => __( 'In-progress', 'woocommerce' ), self::STATUS_FAILED => __( 'Failed', 'woocommerce' ), self::STATUS_CANCELED => __( 'Canceled', 'woocommerce' ), ); } /** * Check if there are any pending scheduled actions due to run. * * @return string */ public function has_pending_actions_due() { $pending_actions = $this->query_actions( array( 'per_page' => 1, 'date' => as_get_datetime_object(), 'status' => self::STATUS_PENDING, 'orderby' => 'none', ), 'count' ); return ! empty( $pending_actions ); } /** * Callable initialization function optionally overridden in derived classes. */ public function init() {} /** * Callable function to mark an action as migrated optionally overridden in derived classes. * * @param int $action_id Action ID. */ public function mark_migrated( $action_id ) {} /** * Get instance. * * @return ActionScheduler_Store */ public static function instance() { if ( empty( self::$store ) ) { $class = apply_filters( 'action_scheduler_store_class', self::DEFAULT_CLASS ); self::$store = new $class(); } return self::$store; } } action-scheduler/classes/abstracts/ActionScheduler_Abstract_RecurringSchedule.php 0000777 00000006346 15252010675 0024550 0 ustar 00 <?php /** * Class ActionScheduler_Abstract_RecurringSchedule */ abstract class ActionScheduler_Abstract_RecurringSchedule extends ActionScheduler_Abstract_Schedule { /** * The date & time the first instance of this schedule was setup to run (which may not be this instance). * * Schedule objects are attached to an action object. Each schedule stores the run date for that * object as the start date - @see $this->start - and logic to calculate the next run date after * that - @see $this->calculate_next(). The $first_date property also keeps a record of when the very * first instance of this chain of schedules ran. * * @var DateTime */ private $first_date = null; /** * Timestamp equivalent of @see $this->first_date * * @var int */ protected $first_timestamp = null; /** * The recurrence between each time an action is run using this schedule. * Used to calculate the start date & time. Can be a number of seconds, in the * case of ActionScheduler_IntervalSchedule, or a cron expression, as in the * case of ActionScheduler_CronSchedule. Or something else. * * @var mixed */ protected $recurrence; /** * Construct. * * @param DateTime $date The date & time to run the action. * @param mixed $recurrence The data used to determine the schedule's recurrence. * @param DateTime|null $first (Optional) The date & time the first instance of this interval schedule ran. Default null, meaning this is the first instance. */ public function __construct( DateTime $date, $recurrence, ?DateTime $first = null ) { parent::__construct( $date ); $this->first_date = empty( $first ) ? $date : $first; $this->recurrence = $recurrence; } /** * Schedule is recurring. * * @return bool */ public function is_recurring() { return true; } /** * Get the date & time of the first schedule in this recurring series. * * @return DateTime|null */ public function get_first_date() { return clone $this->first_date; } /** * Get the schedule's recurrence. * * @return string */ public function get_recurrence() { return $this->recurrence; } /** * For PHP 5.2 compat, since DateTime objects can't be serialized * * @return array */ public function __sleep() { $sleep_params = parent::__sleep(); $this->first_timestamp = $this->first_date->getTimestamp(); return array_merge( $sleep_params, array( 'first_timestamp', 'recurrence', ) ); } /** * Unserialize recurring schedules serialized/stored prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, schedules used different property names to refer * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. This was addressed in * Action Scheduler 3.0.0, where properties and property names were aligned for better * inheritance. To maintain backward compatibility with scheduled serialized and stored * prior to 3.0, we need to correctly map the old property names. */ public function __wakeup() { parent::__wakeup(); if ( $this->first_timestamp > 0 ) { $this->first_date = as_get_datetime_object( $this->first_timestamp ); } else { $this->first_date = $this->get_date(); } } } action-scheduler/classes/abstracts/ActionScheduler_Abstract_QueueRunner.php 0000777 00000032705 15252010675 0023407 0 ustar 00 <?php /** * Abstract class with common Queue Cleaner functionality. */ abstract class ActionScheduler_Abstract_QueueRunner extends ActionScheduler_Abstract_QueueRunner_Deprecated { /** * ActionScheduler_QueueCleaner instance. * * @var ActionScheduler_QueueCleaner */ protected $cleaner; /** * ActionScheduler_FatalErrorMonitor instance. * * @var ActionScheduler_FatalErrorMonitor */ protected $monitor; /** * ActionScheduler_Store instance. * * @var ActionScheduler_Store */ protected $store; /** * The created time. * * Represents when the queue runner was constructed and used when calculating how long a PHP request has been running. * For this reason it should be as close as possible to the PHP request start time. * * @var int */ private $created_time; /** * ActionScheduler_Abstract_QueueRunner constructor. * * @param ActionScheduler_Store|null $store Store object. * @param ActionScheduler_FatalErrorMonitor|null $monitor Monitor object. * @param ActionScheduler_QueueCleaner|null $cleaner Cleaner object. */ public function __construct( ?ActionScheduler_Store $store = null, ?ActionScheduler_FatalErrorMonitor $monitor = null, ?ActionScheduler_QueueCleaner $cleaner = null ) { $this->created_time = microtime( true ); $this->store = $store ? $store : ActionScheduler_Store::instance(); $this->monitor = $monitor ? $monitor : new ActionScheduler_FatalErrorMonitor( $this->store ); $this->cleaner = $cleaner ? $cleaner : new ActionScheduler_QueueCleaner( $this->store ); } /** * Process an individual action. * * @param int $action_id The action ID to process. * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron' * Generally, this should be capitalised and not localised as it's a proper noun. * @throws \Exception When error running action. */ public function process_action( $action_id, $context = '' ) { // Temporarily override the error handler while we process the current action. // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_set_error_handler set_error_handler( /** * Temporary error handler which can catch errors and convert them into exceptions. This facilitates more * robust error handling across all supported PHP versions. * * @throws Exception * * @param int $type Error level expressed as an integer. * @param string $message Error message. */ function ( $type, $message ) { throw new Exception( $message ); }, E_USER_ERROR | E_RECOVERABLE_ERROR ); /* * The nested try/catch structure is required because we potentially need to convert thrown errors into * exceptions (and an exception thrown from a catch block cannot be caught by a later catch block in the *same* * structure). */ try { try { $valid_action = true; do_action( 'action_scheduler_before_execute', $action_id, $context ); if ( ActionScheduler_Store::STATUS_PENDING !== $this->store->get_status( $action_id ) ) { $valid_action = false; do_action( 'action_scheduler_execution_ignored', $action_id, $context ); return; } do_action( 'action_scheduler_begin_execute', $action_id, $context ); $action = $this->store->fetch_action( $action_id ); $this->store->log_execution( $action_id ); $action->execute(); do_action( 'action_scheduler_after_execute', $action_id, $action, $context ); $this->store->mark_complete( $action_id ); } catch ( Throwable $e ) { // Throwable is defined when executing under PHP 7.0 and up. We convert it to an exception, for // compatibility with ActionScheduler_Logger. throw new Exception( $e->getMessage(), $e->getCode(), $e ); } } catch ( Exception $e ) { // This catch block exists for compatibility with PHP 5.6. $this->handle_action_error( $action_id, $e, $context, $valid_action ); } finally { restore_error_handler(); } if ( isset( $action ) && is_a( $action, 'ActionScheduler_Action' ) && $action->get_schedule()->is_recurring() ) { $this->schedule_next_instance( $action, $action_id ); } } /** * Marks actions as either having failed execution or failed validation, as appropriate. * * @param int $action_id Action ID. * @param Exception $e Exception instance. * @param string $context Execution context. * @param bool $valid_action If the action is valid. * * @return void */ private function handle_action_error( $action_id, $e, $context, $valid_action ) { if ( $valid_action ) { $this->store->mark_failure( $action_id ); /** * Runs when action execution fails. * * @param int $action_id Action ID. * @param Exception $e Exception instance. * @param string $context Execution context. */ do_action( 'action_scheduler_failed_execution', $action_id, $e, $context ); } else { /** * Runs when action validation fails. * * @param int $action_id Action ID. * @param Exception $e Exception instance. * @param string $context Execution context. */ do_action( 'action_scheduler_failed_validation', $action_id, $e, $context ); } } /** * Schedule the next instance of the action if necessary. * * @param ActionScheduler_Action $action Action. * @param int $action_id Action ID. */ protected function schedule_next_instance( ActionScheduler_Action $action, $action_id ) { // If a recurring action has been consistently failing, we may wish to stop rescheduling it. if ( ActionScheduler_Store::STATUS_FAILED === $this->store->get_status( $action_id ) && $this->recurring_action_is_consistently_failing( $action, $action_id ) ) { ActionScheduler_Logger::instance()->log( $action_id, __( 'This action appears to be consistently failing. A new instance will not be scheduled.', 'woocommerce' ) ); return; } try { ActionScheduler::factory()->repeat( $action ); } catch ( Exception $e ) { do_action( 'action_scheduler_failed_to_schedule_next_instance', $action_id, $e, $action ); } } /** * Determine if the specified recurring action has been consistently failing. * * @param ActionScheduler_Action $action The recurring action to be rescheduled. * @param int $action_id The ID of the recurring action. * * @return bool */ private function recurring_action_is_consistently_failing( ActionScheduler_Action $action, $action_id ) { /** * Controls the failure threshold for recurring actions. * * Before rescheduling a recurring action, we look at its status. If it failed, we then check if all of the most * recent actions (upto the threshold set by this filter) sharing the same hook have also failed: if they have, * that is considered consistent failure and a new instance of the action will not be scheduled. * * @param int $failure_threshold Number of actions of the same hook to examine for failure. Defaults to 5. */ $consistent_failure_threshold = (int) apply_filters( 'action_scheduler_recurring_action_failure_threshold', 5 ); // This query should find the earliest *failing* action (for the hook we are interested in) within our threshold. $query_args = array( 'hook' => $action->get_hook(), 'status' => ActionScheduler_Store::STATUS_FAILED, 'date' => date_create( 'now', timezone_open( 'UTC' ) )->format( 'Y-m-d H:i:s' ), 'date_compare' => '<', 'per_page' => 1, 'offset' => $consistent_failure_threshold - 1, ); $first_failing_action_id = $this->store->query_actions( $query_args ); // If we didn't retrieve an action ID, then there haven't been enough failures for us to worry about. if ( empty( $first_failing_action_id ) ) { return false; } // Now let's fetch the first action (having the same hook) of *any status* within the same window. unset( $query_args['status'] ); $first_action_id_with_the_same_hook = $this->store->query_actions( $query_args ); /** * If a recurring action is assessed as consistently failing, it will not be rescheduled. This hook provides a * way to observe and optionally override that assessment. * * @param bool $is_consistently_failing If the action is considered to be consistently failing. * @param ActionScheduler_Action $action The action being assessed. */ return (bool) apply_filters( 'action_scheduler_recurring_action_is_consistently_failing', $first_action_id_with_the_same_hook === $first_failing_action_id, $action ); } /** * Run the queue cleaner. */ protected function run_cleanup() { $this->cleaner->clean( 10 * $this->get_time_limit() ); } /** * Get the number of concurrent batches a runner allows. * * @return int */ public function get_allowed_concurrent_batches() { return apply_filters( 'action_scheduler_queue_runner_concurrent_batches', 1 ); } /** * Check if the number of allowed concurrent batches is met or exceeded. * * @return bool */ public function has_maximum_concurrent_batches() { return $this->store->get_claim_count() >= $this->get_allowed_concurrent_batches(); } /** * Get the maximum number of seconds a batch can run for. * * @return int The number of seconds. */ protected function get_time_limit() { $time_limit = 30; // Apply deprecated filter from deprecated get_maximum_execution_time() method. if ( has_filter( 'action_scheduler_maximum_execution_time' ) ) { _deprecated_function( 'action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit' ); $time_limit = apply_filters( 'action_scheduler_maximum_execution_time', $time_limit ); } return absint( apply_filters( 'action_scheduler_queue_runner_time_limit', $time_limit ) ); } /** * Get the number of seconds the process has been running. * * @return int The number of seconds. */ protected function get_execution_time() { $execution_time = microtime( true ) - $this->created_time; // Get the CPU time if the hosting environment uses it rather than wall-clock time to calculate a process's execution time. if ( function_exists( 'getrusage' ) && apply_filters( 'action_scheduler_use_cpu_execution_time', defined( 'PANTHEON_ENVIRONMENT' ) ) ) { $resource_usages = getrusage(); if ( isset( $resource_usages['ru_stime.tv_usec'], $resource_usages['ru_stime.tv_usec'] ) ) { $execution_time = $resource_usages['ru_stime.tv_sec'] + ( $resource_usages['ru_stime.tv_usec'] / 1000000 ); } } return $execution_time; } /** * Check if the host's max execution time is (likely) to be exceeded if processing more actions. * * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action. * @return bool */ protected function time_likely_to_be_exceeded( $processed_actions ) { $execution_time = $this->get_execution_time(); $max_execution_time = $this->get_time_limit(); // Safety against division by zero errors. if ( 0 === $processed_actions ) { return $execution_time >= $max_execution_time; } $time_per_action = $execution_time / $processed_actions; $estimated_time = $execution_time + ( $time_per_action * 3 ); $likely_to_be_exceeded = $estimated_time > $max_execution_time; return apply_filters( 'action_scheduler_maximum_execution_time_likely_to_be_exceeded', $likely_to_be_exceeded, $this, $processed_actions, $execution_time, $max_execution_time ); } /** * Get memory limit * * Based on WP_Background_Process::get_memory_limit() * * @return int */ protected function get_memory_limit() { if ( function_exists( 'ini_get' ) ) { $memory_limit = ini_get( 'memory_limit' ); } else { $memory_limit = '128M'; // Sensible default, and minimum required by WooCommerce. } if ( ! $memory_limit || -1 === $memory_limit || '-1' === $memory_limit ) { // Unlimited, set to 32GB. $memory_limit = '32G'; } return ActionScheduler_Compatibility::convert_hr_to_bytes( $memory_limit ); } /** * Memory exceeded * * Ensures the batch process never exceeds 90% of the maximum WordPress memory. * * Based on WP_Background_Process::memory_exceeded() * * @return bool */ protected function memory_exceeded() { $memory_limit = $this->get_memory_limit() * 0.90; $current_memory = memory_get_usage( true ); $memory_exceeded = $current_memory >= $memory_limit; return apply_filters( 'action_scheduler_memory_exceeded', $memory_exceeded, $this ); } /** * See if the batch limits have been exceeded, which is when memory usage is almost at * the maximum limit, or the time to process more actions will exceed the max time limit. * * Based on WC_Background_Process::batch_limits_exceeded() * * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action. * @return bool */ protected function batch_limits_exceeded( $processed_actions ) { return $this->memory_exceeded() || $this->time_likely_to_be_exceeded( $processed_actions ); } /** * Process actions in the queue. * * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron' * Generally, this should be capitalised and not localised as it's a proper noun. * @return int The number of actions processed. */ abstract public function run( $context = '' ); } action-scheduler/classes/abstracts/ActionScheduler_Abstract_Schema.php 0000777 00000011443 15252010675 0022325 0 ustar 00 <?php /** * Class ActionScheduler_Abstract_Schema * * @package Action_Scheduler * * @codeCoverageIgnore * * Utility class for creating/updating custom tables */ abstract class ActionScheduler_Abstract_Schema { /** * Increment this value in derived class to trigger a schema update. * * @var int */ protected $schema_version = 1; /** * Schema version stored in database. * * @var string */ protected $db_version; /** * Names of tables that will be registered by this class. * * @var array */ protected $tables = array(); /** * Can optionally be used by concrete classes to carry out additional initialization work * as needed. */ public function init() {} /** * Register tables with WordPress, and create them if needed. * * @param bool $force_update Optional. Default false. Use true to always run the schema update. * * @return void */ public function register_tables( $force_update = false ) { global $wpdb; // make WP aware of our tables. foreach ( $this->tables as $table ) { $wpdb->tables[] = $table; $name = $this->get_full_table_name( $table ); $wpdb->$table = $name; } // create the tables. if ( $this->schema_update_required() || $force_update ) { foreach ( $this->tables as $table ) { /** * Allow custom processing before updating a table schema. * * @param string $table Name of table being updated. * @param string $db_version Existing version of the table being updated. */ do_action( 'action_scheduler_before_schema_update', $table, $this->db_version ); $this->update_table( $table ); } $this->mark_schema_update_complete(); } } /** * Get table definition. * * @param string $table The name of the table. * * @return string The CREATE TABLE statement, suitable for passing to dbDelta */ abstract protected function get_table_definition( $table ); /** * Determine if the database schema is out of date * by comparing the integer found in $this->schema_version * with the option set in the WordPress options table * * @return bool */ private function schema_update_required() { $option_name = 'schema-' . static::class; $this->db_version = get_option( $option_name, 0 ); // Check for schema option stored by the Action Scheduler Custom Tables plugin in case site has migrated from that plugin with an older schema. if ( 0 === $this->db_version ) { $plugin_option_name = 'schema-'; switch ( static::class ) { case 'ActionScheduler_StoreSchema': $plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Store_Table_Maker'; break; case 'ActionScheduler_LoggerSchema': $plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Logger_Table_Maker'; break; } $this->db_version = get_option( $plugin_option_name, 0 ); delete_option( $plugin_option_name ); } return version_compare( $this->db_version, $this->schema_version, '<' ); } /** * Update the option in WordPress to indicate that * our schema is now up to date * * @return void */ private function mark_schema_update_complete() { $option_name = 'schema-' . static::class; // work around race conditions and ensure that our option updates. $value_to_save = (string) $this->schema_version . '.0.' . time(); update_option( $option_name, $value_to_save ); } /** * Update the schema for the given table * * @param string $table The name of the table to update. * * @return void */ private function update_table( $table ) { require_once ABSPATH . 'wp-admin/includes/upgrade.php'; $definition = $this->get_table_definition( $table ); if ( $definition ) { $updated = dbDelta( $definition ); foreach ( $updated as $updated_table => $update_description ) { if ( strpos( $update_description, 'Created table' ) === 0 ) { do_action( 'action_scheduler/created_table', $updated_table, $table ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores } } } } /** * Get full table name. * * @param string $table Table name. * * @return string The full name of the table, including the * table prefix for the current blog */ protected function get_full_table_name( $table ) { return $GLOBALS['wpdb']->prefix . $table; } /** * Confirms that all of the tables registered by this schema class have been created. * * @return bool */ public function tables_exist() { global $wpdb; $tables_exist = true; foreach ( $this->tables as $table_name ) { $table_name = $wpdb->prefix . $table_name; $pattern = str_replace( '_', '\\_', $table_name ); $existing_table = $wpdb->get_var( $wpdb->prepare( 'SHOW TABLES LIKE %s', $pattern ) ); if ( $existing_table !== $table_name ) { $tables_exist = false; break; } } return $tables_exist; } } action-scheduler/classes/schema/ActionScheduler_LoggerSchema.php 0000777 00000005672 15252010675 0021123 0 ustar 00 <?php /** * Class ActionScheduler_LoggerSchema * * @codeCoverageIgnore * * Creates a custom table for storing action logs */ class ActionScheduler_LoggerSchema extends ActionScheduler_Abstract_Schema { const LOG_TABLE = 'actionscheduler_logs'; /** * Schema version. * * Increment this value to trigger a schema update. * * @var int */ protected $schema_version = 3; /** * Construct. */ public function __construct() { $this->tables = array( self::LOG_TABLE, ); } /** * Performs additional setup work required to support this schema. */ public function init() { add_action( 'action_scheduler_before_schema_update', array( $this, 'update_schema_3_0' ), 10, 2 ); } /** * Get table definition. * * @param string $table Table name. */ protected function get_table_definition( $table ) { global $wpdb; $table_name = $wpdb->$table; $charset_collate = $wpdb->get_charset_collate(); switch ( $table ) { case self::LOG_TABLE: $default_date = ActionScheduler_StoreSchema::DEFAULT_DATE; return "CREATE TABLE $table_name ( log_id bigint(20) unsigned NOT NULL auto_increment, action_id bigint(20) unsigned NOT NULL, message text NOT NULL, log_date_gmt datetime NULL default '{$default_date}', log_date_local datetime NULL default '{$default_date}', PRIMARY KEY (log_id), KEY action_id (action_id), KEY log_date_gmt (log_date_gmt) ) $charset_collate"; default: return ''; } } /** * Update the logs table schema, allowing datetime fields to be NULL. * * This is needed because the NOT NULL constraint causes a conflict with some versions of MySQL * configured with sql_mode=NO_ZERO_DATE, which can for instance lead to tables not being created. * * Most other schema updates happen via ActionScheduler_Abstract_Schema::update_table(), however * that method relies on dbDelta() and this change is not possible when using that function. * * @param string $table Name of table being updated. * @param string $db_version The existing schema version of the table. */ public function update_schema_3_0( $table, $db_version ) { global $wpdb; if ( 'actionscheduler_logs' !== $table || version_compare( $db_version, '3', '>=' ) ) { return; } // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared $table_name = $wpdb->prefix . 'actionscheduler_logs'; $table_list = $wpdb->get_col( "SHOW TABLES LIKE '{$table_name}'" ); $default_date = ActionScheduler_StoreSchema::DEFAULT_DATE; if ( ! empty( $table_list ) ) { $query = " ALTER TABLE {$table_name} MODIFY COLUMN log_date_gmt datetime NULL default '{$default_date}', MODIFY COLUMN log_date_local datetime NULL default '{$default_date}' "; $wpdb->query( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared } // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared } } action-scheduler/classes/schema/ActionScheduler_StoreSchema.php 0000777 00000012217 15252010675 0020771 0 ustar 00 <?php /** * Class ActionScheduler_StoreSchema * * @codeCoverageIgnore * * Creates custom tables for storing scheduled actions */ class ActionScheduler_StoreSchema extends ActionScheduler_Abstract_Schema { const ACTIONS_TABLE = 'actionscheduler_actions'; const CLAIMS_TABLE = 'actionscheduler_claims'; const GROUPS_TABLE = 'actionscheduler_groups'; const DEFAULT_DATE = '0000-00-00 00:00:00'; /** * Schema version. * * Increment this value to trigger a schema update. * * @var int */ protected $schema_version = 8; /** * Construct. */ public function __construct() { $this->tables = array( self::ACTIONS_TABLE, self::CLAIMS_TABLE, self::GROUPS_TABLE, ); } /** * Performs additional setup work required to support this schema. */ public function init() { add_action( 'action_scheduler_before_schema_update', array( $this, 'update_schema_5_0' ), 10, 2 ); } /** * Get table definition. * * @param string $table Table name. */ protected function get_table_definition( $table ) { global $wpdb; $table_name = $wpdb->$table; $charset_collate = $wpdb->get_charset_collate(); $default_date = self::DEFAULT_DATE; // phpcs:ignore Squiz.PHP.CommentedOutCode $max_index_length = 191; // @see wp_get_db_schema() $hook_status_scheduled_date_gmt_max_index_length = $max_index_length - 20 - 8; // - status, - scheduled_date_gmt switch ( $table ) { case self::ACTIONS_TABLE: return "CREATE TABLE {$table_name} ( action_id bigint(20) unsigned NOT NULL auto_increment, hook varchar(191) NOT NULL, status varchar(20) NOT NULL, scheduled_date_gmt datetime NULL default '{$default_date}', scheduled_date_local datetime NULL default '{$default_date}', priority tinyint unsigned NOT NULL default '10', args varchar($max_index_length), schedule longtext, group_id bigint(20) unsigned NOT NULL default '0', attempts int(11) NOT NULL default '0', last_attempt_gmt datetime NULL default '{$default_date}', last_attempt_local datetime NULL default '{$default_date}', claim_id bigint(20) unsigned NOT NULL default '0', extended_args varchar(8000) DEFAULT NULL, PRIMARY KEY (action_id), KEY hook_status_scheduled_date_gmt (hook($hook_status_scheduled_date_gmt_max_index_length), status, scheduled_date_gmt), KEY status_scheduled_date_gmt (status, scheduled_date_gmt), KEY scheduled_date_gmt (scheduled_date_gmt), KEY args (args($max_index_length)), KEY group_id (group_id), KEY last_attempt_gmt (last_attempt_gmt), KEY `claim_id_status_priority_scheduled_date_gmt` (`claim_id`,`status`,`priority`,`scheduled_date_gmt`), KEY `status_last_attempt_gmt` (`status`,`last_attempt_gmt`), KEY `status_claim_id` (`status`,`claim_id`) ) $charset_collate"; case self::CLAIMS_TABLE: return "CREATE TABLE {$table_name} ( claim_id bigint(20) unsigned NOT NULL auto_increment, date_created_gmt datetime NULL default '{$default_date}', PRIMARY KEY (claim_id), KEY date_created_gmt (date_created_gmt) ) $charset_collate"; case self::GROUPS_TABLE: return "CREATE TABLE {$table_name} ( group_id bigint(20) unsigned NOT NULL auto_increment, slug varchar(255) NOT NULL, PRIMARY KEY (group_id), KEY slug (slug($max_index_length)) ) $charset_collate"; default: return ''; } } /** * Update the actions table schema, allowing datetime fields to be NULL. * * This is needed because the NOT NULL constraint causes a conflict with some versions of MySQL * configured with sql_mode=NO_ZERO_DATE, which can for instance lead to tables not being created. * * Most other schema updates happen via ActionScheduler_Abstract_Schema::update_table(), however * that method relies on dbDelta() and this change is not possible when using that function. * * @param string $table Name of table being updated. * @param string $db_version The existing schema version of the table. */ public function update_schema_5_0( $table, $db_version ) { global $wpdb; if ( 'actionscheduler_actions' !== $table || version_compare( $db_version, '5', '>=' ) ) { return; } // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared $table_name = $wpdb->prefix . 'actionscheduler_actions'; $table_list = $wpdb->get_col( "SHOW TABLES LIKE '{$table_name}'" ); $default_date = self::DEFAULT_DATE; if ( ! empty( $table_list ) ) { $query = " ALTER TABLE {$table_name} MODIFY COLUMN scheduled_date_gmt datetime NULL default '{$default_date}', MODIFY COLUMN scheduled_date_local datetime NULL default '{$default_date}', MODIFY COLUMN last_attempt_gmt datetime NULL default '{$default_date}', MODIFY COLUMN last_attempt_local datetime NULL default '{$default_date}' "; $wpdb->query( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared } // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared } } action-scheduler/classes/ActionScheduler_wcSystemStatus.php 0000777 00000012167 15252010675 0020342 0 ustar 00 <?php /** * Class ActionScheduler_wcSystemStatus */ class ActionScheduler_wcSystemStatus { /** * The active data stores * * @var ActionScheduler_Store */ protected $store; /** * Constructor method for ActionScheduler_wcSystemStatus. * * @param ActionScheduler_Store $store Active store object. * * @return void */ public function __construct( $store ) { $this->store = $store; } /** * Display action data, including number of actions grouped by status and the oldest & newest action in each status. * * Helpful to identify issues, like a clogged queue. */ public function render() { $action_counts = $this->store->action_counts(); $status_labels = $this->store->get_status_labels(); $oldest_and_newest = $this->get_oldest_and_newest( array_keys( $status_labels ) ); $this->get_template( $status_labels, $action_counts, $oldest_and_newest ); } /** * Get oldest and newest scheduled dates for a given set of statuses. * * @param array $status_keys Set of statuses to find oldest & newest action for. * @return array */ protected function get_oldest_and_newest( $status_keys ) { $oldest_and_newest = array(); foreach ( $status_keys as $status ) { $oldest_and_newest[ $status ] = array( 'oldest' => '–', 'newest' => '–', ); if ( 'in-progress' === $status ) { continue; } $oldest_and_newest[ $status ]['oldest'] = $this->get_action_status_date( $status, 'oldest' ); $oldest_and_newest[ $status ]['newest'] = $this->get_action_status_date( $status, 'newest' ); } return $oldest_and_newest; } /** * Get oldest or newest scheduled date for a given status. * * @param string $status Action status label/name string. * @param string $date_type Oldest or Newest. * @return DateTime */ protected function get_action_status_date( $status, $date_type = 'oldest' ) { $order = 'oldest' === $date_type ? 'ASC' : 'DESC'; $action = $this->store->query_actions( array( 'status' => $status, 'per_page' => 1, 'order' => $order, ) ); if ( ! empty( $action ) ) { $date_object = $this->store->get_date( $action[0] ); $action_date = $date_object->format( 'Y-m-d H:i:s O' ); } else { $action_date = '–'; } return $action_date; } /** * Get oldest or newest scheduled date for a given status. * * @param array $status_labels Set of statuses to find oldest & newest action for. * @param array $action_counts Number of actions grouped by status. * @param array $oldest_and_newest Date of the oldest and newest action with each status. */ protected function get_template( $status_labels, $action_counts, $oldest_and_newest ) { $as_version = ActionScheduler_Versions::instance()->latest_version(); $as_datastore = get_class( ActionScheduler_Store::instance() ); ?> <table class="wc_status_table widefat" cellspacing="0"> <thead> <tr> <th colspan="5" data-export-label="Action Scheduler"><h2><?php esc_html_e( 'Action Scheduler', 'woocommerce' ); ?><?php echo wc_help_tip( esc_html__( 'This section shows details of Action Scheduler.', 'woocommerce' ) ); ?></h2></th> </tr> <tr> <td colspan="2" data-export-label="Version"><?php esc_html_e( 'Version:', 'woocommerce' ); ?></td> <td colspan="3"><?php echo esc_html( $as_version ); ?></td> </tr> <tr> <td colspan="2" data-export-label="Data store"><?php esc_html_e( 'Data store:', 'woocommerce' ); ?></td> <td colspan="3"><?php echo esc_html( $as_datastore ); ?></td> </tr> <tr> <td><strong><?php esc_html_e( 'Action Status', 'woocommerce' ); ?></strong></td> <td class="help"> </td> <td><strong><?php esc_html_e( 'Count', 'woocommerce' ); ?></strong></td> <td><strong><?php esc_html_e( 'Oldest Scheduled Date', 'woocommerce' ); ?></strong></td> <td><strong><?php esc_html_e( 'Newest Scheduled Date', 'woocommerce' ); ?></strong></td> </tr> </thead> <tbody> <?php foreach ( $action_counts as $status => $count ) { // WC uses the 3rd column for export, so we need to display more data in that (hidden when viewed as part of the table) and add an empty 2nd column. printf( '<tr><td>%1$s</td><td> </td><td>%2$s<span style="display: none;">, Oldest: %3$s, Newest: %4$s</span></td><td>%3$s</td><td>%4$s</td></tr>', esc_html( $status_labels[ $status ] ), esc_html( number_format_i18n( $count ) ), esc_html( $oldest_and_newest[ $status ]['oldest'] ), esc_html( $oldest_and_newest[ $status ]['newest'] ) ); } ?> </tbody> </table> <?php } /** * Is triggered when invoking inaccessible methods in an object context. * * @param string $name Name of method called. * @param array $arguments Parameters to invoke the method with. * * @return mixed * @link https://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.methods */ public function __call( $name, $arguments ) { switch ( $name ) { case 'print': _deprecated_function( __CLASS__ . '::print()', '2.2.4', __CLASS__ . '::render()' ); return call_user_func_array( array( $this, 'render' ), $arguments ); } return null; } } action-scheduler/classes/ActionScheduler_FatalErrorMonitor.php 0000777 00000005005 15252010675 0020722 0 ustar 00 <?php /** * Class ActionScheduler_FatalErrorMonitor */ class ActionScheduler_FatalErrorMonitor { /** * ActionScheduler_ActionClaim instance. * * @var ActionScheduler_ActionClaim */ private $claim = null; /** * ActionScheduler_Store instance. * * @var ActionScheduler_Store */ private $store = null; /** * Current action's ID. * * @var int */ private $action_id = 0; /** * Construct. * * @param ActionScheduler_Store $store Action store. */ public function __construct( ActionScheduler_Store $store ) { $this->store = $store; } /** * Start monitoring. * * @param ActionScheduler_ActionClaim $claim Claimed actions. */ public function attach( ActionScheduler_ActionClaim $claim ) { $this->claim = $claim; add_action( 'shutdown', array( $this, 'handle_unexpected_shutdown' ) ); add_action( 'action_scheduler_before_execute', array( $this, 'track_current_action' ), 0, 1 ); add_action( 'action_scheduler_after_execute', array( $this, 'untrack_action' ), 0, 0 ); add_action( 'action_scheduler_execution_ignored', array( $this, 'untrack_action' ), 0, 0 ); add_action( 'action_scheduler_failed_execution', array( $this, 'untrack_action' ), 0, 0 ); } /** * Stop monitoring. */ public function detach() { $this->claim = null; $this->untrack_action(); remove_action( 'shutdown', array( $this, 'handle_unexpected_shutdown' ) ); remove_action( 'action_scheduler_before_execute', array( $this, 'track_current_action' ), 0 ); remove_action( 'action_scheduler_after_execute', array( $this, 'untrack_action' ), 0 ); remove_action( 'action_scheduler_execution_ignored', array( $this, 'untrack_action' ), 0 ); remove_action( 'action_scheduler_failed_execution', array( $this, 'untrack_action' ), 0 ); } /** * Track specified action. * * @param int $action_id Action ID to track. */ public function track_current_action( $action_id ) { $this->action_id = $action_id; } /** * Un-track action. */ public function untrack_action() { $this->action_id = 0; } /** * Handle unexpected shutdown. */ public function handle_unexpected_shutdown() { $error = error_get_last(); if ( $error ) { if ( in_array( $error['type'], array( E_ERROR, E_PARSE, E_COMPILE_ERROR, E_USER_ERROR, E_RECOVERABLE_ERROR ), true ) ) { if ( ! empty( $this->action_id ) ) { $this->store->mark_failure( $this->action_id ); do_action( 'action_scheduler_unexpected_shutdown', $this->action_id, $error ); } } $this->store->release_claim( $this->claim ); } } } action-scheduler/classes/WP_CLI/System_Command.php 0000777 00000016100 15252010675 0016112 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI; // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaping output is not necessary in WP CLI. use ActionScheduler_SystemInformation; use WP_CLI; use function \WP_CLI\Utils\get_flag_value; /** * System info WP-CLI commands for Action Scheduler. */ class System_Command { /** * Data store for querying actions * * @var ActionScheduler_Store */ protected $store; /** * Construct. */ public function __construct() { $this->store = \ActionScheduler::store(); } /** * Print in-use data store class. * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @return void * * @subcommand data-store */ public function datastore( array $args, array $assoc_args ) { echo $this->get_current_datastore(); } /** * Print in-use runner class. * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @return void */ public function runner( array $args, array $assoc_args ) { echo $this->get_current_runner(); } /** * Get system status. * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @return void */ public function status( array $args, array $assoc_args ) { /** * Get runner status. * * @link https://github.com/woocommerce/action-scheduler-disable-default-runner */ $runner_enabled = has_action( 'action_scheduler_run_queue', array( \ActionScheduler::runner(), 'run' ) ); \WP_CLI::line( sprintf( 'Data store: %s', $this->get_current_datastore() ) ); \WP_CLI::line( sprintf( 'Runner: %s%s', $this->get_current_runner(), ( $runner_enabled ? '' : ' (disabled)' ) ) ); \WP_CLI::line( sprintf( 'Version: %s', $this->get_latest_version() ) ); $rows = array(); $action_counts = $this->store->action_counts(); $oldest_and_newest = $this->get_oldest_and_newest( array_keys( $action_counts ) ); foreach ( $action_counts as $status => $count ) { $rows[] = array( 'status' => $status, 'count' => $count, 'oldest' => $oldest_and_newest[ $status ]['oldest'], 'newest' => $oldest_and_newest[ $status ]['newest'], ); } $formatter = new \WP_CLI\Formatter( $assoc_args, array( 'status', 'count', 'oldest', 'newest' ) ); $formatter->display_items( $rows ); } /** * Display the active version, or all registered versions. * * ## OPTIONS * * [--all] * : List all registered versions. * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @return void */ public function version( array $args, array $assoc_args ) { $all = (bool) get_flag_value( $assoc_args, 'all' ); $latest = $this->get_latest_version(); if ( ! $all ) { echo $latest; \WP_CLI::halt( 0 ); } $instance = \ActionScheduler_Versions::instance(); $versions = $instance->get_versions(); $rows = array(); foreach ( $versions as $version => $callback ) { $active = $version === $latest; $rows[ $version ] = array( 'version' => $version, 'callback' => $callback, 'active' => $active ? 'yes' : 'no', ); } uksort( $rows, 'version_compare' ); $formatter = new \WP_CLI\Formatter( $assoc_args, array( 'version', 'callback', 'active' ) ); $formatter->display_items( $rows ); } /** * Display the current source, or all registered sources. * * ## OPTIONS * * [--all] * : List all registered sources. * * [--fullpath] * : List full path of source(s). * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @uses ActionScheduler_SystemInformation::active_source_path() * @uses \WP_CLI\Formatter::display_items() * @uses $this->get_latest_version() * @return void */ public function source( array $args, array $assoc_args ) { $all = (bool) get_flag_value( $assoc_args, 'all' ); $fullpath = (bool) get_flag_value( $assoc_args, 'fullpath' ); $source = ActionScheduler_SystemInformation::active_source_path(); $path = $source; if ( ! $fullpath ) { $path = str_replace( ABSPATH, '', $path ); } if ( ! $all ) { echo $path; \WP_CLI::halt( 0 ); } $sources = ActionScheduler_SystemInformation::get_sources(); if ( empty( $sources ) ) { WP_CLI::log( __( 'Detailed information about registered sources is not currently available.', 'woocommerce' ) ); return; } $rows = array(); foreach ( $sources as $check_source => $version ) { $active = dirname( $check_source ) === $source; $path = $check_source; if ( ! $fullpath ) { $path = str_replace( ABSPATH, '', $path ); } $rows[ $check_source ] = array( 'source' => $path, 'version' => $version, 'active' => $active ? 'yes' : 'no', ); } ksort( $rows ); \WP_CLI::log( PHP_EOL . 'Please note there can only be one unique registered instance of Action Scheduler per ' . PHP_EOL . 'version number, so this list may not include all the currently present copies of ' . PHP_EOL . 'Action Scheduler.' . PHP_EOL ); $formatter = new \WP_CLI\Formatter( $assoc_args, array( 'source', 'version', 'active' ) ); $formatter->display_items( $rows ); } /** * Get current data store. * * @return string */ protected function get_current_datastore() { return get_class( $this->store ); } /** * Get latest version. * * @param null|\ActionScheduler_Versions $instance Versions. * @return string */ protected function get_latest_version( $instance = null ) { if ( is_null( $instance ) ) { $instance = \ActionScheduler_Versions::instance(); } return $instance->latest_version(); } /** * Get current runner. * * @return string */ protected function get_current_runner() { return get_class( \ActionScheduler::runner() ); } /** * Get oldest and newest scheduled dates for a given set of statuses. * * @param array $status_keys Set of statuses to find oldest & newest action for. * @return array */ protected function get_oldest_and_newest( $status_keys ) { $oldest_and_newest = array(); foreach ( $status_keys as $status ) { $oldest_and_newest[ $status ] = array( 'oldest' => '–', 'newest' => '–', ); if ( 'in-progress' === $status ) { continue; } $oldest_and_newest[ $status ]['oldest'] = $this->get_action_status_date( $status, 'oldest' ); $oldest_and_newest[ $status ]['newest'] = $this->get_action_status_date( $status, 'newest' ); } return $oldest_and_newest; } /** * Get oldest or newest scheduled date for a given status. * * @param string $status Action status label/name string. * @param string $date_type Oldest or Newest. * @return string */ protected function get_action_status_date( $status, $date_type = 'oldest' ) { $order = 'oldest' === $date_type ? 'ASC' : 'DESC'; $args = array( 'status' => $status, 'per_page' => 1, 'order' => $order, ); $action = $this->store->query_actions( $args ); if ( ! empty( $action ) ) { $date_object = $this->store->get_date( $action[0] ); $action_date = $date_object->format( 'Y-m-d H:i:s O' ); } else { $action_date = '–'; } return $action_date; } } action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php 0000777 00000015256 15252010675 0022711 0 ustar 00 <?php /** * Commands for Action Scheduler. */ class ActionScheduler_WPCLI_Scheduler_command extends WP_CLI_Command { /** * Force tables schema creation for Action Scheduler * * ## OPTIONS * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * * @subcommand fix-schema */ public function fix_schema( $args, $assoc_args ) { $schema_classes = array( ActionScheduler_LoggerSchema::class, ActionScheduler_StoreSchema::class ); foreach ( $schema_classes as $classname ) { if ( is_subclass_of( $classname, ActionScheduler_Abstract_Schema::class ) ) { $obj = new $classname(); $obj->init(); $obj->register_tables( true ); WP_CLI::success( sprintf( /* translators: %s refers to the schema name*/ __( 'Registered schema for %s', 'woocommerce' ), $classname ) ); } } } /** * Run the Action Scheduler * * ## OPTIONS * * [--batch-size=<size>] * : The maximum number of actions to run. Defaults to 100. * * [--batches=<size>] * : Limit execution to a number of batches. Defaults to 0, meaning batches will continue being executed until all actions are complete. * * [--cleanup-batch-size=<size>] * : The maximum number of actions to clean up. Defaults to the value of --batch-size. * * [--hooks=<hooks>] * : Only run actions with the specified hook. Omitting this option runs actions with any hook. Define multiple hooks as a comma separated string (without spaces), e.g. `--hooks=hook_one,hook_two,hook_three` * * [--group=<group>] * : Only run actions from the specified group. Omitting this option runs actions from all groups. * * [--exclude-groups=<groups>] * : Run actions from all groups except the specified group(s). Define multiple groups as a comma separated string (without spaces), e.g. '--group_a,group_b'. This option is ignored when `--group` is used. * * [--free-memory-on=<count>] * : The number of actions to process between freeing memory. 0 disables freeing memory. Default 50. * * [--pause=<seconds>] * : The number of seconds to pause when freeing memory. Default no pause. * * [--force] * : Whether to force execution despite the maximum number of concurrent processes being exceeded. * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @throws \WP_CLI\ExitException When an error occurs. * * @subcommand run */ public function run( $args, $assoc_args ) { // Handle passed arguments. $batch = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'batch-size', 100 ) ); $batches = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'batches', 0 ) ); $clean = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'cleanup-batch-size', $batch ) ); $hooks = explode( ',', WP_CLI\Utils\get_flag_value( $assoc_args, 'hooks', '' ) ); $hooks = array_filter( array_map( 'trim', $hooks ) ); $group = \WP_CLI\Utils\get_flag_value( $assoc_args, 'group', '' ); $exclude_groups = \WP_CLI\Utils\get_flag_value( $assoc_args, 'exclude-groups', '' ); $free_on = \WP_CLI\Utils\get_flag_value( $assoc_args, 'free-memory-on', 50 ); $sleep = \WP_CLI\Utils\get_flag_value( $assoc_args, 'pause', 0 ); $force = \WP_CLI\Utils\get_flag_value( $assoc_args, 'force', false ); ActionScheduler_DataController::set_free_ticks( $free_on ); ActionScheduler_DataController::set_sleep_time( $sleep ); $batches_completed = 0; $actions_completed = 0; $unlimited = 0 === $batches; if ( is_callable( array( ActionScheduler::store(), 'set_claim_filter' ) ) ) { $exclude_groups = $this->parse_comma_separated_string( $exclude_groups ); if ( ! empty( $exclude_groups ) ) { ActionScheduler::store()->set_claim_filter( 'exclude-groups', $exclude_groups ); } } try { // Custom queue cleaner instance. $cleaner = new ActionScheduler_QueueCleaner( null, $clean ); // Get the queue runner instance. $runner = new ActionScheduler_WPCLI_QueueRunner( null, null, $cleaner ); // Determine how many tasks will be run in the first batch. $total = $runner->setup( $batch, $hooks, $group, $force ); // Run actions for as long as possible. while ( $total > 0 ) { $this->print_total_actions( $total ); $actions_completed += $runner->run(); $batches_completed++; // Maybe set up tasks for the next batch. $total = ( $unlimited || $batches_completed < $batches ) ? $runner->setup( $batch, $hooks, $group, $force ) : 0; } } catch ( Exception $e ) { $this->print_error( $e ); } $this->print_total_batches( $batches_completed ); $this->print_success( $actions_completed ); } /** * Converts a string of comma-separated values into an array of those same values. * * @param string $string The string of one or more comma separated values. * * @return array */ private function parse_comma_separated_string( $string ): array { return array_filter( str_getcsv( $string ) ); } /** * Print WP CLI message about how many actions are about to be processed. * * @param int $total Number of actions found. */ protected function print_total_actions( $total ) { WP_CLI::log( sprintf( /* translators: %d refers to how many scheduled tasks were found to run */ _n( 'Found %d scheduled task', 'Found %d scheduled tasks', $total, 'woocommerce' ), $total ) ); } /** * Print WP CLI message about how many batches of actions were processed. * * @param int $batches_completed Number of completed batches. */ protected function print_total_batches( $batches_completed ) { WP_CLI::log( sprintf( /* translators: %d refers to the total number of batches executed */ _n( '%d batch executed.', '%d batches executed.', $batches_completed, 'woocommerce' ), $batches_completed ) ); } /** * Convert an exception into a WP CLI error. * * @param Exception $e The error object. * * @throws \WP_CLI\ExitException Under some conditions WP CLI may throw an exception. */ protected function print_error( Exception $e ) { WP_CLI::error( sprintf( /* translators: %s refers to the exception error message */ __( 'There was an error running the action scheduler: %s', 'woocommerce' ), $e->getMessage() ) ); } /** * Print a success message with the number of completed actions. * * @param int $actions_completed Number of completed actions. */ protected function print_success( $actions_completed ) { WP_CLI::success( sprintf( /* translators: %d refers to the total number of tasks completed */ _n( '%d scheduled task completed.', '%d scheduled tasks completed.', $actions_completed, 'woocommerce' ), $actions_completed ) ); } } action-scheduler/classes/WP_CLI/Action_Command.php 0000777 00000020224 15252010675 0016045 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI; /** * Action command for Action Scheduler. */ class Action_Command extends \WP_CLI_Command { /** * Cancel the next occurrence or all occurrences of a scheduled action. * * ## OPTIONS * * [<hook>] * : Name of the action hook. * * [--group=<group>] * : The group the job is assigned to. * * [--args=<args>] * : JSON object of arguments assigned to the job. * --- * default: [] * --- * * [--all] * : Cancel all occurrences of a scheduled action. * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function cancel( array $args, array $assoc_args ) { require_once 'Action/Cancel_Command.php'; $command = new Action\Cancel_Command( $args, $assoc_args ); $command->execute(); } /** * Creates a new scheduled action. * * ## OPTIONS * * <hook> * : Name of the action hook. * * <start> * : A unix timestamp representing the date you want the action to start. Also 'async' or 'now' to enqueue an async action. * * [--args=<args>] * : JSON object of arguments to pass to callbacks when the hook triggers. * --- * default: [] * --- * * [--cron=<cron>] * : A cron-like schedule string (https://crontab.guru/). * --- * default: '' * --- * * [--group=<group>] * : The group to assign this job to. * --- * default: '' * --- * * [--interval=<interval>] * : Number of seconds to wait between runs. * --- * default: 0 * --- * * ## EXAMPLES * * wp action-scheduler action create hook_async async * wp action-scheduler action create hook_single 1627147598 * wp action-scheduler action create hook_recurring 1627148188 --interval=5 * wp action-scheduler action create hook_cron 1627147655 --cron='5 4 * * *' * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function create( array $args, array $assoc_args ) { require_once 'Action/Create_Command.php'; $command = new Action\Create_Command( $args, $assoc_args ); $command->execute(); } /** * Delete existing scheduled action(s). * * ## OPTIONS * * <id>... * : One or more IDs of actions to delete. * --- * default: 0 * --- * * ## EXAMPLES * * # Delete the action with id 100 * $ wp action-scheduler action delete 100 * * # Delete the actions with ids 100 and 200 * $ wp action-scheduler action delete 100 200 * * # Delete the first five pending actions in 'action-scheduler' group * $ wp action-scheduler action delete $( wp action-scheduler action list --status=pending --group=action-scheduler --format=ids ) * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function delete( array $args, array $assoc_args ) { require_once 'Action/Delete_Command.php'; $command = new Action\Delete_Command( $args, $assoc_args ); $command->execute(); } /** * Generates some scheduled actions. * * ## OPTIONS * * <hook> * : Name of the action hook. * * <start> * : The Unix timestamp representing the date you want the action to start. * * [--count=<count>] * : Number of actions to create. * --- * default: 1 * --- * * [--interval=<interval>] * : Number of seconds to wait between runs. * --- * default: 0 * --- * * [--args=<args>] * : JSON object of arguments to pass to callbacks when the hook triggers. * --- * default: [] * --- * * [--group=<group>] * : The group to assign this job to. * --- * default: '' * --- * * ## EXAMPLES * * wp action-scheduler action generate test_multiple 1627147598 --count=5 --interval=5 * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function generate( array $args, array $assoc_args ) { require_once 'Action/Generate_Command.php'; $command = new Action\Generate_Command( $args, $assoc_args ); $command->execute(); } /** * Get details about a scheduled action. * * ## OPTIONS * * <id> * : The ID of the action to get. * --- * default: 0 * --- * * [--field=<field>] * : Instead of returning the whole action, returns the value of a single field. * * [--fields=<fields>] * : Limit the output to specific fields (comma-separated). Defaults to all fields. * * [--format=<format>] * : Render output in a particular format. * --- * default: table * options: * - table * - csv * - json * - yaml * --- * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function get( array $args, array $assoc_args ) { require_once 'Action/Get_Command.php'; $command = new Action\Get_Command( $args, $assoc_args ); $command->execute(); } /** * Get a list of scheduled actions. * * Display actions based on all arguments supported by * [as_get_scheduled_actions()](https://actionscheduler.org/api/#function-reference--as_get_scheduled_actions). * * ## OPTIONS * * [--<field>=<value>] * : One or more arguments to pass to as_get_scheduled_actions(). * * [--field=<field>] * : Prints the value of a single property for each action. * * [--fields=<fields>] * : Limit the output to specific object properties. * * [--format=<format>] * : Render output in a particular format. * --- * default: table * options: * - table * - csv * - ids * - json * - count * - yaml * --- * * ## AVAILABLE FIELDS * * These fields will be displayed by default for each action: * * * id * * hook * * status * * group * * recurring * * scheduled_date * * These fields are optionally available: * * * args * * log_entries * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void * * @subcommand list */ public function subcommand_list( array $args, array $assoc_args ) { require_once 'Action/List_Command.php'; $command = new Action\List_Command( $args, $assoc_args ); $command->execute(); } /** * Get logs for a scheduled action. * * ## OPTIONS * * <id> * : The ID of the action to get. * --- * default: 0 * --- * * @param array $args Positional arguments. * @return void */ public function logs( array $args ) { $command = sprintf( 'action-scheduler action get %d --field=log_entries', $args[0] ); WP_CLI::runcommand( $command ); } /** * Get the ID or timestamp of the next scheduled action. * * ## OPTIONS * * <hook> * : The hook of the next scheduled action. * * [--args=<args>] * : JSON object of arguments to search for next scheduled action. * --- * default: [] * --- * * [--group=<group>] * : The group to which the next scheduled action is assigned. * --- * default: '' * --- * * [--raw] * : Display the raw output of as_next_scheduled_action() (timestamp or boolean). * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function next( array $args, array $assoc_args ) { require_once 'Action/Next_Command.php'; $command = new Action\Next_Command( $args, $assoc_args ); $command->execute(); } /** * Run existing scheduled action(s). * * ## OPTIONS * * <id>... * : One or more IDs of actions to run. * --- * default: 0 * --- * * ## EXAMPLES * * # Run the action with id 100 * $ wp action-scheduler action run 100 * * # Run the actions with ids 100 and 200 * $ wp action-scheduler action run 100 200 * * # Run the first five pending actions in 'action-scheduler' group * $ wp action-scheduler action run $( wp action-scheduler action list --status=pending --group=action-scheduler --format=ids ) * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function run( array $args, array $assoc_args ) { require_once 'Action/Run_Command.php'; $command = new Action\Run_Command( $args, $assoc_args ); $command->execute(); } } action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_Clean_Command.php 0000777 00000007344 15252010675 0021754 0 ustar 00 <?php /** * Commands for Action Scheduler. */ class ActionScheduler_WPCLI_Clean_Command extends WP_CLI_Command { /** * Run the Action Scheduler Queue Cleaner * * ## OPTIONS * * [--batch-size=<size>] * : The maximum number of actions to delete per batch. Defaults to 20. * * [--batches=<size>] * : Limit execution to a number of batches. Defaults to 0, meaning batches will continue all eligible actions are deleted. * * [--status=<status>] * : Only clean actions with the specified status. Defaults to Canceled, Completed. Define multiple statuses as a comma separated string (without spaces), e.g. `--status=complete,failed,canceled` * * [--before=<datestring>] * : Only delete actions with scheduled date older than this. Defaults to 31 days. e.g `--before='7 days ago'`, `--before='02-Feb-2020 20:20:20'` * * [--pause=<seconds>] * : The number of seconds to pause between batches. Default no pause. * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @throws \WP_CLI\ExitException When an error occurs. * * @subcommand clean */ public function clean( $args, $assoc_args ) { // Handle passed arguments. $batch = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'batch-size', 20 ) ); $batches = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'batches', 0 ) ); $status = explode( ',', WP_CLI\Utils\get_flag_value( $assoc_args, 'status', '' ) ); $status = array_filter( array_map( 'trim', $status ) ); $before = \WP_CLI\Utils\get_flag_value( $assoc_args, 'before', '' ); $sleep = \WP_CLI\Utils\get_flag_value( $assoc_args, 'pause', 0 ); $batches_completed = 0; $actions_deleted = 0; $unlimited = 0 === $batches; try { $lifespan = as_get_datetime_object( $before ); } catch ( Exception $e ) { $lifespan = null; } try { // Custom queue cleaner instance. $cleaner = new ActionScheduler_QueueCleaner( null, $batch ); // Clean actions for as long as possible. while ( $unlimited || $batches_completed < $batches ) { if ( $sleep && $batches_completed > 0 ) { sleep( $sleep ); } $deleted = count( $cleaner->clean_actions( $status, $lifespan, null, 'CLI' ) ); if ( $deleted <= 0 ) { break; } $actions_deleted += $deleted; $batches_completed++; $this->print_success( $deleted ); } } catch ( Exception $e ) { $this->print_error( $e ); } $this->print_total_batches( $batches_completed ); if ( $batches_completed > 1 ) { $this->print_success( $actions_deleted ); } } /** * Print WP CLI message about how many batches of actions were processed. * * @param int $batches_processed Number of batches processed. */ protected function print_total_batches( int $batches_processed ) { WP_CLI::log( sprintf( /* translators: %d refers to the total number of batches processed */ _n( '%d batch processed.', '%d batches processed.', $batches_processed, 'woocommerce' ), $batches_processed ) ); } /** * Convert an exception into a WP CLI error. * * @param Exception $e The error object. */ protected function print_error( Exception $e ) { WP_CLI::error( sprintf( /* translators: %s refers to the exception error message */ __( 'There was an error deleting an action: %s', 'woocommerce' ), $e->getMessage() ) ); } /** * Print a success message with the number of completed actions. * * @param int $actions_deleted Number of deleted actions. */ protected function print_success( int $actions_deleted ) { WP_CLI::success( sprintf( /* translators: %d refers to the total number of actions deleted */ _n( '%d action deleted.', '%d actions deleted.', $actions_deleted, 'woocommerce' ), $actions_deleted ) ); } } action-scheduler/classes/WP_CLI/Action/Create_Command.php 0000777 00000010533 15252010675 0017252 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI\Action; use function \WP_CLI\Utils\get_flag_value; /** * WP-CLI command: action-scheduler action create */ class Create_Command extends \ActionScheduler_WPCLI_Command { const ASYNC_OPTS = array( 'async', 0 ); /** * Execute command. * * @return void */ public function execute() { $hook = $this->args[0]; $schedule_start = $this->args[1]; $callback_args = get_flag_value( $this->assoc_args, 'args', array() ); $group = get_flag_value( $this->assoc_args, 'group', '' ); $interval = absint( get_flag_value( $this->assoc_args, 'interval', 0 ) ); $cron = get_flag_value( $this->assoc_args, 'cron', '' ); $unique = get_flag_value( $this->assoc_args, 'unique', false ); $priority = absint( get_flag_value( $this->assoc_args, 'priority', 10 ) ); if ( ! empty( $callback_args ) ) { $callback_args = json_decode( $callback_args, true ); } $function_args = array( 'start' => $schedule_start, 'cron' => $cron, 'interval' => $interval, 'hook' => $hook, 'callback_args' => $callback_args, 'group' => $group, 'unique' => $unique, 'priority' => $priority, ); try { // Generate schedule start if appropriate. if ( ! in_array( $schedule_start, static::ASYNC_OPTS, true ) ) { $schedule_start = as_get_datetime_object( $schedule_start ); $function_args['start'] = $schedule_start->format( 'U' ); } } catch ( \Exception $e ) { \WP_CLI::error( $e->getMessage() ); } // Default to creating single action. $action_type = 'single'; $function = 'as_schedule_single_action'; if ( ! empty( $interval ) ) { // Creating recurring action. $action_type = 'recurring'; $function = 'as_schedule_recurring_action'; $function_args = array_filter( $function_args, static function( $key ) { return in_array( $key, array( 'start', 'interval', 'hook', 'callback_args', 'group', 'unique', 'priority' ), true ); }, ARRAY_FILTER_USE_KEY ); } elseif ( ! empty( $cron ) ) { // Creating cron action. $action_type = 'cron'; $function = 'as_schedule_cron_action'; $function_args = array_filter( $function_args, static function( $key ) { return in_array( $key, array( 'start', 'cron', 'hook', 'callback_args', 'group', 'unique', 'priority' ), true ); }, ARRAY_FILTER_USE_KEY ); } elseif ( in_array( $function_args['start'], static::ASYNC_OPTS, true ) ) { // Enqueue async action. $action_type = 'async'; $function = 'as_enqueue_async_action'; $function_args = array_filter( $function_args, static function( $key ) { return in_array( $key, array( 'hook', 'callback_args', 'group', 'unique', 'priority' ), true ); }, ARRAY_FILTER_USE_KEY ); } else { // Enqueue single action. $function_args = array_filter( $function_args, static function( $key ) { return in_array( $key, array( 'start', 'hook', 'callback_args', 'group', 'unique', 'priority' ), true ); }, ARRAY_FILTER_USE_KEY ); } $function_args = array_values( $function_args ); try { $action_id = call_user_func_array( $function, $function_args ); } catch ( \Exception $e ) { $this->print_error( $e ); } if ( 0 === $action_id ) { $e = new \Exception( __( 'Unable to create a scheduled action.', 'woocommerce' ) ); $this->print_error( $e ); } $this->print_success( $action_id, $action_type ); } /** * Print a success message with the action ID. * * @param int $action_id Created action ID. * @param string $action_type Type of action. * * @return void */ protected function print_success( $action_id, $action_type ) { \WP_CLI::success( sprintf( /* translators: %1$s: type of action, %2$d: ID of the created action */ __( '%1$s action (%2$d) scheduled.', 'woocommerce' ), ucfirst( $action_type ), $action_id ) ); } /** * Convert an exception into a WP CLI error. * * @param \Exception $e The error object. * @throws \WP_CLI\ExitException When an error occurs. * @return void */ protected function print_error( \Exception $e ) { \WP_CLI::error( sprintf( /* translators: %s refers to the exception error message. */ __( 'There was an error creating the scheduled action: %s', 'woocommerce' ), $e->getMessage() ) ); } } action-scheduler/classes/WP_CLI/Action/List_Command.php 0000777 00000006067 15252010675 0016771 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI\Action; // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaping output is not necessary in WP CLI. /** * WP-CLI command: action-scheduler action list */ class List_Command extends \ActionScheduler_WPCLI_Command { const PARAMETERS = array( 'hook', 'args', 'date', 'date_compare', 'modified', 'modified_compare', 'group', 'status', 'claimed', 'per_page', 'offset', 'orderby', 'order', ); /** * Execute command. * * @return void */ public function execute() { $store = \ActionScheduler::store(); $logger = \ActionScheduler::logger(); $fields = array( 'id', 'hook', 'status', 'group', 'recurring', 'scheduled_date', ); $this->process_csv_arguments_to_arrays(); if ( ! empty( $this->assoc_args['fields'] ) ) { $fields = $this->assoc_args['fields']; } $formatter = new \WP_CLI\Formatter( $this->assoc_args, $fields ); $query_args = $this->assoc_args; /** * The `claimed` parameter expects a boolean or integer: * check for string 'false', and set explicitly to `false` boolean. */ if ( array_key_exists( 'claimed', $query_args ) && 'false' === strtolower( $query_args['claimed'] ) ) { $query_args['claimed'] = false; } $return_format = 'OBJECT'; if ( in_array( $formatter->format, array( 'ids', 'count' ), true ) ) { $return_format = '\'ids\''; } // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export $params = var_export( $query_args, true ); if ( empty( $query_args ) ) { $params = 'array()'; } \WP_CLI::debug( sprintf( 'as_get_scheduled_actions( %s, %s )', $params, $return_format ) ); if ( ! empty( $query_args['args'] ) ) { $query_args['args'] = json_decode( $query_args['args'], true ); } switch ( $formatter->format ) { case 'ids': $actions = as_get_scheduled_actions( $query_args, 'ids' ); echo implode( ' ', $actions ); break; case 'count': $actions = as_get_scheduled_actions( $query_args, 'ids' ); $formatter->display_items( $actions ); break; default: $actions = as_get_scheduled_actions( $query_args, OBJECT ); $actions_arr = array(); foreach ( $actions as $action_id => $action ) { $action_arr = array( 'id' => $action_id, 'hook' => $action->get_hook(), 'status' => $store->get_status( $action_id ), 'args' => $action->get_args(), 'group' => $action->get_group(), 'recurring' => $action->get_schedule()->is_recurring() ? 'yes' : 'no', 'scheduled_date' => $this->get_schedule_display_string( $action->get_schedule() ), 'log_entries' => array(), ); foreach ( $logger->get_logs( $action_id ) as $log_entry ) { $action_arr['log_entries'][] = array( 'date' => $log_entry->get_date()->format( static::DATE_FORMAT ), 'message' => $log_entry->get_message(), ); } $actions_arr[] = $action_arr; } $formatter->display_items( $actions_arr ); break; } } } action-scheduler/classes/WP_CLI/Action/Delete_Command.php 0000777 00000005126 15252010675 0017253 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI\Action; /** * WP-CLI command: action-scheduler action delete */ class Delete_Command extends \ActionScheduler_WPCLI_Command { /** * Array of action IDs to delete. * * @var int[] */ protected $action_ids = array(); /** * Number of deleted, failed, and total actions deleted. * * @var array<string, int> */ protected $action_counts = array( 'deleted' => 0, 'failed' => 0, 'total' => 0, ); /** * Construct. * * @param string[] $args Positional arguments. * @param array<string, string> $assoc_args Keyed arguments. */ public function __construct( array $args, array $assoc_args ) { parent::__construct( $args, $assoc_args ); $this->action_ids = array_map( 'absint', $args ); $this->action_counts['total'] = count( $this->action_ids ); add_action( 'action_scheduler_deleted_action', array( $this, 'on_action_deleted' ) ); } /** * Execute. * * @return void */ public function execute() { $store = \ActionScheduler::store(); $progress_bar = \WP_CLI\Utils\make_progress_bar( sprintf( /* translators: %d: number of actions to be deleted */ _n( 'Deleting %d action', 'Deleting %d actions', $this->action_counts['total'], 'woocommerce' ), number_format_i18n( $this->action_counts['total'] ) ), $this->action_counts['total'] ); foreach ( $this->action_ids as $action_id ) { try { $store->delete_action( $action_id ); } catch ( \Exception $e ) { $this->action_counts['failed']++; \WP_CLI::warning( $e->getMessage() ); } $progress_bar->tick(); } $progress_bar->finish(); /* translators: %1$d: number of actions deleted */ $format = _n( 'Deleted %1$d action', 'Deleted %1$d actions', $this->action_counts['deleted'], 'woocommerce' ) . ', '; /* translators: %2$d: number of actions deletions failed */ $format .= _n( '%2$d failure.', '%2$d failures.', $this->action_counts['failed'], 'woocommerce' ); \WP_CLI::success( sprintf( $format, number_format_i18n( $this->action_counts['deleted'] ), number_format_i18n( $this->action_counts['failed'] ) ) ); } /** * Action: action_scheduler_deleted_action * * @param int $action_id Action ID. * @return void */ public function on_action_deleted( $action_id ) { if ( 'action_scheduler_deleted_action' !== current_action() ) { return; } $action_id = absint( $action_id ); if ( ! in_array( $action_id, $this->action_ids, true ) ) { return; } $this->action_counts['deleted']++; \WP_CLI::debug( sprintf( 'Action %d was deleted.', $action_id ) ); } } action-scheduler/classes/WP_CLI/Action/Next_Command.php 0000777 00000003503 15252010675 0016764 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI\Action; // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaping output is not necessary in WP CLI. use function \WP_CLI\Utils\get_flag_value; /** * WP-CLI command: action-scheduler action next */ class Next_Command extends \ActionScheduler_WPCLI_Command { /** * Execute command. * * @return void */ public function execute() { $hook = $this->args[0]; $group = get_flag_value( $this->assoc_args, 'group', '' ); $callback_args = get_flag_value( $this->assoc_args, 'args', null ); $raw = (bool) get_flag_value( $this->assoc_args, 'raw', false ); if ( ! empty( $callback_args ) ) { $callback_args = json_decode( $callback_args, true ); } if ( $raw ) { \WP_CLI::line( as_next_scheduled_action( $hook, $callback_args, $group ) ); return; } $params = array( 'hook' => $hook, 'orderby' => 'date', 'order' => 'ASC', 'group' => $group, ); if ( is_array( $callback_args ) ) { $params['args'] = $callback_args; } $params['status'] = \ActionScheduler_Store::STATUS_RUNNING; // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export \WP_CLI::debug( 'ActionScheduler()::store()->query_action( ' . var_export( $params, true ) . ' )' ); $store = \ActionScheduler::store(); $action_id = $store->query_action( $params ); if ( $action_id ) { echo $action_id; return; } $params['status'] = \ActionScheduler_Store::STATUS_PENDING; // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export \WP_CLI::debug( 'ActionScheduler()::store()->query_action( ' . var_export( $params, true ) . ' )' ); $action_id = $store->query_action( $params ); if ( $action_id ) { echo $action_id; return; } \WP_CLI::warning( 'No matching next action.' ); } } action-scheduler/classes/WP_CLI/Action/Cancel_Command.php 0000777 00000006340 15252010675 0017235 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI\Action; use function \WP_CLI\Utils\get_flag_value; /** * WP-CLI command: action-scheduler action cancel */ class Cancel_Command extends \ActionScheduler_WPCLI_Command { /** * Execute command. * * @return void */ public function execute() { $hook = ''; $group = get_flag_value( $this->assoc_args, 'group', '' ); $callback_args = get_flag_value( $this->assoc_args, 'args', null ); $all = get_flag_value( $this->assoc_args, 'all', false ); if ( ! empty( $this->args[0] ) ) { $hook = $this->args[0]; } if ( ! empty( $callback_args ) ) { $callback_args = json_decode( $callback_args, true ); } if ( $all ) { $this->cancel_all( $hook, $callback_args, $group ); return; } $this->cancel_single( $hook, $callback_args, $group ); } /** * Cancel single action. * * @param string $hook The hook that the job will trigger. * @param array $callback_args Args that would have been passed to the job. * @param string $group The group the job is assigned to. * @return void */ protected function cancel_single( $hook, $callback_args, $group ) { if ( empty( $hook ) ) { \WP_CLI::error( __( 'Please specify hook of action to cancel.', 'woocommerce' ) ); } try { $result = as_unschedule_action( $hook, $callback_args, $group ); } catch ( \Exception $e ) { $this->print_error( $e, false ); } if ( null === $result ) { $e = new \Exception( __( 'Unable to cancel scheduled action: check the logs.', 'woocommerce' ) ); $this->print_error( $e, false ); } $this->print_success( false ); } /** * Cancel all actions. * * @param string $hook The hook that the job will trigger. * @param array $callback_args Args that would have been passed to the job. * @param string $group The group the job is assigned to. * @return void */ protected function cancel_all( $hook, $callback_args, $group ) { if ( empty( $hook ) && empty( $group ) ) { \WP_CLI::error( __( 'Please specify hook and/or group of actions to cancel.', 'woocommerce' ) ); } try { $result = as_unschedule_all_actions( $hook, $callback_args, $group ); } catch ( \Exception $e ) { $this->print_error( $e, $multiple ); } /** * Because as_unschedule_all_actions() does not provide a result, * neither confirm or deny actions cancelled. */ \WP_CLI::success( __( 'Request to cancel scheduled actions completed.', 'woocommerce' ) ); } /** * Print a success message. * * @return void */ protected function print_success() { \WP_CLI::success( __( 'Scheduled action cancelled.', 'woocommerce' ) ); } /** * Convert an exception into a WP CLI error. * * @param \Exception $e The error object. * @param bool $multiple Boolean if multiple actions. * @throws \WP_CLI\ExitException When an error occurs. * @return void */ protected function print_error( \Exception $e, $multiple ) { \WP_CLI::error( sprintf( /* translators: %1$s: singular or plural %2$s: refers to the exception error message. */ __( 'There was an error cancelling the %1$s: %2$s', 'woocommerce' ), $multiple ? __( 'scheduled actions', 'woocommerce' ) : __( 'scheduled action', 'woocommerce' ), $e->getMessage() ) ); } } action-scheduler/classes/WP_CLI/Action/Run_Command.php 0000777 00000011142 15252010675 0016610 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI\Action; /** * WP-CLI command: action-scheduler action run */ class Run_Command extends \ActionScheduler_WPCLI_Command { /** * Array of action IDs to execute. * * @var int[] */ protected $action_ids = array(); /** * Number of executed, failed, ignored, invalid, and total actions. * * @var array<string, int> */ protected $action_counts = array( 'executed' => 0, 'failed' => 0, 'ignored' => 0, 'invalid' => 0, 'total' => 0, ); /** * Construct. * * @param string[] $args Positional arguments. * @param array<string, string> $assoc_args Keyed arguments. */ public function __construct( array $args, array $assoc_args ) { parent::__construct( $args, $assoc_args ); $this->action_ids = array_map( 'absint', $args ); $this->action_counts['total'] = count( $this->action_ids ); add_action( 'action_scheduler_execution_ignored', array( $this, 'on_action_ignored' ) ); add_action( 'action_scheduler_after_execute', array( $this, 'on_action_executed' ) ); add_action( 'action_scheduler_failed_execution', array( $this, 'on_action_failed' ), 10, 2 ); add_action( 'action_scheduler_failed_validation', array( $this, 'on_action_invalid' ), 10, 2 ); } /** * Execute. * * @return void */ public function execute() { $runner = \ActionScheduler::runner(); $progress_bar = \WP_CLI\Utils\make_progress_bar( sprintf( /* translators: %d: number of actions */ _n( 'Executing %d action', 'Executing %d actions', $this->action_counts['total'], 'woocommerce' ), number_format_i18n( $this->action_counts['total'] ) ), $this->action_counts['total'] ); foreach ( $this->action_ids as $action_id ) { $runner->process_action( $action_id, 'Action Scheduler CLI' ); $progress_bar->tick(); } $progress_bar->finish(); foreach ( array( 'ignored', 'invalid', 'failed', ) as $type ) { $count = $this->action_counts[ $type ]; if ( empty( $count ) ) { continue; } /* * translators: * %1$d: count of actions evaluated. * %2$s: type of action evaluated. */ $format = _n( '%1$d action %2$s.', '%1$d actions %2$s.', $count, 'woocommerce' ); \WP_CLI::warning( sprintf( $format, number_format_i18n( $count ), $type ) ); } \WP_CLI::success( sprintf( /* translators: %d: number of executed actions */ _n( 'Executed %d action.', 'Executed %d actions.', $this->action_counts['executed'], 'woocommerce' ), number_format_i18n( $this->action_counts['executed'] ) ) ); } /** * Action: action_scheduler_execution_ignored * * @param int $action_id Action ID. * @return void */ public function on_action_ignored( $action_id ) { if ( 'action_scheduler_execution_ignored' !== current_action() ) { return; } $action_id = absint( $action_id ); if ( ! in_array( $action_id, $this->action_ids, true ) ) { return; } $this->action_counts['ignored']++; \WP_CLI::debug( sprintf( 'Action %d was ignored.', $action_id ) ); } /** * Action: action_scheduler_after_execute * * @param int $action_id Action ID. * @return void */ public function on_action_executed( $action_id ) { if ( 'action_scheduler_after_execute' !== current_action() ) { return; } $action_id = absint( $action_id ); if ( ! in_array( $action_id, $this->action_ids, true ) ) { return; } $this->action_counts['executed']++; \WP_CLI::debug( sprintf( 'Action %d was executed.', $action_id ) ); } /** * Action: action_scheduler_failed_execution * * @param int $action_id Action ID. * @param \Exception $e Exception. * @return void */ public function on_action_failed( $action_id, \Exception $e ) { if ( 'action_scheduler_failed_execution' !== current_action() ) { return; } $action_id = absint( $action_id ); if ( ! in_array( $action_id, $this->action_ids, true ) ) { return; } $this->action_counts['failed']++; \WP_CLI::debug( sprintf( 'Action %d failed execution: %s', $action_id, $e->getMessage() ) ); } /** * Action: action_scheduler_failed_validation * * @param int $action_id Action ID. * @param \Exception $e Exception. * @return void */ public function on_action_invalid( $action_id, \Exception $e ) { if ( 'action_scheduler_failed_validation' !== current_action() ) { return; } $action_id = absint( $action_id ); if ( ! in_array( $action_id, $this->action_ids, true ) ) { return; } $this->action_counts['invalid']++; \WP_CLI::debug( sprintf( 'Action %d failed validation: %s', $action_id, $e->getMessage() ) ); } } action-scheduler/classes/WP_CLI/Action/Generate_Command.php 0000777 00000006720 15252010675 0017604 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI\Action; use function \WP_CLI\Utils\get_flag_value; /** * WP-CLI command: action-scheduler action generate */ class Generate_Command extends \ActionScheduler_WPCLI_Command { /** * Execute command. * * @return void */ public function execute() { $hook = $this->args[0]; $schedule_start = $this->args[1]; $callback_args = get_flag_value( $this->assoc_args, 'args', array() ); $group = get_flag_value( $this->assoc_args, 'group', '' ); $interval = (int) get_flag_value( $this->assoc_args, 'interval', 0 ); // avoid absint() to support negative intervals $count = absint( get_flag_value( $this->assoc_args, 'count', 1 ) ); if ( ! empty( $callback_args ) ) { $callback_args = json_decode( $callback_args, true ); } $schedule_start = as_get_datetime_object( $schedule_start ); $function_args = array( 'start' => absint( $schedule_start->format( 'U' ) ), 'interval' => $interval, 'count' => $count, 'hook' => $hook, 'callback_args' => $callback_args, 'group' => $group, ); $function_args = array_values( $function_args ); try { $actions_added = $this->generate( ...$function_args ); } catch ( \Exception $e ) { $this->print_error( $e ); } $num_actions_added = count( (array) $actions_added ); $this->print_success( $num_actions_added, 'single' ); } /** * Schedule multiple single actions. * * @param int $schedule_start Starting timestamp of first action. * @param int $interval How long to wait between runs. * @param int $count Limit number of actions to schedule. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @return int[] IDs of actions added. */ protected function generate( $schedule_start, $interval, $count, $hook, array $args = array(), $group = '' ) { $actions_added = array(); $progress_bar = \WP_CLI\Utils\make_progress_bar( sprintf( /* translators: %d is number of actions to create */ _n( 'Creating %d action', 'Creating %d actions', $count, 'woocommerce' ), number_format_i18n( $count ) ), $count ); for ( $i = 0; $i < $count; $i++ ) { $actions_added[] = as_schedule_single_action( $schedule_start + ( $i * $interval ), $hook, $args, $group ); $progress_bar->tick(); } $progress_bar->finish(); return $actions_added; } /** * Print a success message with the action ID. * * @param int $actions_added Number of actions generated. * @param string $action_type Type of actions scheduled. * @return void */ protected function print_success( $actions_added, $action_type ) { \WP_CLI::success( sprintf( /* translators: %1$d refers to the total number of tasks added, %2$s is the action type */ _n( '%1$d %2$s action scheduled.', '%1$d %2$s actions scheduled.', $actions_added, 'woocommerce' ), number_format_i18n( $actions_added ), $action_type ) ); } /** * Convert an exception into a WP CLI error. * * @param \Exception $e The error object. * @throws \WP_CLI\ExitException When an error occurs. * @return void */ protected function print_error( \Exception $e ) { \WP_CLI::error( sprintf( /* translators: %s refers to the exception error message. */ __( 'There was an error creating the scheduled action: %s', 'woocommerce' ), $e->getMessage() ) ); } } action-scheduler/classes/WP_CLI/Action/Get_Command.php 0000777 00000004233 15252010675 0016566 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI\Action; /** * WP-CLI command: action-scheduler action get */ class Get_Command extends \ActionScheduler_WPCLI_Command { /** * Execute command. * * @return void */ public function execute() { $action_id = $this->args[0]; $store = \ActionScheduler::store(); $logger = \ActionScheduler::logger(); $action = $store->fetch_action( $action_id ); if ( is_a( $action, ActionScheduler_NullAction::class ) ) { /* translators: %d is action ID. */ \WP_CLI::error( sprintf( esc_html__( 'Unable to retrieve action %d.', 'woocommerce' ), $action_id ) ); } $only_logs = ! empty( $this->assoc_args['field'] ) && 'log_entries' === $this->assoc_args['field']; $only_logs = $only_logs || ( ! empty( $this->assoc_args['fields'] ) && 'log_entries' === $this->assoc_args['fields'] ); $log_entries = array(); foreach ( $logger->get_logs( $action_id ) as $log_entry ) { $log_entries[] = array( 'date' => $log_entry->get_date()->format( static::DATE_FORMAT ), 'message' => $log_entry->get_message(), ); } if ( $only_logs ) { $args = array( 'format' => \WP_CLI\Utils\get_flag_value( $this->assoc_args, 'format', 'table' ), ); $formatter = new \WP_CLI\Formatter( $args, array( 'date', 'message' ) ); $formatter->display_items( $log_entries ); return; } try { $status = $store->get_status( $action_id ); } catch ( \Exception $e ) { \WP_CLI::error( $e->getMessage() ); } $action_arr = array( 'id' => $this->args[0], 'hook' => $action->get_hook(), 'status' => $status, 'args' => $action->get_args(), 'group' => $action->get_group(), 'recurring' => $action->get_schedule()->is_recurring() ? 'yes' : 'no', 'scheduled_date' => $this->get_schedule_display_string( $action->get_schedule() ), 'log_entries' => $log_entries, ); $fields = array_keys( $action_arr ); if ( ! empty( $this->assoc_args['fields'] ) ) { $fields = explode( ',', $this->assoc_args['fields'] ); } $formatter = new \WP_CLI\Formatter( $this->assoc_args, $fields ); $formatter->display_item( $action_arr ); } } action-scheduler/classes/WP_CLI/ProgressBar.php 0000777 00000005311 15252010675 0015423 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI; /** * WP_CLI progress bar for Action Scheduler. */ /** * Class ProgressBar * * @package Action_Scheduler\WP_CLI * * @since 3.0.0 * * @codeCoverageIgnore */ class ProgressBar { /** * Current number of ticks. * * @var integer */ protected $total_ticks; /** * Total number of ticks. * * @var integer */ protected $count; /** * Progress bar update interval. * * @var integer */ protected $interval; /** * Progress bar message. * * @var string */ protected $message; /** * Instance. * * @var \cli\progress\Bar */ protected $progress_bar; /** * ProgressBar constructor. * * @param string $message Text to display before the progress bar. * @param integer $count Total number of ticks to be performed. * @param integer $interval Optional. The interval in milliseconds between updates. Default 100. * * @throws \Exception When this is not run within WP CLI. */ public function __construct( $message, $count, $interval = 100 ) { if ( ! ( defined( 'WP_CLI' ) && WP_CLI ) ) { /* translators: %s php class name */ throw new \Exception( sprintf( __( 'The %s class can only be run within WP CLI.', 'woocommerce' ), __CLASS__ ) ); } $this->total_ticks = 0; $this->message = $message; $this->count = $count; $this->interval = $interval; } /** * Increment the progress bar ticks. */ public function tick() { if ( null === $this->progress_bar ) { $this->setup_progress_bar(); } $this->progress_bar->tick(); $this->total_ticks++; do_action( 'action_scheduler/progress_tick', $this->total_ticks ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores } /** * Get the progress bar tick count. * * @return int */ public function current() { return $this->progress_bar ? $this->progress_bar->current() : 0; } /** * Finish the current progress bar. */ public function finish() { if ( null !== $this->progress_bar ) { $this->progress_bar->finish(); } $this->progress_bar = null; } /** * Set the message used when creating the progress bar. * * @param string $message The message to be used when the next progress bar is created. */ public function set_message( $message ) { $this->message = $message; } /** * Set the count for a new progress bar. * * @param integer $count The total number of ticks expected to complete. */ public function set_count( $count ) { $this->count = $count; $this->finish(); } /** * Set up the progress bar. */ protected function setup_progress_bar() { $this->progress_bar = \WP_CLI\Utils\make_progress_bar( $this->message, $this->count, $this->interval ); } } action-scheduler/classes/WP_CLI/Migration_Command.php 0000777 00000011670 15252010675 0016566 0 ustar 00 <?php namespace Action_Scheduler\WP_CLI; use Action_Scheduler\Migration\Config; use Action_Scheduler\Migration\Runner; use Action_Scheduler\Migration\Scheduler; use Action_Scheduler\Migration\Controller; use WP_CLI; use WP_CLI_Command; /** * Class Migration_Command * * @package Action_Scheduler\WP_CLI * * @since 3.0.0 * * @codeCoverageIgnore */ class Migration_Command extends WP_CLI_Command { /** * Number of actions migrated. * * @var int */ private $total_processed = 0; /** * Register the command with WP-CLI */ public function register() { if ( ! defined( 'WP_CLI' ) || ! WP_CLI ) { return; } WP_CLI::add_command( 'action-scheduler migrate', array( $this, 'migrate' ), array( 'shortdesc' => 'Migrates actions to the DB tables store', 'synopsis' => array( array( 'type' => 'assoc', 'name' => 'batch-size', 'optional' => true, 'default' => 100, 'description' => 'The number of actions to process in each batch', ), array( 'type' => 'assoc', 'name' => 'free-memory-on', 'optional' => true, 'default' => 50, 'description' => 'The number of actions to process between freeing memory. 0 disables freeing memory', ), array( 'type' => 'assoc', 'name' => 'pause', 'optional' => true, 'default' => 0, 'description' => 'The number of seconds to pause when freeing memory', ), array( 'type' => 'flag', 'name' => 'dry-run', 'optional' => true, 'description' => 'Reports on the actions that would have been migrated, but does not change any data', ), ), ) ); } /** * Process the data migration. * * @param array $positional_args Required for WP CLI. Not used in migration. * @param array $assoc_args Optional arguments. * * @return void */ public function migrate( $positional_args, $assoc_args ) { $this->init_logging(); $config = $this->get_migration_config( $assoc_args ); $runner = new Runner( $config ); $runner->init_destination(); $batch_size = isset( $assoc_args['batch-size'] ) ? (int) $assoc_args['batch-size'] : 100; $free_on = isset( $assoc_args['free-memory-on'] ) ? (int) $assoc_args['free-memory-on'] : 50; $sleep = isset( $assoc_args['pause'] ) ? (int) $assoc_args['pause'] : 0; \ActionScheduler_DataController::set_free_ticks( $free_on ); \ActionScheduler_DataController::set_sleep_time( $sleep ); do { $actions_processed = $runner->run( $batch_size ); $this->total_processed += $actions_processed; } while ( $actions_processed > 0 ); if ( ! $config->get_dry_run() ) { // let the scheduler know that there's nothing left to do. $scheduler = new Scheduler(); $scheduler->mark_complete(); } WP_CLI::success( sprintf( '%s complete. %d actions processed.', $config->get_dry_run() ? 'Dry run' : 'Migration', $this->total_processed ) ); } /** * Build the config object used to create the Runner * * @param array $args Optional arguments. * * @return ActionScheduler\Migration\Config */ private function get_migration_config( $args ) { $args = wp_parse_args( $args, array( 'dry-run' => false, ) ); $config = Controller::instance()->get_migration_config_object(); $config->set_dry_run( ! empty( $args['dry-run'] ) ); return $config; } /** * Hook command line logging into migration actions. */ private function init_logging() { add_action( 'action_scheduler/migrate_action_dry_run', function ( $action_id ) { WP_CLI::debug( sprintf( 'Dry-run: migrated action %d', $action_id ) ); } ); add_action( 'action_scheduler/no_action_to_migrate', function ( $action_id ) { WP_CLI::debug( sprintf( 'No action found to migrate for ID %d', $action_id ) ); } ); add_action( 'action_scheduler/migrate_action_failed', function ( $action_id ) { WP_CLI::warning( sprintf( 'Failed migrating action with ID %d', $action_id ) ); } ); add_action( 'action_scheduler/migrate_action_incomplete', function ( $source_id, $destination_id ) { WP_CLI::warning( sprintf( 'Unable to remove source action with ID %d after migrating to new ID %d', $source_id, $destination_id ) ); }, 10, 2 ); add_action( 'action_scheduler/migrated_action', function ( $source_id, $destination_id ) { WP_CLI::debug( sprintf( 'Migrated source action with ID %d to new store with ID %d', $source_id, $destination_id ) ); }, 10, 2 ); add_action( 'action_scheduler/migration_batch_starting', function ( $batch ) { WP_CLI::debug( 'Beginning migration of batch: ' . print_r( $batch, true ) ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r } ); add_action( 'action_scheduler/migration_batch_complete', function ( $batch ) { WP_CLI::log( sprintf( 'Completed migration of %d actions', count( $batch ) ) ); } ); } } action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_QueueRunner.php 0000777 00000014261 15252010675 0021546 0 ustar 00 <?php use Action_Scheduler\WP_CLI\ProgressBar; /** * WP CLI Queue runner. * * This class can only be called from within a WP CLI instance. */ class ActionScheduler_WPCLI_QueueRunner extends ActionScheduler_Abstract_QueueRunner { /** * Claimed actions. * * @var array */ protected $actions; /** * ActionScheduler_ActionClaim instance. * * @var ActionScheduler_ActionClaim */ protected $claim; /** * Progress bar instance. * * @var \cli\progress\Bar */ protected $progress_bar; /** * ActionScheduler_WPCLI_QueueRunner constructor. * * @param ActionScheduler_Store|null $store Store object. * @param ActionScheduler_FatalErrorMonitor|null $monitor Monitor object. * @param ActionScheduler_QueueCleaner|null $cleaner Cleaner object. * * @throws Exception When this is not run within WP CLI. */ public function __construct( ?ActionScheduler_Store $store = null, ?ActionScheduler_FatalErrorMonitor $monitor = null, ?ActionScheduler_QueueCleaner $cleaner = null ) { if ( ! ( defined( 'WP_CLI' ) && WP_CLI ) ) { /* translators: %s php class name */ throw new Exception( sprintf( __( 'The %s class can only be run within WP CLI.', 'woocommerce' ), __CLASS__ ) ); } parent::__construct( $store, $monitor, $cleaner ); } /** * Set up the Queue before processing. * * @param int $batch_size The batch size to process. * @param array $hooks The hooks being used to filter the actions claimed in this batch. * @param string $group The group of actions to claim with this batch. * @param bool $force Whether to force running even with too many concurrent processes. * * @return int The number of actions that will be run. * @throws \WP_CLI\ExitException When there are too many concurrent batches. */ public function setup( $batch_size, $hooks = array(), $group = '', $force = false ) { $this->run_cleanup(); $this->add_hooks(); // Check to make sure there aren't too many concurrent processes running. if ( $this->has_maximum_concurrent_batches() ) { if ( $force ) { WP_CLI::warning( __( 'There are too many concurrent batches, but the run is forced to continue.', 'woocommerce' ) ); } else { WP_CLI::error( __( 'There are too many concurrent batches.', 'woocommerce' ) ); } } // Stake a claim and store it. $this->claim = $this->store->stake_claim( $batch_size, null, $hooks, $group ); $this->monitor->attach( $this->claim ); $this->actions = $this->claim->get_actions(); return count( $this->actions ); } /** * Add our hooks to the appropriate actions. */ protected function add_hooks() { add_action( 'action_scheduler_before_execute', array( $this, 'before_execute' ) ); add_action( 'action_scheduler_after_execute', array( $this, 'after_execute' ), 10, 2 ); add_action( 'action_scheduler_failed_execution', array( $this, 'action_failed' ), 10, 2 ); } /** * Set up the WP CLI progress bar. */ protected function setup_progress_bar() { $count = count( $this->actions ); $this->progress_bar = new ProgressBar( /* translators: %d: amount of actions */ sprintf( _n( 'Running %d action', 'Running %d actions', $count, 'woocommerce' ), $count ), $count ); } /** * Process actions in the queue. * * @param string $context Optional runner context. Default 'WP CLI'. * * @return int The number of actions processed. */ public function run( $context = 'WP CLI' ) { do_action( 'action_scheduler_before_process_queue' ); $this->setup_progress_bar(); foreach ( $this->actions as $action_id ) { // Error if we lost the claim. if ( ! in_array( $action_id, $this->store->find_actions_by_claim_id( $this->claim->get_id() ), true ) ) { WP_CLI::warning( __( 'The claim has been lost. Aborting current batch.', 'woocommerce' ) ); break; } $this->process_action( $action_id, $context ); $this->progress_bar->tick(); } $completed = $this->progress_bar->current(); $this->progress_bar->finish(); $this->store->release_claim( $this->claim ); do_action( 'action_scheduler_after_process_queue' ); return $completed; } /** * Handle WP CLI message when the action is starting. * * @param int $action_id Action ID. */ public function before_execute( $action_id ) { /* translators: %s refers to the action ID */ WP_CLI::log( sprintf( __( 'Started processing action %s', 'woocommerce' ), $action_id ) ); } /** * Handle WP CLI message when the action has completed. * * @param int $action_id ActionID. * @param null|ActionScheduler_Action $action The instance of the action. Default to null for backward compatibility. */ public function after_execute( $action_id, $action = null ) { // backward compatibility. if ( null === $action ) { $action = $this->store->fetch_action( $action_id ); } /* translators: 1: action ID 2: hook name */ WP_CLI::log( sprintf( __( 'Completed processing action %1$s with hook: %2$s', 'woocommerce' ), $action_id, $action->get_hook() ) ); } /** * Handle WP CLI message when the action has failed. * * @param int $action_id Action ID. * @param Exception $exception Exception. * @throws \WP_CLI\ExitException With failure message. */ public function action_failed( $action_id, $exception ) { WP_CLI::error( /* translators: 1: action ID 2: exception message */ sprintf( __( 'Error processing action %1$s: %2$s', 'woocommerce' ), $action_id, $exception->getMessage() ), false ); } /** * Sleep and help avoid hitting memory limit * * @param int $sleep_time Amount of seconds to sleep. * @deprecated 3.0.0 */ protected function stop_the_insanity( $sleep_time = 0 ) { _deprecated_function( 'ActionScheduler_WPCLI_QueueRunner::stop_the_insanity', '3.0.0', 'ActionScheduler_DataController::free_memory' ); ActionScheduler_DataController::free_memory(); } /** * Maybe trigger the stop_the_insanity() method to free up memory. */ protected function maybe_stop_the_insanity() { // The value returned by progress_bar->current() might be padded. Remove padding, and convert to int. $current_iteration = intval( trim( $this->progress_bar->current() ) ); if ( 0 === $current_iteration % 50 ) { $this->stop_the_insanity(); } } } action-scheduler/classes/ActionScheduler_QueueCleaner.php 0000777 00000017602 15252010675 0017675 0 ustar 00 <?php /** * Class ActionScheduler_QueueCleaner */ class ActionScheduler_QueueCleaner { /** * The batch size. * * @var int */ protected $batch_size; /** * ActionScheduler_Store instance. * * @var ActionScheduler_Store */ private $store = null; /** * 31 days in seconds. * * @var int */ private $month_in_seconds = 2678400; /** * Default list of statuses purged by the cleaner process. * * @var string[] */ private $default_statuses_to_purge = array( ActionScheduler_Store::STATUS_COMPLETE, ActionScheduler_Store::STATUS_CANCELED, ); /** * ActionScheduler_QueueCleaner constructor. * * @param ActionScheduler_Store|null $store The store instance. * @param int $batch_size The batch size. */ public function __construct( ?ActionScheduler_Store $store = null, $batch_size = 20 ) { $this->store = $store ? $store : ActionScheduler_Store::instance(); $this->batch_size = $batch_size; } /** * Default queue cleaner process used by queue runner. * * @return array */ public function delete_old_actions() { /** * Filter the minimum scheduled date age for action deletion. * * @param int $retention_period Minimum scheduled age in seconds of the actions to be deleted. */ $lifespan = apply_filters( 'action_scheduler_retention_period', $this->month_in_seconds ); try { $cutoff = as_get_datetime_object( $lifespan . ' seconds ago' ); } catch ( Exception $e ) { _doing_it_wrong( __METHOD__, sprintf( /* Translators: %s is the exception message. */ esc_html__( 'It was not possible to determine a valid cut-off time: %s.', 'woocommerce' ), esc_html( $e->getMessage() ) ), '3.5.5' ); return array(); } /** * Filter the statuses when cleaning the queue. * * @param string[] $default_statuses_to_purge Action statuses to clean. */ $statuses_to_purge = (array) apply_filters( 'action_scheduler_default_cleaner_statuses', $this->default_statuses_to_purge ); return $this->clean_actions( $statuses_to_purge, $cutoff, $this->get_batch_size() ); } /** * Delete selected actions limited by status and date. * * @param string[] $statuses_to_purge List of action statuses to purge. Defaults to canceled, complete. * @param DateTime $cutoff_date Date limit for selecting actions. Defaults to 31 days ago. * @param int|null $batch_size Maximum number of actions per status to delete. Defaults to 20. * @param string $context Calling process context. Defaults to `old`. * @return array Actions deleted. */ public function clean_actions( array $statuses_to_purge, DateTime $cutoff_date, $batch_size = null, $context = 'old' ) { $batch_size = ! is_null( $batch_size ) ? $batch_size : $this->batch_size; $cutoff = ! is_null( $cutoff_date ) ? $cutoff_date : as_get_datetime_object( $this->month_in_seconds . ' seconds ago' ); $lifespan = time() - $cutoff->getTimestamp(); if ( empty( $statuses_to_purge ) ) { $statuses_to_purge = $this->default_statuses_to_purge; } $deleted_actions = array(); foreach ( $statuses_to_purge as $status ) { $actions_to_delete = $this->store->query_actions( array( 'status' => $status, 'modified' => $cutoff, 'modified_compare' => '<=', 'per_page' => $batch_size, 'orderby' => 'none', ) ); $deleted_actions = array_merge( $deleted_actions, $this->delete_actions( $actions_to_delete, $lifespan, $context ) ); } return $deleted_actions; } /** * Delete actions. * * @param int[] $actions_to_delete List of action IDs to delete. * @param int $lifespan Minimum scheduled age in seconds of the actions being deleted. * @param string $context Context of the delete request. * @return array Deleted action IDs. */ private function delete_actions( array $actions_to_delete, $lifespan = null, $context = 'old' ) { $deleted_actions = array(); if ( is_null( $lifespan ) ) { $lifespan = $this->month_in_seconds; } foreach ( $actions_to_delete as $action_id ) { try { $this->store->delete_action( $action_id ); $deleted_actions[] = $action_id; } catch ( Exception $e ) { /** * Notify 3rd party code of exceptions when deleting a completed action older than the retention period * * This hook provides a way for 3rd party code to log or otherwise handle exceptions relating to their * actions. * * @param int $action_id The scheduled actions ID in the data store * @param Exception $e The exception thrown when attempting to delete the action from the data store * @param int $lifespan The retention period, in seconds, for old actions * @param int $count_of_actions_to_delete The number of old actions being deleted in this batch * @since 2.0.0 */ do_action( "action_scheduler_failed_{$context}_action_deletion", $action_id, $e, $lifespan, count( $actions_to_delete ) ); } } return $deleted_actions; } /** * Unclaim pending actions that have not been run within a given time limit. * * When called by ActionScheduler_Abstract_QueueRunner::run_cleanup(), the time limit passed * as a parameter is 10x the time limit used for queue processing. * * @param int $time_limit The number of seconds to allow a queue to run before unclaiming its pending actions. Default 300 (5 minutes). */ public function reset_timeouts( $time_limit = 300 ) { $timeout = apply_filters( 'action_scheduler_timeout_period', $time_limit ); if ( $timeout < 0 ) { return; } $cutoff = as_get_datetime_object( $timeout . ' seconds ago' ); $actions_to_reset = $this->store->query_actions( array( 'status' => ActionScheduler_Store::STATUS_PENDING, 'modified' => $cutoff, 'modified_compare' => '<=', 'claimed' => true, 'per_page' => $this->get_batch_size(), 'orderby' => 'none', ) ); foreach ( $actions_to_reset as $action_id ) { $this->store->unclaim_action( $action_id ); do_action( 'action_scheduler_reset_action', $action_id ); } } /** * Mark actions that have been running for more than a given time limit as failed, based on * the assumption some uncatchable and unloggable fatal error occurred during processing. * * When called by ActionScheduler_Abstract_QueueRunner::run_cleanup(), the time limit passed * as a parameter is 10x the time limit used for queue processing. * * @param int $time_limit The number of seconds to allow an action to run before it is considered to have failed. Default 300 (5 minutes). */ public function mark_failures( $time_limit = 300 ) { $timeout = apply_filters( 'action_scheduler_failure_period', $time_limit ); if ( $timeout < 0 ) { return; } $cutoff = as_get_datetime_object( $timeout . ' seconds ago' ); $actions_to_reset = $this->store->query_actions( array( 'status' => ActionScheduler_Store::STATUS_RUNNING, 'modified' => $cutoff, 'modified_compare' => '<=', 'per_page' => $this->get_batch_size(), 'orderby' => 'none', ) ); foreach ( $actions_to_reset as $action_id ) { $this->store->mark_failure( $action_id ); do_action( 'action_scheduler_failed_action', $action_id, $timeout ); } } /** * Do all of the cleaning actions. * * @param int $time_limit The number of seconds to use as the timeout and failure period. Default 300 (5 minutes). */ public function clean( $time_limit = 300 ) { $this->delete_old_actions(); $this->reset_timeouts( $time_limit ); $this->mark_failures( $time_limit ); } /** * Get the batch size for cleaning the queue. * * @return int */ protected function get_batch_size() { /** * Filter the batch size when cleaning the queue. * * @param int $batch_size The number of actions to clean in one batch. */ return absint( apply_filters( 'action_scheduler_cleanup_batch_size', $this->batch_size ) ); } } action-scheduler/classes/ActionScheduler_NullLogEntry.php 0000777 00000000512 15252010675 0017705 0 ustar 00 <?php /** * Class ActionScheduler_NullLogEntry */ class ActionScheduler_NullLogEntry extends ActionScheduler_LogEntry { /** * Construct. * * @param string $action_id Action ID. * @param string $message Log entry. */ public function __construct( $action_id = '', $message = '' ) { // nothing to see here. } } action-scheduler/classes/ActionScheduler_Compatibility.php 0000777 00000007500 15252010675 0020124 0 ustar 00 <?php /** * Class ActionScheduler_Compatibility */ class ActionScheduler_Compatibility { /** * Converts a shorthand byte value to an integer byte value. * * Wrapper for wp_convert_hr_to_bytes(), moved to load.php in WordPress 4.6 from media.php * * @link https://secure.php.net/manual/en/function.ini-get.php * @link https://secure.php.net/manual/en/faq.using.php#faq.using.shorthandbytes * * @param string $value A (PHP ini) byte value, either shorthand or ordinary. * @return int An integer byte value. */ public static function convert_hr_to_bytes( $value ) { if ( function_exists( 'wp_convert_hr_to_bytes' ) ) { return wp_convert_hr_to_bytes( $value ); } $value = strtolower( trim( $value ) ); $bytes = (int) $value; if ( false !== strpos( $value, 'g' ) ) { $bytes *= GB_IN_BYTES; } elseif ( false !== strpos( $value, 'm' ) ) { $bytes *= MB_IN_BYTES; } elseif ( false !== strpos( $value, 'k' ) ) { $bytes *= KB_IN_BYTES; } // Deal with large (float) values which run into the maximum integer size. return min( $bytes, PHP_INT_MAX ); } /** * Attempts to raise the PHP memory limit for memory intensive processes. * * Only allows raising the existing limit and prevents lowering it. * * Wrapper for wp_raise_memory_limit(), added in WordPress v4.6.0 * * @return bool|int|string The limit that was set or false on failure. */ public static function raise_memory_limit() { if ( function_exists( 'wp_raise_memory_limit' ) ) { return wp_raise_memory_limit( 'admin' ); } $current_limit = @ini_get( 'memory_limit' ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged $current_limit_int = self::convert_hr_to_bytes( $current_limit ); if ( -1 === $current_limit_int ) { return false; } $wp_max_limit = WP_MAX_MEMORY_LIMIT; $wp_max_limit_int = self::convert_hr_to_bytes( $wp_max_limit ); $filtered_limit = apply_filters( 'admin_memory_limit', $wp_max_limit ); $filtered_limit_int = self::convert_hr_to_bytes( $filtered_limit ); // phpcs:disable WordPress.PHP.IniSet.memory_limit_Blacklisted // phpcs:disable WordPress.PHP.NoSilencedErrors.Discouraged if ( -1 === $filtered_limit_int || ( $filtered_limit_int > $wp_max_limit_int && $filtered_limit_int > $current_limit_int ) ) { if ( false !== @ini_set( 'memory_limit', $filtered_limit ) ) { return $filtered_limit; } else { return false; } } elseif ( -1 === $wp_max_limit_int || $wp_max_limit_int > $current_limit_int ) { if ( false !== @ini_set( 'memory_limit', $wp_max_limit ) ) { return $wp_max_limit; } else { return false; } } // phpcs:enable return false; } /** * Attempts to raise the PHP timeout for time intensive processes. * * Only allows raising the existing limit and prevents lowering it. Wrapper for wc_set_time_limit(), when available. * * @param int $limit The time limit in seconds. */ public static function raise_time_limit( $limit = 0 ) { $limit = (int) $limit; $max_execution_time = (int) ini_get( 'max_execution_time' ); // If the max execution time is already set to zero (unlimited), there is no reason to make a further change. if ( 0 === $max_execution_time ) { return; } // Whichever of $max_execution_time or $limit is higher is the amount by which we raise the time limit. $raise_by = 0 === $limit || $limit > $max_execution_time ? $limit : $max_execution_time; if ( function_exists( 'wc_set_time_limit' ) ) { wc_set_time_limit( $raise_by ); } elseif ( function_exists( 'set_time_limit' ) && false === strpos( ini_get( 'disable_functions' ), 'set_time_limit' ) && ! ini_get( 'safe_mode' ) ) { // phpcs:ignore PHPCompatibility.IniDirectives.RemovedIniDirectives.safe_modeDeprecatedRemoved @set_time_limit( $raise_by ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged } } } action-scheduler/classes/ActionScheduler_ActionClaim.php 0000777 00000001214 15252010675 0017472 0 ustar 00 <?php /** * Class ActionScheduler_ActionClaim */ class ActionScheduler_ActionClaim { /** * Claim ID. * * @var string */ private $id = ''; /** * Claimed action IDs. * * @var int[] */ private $action_ids = array(); /** * Construct. * * @param string $id Claim ID. * @param int[] $action_ids Action IDs. */ public function __construct( $id, array $action_ids ) { $this->id = $id; $this->action_ids = $action_ids; } /** * Get claim ID. */ public function get_id() { return $this->id; } /** * Get IDs of claimed actions. */ public function get_actions() { return $this->action_ids; } } action-scheduler/classes/ActionScheduler_Versions.php 0000777 00000007152 15252010675 0017126 0 ustar 00 <?php /** * Class ActionScheduler_Versions */ class ActionScheduler_Versions { /** * ActionScheduler_Versions instance. * * @var ActionScheduler_Versions */ private static $instance = null; /** * Versions. * * @var array<string, callable> */ private $versions = array(); /** * Registered sources. * * @var array<string, string> */ private $sources = array(); /** * Register version's callback. * * @param string $version_string Action Scheduler version. * @param callable $initialization_callback Callback to initialize the version. */ public function register( $version_string, $initialization_callback ) { if ( isset( $this->versions[ $version_string ] ) ) { return false; } // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_debug_backtrace $backtrace = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS ); $source = $backtrace[0]['file']; $this->versions[ $version_string ] = $initialization_callback; $this->sources[ $source ] = $version_string; return true; } /** * Get all versions. */ public function get_versions() { return $this->versions; } /** * Get registered sources. * * Use with caution: this method is only available as of Action Scheduler's 3.9.1 * release and, owing to the way Action Scheduler is loaded, it's possible that the * class definition used at runtime will belong to an earlier version. * * @since 3.9.1 * * @return array<string, string> */ public function get_sources() { return $this->sources; } /** * Get latest version registered. */ public function latest_version() { $keys = array_keys( $this->versions ); if ( empty( $keys ) ) { return false; } uasort( $keys, 'version_compare' ); return end( $keys ); } /** * Get callback for latest registered version. */ public function latest_version_callback() { $latest = $this->latest_version(); if ( empty( $latest ) || ! isset( $this->versions[ $latest ] ) ) { return '__return_null'; } return $this->versions[ $latest ]; } /** * Get instance. * * @return ActionScheduler_Versions * @codeCoverageIgnore */ public static function instance() { if ( empty( self::$instance ) ) { self::$instance = new self(); } return self::$instance; } /** * Initialize. * * @codeCoverageIgnore */ public static function initialize_latest_version() { $self = self::instance(); call_user_func( $self->latest_version_callback() ); } /** * Returns information about the plugin or theme which contains the current active version * of Action Scheduler. * * If this cannot be determined, or if Action Scheduler is being loaded via some other * method, then it will return an empty array. Otherwise, if populated, the array will * look like the following: * * [ * 'type' => 'plugin', # or 'theme' * 'name' => 'Name', * ] * * @deprecated 3.9.2 Use ActionScheduler_SystemInformation::active_source(). * * @return array */ public function active_source(): array { _deprecated_function( __METHOD__, '3.9.2', 'ActionScheduler_SystemInformation::active_source()' ); return ActionScheduler_SystemInformation::active_source(); } /** * Returns the directory path for the currently active installation of Action Scheduler. * * @deprecated 3.9.2 Use ActionScheduler_SystemInformation::active_source_path(). * * @return string */ public function active_source_path(): string { _deprecated_function( __METHOD__, '3.9.2', 'ActionScheduler_SystemInformation::active_source_path()' ); return ActionScheduler_SystemInformation::active_source_path(); } } action-scheduler/classes/ActionScheduler_LogEntry.php 0000777 00000003626 15252010675 0017063 0 ustar 00 <?php /** * Class ActionScheduler_LogEntry */ class ActionScheduler_LogEntry { /** * Action's ID for log entry. * * @var int $action_id */ protected $action_id = ''; /** * Log entry's message. * * @var string $message */ protected $message = ''; /** * Log entry's date. * * @var Datetime $date */ protected $date; /** * Constructor * * @param mixed $action_id Action ID. * @param string $message Message. * @param Datetime $date Datetime object with the time when this log entry was created. If this parameter is * not provided a new Datetime object (with current time) will be created. */ public function __construct( $action_id, $message, $date = null ) { /* * ActionScheduler_wpCommentLogger::get_entry() previously passed a 3rd param of $comment->comment_type * to ActionScheduler_LogEntry::__construct(), goodness knows why, and the Follow-up Emails plugin * hard-codes loading its own version of ActionScheduler_wpCommentLogger with that out-dated method, * goodness knows why, so we need to guard against that here instead of using a DateTime type declaration * for the constructor's 3rd param of $date and causing a fatal error with older versions of FUE. */ if ( null !== $date && ! is_a( $date, 'DateTime' ) ) { _doing_it_wrong( __METHOD__, 'The third parameter must be a valid DateTime instance, or null.', '2.0.0' ); $date = null; } $this->action_id = $action_id; $this->message = $message; $this->date = $date ? $date : new Datetime(); } /** * Returns the date when this log entry was created * * @return Datetime */ public function get_date() { return $this->date; } /** * Get action ID of log entry. */ public function get_action_id() { return $this->action_id; } /** * Get log entry message. */ public function get_message() { return $this->message; } } action-scheduler/classes/migration/Runner.php 0000777 00000010162 15252010675 0015417 0 ustar 00 <?php namespace Action_Scheduler\Migration; /** * Class Runner * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class Runner { /** * Source store instance. * * @var ActionScheduler_Store */ private $source_store; /** * Destination store instance. * * @var ActionScheduler_Store */ private $destination_store; /** * Source logger instance. * * @var ActionScheduler_Logger */ private $source_logger; /** * Destination logger instance. * * @var ActionScheduler_Logger */ private $destination_logger; /** * Batch fetcher instance. * * @var BatchFetcher */ private $batch_fetcher; /** * Action migrator instance. * * @var ActionMigrator */ private $action_migrator; /** * Log migrator instance. * * @var LogMigrator */ private $log_migrator; /** * Progress bar instance. * * @var ProgressBar */ private $progress_bar; /** * Runner constructor. * * @param Config $config Migration configuration object. */ public function __construct( Config $config ) { $this->source_store = $config->get_source_store(); $this->destination_store = $config->get_destination_store(); $this->source_logger = $config->get_source_logger(); $this->destination_logger = $config->get_destination_logger(); $this->batch_fetcher = new BatchFetcher( $this->source_store ); if ( $config->get_dry_run() ) { $this->log_migrator = new DryRun_LogMigrator( $this->source_logger, $this->destination_logger ); $this->action_migrator = new DryRun_ActionMigrator( $this->source_store, $this->destination_store, $this->log_migrator ); } else { $this->log_migrator = new LogMigrator( $this->source_logger, $this->destination_logger ); $this->action_migrator = new ActionMigrator( $this->source_store, $this->destination_store, $this->log_migrator ); } if ( defined( 'WP_CLI' ) && WP_CLI ) { $this->progress_bar = $config->get_progress_bar(); } } /** * Run migration batch. * * @param int $batch_size Optional batch size. Default 10. * * @return int Size of batch processed. */ public function run( $batch_size = 10 ) { $batch = $this->batch_fetcher->fetch( $batch_size ); $batch_size = count( $batch ); if ( ! $batch_size ) { return 0; } if ( $this->progress_bar ) { /* translators: %d: amount of actions */ $this->progress_bar->set_message( sprintf( _n( 'Migrating %d action', 'Migrating %d actions', $batch_size, 'woocommerce' ), $batch_size ) ); $this->progress_bar->set_count( $batch_size ); } $this->migrate_actions( $batch ); return $batch_size; } /** * Migration a batch of actions. * * @param array $action_ids List of action IDs to migrate. */ public function migrate_actions( array $action_ids ) { do_action( 'action_scheduler/migration_batch_starting', $action_ids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores \ActionScheduler::logger()->unhook_stored_action(); $this->destination_logger->unhook_stored_action(); foreach ( $action_ids as $source_action_id ) { $destination_action_id = $this->action_migrator->migrate( $source_action_id ); if ( $destination_action_id ) { $this->destination_logger->log( $destination_action_id, sprintf( /* translators: 1: source action ID 2: source store class 3: destination action ID 4: destination store class */ __( 'Migrated action with ID %1$d in %2$s to ID %3$d in %4$s', 'woocommerce' ), $source_action_id, get_class( $this->source_store ), $destination_action_id, get_class( $this->destination_store ) ) ); } if ( $this->progress_bar ) { $this->progress_bar->tick(); } } if ( $this->progress_bar ) { $this->progress_bar->finish(); } \ActionScheduler::logger()->hook_stored_action(); do_action( 'action_scheduler/migration_batch_complete', $action_ids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores } /** * Initialize destination store and logger. */ public function init_destination() { $this->destination_store->init(); $this->destination_logger->init(); } } action-scheduler/classes/migration/ActionScheduler_DBStoreMigrator.php 0000777 00000003446 15252010675 0022320 0 ustar 00 <?php /** * Class ActionScheduler_DBStoreMigrator * * A class for direct saving of actions to the table data store during migration. * * @since 3.0.0 */ class ActionScheduler_DBStoreMigrator extends ActionScheduler_DBStore { /** * Save an action with optional last attempt date. * * Normally, saving an action sets its attempted date to 0000-00-00 00:00:00 because when an action is first saved, * it can't have been attempted yet, but migrated completed actions will have an attempted date, so we need to save * that when first saving the action. * * @param ActionScheduler_Action $action Action to migrate. * @param null|DateTime $scheduled_date Optional date of the first instance to store. * @param null|DateTime $last_attempt_date Optional date the action was last attempted. * * @return string The action ID * @throws \RuntimeException When the action is not saved. */ public function save_action( ActionScheduler_Action $action, ?DateTime $scheduled_date = null, ?DateTime $last_attempt_date = null ) { try { /** * Global. * * @var \wpdb $wpdb */ global $wpdb; $action_id = parent::save_action( $action, $scheduled_date ); if ( null !== $last_attempt_date ) { $data = array( 'last_attempt_gmt' => $this->get_scheduled_date_string( $action, $last_attempt_date ), 'last_attempt_local' => $this->get_scheduled_date_string_local( $action, $last_attempt_date ), ); $wpdb->update( $wpdb->actionscheduler_actions, $data, array( 'action_id' => $action_id ), array( '%s', '%s' ), array( '%d' ) ); } return $action_id; } catch ( \Exception $e ) { // translators: %s is an error message. throw new \RuntimeException( sprintf( __( 'Error saving action: %s', 'woocommerce' ), $e->getMessage() ), 0 ); } } } action-scheduler/classes/migration/Config.php 0000777 00000010132 15252010675 0015350 0 ustar 00 <?php namespace Action_Scheduler\Migration; use Action_Scheduler\WP_CLI\ProgressBar; use ActionScheduler_Logger as Logger; use ActionScheduler_Store as Store; /** * Class Config * * @package Action_Scheduler\Migration * * @since 3.0.0 * * A config builder for the ActionScheduler\Migration\Runner class */ class Config { /** * Source store instance. * * @var ActionScheduler_Store */ private $source_store; /** * Source logger instance. * * @var ActionScheduler_Logger */ private $source_logger; /** * Destination store instance. * * @var ActionScheduler_Store */ private $destination_store; /** * Destination logger instance. * * @var ActionScheduler_Logger */ private $destination_logger; /** * Progress bar object. * * @var Action_Scheduler\WP_CLI\ProgressBar */ private $progress_bar; /** * Flag indicating a dryrun. * * @var bool */ private $dry_run = false; /** * Config constructor. */ public function __construct() { } /** * Get the configured source store. * * @return ActionScheduler_Store * @throws \RuntimeException When source store is not configured. */ public function get_source_store() { if ( empty( $this->source_store ) ) { throw new \RuntimeException( __( 'Source store must be configured before running a migration', 'woocommerce' ) ); } return $this->source_store; } /** * Set the configured source store. * * @param ActionScheduler_Store $store Source store object. */ public function set_source_store( Store $store ) { $this->source_store = $store; } /** * Get the configured source logger. * * @return ActionScheduler_Logger * @throws \RuntimeException When source logger is not configured. */ public function get_source_logger() { if ( empty( $this->source_logger ) ) { throw new \RuntimeException( __( 'Source logger must be configured before running a migration', 'woocommerce' ) ); } return $this->source_logger; } /** * Set the configured source logger. * * @param ActionScheduler_Logger $logger Logger object. */ public function set_source_logger( Logger $logger ) { $this->source_logger = $logger; } /** * Get the configured destination store. * * @return ActionScheduler_Store * @throws \RuntimeException When destination store is not configured. */ public function get_destination_store() { if ( empty( $this->destination_store ) ) { throw new \RuntimeException( __( 'Destination store must be configured before running a migration', 'woocommerce' ) ); } return $this->destination_store; } /** * Set the configured destination store. * * @param ActionScheduler_Store $store Action store object. */ public function set_destination_store( Store $store ) { $this->destination_store = $store; } /** * Get the configured destination logger. * * @return ActionScheduler_Logger * @throws \RuntimeException When destination logger is not configured. */ public function get_destination_logger() { if ( empty( $this->destination_logger ) ) { throw new \RuntimeException( __( 'Destination logger must be configured before running a migration', 'woocommerce' ) ); } return $this->destination_logger; } /** * Set the configured destination logger. * * @param ActionScheduler_Logger $logger Logger object. */ public function set_destination_logger( Logger $logger ) { $this->destination_logger = $logger; } /** * Get flag indicating whether it's a dry run. * * @return bool */ public function get_dry_run() { return $this->dry_run; } /** * Set flag indicating whether it's a dry run. * * @param bool $dry_run Dry run toggle. */ public function set_dry_run( $dry_run ) { $this->dry_run = (bool) $dry_run; } /** * Get progress bar object. * * @return ActionScheduler\WPCLI\ProgressBar */ public function get_progress_bar() { return $this->progress_bar; } /** * Set progress bar object. * * @param ActionScheduler\WPCLI\ProgressBar $progress_bar Progress bar object. */ public function set_progress_bar( ProgressBar $progress_bar ) { $this->progress_bar = $progress_bar; } } action-scheduler/classes/migration/BatchFetcher.php 0000777 00000003350 15252010675 0016471 0 ustar 00 <?php namespace Action_Scheduler\Migration; use ActionScheduler_Store as Store; /** * Class BatchFetcher * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class BatchFetcher { /** * Store instance. * * @var ActionScheduler_Store */ private $store; /** * BatchFetcher constructor. * * @param ActionScheduler_Store $source_store Source store object. */ public function __construct( Store $source_store ) { $this->store = $source_store; } /** * Retrieve a list of actions. * * @param int $count The number of actions to retrieve. * * @return int[] A list of action IDs */ public function fetch( $count = 10 ) { foreach ( $this->get_query_strategies( $count ) as $query ) { $action_ids = $this->store->query_actions( $query ); if ( ! empty( $action_ids ) ) { return $action_ids; } } return array(); } /** * Generate a list of prioritized of action search parameters. * * @param int $count Number of actions to find. * * @return array */ private function get_query_strategies( $count ) { $now = as_get_datetime_object(); $args = array( 'date' => $now, 'per_page' => $count, 'offset' => 0, 'orderby' => 'date', 'order' => 'ASC', ); $priorities = array( Store::STATUS_PENDING, Store::STATUS_FAILED, Store::STATUS_CANCELED, Store::STATUS_COMPLETE, Store::STATUS_RUNNING, '', // any other unanticipated status. ); foreach ( $priorities as $status ) { yield wp_parse_args( array( 'status' => $status, 'date_compare' => '<=', ), $args ); yield wp_parse_args( array( 'status' => $status, 'date_compare' => '>=', ), $args ); } } } action-scheduler/classes/migration/DryRun_LogMigrator.php 0000777 00000000713 15252010675 0017700 0 ustar 00 <?php namespace Action_Scheduler\Migration; /** * Class DryRun_LogMigrator * * @package Action_Scheduler\Migration * * @codeCoverageIgnore */ class DryRun_LogMigrator extends LogMigrator { /** * Simulate migrating an action log. * * @param int $source_action_id Source logger object. * @param int $destination_action_id Destination logger object. */ public function migrate( $source_action_id, $destination_action_id ) { // no-op. } } action-scheduler/classes/migration/DryRun_ActionMigrator.php 0000777 00000001052 15252010675 0020371 0 ustar 00 <?php namespace Action_Scheduler\Migration; /** * Class DryRun_ActionMigrator * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class DryRun_ActionMigrator extends ActionMigrator { /** * Simulate migrating an action. * * @param int $source_action_id Action ID. * * @return int */ public function migrate( $source_action_id ) { do_action( 'action_scheduler/migrate_action_dry_run', $source_action_id ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores return 0; } } action-scheduler/classes/migration/Scheduler.php 0000777 00000006050 15252010675 0016065 0 ustar 00 <?php namespace Action_Scheduler\Migration; /** * Class Scheduler * * @package Action_Scheduler\WP_CLI * * @since 3.0.0 * * @codeCoverageIgnore */ class Scheduler { /** Migration action hook. */ const HOOK = 'action_scheduler/migration_hook'; /** Migration action group. */ const GROUP = 'action-scheduler-migration'; /** * Set up the callback for the scheduled job. */ public function hook() { add_action( self::HOOK, array( $this, 'run_migration' ), 10, 0 ); } /** * Remove the callback for the scheduled job. */ public function unhook() { remove_action( self::HOOK, array( $this, 'run_migration' ), 10 ); } /** * The migration callback. */ public function run_migration() { $migration_runner = $this->get_migration_runner(); $count = $migration_runner->run( $this->get_batch_size() ); if ( 0 === $count ) { $this->mark_complete(); } else { $this->schedule_migration( time() + $this->get_schedule_interval() ); } } /** * Mark the migration complete. */ public function mark_complete() { $this->unschedule_migration(); \ActionScheduler_DataController::mark_migration_complete(); do_action( 'action_scheduler/migration_complete' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores } /** * Get a flag indicating whether the migration is scheduled. * * @return bool Whether there is a pending action in the store to handle the migration */ public function is_migration_scheduled() { $next = as_next_scheduled_action( self::HOOK ); return ! empty( $next ); } /** * Schedule the migration. * * @param int $when Optional timestamp to run the next migration batch. Defaults to now. * * @return string The action ID */ public function schedule_migration( $when = 0 ) { $next = as_next_scheduled_action( self::HOOK ); if ( ! empty( $next ) ) { return $next; } if ( empty( $when ) ) { $when = time() + MINUTE_IN_SECONDS; } return as_schedule_single_action( $when, self::HOOK, array(), self::GROUP ); } /** * Remove the scheduled migration action. */ public function unschedule_migration() { as_unschedule_action( self::HOOK, null, self::GROUP ); } /** * Get migration batch schedule interval. * * @return int Seconds between migration runs. Defaults to 0 seconds to allow chaining migration via Async Runners. */ private function get_schedule_interval() { return (int) apply_filters( 'action_scheduler/migration_interval', 0 ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores } /** * Get migration batch size. * * @return int Number of actions to migrate in each batch. Defaults to 250. */ private function get_batch_size() { return (int) apply_filters( 'action_scheduler/migration_batch_size', 250 ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores } /** * Get migration runner object. * * @return Runner */ private function get_migration_runner() { $config = Controller::instance()->get_migration_config_object(); return new Runner( $config ); } } action-scheduler/classes/migration/ActionMigrator.php 0000777 00000010246 15252010675 0017073 0 ustar 00 <?php namespace Action_Scheduler\Migration; /** * Class ActionMigrator * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class ActionMigrator { /** * Source store instance. * * @var ActionScheduler_Store */ private $source; /** * Destination store instance. * * @var ActionScheduler_Store */ private $destination; /** * LogMigrator instance. * * @var LogMigrator */ private $log_migrator; /** * ActionMigrator constructor. * * @param \ActionScheduler_Store $source_store Source store object. * @param \ActionScheduler_Store $destination_store Destination store object. * @param LogMigrator $log_migrator Log migrator object. */ public function __construct( \ActionScheduler_Store $source_store, \ActionScheduler_Store $destination_store, LogMigrator $log_migrator ) { $this->source = $source_store; $this->destination = $destination_store; $this->log_migrator = $log_migrator; } /** * Migrate an action. * * @param int $source_action_id Action ID. * * @return int 0|new action ID * @throws \RuntimeException When unable to delete action from the source store. */ public function migrate( $source_action_id ) { try { $action = $this->source->fetch_action( $source_action_id ); $status = $this->source->get_status( $source_action_id ); } catch ( \Exception $e ) { $action = null; $status = ''; } if ( is_null( $action ) || empty( $status ) || ! $action->get_schedule()->get_date() ) { // null action or empty status means the fetch operation failed or the action didn't exist. // null schedule means it's missing vital data. // delete it and move on. try { $this->source->delete_action( $source_action_id ); } catch ( \Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch // nothing to do, it didn't exist in the first place. } do_action( 'action_scheduler/no_action_to_migrate', $source_action_id, $this->source, $this->destination ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores return 0; } try { // Make sure the last attempt date is set correctly for completed and failed actions. $last_attempt_date = ( \ActionScheduler_Store::STATUS_PENDING !== $status ) ? $this->source->get_date( $source_action_id ) : null; $destination_action_id = $this->destination->save_action( $action, null, $last_attempt_date ); } catch ( \Exception $e ) { do_action( 'action_scheduler/migrate_action_failed', $source_action_id, $this->source, $this->destination ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores return 0; // could not save the action in the new store. } try { switch ( $status ) { case \ActionScheduler_Store::STATUS_FAILED: $this->destination->mark_failure( $destination_action_id ); break; case \ActionScheduler_Store::STATUS_CANCELED: $this->destination->cancel_action( $destination_action_id ); break; } $this->log_migrator->migrate( $source_action_id, $destination_action_id ); $this->source->delete_action( $source_action_id ); $test_action = $this->source->fetch_action( $source_action_id ); if ( ! is_a( $test_action, 'ActionScheduler_NullAction' ) ) { // translators: %s is an action ID. throw new \RuntimeException( sprintf( __( 'Unable to remove source migrated action %s', 'woocommerce' ), $source_action_id ) ); } do_action( 'action_scheduler/migrated_action', $source_action_id, $destination_action_id, $this->source, $this->destination ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores return $destination_action_id; } catch ( \Exception $e ) { // could not delete from the old store. $this->source->mark_migrated( $source_action_id ); // phpcs:disable WordPress.NamingConventions.ValidHookName.UseUnderscores do_action( 'action_scheduler/migrate_action_incomplete', $source_action_id, $destination_action_id, $this->source, $this->destination ); do_action( 'action_scheduler/migrated_action', $source_action_id, $destination_action_id, $this->source, $this->destination ); // phpcs:enable return $destination_action_id; } } } action-scheduler/classes/migration/Controller.php 0000777 00000014567 15252010675 0016306 0 ustar 00 <?php namespace Action_Scheduler\Migration; use ActionScheduler_DataController; use ActionScheduler_LoggerSchema; use ActionScheduler_StoreSchema; use Action_Scheduler\WP_CLI\ProgressBar; /** * Class Controller * * The main plugin/initialization class for migration to custom tables. * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class Controller { /** * Instance. * * @var self */ private static $instance; /** * Scheduler instance. * * @var Action_Scheduler\Migration\Scheduler */ private $migration_scheduler; /** * Class name of the store object. * * @var string */ private $store_classname; /** * Class name of the logger object. * * @var string */ private $logger_classname; /** * Flag to indicate migrating custom store. * * @var bool */ private $migrate_custom_store; /** * Controller constructor. * * @param Scheduler $migration_scheduler Migration scheduler object. */ protected function __construct( Scheduler $migration_scheduler ) { $this->migration_scheduler = $migration_scheduler; $this->store_classname = ''; } /** * Set the action store class name. * * @param string $class Classname of the store class. * * @return string */ public function get_store_class( $class ) { if ( \ActionScheduler_DataController::is_migration_complete() ) { return \ActionScheduler_DataController::DATASTORE_CLASS; } elseif ( \ActionScheduler_Store::DEFAULT_CLASS !== $class ) { $this->store_classname = $class; return $class; } else { return 'ActionScheduler_HybridStore'; } } /** * Set the action logger class name. * * @param string $class Classname of the logger class. * * @return string */ public function get_logger_class( $class ) { \ActionScheduler_Store::instance(); if ( $this->has_custom_datastore() ) { $this->logger_classname = $class; return $class; } else { return \ActionScheduler_DataController::LOGGER_CLASS; } } /** * Get flag indicating whether a custom datastore is in use. * * @return bool */ public function has_custom_datastore() { return (bool) $this->store_classname; } /** * Set up the background migration process. * * @return void */ public function schedule_migration() { $logging_tables = new ActionScheduler_LoggerSchema(); $store_tables = new ActionScheduler_StoreSchema(); /* * In some unusual cases, the expected tables may not have been created. In such cases * we do not schedule a migration as doing so will lead to fatal error conditions. * * In such cases the user will likely visit the Tools > Scheduled Actions screen to * investigate, and will see appropriate messaging (this step also triggers an attempt * to rebuild any missing tables). * * @see https://github.com/woocommerce/action-scheduler/issues/653 */ if ( ActionScheduler_DataController::is_migration_complete() || $this->migration_scheduler->is_migration_scheduled() || ! $store_tables->tables_exist() || ! $logging_tables->tables_exist() ) { return; } $this->migration_scheduler->schedule_migration(); } /** * Get the default migration config object * * @return ActionScheduler\Migration\Config */ public function get_migration_config_object() { static $config = null; if ( ! $config ) { $source_store = $this->store_classname ? new $this->store_classname() : new \ActionScheduler_wpPostStore(); $source_logger = $this->logger_classname ? new $this->logger_classname() : new \ActionScheduler_wpCommentLogger(); $config = new Config(); $config->set_source_store( $source_store ); $config->set_source_logger( $source_logger ); $config->set_destination_store( new \ActionScheduler_DBStoreMigrator() ); $config->set_destination_logger( new \ActionScheduler_DBLogger() ); if ( defined( 'WP_CLI' ) && WP_CLI ) { $config->set_progress_bar( new ProgressBar( '', 0 ) ); } } return apply_filters( 'action_scheduler/migration_config', $config ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores } /** * Hook dashboard migration notice. */ public function hook_admin_notices() { if ( ! $this->allow_migration() || \ActionScheduler_DataController::is_migration_complete() ) { return; } add_action( 'admin_notices', array( $this, 'display_migration_notice' ), 10, 0 ); } /** * Show a dashboard notice that migration is in progress. */ public function display_migration_notice() { printf( '<div class="notice notice-warning"><p>%s</p></div>', esc_html__( 'Action Scheduler migration in progress. The list of scheduled actions may be incomplete.', 'woocommerce' ) ); } /** * Add store classes. Hook migration. */ private function hook() { add_filter( 'action_scheduler_store_class', array( $this, 'get_store_class' ), 100, 1 ); add_filter( 'action_scheduler_logger_class', array( $this, 'get_logger_class' ), 100, 1 ); add_action( 'init', array( $this, 'maybe_hook_migration' ) ); add_action( 'wp_loaded', array( $this, 'schedule_migration' ) ); // Action Scheduler may be displayed as a Tools screen or WooCommerce > Status administration screen. add_action( 'load-tools_page_action-scheduler', array( $this, 'hook_admin_notices' ), 10, 0 ); add_action( 'load-woocommerce_page_wc-status', array( $this, 'hook_admin_notices' ), 10, 0 ); } /** * Possibly hook the migration scheduler action. */ public function maybe_hook_migration() { if ( ! $this->allow_migration() || \ActionScheduler_DataController::is_migration_complete() ) { return; } $this->migration_scheduler->hook(); } /** * Allow datastores to enable migration to AS tables. */ public function allow_migration() { if ( ! \ActionScheduler_DataController::dependencies_met() ) { return false; } if ( null === $this->migrate_custom_store ) { $this->migrate_custom_store = apply_filters( 'action_scheduler_migrate_data_store', false ); } return ( ! $this->has_custom_datastore() ) || $this->migrate_custom_store; } /** * Proceed with the migration if the dependencies have been met. */ public static function init() { if ( \ActionScheduler_DataController::dependencies_met() ) { self::instance()->hook(); } } /** * Singleton factory. */ public static function instance() { if ( ! isset( self::$instance ) ) { self::$instance = new static( new Scheduler() ); } return self::$instance; } } action-scheduler/classes/migration/LogMigrator.php 0000777 00000002441 15252010675 0016375 0 ustar 00 <?php namespace Action_Scheduler\Migration; use ActionScheduler_Logger; /** * Class LogMigrator * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class LogMigrator { /** * Source logger instance. * * @var ActionScheduler_Logger */ private $source; /** * Destination logger instance. * * @var ActionScheduler_Logger */ private $destination; /** * ActionMigrator constructor. * * @param ActionScheduler_Logger $source_logger Source logger object. * @param ActionScheduler_Logger $destination_logger Destination logger object. */ public function __construct( ActionScheduler_Logger $source_logger, ActionScheduler_Logger $destination_logger ) { $this->source = $source_logger; $this->destination = $destination_logger; } /** * Migrate an action log. * * @param int $source_action_id Source logger object. * @param int $destination_action_id Destination logger object. */ public function migrate( $source_action_id, $destination_action_id ) { $logs = $this->source->get_logs( $source_action_id ); foreach ( $logs as $log ) { if ( absint( $log->get_action_id() ) === absint( $source_action_id ) ) { $this->destination->log( $destination_action_id, $log->get_message(), $log->get_date() ); } } } } action-scheduler/deprecated/ActionScheduler_Schedule_Deprecated.php 0000777 00000001500 15252010675 0021624 0 ustar 00 <?php /** * Class ActionScheduler_Abstract_Schedule */ abstract class ActionScheduler_Schedule_Deprecated implements ActionScheduler_Schedule { /** * Get the date & time this schedule was created to run, or calculate when it should be run * after a given date & time. * * @param DateTime $after DateTime to calculate against. * * @return DateTime|null */ public function next( ?DateTime $after = null ) { if ( empty( $after ) ) { $return_value = $this->get_date(); $replacement_method = 'get_date()'; } else { $return_value = $this->get_next( $after ); $replacement_method = 'get_next( $after )'; } _deprecated_function( __METHOD__, '3.0.0', __CLASS__ . '::' . $replacement_method ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped return $return_value; } } action-scheduler/deprecated/ActionScheduler_Store_Deprecated.php 0000777 00000002043 15252010675 0021167 0 ustar 00 <?php /** * Class ActionScheduler_Store_Deprecated * * @codeCoverageIgnore */ abstract class ActionScheduler_Store_Deprecated { /** * Mark an action that failed to fetch correctly as failed. * * @since 2.2.6 * * @param int $action_id The ID of the action. */ public function mark_failed_fetch_action( $action_id ) { _deprecated_function( __METHOD__, '3.0.0', 'ActionScheduler_Store::mark_failure()' ); self::$store->mark_failure( $action_id ); } /** * Add base hooks * * @since 2.2.6 */ protected static function hook() { _deprecated_function( __METHOD__, '3.0.0' ); } /** * Remove base hooks * * @since 2.2.6 */ protected static function unhook() { _deprecated_function( __METHOD__, '3.0.0' ); } /** * Get the site's local time. * * @deprecated 2.1.0 * @return DateTimeZone */ protected function get_local_timezone() { _deprecated_function( __FUNCTION__, '2.1.0', 'ActionScheduler_TimezoneHelper::set_local_timezone()' ); return ActionScheduler_TimezoneHelper::get_local_timezone(); } } action-scheduler/deprecated/ActionScheduler_Abstract_QueueRunner_Deprecated.php 0000777 00000001524 15252010675 0024177 0 ustar 00 <?php /** * Abstract class with common Queue Cleaner functionality. */ abstract class ActionScheduler_Abstract_QueueRunner_Deprecated { /** * Get the maximum number of seconds a batch can run for. * * @deprecated 2.1.1 * @return int The number of seconds. */ protected function get_maximum_execution_time() { _deprecated_function( __METHOD__, '2.1.1', 'ActionScheduler_Abstract_QueueRunner::get_time_limit()' ); $maximum_execution_time = 30; // Apply deprecated filter. if ( has_filter( 'action_scheduler_maximum_execution_time' ) ) { _deprecated_function( 'action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit' ); $maximum_execution_time = apply_filters( 'action_scheduler_maximum_execution_time', $maximum_execution_time ); } return absint( $maximum_execution_time ); } } action-scheduler/deprecated/functions.php 0000777 00000012231 15252010675 0014627 0 ustar 00 <?php /** * Deprecated API functions for scheduling actions * * Functions with the wc prefix were deprecated to avoid confusion with * Action Scheduler being included in WooCommerce core, and it providing * a different set of APIs for working with the action queue. * * @package ActionScheduler */ /** * Schedule an action to run one time. * * @param int $timestamp When the job will run. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * * @return string The job ID */ function wc_schedule_single_action( $timestamp, $hook, $args = array(), $group = '' ) { _deprecated_function( __FUNCTION__, '2.1.0', 'as_schedule_single_action()' ); return as_schedule_single_action( $timestamp, $hook, $args, $group ); } /** * Schedule a recurring action. * * @param int $timestamp When the first instance of the job will run. * @param int $interval_in_seconds How long to wait between runs. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * * @deprecated 2.1.0 * * @return string The job ID */ function wc_schedule_recurring_action( $timestamp, $interval_in_seconds, $hook, $args = array(), $group = '' ) { _deprecated_function( __FUNCTION__, '2.1.0', 'as_schedule_recurring_action()' ); return as_schedule_recurring_action( $timestamp, $interval_in_seconds, $hook, $args, $group ); } /** * Schedule an action that recurs on a cron-like schedule. * * @param int $timestamp The schedule will start on or after this time. * @param string $schedule A cron-link schedule string. * @see http://en.wikipedia.org/wiki/Cron * * * * * * * * ┬ ┬ ┬ ┬ ┬ ┬ * | | | | | | * | | | | | + year [optional] * | | | | +----- day of week (0 - 7) (Sunday=0 or 7) * | | | +---------- month (1 - 12) * | | +--------------- day of month (1 - 31) * | +-------------------- hour (0 - 23) * +------------------------- min (0 - 59) * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * * @deprecated 2.1.0 * * @return string The job ID */ function wc_schedule_cron_action( $timestamp, $schedule, $hook, $args = array(), $group = '' ) { _deprecated_function( __FUNCTION__, '2.1.0', 'as_schedule_cron_action()' ); return as_schedule_cron_action( $timestamp, $schedule, $hook, $args, $group ); } /** * Cancel the next occurrence of a job. * * @param string $hook The hook that the job will trigger. * @param array $args Args that would have been passed to the job. * @param string $group Action's group. * * @deprecated 2.1.0 */ function wc_unschedule_action( $hook, $args = array(), $group = '' ) { _deprecated_function( __FUNCTION__, '2.1.0', 'as_unschedule_action()' ); as_unschedule_action( $hook, $args, $group ); } /** * Get next scheduled action. * * @param string $hook Action's hook. * @param array $args Action's args. * @param string $group Action's group. * * @deprecated 2.1.0 * * @return int|bool The timestamp for the next occurrence, or false if nothing was found */ function wc_next_scheduled_action( $hook, $args = null, $group = '' ) { _deprecated_function( __FUNCTION__, '2.1.0', 'as_next_scheduled_action()' ); return as_next_scheduled_action( $hook, $args, $group ); } /** * Find scheduled actions * * @param array $args Possible arguments, with their default values: * 'hook' => '' - the name of the action that will be triggered * 'args' => NULL - the args array that will be passed with the action * 'date' => NULL - the scheduled date of the action. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. * 'date_compare' => '<=' - operator for testing "date". accepted values are '!=', '>', '>=', '<', '<=', '=' * 'modified' => NULL - the date the action was last updated. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. * 'modified_compare' => '<=' - operator for testing "modified". accepted values are '!=', '>', '>=', '<', '<=', '=' * 'group' => '' - the group the action belongs to * 'status' => '' - ActionScheduler_Store::STATUS_COMPLETE or ActionScheduler_Store::STATUS_PENDING * 'claimed' => NULL - TRUE to find claimed actions, FALSE to find unclaimed actions, a string to find a specific claim ID * 'per_page' => 5 - Number of results to return * 'offset' => 0 * 'orderby' => 'date' - accepted values are 'hook', 'group', 'modified', or 'date' * 'order' => 'ASC'. * @param string $return_format OBJECT, ARRAY_A, or ids. * * @deprecated 2.1.0 * * @return array */ function wc_get_scheduled_actions( $args = array(), $return_format = OBJECT ) { _deprecated_function( __FUNCTION__, '2.1.0', 'as_get_scheduled_actions()' ); return as_get_scheduled_actions( $args, $return_format ); } action-scheduler/deprecated/ActionScheduler_AdminView_Deprecated.php 0000777 00000012532 15252010675 0021762 0 ustar 00 <?php /** * Class ActionScheduler_AdminView_Deprecated * * Store deprecated public functions previously found in the ActionScheduler_AdminView class. * Keeps them out of the way of the main class. * * @codeCoverageIgnore */ class ActionScheduler_AdminView_Deprecated { /** * Adjust parameters for custom post type. * * @param array $args Args. */ public function action_scheduler_post_type_args( $args ) { _deprecated_function( __METHOD__, '2.0.0' ); return $args; } /** * Customise the post status related views displayed on the Scheduled Actions administration screen. * * @param array $views An associative array of views and view labels which can be used to filter the 'scheduled-action' posts displayed on the Scheduled Actions administration screen. * @return array $views An associative array of views and view labels which can be used to filter the 'scheduled-action' posts displayed on the Scheduled Actions administration screen. */ public function list_table_views( $views ) { _deprecated_function( __METHOD__, '2.0.0' ); return $views; } /** * Do not include the "Edit" action for the Scheduled Actions administration screen. * * Hooked to the 'bulk_actions-edit-action-scheduler' filter. * * @param array $actions An associative array of actions which can be performed on the 'scheduled-action' post type. * @return array $actions An associative array of actions which can be performed on the 'scheduled-action' post type. */ public function bulk_actions( $actions ) { _deprecated_function( __METHOD__, '2.0.0' ); return $actions; } /** * Completely customer the columns displayed on the Scheduled Actions administration screen. * * Because we can't filter the content of the default title and date columns, we need to recreate our own * custom columns for displaying those post fields. For the column content, @see self::list_table_column_content(). * * @param array $columns An associative array of columns that are use for the table on the Scheduled Actions administration screen. * @return array $columns An associative array of columns that are use for the table on the Scheduled Actions administration screen. */ public function list_table_columns( $columns ) { _deprecated_function( __METHOD__, '2.0.0' ); return $columns; } /** * Make our custom title & date columns use defaulting title & date sorting. * * @param array $columns An associative array of columns that can be used to sort the table on the Scheduled Actions administration screen. * @return array $columns An associative array of columns that can be used to sort the table on the Scheduled Actions administration screen. */ public static function list_table_sortable_columns( $columns ) { _deprecated_function( __METHOD__, '2.0.0' ); return $columns; } /** * Print the content for our custom columns. * * @param string $column_name The key for the column for which we should output our content. * @param int $post_id The ID of the 'scheduled-action' post for which this row relates. */ public static function list_table_column_content( $column_name, $post_id ) { _deprecated_function( __METHOD__, '2.0.0' ); } /** * Hide the inline "Edit" action for all 'scheduled-action' posts. * * Hooked to the 'post_row_actions' filter. * * @param array $actions An associative array of actions which can be performed on the 'scheduled-action' post type. * @param WP_Post $post The 'scheduled-action' post object. * @return array $actions An associative array of actions which can be performed on the 'scheduled-action' post type. */ public static function row_actions( $actions, $post ) { _deprecated_function( __METHOD__, '2.0.0' ); return $actions; } /** * Run an action when triggered from the Action Scheduler administration screen. * * @codeCoverageIgnore */ public static function maybe_execute_action() { _deprecated_function( __METHOD__, '2.0.0' ); } /** * Convert an interval of seconds into a two part human friendly string. * * The WordPress human_time_diff() function only calculates the time difference to one degree, meaning * even if an action is 1 day and 11 hours away, it will display "1 day". This function goes one step * further to display two degrees of accuracy. * * Based on Crontrol::interval() function by Edward Dale: https://wordpress.org/plugins/wp-crontrol/ * * @return void */ public static function admin_notices() { _deprecated_function( __METHOD__, '2.0.0' ); } /** * Filter search queries to allow searching by Claim ID (i.e. post_password). * * @param string $orderby MySQL orderby string. * @param WP_Query $query Instance of a WP_Query object. * @return void */ public function custom_orderby( $orderby, $query ) { _deprecated_function( __METHOD__, '2.0.0' ); } /** * Filter search queries to allow searching by Claim ID (i.e. post_password). * * @param string $search MySQL search string. * @param WP_Query $query Instance of a WP_Query object. * @return void */ public function search_post_password( $search, $query ) { _deprecated_function( __METHOD__, '2.0.0' ); } /** * Change messages when a scheduled action is updated. * * @param array $messages Messages. * @return array */ public function post_updated_messages( $messages ) { _deprecated_function( __METHOD__, '2.0.0' ); return $messages; } } action-scheduler/action-scheduler.php 0000777 00000005717 15252010675 0013763 0 ustar 00 <?php /** * Plugin Name: Action Scheduler * Plugin URI: https://actionscheduler.org * Description: A robust scheduling library for use in WordPress plugins. * Author: Automattic * Author URI: https://automattic.com/ * Version: 3.9.3 * License: GPLv3 * Requires at least: 6.5 * Tested up to: 6.8 * Requires PHP: 7.2 * * Copyright 2019 Automattic, Inc. (https://automattic.com/contact/) * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * 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 <https://www.gnu.org/licenses/>. * * @package ActionScheduler */ if ( ! function_exists( 'action_scheduler_register_3_dot_9_dot_3' ) && function_exists( 'add_action' ) ) { // WRCS: DEFINED_VERSION. if ( ! class_exists( 'ActionScheduler_Versions', false ) ) { require_once __DIR__ . '/classes/ActionScheduler_Versions.php'; add_action( 'plugins_loaded', array( 'ActionScheduler_Versions', 'initialize_latest_version' ), 1, 0 ); } add_action( 'plugins_loaded', 'action_scheduler_register_3_dot_9_dot_3', 0, 0 ); // WRCS: DEFINED_VERSION. // phpcs:disable Generic.Functions.OpeningFunctionBraceKernighanRitchie.ContentAfterBrace /** * Registers this version of Action Scheduler. */ function action_scheduler_register_3_dot_9_dot_3() { // WRCS: DEFINED_VERSION. $versions = ActionScheduler_Versions::instance(); $versions->register( '3.9.3', 'action_scheduler_initialize_3_dot_9_dot_3' ); // WRCS: DEFINED_VERSION. } // phpcs:disable Generic.Functions.OpeningFunctionBraceKernighanRitchie.ContentAfterBrace /** * Initializes this version of Action Scheduler. */ function action_scheduler_initialize_3_dot_9_dot_3() { // WRCS: DEFINED_VERSION. // A final safety check is required even here, because historic versions of Action Scheduler // followed a different pattern (in some unusual cases, we could reach this point and the // ActionScheduler class is already defined—so we need to guard against that). if ( ! class_exists( 'ActionScheduler', false ) ) { require_once __DIR__ . '/classes/abstracts/ActionScheduler.php'; ActionScheduler::init( __FILE__ ); } } // Support usage in themes - load this version if no plugin has loaded a version yet. if ( did_action( 'plugins_loaded' ) && ! doing_action( 'plugins_loaded' ) && ! class_exists( 'ActionScheduler', false ) ) { action_scheduler_initialize_3_dot_9_dot_3(); // WRCS: DEFINED_VERSION. do_action( 'action_scheduler_pre_theme_init' ); ActionScheduler_Versions::initialize_latest_version(); } } action-scheduler/readme.txt 0000777 00000030032 15252010675 0012003 0 ustar 00 === Action Scheduler === Contributors: Automattic, wpmuguru, claudiosanches, peterfabian1000, vedjain, jamosova, obliviousharmony, konamiman, sadowski, royho, barryhughes-1 Tags: scheduler, cron Stable tag: 3.9.3 License: GPLv3 Requires at least: 6.5 Tested up to: 6.8 Requires PHP: 7.2 Action Scheduler - Job Queue for WordPress == Description == Action Scheduler is a scalable, traceable job queue for background processing large sets of actions in WordPress. It's specially designed to be distributed in WordPress plugins. Action Scheduler works by triggering an action hook to run at some time in the future. Each hook can be scheduled with unique data, to allow callbacks to perform operations on that data. The hook can also be scheduled to run on one or more occasions. Think of it like an extension to `do_action()` which adds the ability to delay and repeat a hook. ## Battle-Tested Background Processing Every month, Action Scheduler processes millions of payments for [Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/), webhooks for [WooCommerce](https://wordpress.org/plugins/woocommerce/), as well as emails and other events for a range of other plugins. It's been seen on live sites processing queues in excess of 50,000 jobs and doing resource intensive operations, like processing payments and creating orders, at a sustained rate of over 10,000 / hour without negatively impacting normal site operations. This is all on infrastructure and WordPress sites outside the control of the plugin author. If your plugin needs background processing, especially of large sets of tasks, Action Scheduler can help. ## Learn More To learn more about how Action Scheduler works, and how to use it in your plugin, check out the docs on [ActionScheduler.org](https://actionscheduler.org). There you will find: * [Usage guide](https://actionscheduler.org/usage/): instructions on installing and using Action Scheduler * [WP CLI guide](https://actionscheduler.org/wp-cli/): instructions on running Action Scheduler at scale via WP CLI * [API Reference](https://actionscheduler.org/api/): complete reference guide for all API functions * [Administration Guide](https://actionscheduler.org/admin/): guide to managing scheduled actions via the administration screen * [Guide to Background Processing at Scale](https://actionscheduler.org/perf/): instructions for running Action Scheduler at scale via the default WP Cron queue runner ## Credits Action Scheduler is developed and maintained by [Automattic](http://automattic.com/) with significant early development completed by [Flightless](https://flightless.us/). Collaboration is cool. We'd love to work with you to improve Action Scheduler. [Pull Requests](https://github.com/woocommerce/action-scheduler/pulls) welcome. == Changelog == = 3.9.3 - 2025-07-15 = * Add hook 'action_scheduler_ensure_recurring_actions' specifically for scheduling recurring actions. * Assume an action is valid until proven otherwise. * Implement SKIP LOCKED during action claiming. * Import `get_flag_value()` from `WP_CLI\Utils` before using. * Make `$unique` available to all pre-creation/short-circuit hooks. * Make version/source information available via new class. * Only release claims on pending actions. * Tweak - WP 6.8 compatibility. * Update minimum supported php and phpunit versions. * Update readme.txt. * WP CLI get action command: correct parentheses/nesting of conditional checks. = 3.9.2 - 2025-02-03 = * Fixed fatal errors by moving version info methods to a new class and deprecating conflicting ones in ActionScheduler_Versions = 3.9.1 - 2025-01-21 = * A number of new WP CLI commands have been added, making it easier to manage actions in the terminal and from scripts. * New wp action-scheduler source command to help determine how Action Scheduler is being loaded. * Additional information about the active instance of Action Scheduler is now available in the Help pull-down drawer. * Make some other nullable parameters explicitly nullable. * Set option value to `no` rather than deleting. = 3.9.0 - 2024-11-14 = * Minimum required version of PHP is now 7.1. * Performance improvements for the `as_pending_actions_due()` function. * Existing filter hook `action_scheduler_claim_actions_order_by` enhanced to provide callbacks with additional information. * Improved compatibility with PHP 8.4, specifically by making implicitly nullable parameters explicitly nullable. * A large number of coding standards-enhancements, to help reduce friction when submitting plugins to marketplaces and plugin directories. Special props @crstauf for this effort. * Minor documentation tweaks and improvements. = 3.8.2 - 2024-09-12 = * Add missing parameter to the `pre_as_enqueue_async_action` hook. * Bump minimum PHP version to 7.0. * Bump minimum WordPress version to 6.4. * Make the batch size adjustable during processing. = 3.8.1 - 2024-06-20 = * Fix typos. * Improve the messaging in our unidentified action exceptions. = 3.8.0 - 2024-05-22 = * Documentation - Fixed typos in perf.md. * Update - We now require WordPress 6.3 or higher. * Update - We now require PHP 7.0 or higher. = 3.7.4 - 2024-04-05 = * Give a clear description of how the $unique parameter works. * Preserve the tab field if set. * Tweak - WP 6.5 compatibility. = 3.7.3 - 2024-03-20 = * Do not iterate over all of GET when building form in list table. * Fix a few issues reported by PCP (Plugin Check Plugin). * Try to save actions as unique even when the store doesn't support it. * Tweak - WP 6.4 compatibility. * Update "Tested up to" tag to WordPress 6.5. * update version in package-lock.json. = 3.7.2 - 2024-02-14 = * No longer user variables in `_n()` translation function. = 3.7.1 - 2023-12-13 = * update semver to 5.7.2 because of a security vulnerability in 5.7.1. = 3.7.0 - 2023-11-20 = * Important: starting with this release, Action Scheduler follows an L-2 version policy (WordPress, and consequently PHP). * Add extended indexes for hook_status_scheduled_date_gmt and status_scheduled_date_gmt. * Catch and log exceptions thrown when actions can't be created, e.g. under a corrupt database schema. * Tweak - WP 6.4 compatibility. * Update unit tests for upcoming dependency version policy. * make sure hook action_scheduler_failed_execution can access original exception object. * mention dependency version policy in usage.md. = 3.6.4 - 2023-10-11 = * Performance improvements when bulk cancelling actions. * Dev-related fixes. = 3.6.3 - 2023-09-13 = * Use `_doing_it_wrong` in initialization check. = 3.6.2 - 2023-08-09 = * Add guidance about passing arguments. * Atomic option locking. * Improve bulk delete handling. * Include database error in the exception message. * Tweak - WP 6.3 compatibility. = 3.6.1 - 2023-06-14 = * Document new optional `$priority` arg for various API functions. * Document the new `--exclude-groups` WP CLI option. * Document the new `action_scheduler_init` hook. * Ensure actions within each claim are executed in the expected order. * Fix incorrect text domain. * Remove SHOW TABLES usage when checking if tables exist. = 3.6.0 - 2023-05-10 = * Add $unique parameter to function signatures. * Add a cast-to-int for extra safety before forming new DateTime object. * Add a hook allowing exceptions for consistently failing recurring actions. * Add action priorities. * Add init hook. * Always raise the time limit. * Bump minimatch from 3.0.4 to 3.0.8. * Bump yaml from 2.2.1 to 2.2.2. * Defensive coding relating to gaps in declared schedule types. * Do not process an action if it cannot be set to `in-progress`. * Filter view labels (status names) should be translatable | #919. * Fix WPCLI progress messages. * Improve data-store initialization flow. * Improve error handling across all supported PHP versions. * Improve logic for flushing the runtime cache. * Support exclusion of multiple groups. * Update lint-staged and Node/NPM requirements. * add CLI clean command. * add CLI exclude-group filter. * exclude past-due from list table all filter count. * throwing an exception if as_schedule_recurring_action interval param is not of type integer. = 3.5.4 - 2023-01-17 = * Add pre filters during action registration. * Async scheduling. * Calculate timeouts based on total actions. * Correctly order the parameters for `ActionScheduler_ActionFactory`'s calls to `single_unique`. * Fetch action in memory first before releasing claim to avoid deadlock. * PHP 8.2: declare property to fix creation of dynamic property warning. * PHP 8.2: fix "Using ${var} in strings is deprecated, use {$var} instead". * Prevent `undefined variable` warning for `$num_pastdue_actions`. = 3.5.3 - 2022-11-09 = * Query actions with partial match. = 3.5.2 - 2022-09-16 = * Fix - erroneous 3.5.1 release. = 3.5.1 - 2022-09-13 = * Maintenance on A/S docs. * fix: PHP 8.2 deprecated notice. = 3.5.0 - 2022-08-25 = * Add - The active view link within the "Tools > Scheduled Actions" screen is now clickable. * Add - A warning when there are past-due actions. * Enhancement - Added the ability to schedule unique actions via an atomic operation. * Enhancement - Improvements to cache invalidation when processing batches (when running on WordPress 6.0+). * Enhancement - If a recurring action is found to be consistently failing, it will stop being rescheduled. * Enhancement - Adds a new "Past Due" view to the scheduled actions list table. = 3.4.2 - 2022-06-08 = * Fix - Change the include for better linting. * Fix - update: Added Action scheduler completed action hook. = 3.4.1 - 2022-05-24 = * Fix - Change the include for better linting. * Fix - Fix the documented return type. = 3.4.0 - 2021-10-29 = * Enhancement - Number of items per page can now be set for the Scheduled Actions view (props @ovidiul). #771 * Fix - Do not lower the max_execution_time if it is already set to 0 (unlimited) (props @barryhughes). #755 * Fix - Avoid triggering autoloaders during the version resolution process (props @olegabr). #731 & #776 * Dev - ActionScheduler_wcSystemStatus PHPCS fixes (props @ovidiul). #761 * Dev - ActionScheduler_DBLogger.php PHPCS fixes (props @ovidiul). #768 * Dev - Fixed phpcs for ActionScheduler_Schedule_Deprecated (props @ovidiul). #762 * Dev - Improve actions table indices (props @glagonikas). #774 & #777 * Dev - PHPCS fixes for ActionScheduler_DBStore.php (props @ovidiul). #769 & #778 * Dev - PHPCS Fixes for ActionScheduler_Abstract_ListTable (props @ovidiul). #763 & #779 * Dev - Adds new filter action_scheduler_claim_actions_order_by to allow tuning of the claim query (props @glagonikas). #773 * Dev - PHPCS fixes for ActionScheduler_WpPostStore class (props @ovidiul). #780 = 3.3.0 - 2021-09-15 = * Enhancement - Adds as_has_scheduled_action() to provide a performant way to test for existing actions. #645 * Fix - Improves compatibility with environments where NO_ZERO_DATE is enabled. #519 * Fix - Adds safety checks to guard against errors when our database tables cannot be created. #645 * Dev - Now supports queries that use multiple statuses. #649 * Dev - Minimum requirements for WordPress and PHP bumped (to 5.2 and 5.6 respectively). #723 = 3.2.1 - 2021-06-21 = * Fix - Add extra safety/account for different versions of AS and different loading patterns. #714 * Fix - Handle hidden columns (Tools → Scheduled Actions) | #600. = 3.2.0 - 2021-06-03 = * Fix - Add "no ordering" option to as_next_scheduled_action(). * Fix - Add secondary scheduled date checks when claiming actions (DBStore) | #634. * Fix - Add secondary scheduled date checks when claiming actions (wpPostStore) | #634. * Fix - Adds a new index to the action table, reducing the potential for deadlocks (props: @glagonikas). * Fix - Fix unit tests infrastructure and adapt tests to PHP 8. * Fix - Identify in-use data store. * Fix - Improve test_migration_is_scheduled. * Fix - PHP notice on list table. * Fix - Speed up clean up and batch selects. * Fix - Update pending dependencies. * Fix - [PHP 8.0] Only pass action arg values through to do_action_ref_array(). * Fix - [PHP 8] Set the PHP version to 7.1 in composer.json for PHP 8 compatibility. * Fix - add is_initialized() to docs. * Fix - fix file permissions. * Fix - fixes #664 by replacing __ with esc_html__. action-scheduler/lib/WP_Async_Request.php 0000777 00000007206 15252010675 0014466 0 ustar 00 <?php /** * WP Async Request * * @package WP-Background-Processing */ /* Library URI: https://github.com/deliciousbrains/wp-background-processing/blob/fbbc56f2480910d7959972ec9ec0819a13c6150a/classes/wp-async-request.php Author: Delicious Brains Inc. Author URI: https://deliciousbrains.com/ License: GNU General Public License v2.0 License URI: https://github.com/deliciousbrains/wp-background-processing/commit/126d7945dd3d39f39cb6488ca08fe1fb66cb351a */ if ( ! class_exists( 'WP_Async_Request' ) ) { /** * Abstract WP_Async_Request class. * * @abstract */ abstract class WP_Async_Request { /** * Prefix * * (default value: 'wp') * * @var string */ protected $prefix = 'wp'; /** * Action * * (default value: 'async_request') * * @var string */ protected $action = 'async_request'; /** * Identifier * * @var mixed */ protected $identifier; /** * Data * * (default value: array()) * * @var array */ protected $data = array(); /** * Initiate new async request */ public function __construct() { $this->identifier = $this->prefix . '_' . $this->action; add_action( 'wp_ajax_' . $this->identifier, array( $this, 'maybe_handle' ) ); add_action( 'wp_ajax_nopriv_' . $this->identifier, array( $this, 'maybe_handle' ) ); } /** * Set data used during the request * * @param array $data Data. * * @return $this */ public function data( $data ) { $this->data = $data; return $this; } /** * Dispatch the async request * * @return array|WP_Error */ public function dispatch() { $url = add_query_arg( $this->get_query_args(), $this->get_query_url() ); $args = $this->get_post_args(); return wp_remote_post( esc_url_raw( $url ), $args ); } /** * Get query args * * @return array */ protected function get_query_args() { if ( property_exists( $this, 'query_args' ) ) { return $this->query_args; } $args = array( 'action' => $this->identifier, 'nonce' => wp_create_nonce( $this->identifier ), ); /** * Filters the post arguments used during an async request. * * @param array $url */ return apply_filters( $this->identifier . '_query_args', $args ); } /** * Get query URL * * @return string */ protected function get_query_url() { if ( property_exists( $this, 'query_url' ) ) { return $this->query_url; } $url = admin_url( 'admin-ajax.php' ); /** * Filters the post arguments used during an async request. * * @param string $url */ return apply_filters( $this->identifier . '_query_url', $url ); } /** * Get post args * * @return array */ protected function get_post_args() { if ( property_exists( $this, 'post_args' ) ) { return $this->post_args; } $args = array( 'timeout' => 0.01, 'blocking' => false, 'body' => $this->data, 'cookies' => $_COOKIE, 'sslverify' => apply_filters( 'https_local_ssl_verify', false ), ); /** * Filters the post arguments used during an async request. * * @param array $args */ return apply_filters( $this->identifier . '_post_args', $args ); } /** * Maybe handle * * Check for correct nonce and pass to handler. */ public function maybe_handle() { // Don't lock up other requests while processing. session_write_close(); check_ajax_referer( $this->identifier, 'nonce' ); $this->handle(); wp_die(); } /** * Handle * * Override this method to perform any actions required * during the async request. */ abstract protected function handle(); } } action-scheduler/lib/cron-expression/CronExpression_MonthField.php 0000777 00000002567 15252010675 0021530 0 ustar 00 <?php /** * Month field. Allows: * , / - * * @author Michael Dowling <mtdowling@gmail.com> */ class CronExpression_MonthField extends CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(DateTime $date, $value) { // Convert text month values to integers $value = str_ireplace( array( 'JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN', 'JUL', 'AUG', 'SEP', 'OCT', 'NOV', 'DEC' ), range(1, 12), $value ); return $this->isSatisfied($date->format('m'), $value); } /** * {@inheritdoc} */ public function increment(DateTime $date, $invert = false) { if ($invert) { // $date->modify('last day of previous month'); // remove for php 5.2 compat $date->modify('previous month'); $date->modify($date->format('Y-m-t')); $date->setTime(23, 59); } else { //$date->modify('first day of next month'); // remove for php 5.2 compat $date->modify('next month'); $date->modify($date->format('Y-m-01')); $date->setTime(0, 0); } return $this; } /** * {@inheritdoc} */ public function validate($value) { return (bool) preg_match('/[\*,\/\-0-9A-Z]+/', $value); } } action-scheduler/lib/cron-expression/CronExpression_YearField.php 0000777 00000001651 15252010675 0021334 0 ustar 00 <?php /** * Year field. Allows: * , / - * * @author Michael Dowling <mtdowling@gmail.com> */ class CronExpression_YearField extends CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(DateTime $date, $value) { return $this->isSatisfied($date->format('Y'), $value); } /** * {@inheritdoc} */ public function increment(DateTime $date, $invert = false) { if ($invert) { $date->modify('-1 year'); $date->setDate($date->format('Y'), 12, 31); $date->setTime(23, 59, 0); } else { $date->modify('+1 year'); $date->setDate($date->format('Y'), 1, 1); $date->setTime(0, 0, 0); } return $this; } /** * {@inheritdoc} */ public function validate($value) { return (bool) preg_match('/[\*,\/\-0-9]+/', $value); } } action-scheduler/lib/cron-expression/CronExpression_HoursField.php 0000777 00000002205 15252010675 0021530 0 ustar 00 <?php /** * Hours field. Allows: * , / - * * @author Michael Dowling <mtdowling@gmail.com> */ class CronExpression_HoursField extends CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(DateTime $date, $value) { return $this->isSatisfied($date->format('H'), $value); } /** * {@inheritdoc} */ public function increment(DateTime $date, $invert = false) { // Change timezone to UTC temporarily. This will // allow us to go back or forwards and hour even // if DST will be changed between the hours. $timezone = $date->getTimezone(); $date->setTimezone(new DateTimeZone('UTC')); if ($invert) { $date->modify('-1 hour'); $date->setTime($date->format('H'), 59); } else { $date->modify('+1 hour'); $date->setTime($date->format('H'), 0); } $date->setTimezone($timezone); return $this; } /** * {@inheritdoc} */ public function validate($value) { return (bool) preg_match('/[\*,\/\-0-9]+/', $value); } } action-scheduler/lib/cron-expression/LICENSE 0000777 00000002112 15252010675 0014714 0 ustar 00 Copyright (c) 2011 Michael Dowling <mtdowling@gmail.com> and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. action-scheduler/lib/cron-expression/CronExpression_FieldFactory.php 0000777 00000003321 15252010675 0022037 0 ustar 00 <?php /** * CRON field factory implementing a flyweight factory * * @author Michael Dowling <mtdowling@gmail.com> * @link http://en.wikipedia.org/wiki/Cron */ class CronExpression_FieldFactory { /** * @var array Cache of instantiated fields */ private $fields = array(); /** * Get an instance of a field object for a cron expression position * * @param int $position CRON expression position value to retrieve * * @return CronExpression_FieldInterface * @throws InvalidArgumentException if a position is not valid */ public function getField($position) { if (!isset($this->fields[$position])) { switch ($position) { case 0: $this->fields[$position] = new CronExpression_MinutesField(); break; case 1: $this->fields[$position] = new CronExpression_HoursField(); break; case 2: $this->fields[$position] = new CronExpression_DayOfMonthField(); break; case 3: $this->fields[$position] = new CronExpression_MonthField(); break; case 4: $this->fields[$position] = new CronExpression_DayOfWeekField(); break; case 5: $this->fields[$position] = new CronExpression_YearField(); break; default: throw new InvalidArgumentException( $position . ' is not a valid position' ); } } return $this->fields[$position]; } } action-scheduler/lib/cron-expression/CronExpression_MinutesField.php 0000777 00000001371 15252010675 0022057 0 ustar 00 <?php /** * Minutes field. Allows: * , / - * * @author Michael Dowling <mtdowling@gmail.com> */ class CronExpression_MinutesField extends CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(DateTime $date, $value) { return $this->isSatisfied($date->format('i'), $value); } /** * {@inheritdoc} */ public function increment(DateTime $date, $invert = false) { if ($invert) { $date->modify('-1 minute'); } else { $date->modify('+1 minute'); } return $this; } /** * {@inheritdoc} */ public function validate($value) { return (bool) preg_match('/[\*,\/\-0-9]+/', $value); } } action-scheduler/lib/cron-expression/CronExpression_FieldInterface.php 0000777 00000002162 15252010675 0022332 0 ustar 00 <?php /** * CRON field interface * * @author Michael Dowling <mtdowling@gmail.com> */ interface CronExpression_FieldInterface { /** * Check if the respective value of a DateTime field satisfies a CRON exp * * @param DateTime $date DateTime object to check * @param string $value CRON expression to test against * * @return bool Returns TRUE if satisfied, FALSE otherwise */ public function isSatisfiedBy(DateTime $date, $value); /** * When a CRON expression is not satisfied, this method is used to increment * or decrement a DateTime object by the unit of the cron field * * @param DateTime $date DateTime object to change * @param bool $invert (optional) Set to TRUE to decrement * * @return CronExpression_FieldInterface */ public function increment(DateTime $date, $invert = false); /** * Validates a CRON expression for a given field * * @param string $value CRON expression value to validate * * @return bool Returns TRUE if valid, FALSE otherwise */ public function validate($value); } action-scheduler/lib/cron-expression/CronExpression_AbstractField.php 0000777 00000005020 15252010675 0022171 0 ustar 00 <?php /** * Abstract CRON expression field * * @author Michael Dowling <mtdowling@gmail.com> */ abstract class CronExpression_AbstractField implements CronExpression_FieldInterface { /** * Check to see if a field is satisfied by a value * * @param string $dateValue Date value to check * @param string $value Value to test * * @return bool */ public function isSatisfied($dateValue, $value) { if ($this->isIncrementsOfRanges($value)) { return $this->isInIncrementsOfRanges($dateValue, $value); } elseif ($this->isRange($value)) { return $this->isInRange($dateValue, $value); } return $value == '*' || $dateValue == $value; } /** * Check if a value is a range * * @param string $value Value to test * * @return bool */ public function isRange($value) { return strpos($value, '-') !== false; } /** * Check if a value is an increments of ranges * * @param string $value Value to test * * @return bool */ public function isIncrementsOfRanges($value) { return strpos($value, '/') !== false; } /** * Test if a value is within a range * * @param string $dateValue Set date value * @param string $value Value to test * * @return bool */ public function isInRange($dateValue, $value) { $parts = array_map('trim', explode('-', $value, 2)); return $dateValue >= $parts[0] && $dateValue <= $parts[1]; } /** * Test if a value is within an increments of ranges (offset[-to]/step size) * * @param string $dateValue Set date value * @param string $value Value to test * * @return bool */ public function isInIncrementsOfRanges($dateValue, $value) { $parts = array_map('trim', explode('/', $value, 2)); $stepSize = isset($parts[1]) ? $parts[1] : 0; if ($parts[0] == '*' || $parts[0] === '0') { return (int) $dateValue % $stepSize == 0; } $range = explode('-', $parts[0], 2); $offset = $range[0]; $to = isset($range[1]) ? $range[1] : $dateValue; // Ensure that the date value is within the range if ($dateValue < $offset || $dateValue > $to) { return false; } for ($i = $offset; $i <= $to; $i+= $stepSize) { if ($i == $dateValue) { return true; } } return false; } } action-scheduler/lib/cron-expression/CronExpression.php 0000777 00000026537 15252010675 0017422 0 ustar 00 <?php /** * CRON expression parser that can determine whether or not a CRON expression is * due to run, the next run date and previous run date of a CRON expression. * The determinations made by this class are accurate if checked run once per * minute (seconds are dropped from date time comparisons). * * Schedule parts must map to: * minute [0-59], hour [0-23], day of month, month [1-12|JAN-DEC], day of week * [1-7|MON-SUN], and an optional year. * * @author Michael Dowling <mtdowling@gmail.com> * @link http://en.wikipedia.org/wiki/Cron */ class CronExpression { const MINUTE = 0; const HOUR = 1; const DAY = 2; const MONTH = 3; const WEEKDAY = 4; const YEAR = 5; /** * @var array CRON expression parts */ private $cronParts; /** * @var CronExpression_FieldFactory CRON field factory */ private $fieldFactory; /** * @var array Order in which to test of cron parts */ private static $order = array(self::YEAR, self::MONTH, self::DAY, self::WEEKDAY, self::HOUR, self::MINUTE); /** * Factory method to create a new CronExpression. * * @param string $expression The CRON expression to create. There are * several special predefined values which can be used to substitute the * CRON expression: * * @yearly, @annually) - Run once a year, midnight, Jan. 1 - 0 0 1 1 * * @monthly - Run once a month, midnight, first of month - 0 0 1 * * * @weekly - Run once a week, midnight on Sun - 0 0 * * 0 * @daily - Run once a day, midnight - 0 0 * * * * @hourly - Run once an hour, first minute - 0 * * * * * *@param CronExpression_FieldFactory $fieldFactory (optional) Field factory to use * * @return CronExpression */ public static function factory($expression, ?CronExpression_FieldFactory $fieldFactory = null) { $mappings = array( '@yearly' => '0 0 1 1 *', '@annually' => '0 0 1 1 *', '@monthly' => '0 0 1 * *', '@weekly' => '0 0 * * 0', '@daily' => '0 0 * * *', '@hourly' => '0 * * * *' ); if (isset($mappings[$expression])) { $expression = $mappings[$expression]; } return new self($expression, $fieldFactory ? $fieldFactory : new CronExpression_FieldFactory()); } /** * Parse a CRON expression * * @param string $expression CRON expression (e.g. '8 * * * *') * @param CronExpression_FieldFactory $fieldFactory Factory to create cron fields */ public function __construct($expression, CronExpression_FieldFactory $fieldFactory) { $this->fieldFactory = $fieldFactory; $this->setExpression($expression); } /** * Set or change the CRON expression * * @param string $value CRON expression (e.g. 8 * * * *) * * @return CronExpression * @throws InvalidArgumentException if not a valid CRON expression */ public function setExpression($value) { $this->cronParts = preg_split('/\s/', $value, -1, PREG_SPLIT_NO_EMPTY); if (count($this->cronParts) < 5) { throw new InvalidArgumentException( $value . ' is not a valid CRON expression' ); } foreach ($this->cronParts as $position => $part) { $this->setPart($position, $part); } return $this; } /** * Set part of the CRON expression * * @param int $position The position of the CRON expression to set * @param string $value The value to set * * @return CronExpression * @throws InvalidArgumentException if the value is not valid for the part */ public function setPart($position, $value) { if (!$this->fieldFactory->getField($position)->validate($value)) { throw new InvalidArgumentException( 'Invalid CRON field value ' . $value . ' as position ' . $position ); } $this->cronParts[$position] = $value; return $this; } /** * Get a next run date relative to the current date or a specific date * * @param string|DateTime $currentTime (optional) Relative calculation date * @param int $nth (optional) Number of matches to skip before returning a * matching next run date. 0, the default, will return the current * date and time if the next run date falls on the current date and * time. Setting this value to 1 will skip the first match and go to * the second match. Setting this value to 2 will skip the first 2 * matches and so on. * @param bool $allowCurrentDate (optional) Set to TRUE to return the * current date if it matches the cron expression * * @return DateTime * @throws RuntimeException on too many iterations */ public function getNextRunDate($currentTime = 'now', $nth = 0, $allowCurrentDate = false) { return $this->getRunDate($currentTime, $nth, false, $allowCurrentDate); } /** * Get a previous run date relative to the current date or a specific date * * @param string|DateTime $currentTime (optional) Relative calculation date * @param int $nth (optional) Number of matches to skip before returning * @param bool $allowCurrentDate (optional) Set to TRUE to return the * current date if it matches the cron expression * * @return DateTime * @throws RuntimeException on too many iterations * @see CronExpression::getNextRunDate */ public function getPreviousRunDate($currentTime = 'now', $nth = 0, $allowCurrentDate = false) { return $this->getRunDate($currentTime, $nth, true, $allowCurrentDate); } /** * Get multiple run dates starting at the current date or a specific date * * @param int $total Set the total number of dates to calculate * @param string|DateTime $currentTime (optional) Relative calculation date * @param bool $invert (optional) Set to TRUE to retrieve previous dates * @param bool $allowCurrentDate (optional) Set to TRUE to return the * current date if it matches the cron expression * * @return array Returns an array of run dates */ public function getMultipleRunDates($total, $currentTime = 'now', $invert = false, $allowCurrentDate = false) { $matches = array(); for ($i = 0; $i < max(0, $total); $i++) { $matches[] = $this->getRunDate($currentTime, $i, $invert, $allowCurrentDate); } return $matches; } /** * Get all or part of the CRON expression * * @param string $part (optional) Specify the part to retrieve or NULL to * get the full cron schedule string. * * @return string|null Returns the CRON expression, a part of the * CRON expression, or NULL if the part was specified but not found */ public function getExpression($part = null) { if (null === $part) { return implode(' ', $this->cronParts); } elseif (array_key_exists($part, $this->cronParts)) { return $this->cronParts[$part]; } return null; } /** * Helper method to output the full expression. * * @return string Full CRON expression */ public function __toString() { return $this->getExpression(); } /** * Determine if the cron is due to run based on the current date or a * specific date. This method assumes that the current number of * seconds are irrelevant, and should be called once per minute. * * @param string|DateTime $currentTime (optional) Relative calculation date * * @return bool Returns TRUE if the cron is due to run or FALSE if not */ public function isDue($currentTime = 'now') { if ('now' === $currentTime) { $currentDate = date('Y-m-d H:i'); $currentTime = strtotime($currentDate); } elseif ($currentTime instanceof DateTime) { $currentDate = $currentTime->format('Y-m-d H:i'); $currentTime = strtotime($currentDate); } else { $currentTime = new DateTime($currentTime); $currentTime->setTime($currentTime->format('H'), $currentTime->format('i'), 0); $currentDate = $currentTime->format('Y-m-d H:i'); $currentTime = (int)($currentTime->getTimestamp()); } return $this->getNextRunDate($currentDate, 0, true)->getTimestamp() == $currentTime; } /** * Get the next or previous run date of the expression relative to a date * * @param string|DateTime $currentTime (optional) Relative calculation date * @param int $nth (optional) Number of matches to skip before returning * @param bool $invert (optional) Set to TRUE to go backwards in time * @param bool $allowCurrentDate (optional) Set to TRUE to return the * current date if it matches the cron expression * * @return DateTime * @throws RuntimeException on too many iterations */ protected function getRunDate($currentTime = null, $nth = 0, $invert = false, $allowCurrentDate = false) { if ($currentTime instanceof DateTime) { $currentDate = $currentTime; } else { $currentDate = new DateTime($currentTime ? $currentTime : 'now'); $currentDate->setTimezone(new DateTimeZone(date_default_timezone_get())); } $currentDate->setTime($currentDate->format('H'), $currentDate->format('i'), 0); $nextRun = clone $currentDate; $nth = (int) $nth; // Set a hard limit to bail on an impossible date for ($i = 0; $i < 1000; $i++) { foreach (self::$order as $position) { $part = $this->getExpression($position); if (null === $part) { continue; } $satisfied = false; // Get the field object used to validate this part $field = $this->fieldFactory->getField($position); // Check if this is singular or a list if (strpos($part, ',') === false) { $satisfied = $field->isSatisfiedBy($nextRun, $part); } else { foreach (array_map('trim', explode(',', $part)) as $listPart) { if ($field->isSatisfiedBy($nextRun, $listPart)) { $satisfied = true; break; } } } // If the field is not satisfied, then start over if (!$satisfied) { $field->increment($nextRun, $invert); continue 2; } } // Skip this match if needed if ((!$allowCurrentDate && $nextRun == $currentDate) || --$nth > -1) { $this->fieldFactory->getField(0)->increment($nextRun, $invert); continue; } return $nextRun; } // @codeCoverageIgnoreStart throw new RuntimeException('Impossible CRON expression'); // @codeCoverageIgnoreEnd } } action-scheduler/lib/cron-expression/CronExpression_DayOfMonthField.php 0000777 00000007014 15252010675 0022443 0 ustar 00 <?php /** * Day of month field. Allows: * , / - ? L W * * 'L' stands for "last" and specifies the last day of the month. * * The 'W' character is used to specify the weekday (Monday-Friday) nearest the * given day. As an example, if you were to specify "15W" as the value for the * day-of-month field, the meaning is: "the nearest weekday to the 15th of the * month". So if the 15th is a Saturday, the trigger will fire on Friday the * 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If * the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you * specify "1W" as the value for day-of-month, and the 1st is a Saturday, the * trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary * of a month's days. The 'W' character can only be specified when the * day-of-month is a single day, not a range or list of days. * * @author Michael Dowling <mtdowling@gmail.com> */ class CronExpression_DayOfMonthField extends CronExpression_AbstractField { /** * Get the nearest day of the week for a given day in a month * * @param int $currentYear Current year * @param int $currentMonth Current month * @param int $targetDay Target day of the month * * @return DateTime Returns the nearest date */ private static function getNearestWeekday($currentYear, $currentMonth, $targetDay) { $tday = str_pad($targetDay, 2, '0', STR_PAD_LEFT); $target = new DateTime("$currentYear-$currentMonth-$tday"); $currentWeekday = (int) $target->format('N'); if ($currentWeekday < 6) { return $target; } $lastDayOfMonth = $target->format('t'); foreach (array(-1, 1, -2, 2) as $i) { $adjusted = $targetDay + $i; if ($adjusted > 0 && $adjusted <= $lastDayOfMonth) { $target->setDate($currentYear, $currentMonth, $adjusted); if ($target->format('N') < 6 && $target->format('m') == $currentMonth) { return $target; } } } } /** * {@inheritdoc} */ public function isSatisfiedBy(DateTime $date, $value) { // ? states that the field value is to be skipped if ($value == '?') { return true; } $fieldValue = $date->format('d'); // Check to see if this is the last day of the month if ($value == 'L') { return $fieldValue == $date->format('t'); } // Check to see if this is the nearest weekday to a particular value if (strpos($value, 'W')) { // Parse the target day $targetDay = substr($value, 0, strpos($value, 'W')); // Find out if the current day is the nearest day of the week return $date->format('j') == self::getNearestWeekday( $date->format('Y'), $date->format('m'), $targetDay )->format('j'); } return $this->isSatisfied($date->format('d'), $value); } /** * {@inheritdoc} */ public function increment(DateTime $date, $invert = false) { if ($invert) { $date->modify('previous day'); $date->setTime(23, 59); } else { $date->modify('next day'); $date->setTime(0, 0); } return $this; } /** * {@inheritdoc} */ public function validate($value) { return (bool) preg_match('/[\*,\/\-\?LW0-9A-Za-z]+/', $value); } } action-scheduler/lib/cron-expression/CronExpression_DayOfWeekField.php 0000777 00000007521 15252010675 0022254 0 ustar 00 <?php /** * Day of week field. Allows: * / , - ? L # * * Days of the week can be represented as a number 0-7 (0|7 = Sunday) * or as a three letter string: SUN, MON, TUE, WED, THU, FRI, SAT. * * 'L' stands for "last". It allows you to specify constructs such as * "the last Friday" of a given month. * * '#' is allowed for the day-of-week field, and must be followed by a * number between one and five. It allows you to specify constructs such as * "the second Friday" of a given month. * * @author Michael Dowling <mtdowling@gmail.com> */ class CronExpression_DayOfWeekField extends CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(DateTime $date, $value) { if ($value == '?') { return true; } // Convert text day of the week values to integers $value = str_ireplace( array('SUN', 'MON', 'TUE', 'WED', 'THU', 'FRI', 'SAT'), range(0, 6), $value ); $currentYear = $date->format('Y'); $currentMonth = $date->format('m'); $lastDayOfMonth = $date->format('t'); // Find out if this is the last specific weekday of the month if (strpos($value, 'L')) { $weekday = str_replace('7', '0', substr($value, 0, strpos($value, 'L'))); $tdate = clone $date; $tdate->setDate($currentYear, $currentMonth, $lastDayOfMonth); while ($tdate->format('w') != $weekday) { $tdate->setDate($currentYear, $currentMonth, --$lastDayOfMonth); } return $date->format('j') == $lastDayOfMonth; } // Handle # hash tokens if (strpos($value, '#')) { list($weekday, $nth) = explode('#', $value); // Validate the hash fields if ($weekday < 1 || $weekday > 5) { throw new InvalidArgumentException("Weekday must be a value between 1 and 5. {$weekday} given"); } if ($nth > 5) { throw new InvalidArgumentException('There are never more than 5 of a given weekday in a month'); } // The current weekday must match the targeted weekday to proceed if ($date->format('N') != $weekday) { return false; } $tdate = clone $date; $tdate->setDate($currentYear, $currentMonth, 1); $dayCount = 0; $currentDay = 1; while ($currentDay < $lastDayOfMonth + 1) { if ($tdate->format('N') == $weekday) { if (++$dayCount >= $nth) { break; } } $tdate->setDate($currentYear, $currentMonth, ++$currentDay); } return $date->format('j') == $currentDay; } // Handle day of the week values if (strpos($value, '-')) { $parts = explode('-', $value); if ($parts[0] == '7') { $parts[0] = '0'; } elseif ($parts[1] == '0') { $parts[1] = '7'; } $value = implode('-', $parts); } // Test to see which Sunday to use -- 0 == 7 == Sunday $format = in_array(7, str_split($value)) ? 'N' : 'w'; $fieldValue = $date->format($format); return $this->isSatisfied($fieldValue, $value); } /** * {@inheritdoc} */ public function increment(DateTime $date, $invert = false) { if ($invert) { $date->modify('-1 day'); $date->setTime(23, 59, 0); } else { $date->modify('+1 day'); $date->setTime(0, 0, 0); } return $this; } /** * {@inheritdoc} */ public function validate($value) { return (bool) preg_match('/[\*,\/\-0-9A-Z]+/', $value); } } action-scheduler/changelog.txt 0000777 00000022512 15252010675 0012501 0 ustar 00 *** Changelog *** = 3.9.3 - 2025-07-15 = * Add hook 'action_scheduler_ensure_recurring_actions' specifically for scheduling recurring actions. * Assume an action is valid until proven otherwise. * Implement SKIP LOCKED during action claiming. * Import `get_flag_value()` from `WP_CLI\Utils` before using. * Make `$unique` available to all pre-creation/short-circuit hooks. * Make version/source information available via new class. * Only release claims on pending actions. * Tweak - WP 6.8 compatibility. * Update minimum supported php and phpunit versions. * Update readme.txt. * WP CLI get action command: correct parentheses/nesting of conditional checks. = 3.9.2 - 2025-02-03 = * Fixed fatal errors by moving version info methods to a new class and deprecating conflicting ones in ActionScheduler_Versions = 3.9.1 - 2025-01-21 = * A number of new WP CLI commands have been added, making it easier to manage actions in the terminal and from scripts. * New wp action-scheduler source command to help determine how Action Scheduler is being loaded. * Additional information about the active instance of Action Scheduler is now available in the Help pull-down drawer. * Make some other nullable parameters explicitly nullable. * Set option value to `no` rather than deleting. = 3.9.0 - 2024-11-14 = * Minimum required version of PHP is now 7.1. * Performance improvements for the `as_pending_actions_due()` function. * Existing filter hook `action_scheduler_claim_actions_order_by` enhanced to provide callbacks with additional information. * Improved compatibility with PHP 8.4, specifically by making implicitly nullable parameters explicitly nullable. * A large number of coding standards-enhancements, to help reduce friction when submitting plugins to marketplaces and plugin directories. Special props @crstauf for this effort. * Minor documentation tweaks and improvements. = 3.8.2 - 2024-09-12 = * Add missing parameter to the `pre_as_enqueue_async_action` hook. * Bump minimum PHP version to 7.0. * Bump minimum WordPress version to 6.4. * Make the batch size adjustable during processing. = 3.8.1 - 2024-06-20 = * Fix typos. * Improve the messaging in our unidentified action exceptions. = 3.8.0 - 2024-05-22 = * Documentation - Fixed typos in perf.md. * Update - We now require WordPress 6.3 or higher. * Update - We now require PHP 7.0 or higher. = 3.7.4 - 2024-04-05 = * Give a clear description of how the $unique parameter works. * Preserve the tab field if set. * Tweak - WP 6.5 compatibility. = 3.7.3 - 2024-03-20 = * Do not iterate over all of GET when building form in list table. * Fix a few issues reported by PCP (Plugin Check Plugin). * Try to save actions as unique even when the store doesn't support it. * Tweak - WP 6.4 compatibility. * Update "Tested up to" tag to WordPress 6.5. * update version in package-lock.json. = 3.7.2 - 2024-02-14 = * No longer user variables in `_n()` translation function. = 3.7.1 - 2023-12-13 = * update semver to 5.7.2 because of a security vulnerability in 5.7.1. = 3.7.0 - 2023-11-20 = * Important: starting with this release, Action Scheduler follows an L-2 version policy (WordPress, and consequently PHP). * Add extended indexes for hook_status_scheduled_date_gmt and status_scheduled_date_gmt. * Catch and log exceptions thrown when actions can't be created, e.g. under a corrupt database schema. * Tweak - WP 6.4 compatibility. * Update unit tests for upcoming dependency version policy. * make sure hook action_scheduler_failed_execution can access original exception object. * mention dependency version policy in usage.md. = 3.6.4 - 2023-10-11 = * Performance improvements when bulk cancelling actions. * Dev-related fixes. = 3.6.3 - 2023-09-13 = * Use `_doing_it_wrong` in initialization check. = 3.6.2 - 2023-08-09 = * Add guidance about passing arguments. * Atomic option locking. * Improve bulk delete handling. * Include database error in the exception message. * Tweak - WP 6.3 compatibility. = 3.6.1 - 2023-06-14 = * Document new optional `$priority` arg for various API functions. * Document the new `--exclude-groups` WP CLI option. * Document the new `action_scheduler_init` hook. * Ensure actions within each claim are executed in the expected order. * Fix incorrect text domain. * Remove SHOW TABLES usage when checking if tables exist. = 3.6.0 - 2023-05-10 = * Add $unique parameter to function signatures. * Add a cast-to-int for extra safety before forming new DateTime object. * Add a hook allowing exceptions for consistently failing recurring actions. * Add action priorities. * Add init hook. * Always raise the time limit. * Bump minimatch from 3.0.4 to 3.0.8. * Bump yaml from 2.2.1 to 2.2.2. * Defensive coding relating to gaps in declared schedule types. * Do not process an action if it cannot be set to `in-progress`. * Filter view labels (status names) should be translatable | #919. * Fix WPCLI progress messages. * Improve data-store initialization flow. * Improve error handling across all supported PHP versions. * Improve logic for flushing the runtime cache. * Support exclusion of multiple groups. * Update lint-staged and Node/NPM requirements. * add CLI clean command. * add CLI exclude-group filter. * exclude past-due from list table all filter count. * throwing an exception if as_schedule_recurring_action interval param is not of type integer. = 3.5.4 - 2023-01-17 = * Add pre filters during action registration. * Async scheduling. * Calculate timeouts based on total actions. * Correctly order the parameters for `ActionScheduler_ActionFactory`'s calls to `single_unique`. * Fetch action in memory first before releasing claim to avoid deadlock. * PHP 8.2: declare property to fix creation of dynamic property warning. * PHP 8.2: fix "Using ${var} in strings is deprecated, use {$var} instead". * Prevent `undefined variable` warning for `$num_pastdue_actions`. = 3.5.3 - 2022-11-09 = * Query actions with partial match. = 3.5.2 - 2022-09-16 = * Fix - erroneous 3.5.1 release. = 3.5.1 - 2022-09-13 = * Maintenance on A/S docs. * fix: PHP 8.2 deprecated notice. = 3.5.0 - 2022-08-25 = * Add - The active view link within the "Tools > Scheduled Actions" screen is now clickable. * Add - A warning when there are past-due actions. * Enhancement - Added the ability to schedule unique actions via an atomic operation. * Enhancement - Improvements to cache invalidation when processing batches (when running on WordPress 6.0+). * Enhancement - If a recurring action is found to be consistently failing, it will stop being rescheduled. * Enhancement - Adds a new "Past Due" view to the scheduled actions list table. = 3.4.2 - 2022-06-08 = * Fix - Change the include for better linting. * Fix - update: Added Action scheduler completed action hook. = 3.4.1 - 2022-05-24 = * Fix - Change the include for better linting. * Fix - Fix the documented return type. = 3.4.0 - 2021-10-29 = * Enhancement - Number of items per page can now be set for the Scheduled Actions view (props @ovidiul). #771 * Fix - Do not lower the max_execution_time if it is already set to 0 (unlimited) (props @barryhughes). #755 * Fix - Avoid triggering autoloaders during the version resolution process (props @olegabr). #731 & #776 * Dev - ActionScheduler_wcSystemStatus PHPCS fixes (props @ovidiul). #761 * Dev - ActionScheduler_DBLogger.php PHPCS fixes (props @ovidiul). #768 * Dev - Fixed phpcs for ActionScheduler_Schedule_Deprecated (props @ovidiul). #762 * Dev - Improve actions table indices (props @glagonikas). #774 & #777 * Dev - PHPCS fixes for ActionScheduler_DBStore.php (props @ovidiul). #769 & #778 * Dev - PHPCS Fixes for ActionScheduler_Abstract_ListTable (props @ovidiul). #763 & #779 * Dev - Adds new filter action_scheduler_claim_actions_order_by to allow tuning of the claim query (props @glagonikas). #773 * Dev - PHPCS fixes for ActionScheduler_WpPostStore class (props @ovidiul). #780 = 3.3.0 - 2021-09-15 = * Enhancement - Adds as_has_scheduled_action() to provide a performant way to test for existing actions. #645 * Fix - Improves compatibility with environments where NO_ZERO_DATE is enabled. #519 * Fix - Adds safety checks to guard against errors when our database tables cannot be created. #645 * Dev - Now supports queries that use multiple statuses. #649 * Dev - Minimum requirements for WordPress and PHP bumped (to 5.2 and 5.6 respectively). #723 = 3.2.1 - 2021-06-21 = * Fix - Add extra safety/account for different versions of AS and different loading patterns. #714 * Fix - Handle hidden columns (Tools → Scheduled Actions) | #600. = 3.2.0 - 2021-06-03 = * Fix - Add "no ordering" option to as_next_scheduled_action(). * Fix - Add secondary scheduled date checks when claiming actions (DBStore) | #634. * Fix - Add secondary scheduled date checks when claiming actions (wpPostStore) | #634. * Fix - Adds a new index to the action table, reducing the potential for deadlocks (props: @glagonikas). * Fix - Fix unit tests infrastructure and adapt tests to PHP 8. * Fix - Identify in-use data store. * Fix - Improve test_migration_is_scheduled. * Fix - PHP notice on list table. * Fix - Speed up clean up and batch selects. * Fix - Update pending dependencies. * Fix - [PHP 8.0] Only pass action arg values through to do_action_ref_array(). * Fix - [PHP 8] Set the PHP version to 7.1 in composer.json for PHP 8 compatibility. * Fix - add is_initialized() to docs. * Fix - fix file permissions. * Fix - fixes #664 by replacing __ with esc_html__. = 3.1.6 - 2020-05-12 = * Change log starts. blueprint/blueprint.php 0000777 00000000433 15252010675 0011277 0 ustar 00 <?php /** * Plugin Name: Blueprint * Plugin URI: https://woocommerce.com/ * Description: An empty blueprint definition file to setup wp-env test env. * Version: 0.0.1 * Author: Automattic * Author URI: https://woocommerce.com * Requires at least: 6.4 * Requires PHP: 7.4 */ blueprint/src/ImportSchema.php 0000777 00000004531 15252010675 0012460 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use Automattic\WooCommerce\Blueprint\Schemas\JsonSchema; use Opis\JsonSchema\Errors\ErrorFormatter; use Opis\JsonSchema\Validator; /** * Class ImportSchema * * Handles the import schema functionality for WooCommerce. * * @package Automattic\WooCommerce\Blueprint */ class ImportSchema { use UseWPFunctions; /** * JsonSchema object. * * @var JsonSchema The schema instance. */ private JsonSchema $schema; /** * Validator object. * * @var Validator The JSON schema validator instance. */ private Validator $validator; /** * ImportSchema constructor. * * @param JsonSchema $schema The schema instance. * @param Validator|null $validator The validator instance, optional. */ public function __construct( JsonSchema $schema, ?Validator $validator = null ) { $this->schema = $schema; if ( null === $validator ) { $validator = new Validator(); } $this->validator = $validator; } /** * Get the schema. * * @return JsonSchema The schema. */ public function get_schema() { return $this->schema; } /** * Create an ImportSchema instance from a file. * * @param string $file The file path. * @return ImportSchema The created ImportSchema instance. * * @throws \RuntimeException If the JSON file cannot be read. * @throws \InvalidArgumentException If the JSON is invalid or missing 'steps' field. */ public static function create_from_file( $file ) { return self::create_from_json( $file ); } /** * Create an ImportSchema instance from a JSON file. * * @param string $json_path The JSON file path. * @return ImportSchema The created ImportSchema instance. * * @throws \RuntimeException If the JSON file cannot be read. * @throws \InvalidArgumentException If the JSON is invalid or missing 'steps' field. */ public static function create_from_json( $json_path ) { return new self( new JsonSchema( $json_path ) ); } /** * Import the schema steps. * * @return StepProcessorResult[] */ public function import() { $results = array(); $result = StepProcessorResult::success( 'ImportSchema' ); $results[] = $result; foreach ( $this->schema->get_steps() as $step_schema ) { $step_importer = new ImportStep( $step_schema, $this->validator ); $results[] = $step_importer->import(); } return $results; } } blueprint/src/Cli/ImportCli.php 0000777 00000002460 15252010675 0012475 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Cli; use Automattic\WooCommerce\Blueprint\ImportSchema; use Automattic\WooCommerce\Blueprint\ResultFormatters\CliResultFormatter; /** * Class ImportCli */ class ImportCli { /** * Schema path * * @var string $schema_path The path to the schema file. */ private $schema_path; /** * ImportCli constructor. * * @param string $schema_path The path to the schema file. */ public function __construct( $schema_path ) { $this->schema_path = $schema_path; } /** * Run the import process. * * @param array $optional_args Optional arguments. * * @return void */ public function run( $optional_args ) { try { $blueprint = ImportSchema::create_from_file( $this->schema_path ); } catch ( \Exception $e ) { \WP_CLI::error( $e->getMessage() ); return; } $results = $blueprint->import(); $result_formatter = new CliResultFormatter( $results ); $is_success = $result_formatter->is_success(); if ( isset( $optional_args['show-messages'] ) ) { $result_formatter->format( $optional_args['show-messages'] ); } if ( $is_success ) { \WP_CLI::success( "$this->schema_path imported successfully" ); } else { \WP_CLI::error( "Failed to import $this->schema_path. Run with --show-messages=all to debug" ); } } } blueprint/src/Cli/ExportCli.php 0000777 00000002551 15252010675 0012505 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Cli; use Automattic\WooCommerce\Blueprint\ExportSchema; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Class ExportCli * * This class handles the CLI commands for exporting schemas. * * @package Automattic\WooCommerce\Blueprint\Cli */ class ExportCli { use UseWPFunctions; /** * The path where the exported schema will be saved. * * @var string The path where the exported schema will be saved. */ private string $save_to; /** * ExportCli constructor. * * @param string $save_to The path where the exported schema will be saved. */ public function __construct( $save_to ) { $this->save_to = $save_to; } /** * Run the export process. * * @param array $args The arguments for the export process. */ public function run( $args = array() ) { if ( ! isset( $args['steps'] ) ) { $args['steps'] = array(); } $exporter = new ExportSchema(); $result = $exporter->export( $args['steps'] ); if ( is_wp_error( $result ) ) { \WP_CLI::error( $result->get_error_message() ); return; } $is_saved = $this->wp_filesystem_put_contents( $this->save_to, wp_json_encode( $result, JSON_PRETTY_PRINT ) ); if ( false === $is_saved ) { \WP_CLI::error( "Failed to save to {$this->save_to}" ); } else { \WP_CLI::success( "Exported JSON to {$this->save_to}" ); } } } blueprint/src/StepProcessorResult.php 0000777 00000007101 15252010675 0014073 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use InvalidArgumentException; /** * A class returned by StepProcessor classes containing result of the process and messages. */ class StepProcessorResult { const MESSAGE_TYPES = array( 'error', 'info', 'debug', 'warn' ); /** * Messages * * @var array $messages */ private array $messages = array(); /** * Indicate whether the process was success or not * * @var bool $success */ private bool $success; /** * Step name * * @var string $step_name */ private string $step_name; /** * Construct. * * @param bool $success Indicate whether the process was success or not. * @param string $step_name The name of the step. */ public function __construct( bool $success, string $step_name ) { $this->success = $success; $this->step_name = $step_name; } /** * Get messages. * * @param string $step_name The name of the step. * * @return void */ public function set_step_name( $step_name ) { $this->step_name = $step_name; } /** * Create a new instance with $success = true. * * @param string $stp_name The name of the step. * * @return StepProcessorResult */ public static function success( string $stp_name ): self { return ( new self( true, $stp_name ) ); } /** * Add a new message. * * @param string $message message. * @param string $type one of error, info. * * @throws InvalidArgumentException When incorrect type is given. * @return void */ public function add_message( string $message, string $type = 'error' ) { if ( ! in_array( $type, self::MESSAGE_TYPES, true ) ) { // phpcs:ignore throw new InvalidArgumentException( "{$type} is not allowed. Type must be one of " . implode( ',', self::MESSAGE_TYPES ) ); } $this->messages[] = compact( 'message', 'type' ); } /** * Merge messages from another StepProcessorResult instance. * * @param StepProcessorResult $other The other StepProcessorResult instance. * * @return void */ public function merge_messages( StepProcessorResult $other ) { $this->messages = array_merge( $this->messages, $other->get_messages() ); } /** * Add a new error message. * * @param string $message message. * * @return void */ public function add_error( string $message ) { $this->add_message( $message ); } /** * Add a new debug message. * * @param string $message message. * * @return void */ public function add_debug( string $message ) { $this->add_message( $message, 'debug' ); } /** * Add a new info message. * * @param string $message message. * * @return void */ public function add_info( string $message ) { $this->add_message( $message, 'info' ); } /** * Add a new warn message. * * @param string $message message. * * @return void */ public function add_warn( string $message ) { $this->add_message( $message, 'warn' ); } /** * Filter messages. * * @param string $type one of all, error, and info. * * @return array */ public function get_messages( string $type = 'all' ): array { if ( 'all' === $type ) { return $this->messages; } return array_filter( $this->messages, function ( $message ) use ( $type ) { return $type === $message['type']; } ); } /** * Check to see if the result was success. * * @return bool */ public function is_success(): bool { return true === $this->success && 0 === count( $this->get_messages( 'error' ) ); } /** * Get the name of the step. * * @return string The name of the step. */ public function get_step_name() { return $this->step_name; } } blueprint/src/ResultFormatters/CliResultFormatter.php 0000777 00000003175 15252010675 0017207 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\ResultFormatters; use Automattic\WooCommerce\Blueprint\StepProcessorResult; use function WP_CLI\Utils\format_items; /** * Class CliResultFormatter */ class CliResultFormatter { /** * The results to format. * * @var StepProcessorResult[] */ private array $results; /** * CliResultFormatter constructor. * * @param array $results The results to format. */ public function __construct( array $results ) { $this->results = $results; } /** * Format the results. * * @param string $message_type The message type to format. * * @return void * * @throws \Exception If WP CLI Utils is not found. */ public function format( $message_type = 'debug' ) { $header = array( 'Step Processor', 'Type', 'Message' ); $items = array(); foreach ( $this->results as $result ) { $step_name = $result->get_step_name(); foreach ( $result->get_messages( $message_type ) as $message ) { $items[] = array( 'Step Processor' => $step_name, 'Type' => $message['type'], 'Message' => $message['message'], ); } } $format_items_exist = function_exists( '\WP_CLI\Utils\format_items' ); if ( ! $format_items_exist ) { throw new \Exception( 'WP CLI Utils not found' ); } format_items( 'table', $items, $header ); } /** * Check if all results are successful. * * @return bool True if all results are successful, false otherwise. */ public function is_success() { foreach ( $this->results as $result ) { $is_success = $result->is_success(); if ( ! $is_success ) { return false; } } return true; } } blueprint/src/ResultFormatters/JsonResultFormatter.php 0000777 00000002754 15252010675 0017413 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\ResultFormatters; use Automattic\WooCommerce\Blueprint\StepProcessorResult; /** * Class JsonResultFormatter */ class JsonResultFormatter { /** * The results to format. * * @var StepProcessorResult[] */ private array $results; /** * JsonResultFormatter constructor. * * @param array $results The results to format. */ public function __construct( array $results ) { $this->results = $results; } /** * Format the results. * * @param string $message_type The message type to format. * * @return array */ public function format( $message_type = 'all' ) { $data = array( 'is_success' => $this->is_success(), 'messages' => array(), ); foreach ( $this->results as $result ) { $step_name = $result->get_step_name(); foreach ( $result->get_messages( $message_type ) as $message ) { if ( ! isset( $data['messages'][ $message['type'] ] ) ) { $data['messages'][ $message['type'] ] = array(); } $data['messages'][ $message['type'] ][] = array( 'step' => $step_name, 'type' => $message['type'], 'message' => $message['message'], ); } } return $data; } /** * Check if all results are successful. * * @return bool True if all results are successful, false otherwise. */ public function is_success() { foreach ( $this->results as $result ) { $is_success = $result->is_success(); if ( ! $is_success ) { return false; } } return true; } } blueprint/src/Exporters/StepExporter.php 0000777 00000001455 15252010675 0014526 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Exporters; use Automattic\WooCommerce\Blueprint\Steps\Step; /** * Interface StepExporter * * A Step Exporter is responsible collecting data needed for a Step object and exporting it. * Refer to the Step class for the data needed as each step may require different data. */ interface StepExporter { /** * Collect data needed for a Step object and export it. * * @return Step */ public function export(); /** * Returns the name of the step class it exports. * * @return string */ public function get_step_name(); /** * Check if the current user has the required capabilities for this step. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities(): bool; } blueprint/src/Exporters/ExportInstallThemeSteps.php 0000777 00000003617 15252010675 0016676 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Exporters; use Automattic\WooCommerce\Blueprint\Steps\InstallTheme; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Class ExportInstallThemeSteps * * Exporter for the InstallTheme step. * * @package Automattic\WooCommerce\Blueprint\Exporters */ class ExportInstallThemeSteps implements StepExporter { use UseWPFunctions; /** * Filter callback. * * @var callable */ private $filter_callback; /** * Register a filter callback to filter the plugins to export. * * @param callable $callback Filter callback. * * @return void */ public function filter( callable $callback ) { $this->filter_callback = $callback; } /** * Export the steps. * * @return array */ public function export() { $steps = array(); $themes = $this->wp_get_themes(); if ( is_callable( $this->filter_callback ) ) { $themes = call_user_func( $this->filter_callback, $themes ); } $active_theme = $this->wp_get_theme(); foreach ( $themes as $slug => $theme ) { // Check if the theme is active. $is_active = $theme->get( 'Name' ) === $active_theme->get( 'Name' ); $info = $this->wp_themes_api( 'theme_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false, ), ) ); if ( isset( $info->download_link ) ) { $steps[] = new InstallTheme( $slug, 'wordpress.org/themes', array( 'activate' => $is_active, ) ); } } return $steps; } /** * Get the step name. * * @return string */ public function get_step_name() { return InstallTheme::get_step_name(); } /** * Check if the current user has the required capabilities for this step. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities(): bool { return current_user_can( 'switch_themes' ); } } blueprint/src/Exporters/HasAlias.php 0000777 00000002075 15252010675 0013546 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Exporters; /** * Allows a step to have an alias. * * An alias is useful for selective export. * * Let's say you have three exporters and all of them use `setSiteOptions` step. * * Step A: Exports options from WooCommerce -> Settings * Step B: Exports options for the core profiler selection. * Step C: Exports options for the task list. * * You also have a UI where a client can select which steps to export. In this case, we have three checkboxes. * * [ ] WooCommerce Settings * [ ] WooCommerce Core Profiler * [ ] WooCommerce Task List * * Without alias, the client would see three `setSiteOptions` steps and it's not possible * to distinguish between them from the ExportSchema class. * * With alias, you can give each step a unique alias while keeping the step name the same. * * @todo Link to an example class that uses this interface. * * Interface HasAlias */ interface HasAlias { /** * Get the alias for the step. * * @return string The alias for the step. */ public function get_alias(); } blueprint/src/Exporters/ExportInstallPluginSteps.php 0000777 00000010116 15252010675 0017062 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Exporters; use Automattic\WooCommerce\Blueprint\Steps\InstallPlugin; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Class ExportInstallPluginSteps * * @package Automattic\WooCommerce\Blueprint\Exporters */ class ExportInstallPluginSteps implements StepExporter { use UseWPFunctions; /** * Filter callback. * * @var callable */ private $filter_callback; /** * Whether to include private plugins in the export. * * @var bool Whether to include private plugins in the export. */ private bool $include_private_plugins = false; /** * Set whether to include private plugins in the export. * * @param bool $boolean Whether to include private plugins. */ public function include_private_plugins( bool $boolean ) { $this->include_private_plugins = $boolean; } /** * Register a filter callback to filter the plugins to export. * * @param callable $callback Filter callback. * * @return void */ public function filter( callable $callback ) { $this->filter_callback = $callback; } /** * Export the steps required to install plugins. * * @return array The array of InstallPlugin steps. */ public function export() { $plugins = $this->sort_plugins_by_dep( $this->wp_get_plugins() ); if ( is_callable( $this->filter_callback ) ) { $plugins = call_user_func( $this->filter_callback, $plugins ); } // @todo temporary fix for JN site -- it includes WooCommerce as a custom plugin // since JN sites are using a different slug. $exclude = array( 'WooCommerce Beta Tester' ); $steps = array(); foreach ( $plugins as $path => $plugin ) { if ( in_array( $plugin['Name'], $exclude, true ) ) { continue; } $slug = dirname( $path ); // single-file plugin. if ( '.' === $slug ) { $slug = pathinfo( $path )['filename']; } $info = $this->wp_plugins_api( 'plugin_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false, ), ) ); $has_download_link = isset( $info->download_link ); if ( false === $this->include_private_plugins && ! $has_download_link ) { continue; } $resource = $has_download_link ? 'wordpress.org/plugins' : 'self/plugins'; $steps[] = new InstallPlugin( $slug, $resource, array( 'activate' => true, ) ); } return $steps; } /** * Sort plugins by dependencies -- put the dependencies at the top. * * @param array $plugins List of plugins to sort (from wp_get_plugins function). * * @return array */ public function sort_plugins_by_dep( array $plugins ) { $sorted = array(); $visited = array(); // Create a mapping of lowercase titles to plugin keys for quick lookups. $title_map = array_reduce( array_keys( $plugins ), function ( $carry, $key ) use ( $plugins ) { $title = strtolower( $plugins[ $key ]['Title'] ?? '' ); if ( $title ) { $carry[ $title ] = $key; } return $carry; }, array() ); // Recursive function for topological sort. $visit = function ( $plugin_key ) use ( &$visit, &$sorted, &$visited, $plugins, $title_map ) { if ( isset( $visited[ $plugin_key ] ) ) { return; } $visited[ $plugin_key ] = true; $requires = $plugins[ $plugin_key ]['RequiresPlugins'] ?? array(); foreach ( (array) $requires as $dependency ) { $dependency_key = $title_map[ strtolower( $dependency ) ] ?? null; if ( $dependency_key ) { $visit( $dependency_key ); } } $sorted[ $plugin_key ] = $plugins[ $plugin_key ]; }; // Perform sort for each plugin. foreach ( array_keys( $plugins ) as $plugin_key ) { $visit( $plugin_key ); } return $sorted; } /** * Get the name of the step. * * @return string The step name. */ public function get_step_name() { return InstallPlugin::get_step_name(); } /** * Check if the current user has the required capabilities for this step. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities(): bool { return current_user_can( 'activate_plugins' ); } } blueprint/src/Importers/ImportActivatePlugin.php 0000777 00000003052 15252010675 0016160 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Importers; use Automattic\WooCommerce\Blueprint\StepProcessor; use Automattic\WooCommerce\Blueprint\StepProcessorResult; use Automattic\WooCommerce\Blueprint\Steps\ActivatePlugin; use Automattic\WooCommerce\Blueprint\UsePluginHelpers; /** * Class ImportActivatePlugin */ class ImportActivatePlugin implements StepProcessor { use UsePluginHelpers; /** * Process the schema. * * @param object $schema The schema to process. * * @return StepProcessorResult */ public function process( $schema ): StepProcessorResult { $result = StepProcessorResult::success( ActivatePlugin::get_step_name() ); // Not snake case because it's a property of the schema. $plugin_path = $schema->pluginPath; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase $activate = $this->wp_activate_plugin( $plugin_path ); if ( $this->is_wp_error( $activate ) ) { $result->add_error( "Unable to activate {$plugin_path}." ); } else { $result->add_info( "Activated {$plugin_path}." ); } return $result; } /** * Get the step class. * * @return string */ public function get_step_class(): string { return ActivatePlugin::class; } /** * Check if the current user has the required capabilities for this step. * * @param object $schema The schema to process. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities( $schema ): bool { return current_user_can( 'activate_plugins' ); } } blueprint/src/Importers/ImportActivateTheme.php 0000777 00000003121 15252010675 0015761 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Importers; use Automattic\WooCommerce\Blueprint\StepProcessor; use Automattic\WooCommerce\Blueprint\StepProcessorResult; use Automattic\WooCommerce\Blueprint\Steps\ActivateTheme; use Automattic\WooCommerce\Blueprint\UsePluginHelpers; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Class ImportActivateTheme * * @package Automattic\WooCommerce\Blueprint\Importers */ class ImportActivateTheme implements StepProcessor { use UsePluginHelpers; use UseWPFunctions; /** * Process the step. * * @param object $schema The schema for the step. * * @return StepProcessorResult */ public function process( $schema ): StepProcessorResult { $result = StepProcessorResult::success( ActivateTheme::get_step_name() ); // phpcs:ignore $name = $schema->themeName; $this->wp_switch_theme( $name ); $current_theme = $this->wp_get_theme()->get_stylesheet(); if ( $current_theme === $name ) { $result->add_debug( "Switched theme to '$name'." ); } return $result; } /** * Returns the class name of the step this processor handles. * * @return string The class name of the step this processor handles. */ public function get_step_class(): string { return ActivateTheme::class; } /** * Check if the current user has the required capabilities for this step. * * @param object $schema The schema to process. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities( $schema ): bool { return current_user_can( 'switch_themes' ); } } blueprint/src/Importers/ImportInstallTheme.php 0000777 00000010635 15252010675 0015637 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Importers; use Automattic\WooCommerce\Blueprint\ResourceStorages; use Automattic\WooCommerce\Blueprint\StepProcessor; use Automattic\WooCommerce\Blueprint\StepProcessorResult; use Automattic\WooCommerce\Blueprint\Steps\InstallTheme; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Class ImportInstallTheme * * This class handles the import process for installing themes. * * @package Automattic\WooCommerce\Blueprint\Importers */ class ImportInstallTheme implements StepProcessor { use UseWPFunctions; /** * Collection of resource storages. * * @var ResourceStorages The resource storage used for downloading themes. */ private ResourceStorages $storage; /** * The result of the step processing. * * @var StepProcessorResult The result of the step processing. */ private StepProcessorResult $result; /** * ImportInstallTheme constructor. * * @param ResourceStorages $storage The resource storage used for downloading themes. */ public function __construct( ResourceStorages $storage ) { $this->result = StepProcessorResult::success( InstallTheme::get_step_name() ); $this->storage = $storage; } /** * Process the schema to install the theme. * * @param object $schema The schema containing theme installation details. * * @return StepProcessorResult The result of the step processing. */ public function process( $schema ): StepProcessorResult { $installed_themes = $this->wp_get_themes(); // phpcs:ignore $theme = $schema->themeData; if ( 'wordpress.org/themes' !== $theme->resource ) { $this->result->add_info( "Skipped installing a theme. Unsupported resource type. Only 'wordpress.org/themes' is supported at the moment." ); return $this->result; } if ( ! isset( $schema->options ) ) { $schema->options = new \stdClass(); } if ( isset( $installed_themes[ $theme->slug ] ) ) { $this->activate_theme( $schema ); $this->result->add_info( "Skipped installing {$theme->slug}. It is already installed." ); return $this->result; } if ( $this->storage->is_supported_resource( $theme->resource ) === false ) { $this->result->add_error( "Invalid resource type for {$theme->slug}" ); return $this->result; } $downloaded_path = $this->storage->download( $theme->slug, $theme->resource ); if ( ! $downloaded_path ) { $this->result->add_error( "Unable to download {$theme->slug} with {$theme->resource} resource type." ); return $this->result; } $this->result->add_debug( "'$theme->slug' has been downloaded in $downloaded_path" ); $install = $this->install( $downloaded_path ); if ( $install ) { $this->result->add_debug( "Theme '$theme->slug' installed successfully." ); } else { $this->result->add_error( "Failed to install theme '$theme->slug'." ); } $this->activate_theme( $schema ); return $this->result; } /** * Attempt to activate the theme if the schema specifies to do so. * * @param object $schema installTheme schema. * * @return void */ protected function activate_theme( $schema ) { // phpcs:ignore $theme = $schema->themeData; if ( isset( $schema->options->activate ) && true === $schema->options->activate ) { $this->wp_switch_theme( $theme->slug ); $current_theme = $this->wp_get_theme()->get_stylesheet(); if ( $current_theme === $theme->slug ) { $this->result->add_info( "Switched theme to '$theme->slug'." ); } else { $this->result->add_error( "Failed to switch theme to '$theme->slug'." ); } } } /** * Install the theme from the local path. * * @param string $local_path The local path of the theme to be installed. * * @return bool True if the installation was successful, false otherwise. */ protected function install( $local_path ) { $unzip_result = $this->wp_unzip_file( $local_path, $this->wp_get_theme_root() ); if ( $this->is_wp_error( $unzip_result ) ) { return false; } return true; } /** * Get the class name of the step. * * @return string The class name of the step. */ public function get_step_class(): string { return InstallTheme::class; } /** * Check if the current user has the required capabilities for this step. * * @param object $schema The schema to process. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities( $schema ): bool { return current_user_can( 'install_themes' ); } } blueprint/src/Importers/ImportRunSql.php 0000777 00000021610 15252010675 0014465 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Importers; use Automattic\WooCommerce\Blueprint\StepProcessor; use Automattic\WooCommerce\Blueprint\StepProcessorResult; use Automattic\WooCommerce\Blueprint\Steps\RunSql; use Automattic\WooCommerce\Blueprint\UsePluginHelpers; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Processes SQL execution steps in the Blueprint. * * Handles the execution of SQL queries with safety checks to prevent * unauthorized modifications to sensitive WordPress data. * * @package Automattic\WooCommerce\Blueprint\Importers */ class ImportRunSql implements StepProcessor { use UsePluginHelpers; use UseWPFunctions; /** * List of allowed SQL query types. * * @var array */ private const ALLOWED_QUERY_TYPES = array( 'INSERT', 'UPDATE', 'REPLACE INTO', ); /** * Process the SQL execution step. * * Validates and executes the SQL query while ensuring: * 1. Only allowed query types are executed * 2. No modifications to admin users or roles * 3. No unauthorized changes to user capabilities * * @param object $schema The schema containing the SQL query to execute. * @return StepProcessorResult The result of the SQL execution. */ public function process( $schema ): StepProcessorResult { global $wpdb; $result = StepProcessorResult::success( RunSql::get_step_name() ); $sql = trim( $schema->sql->contents ); // Check if the query type is allowed. if ( ! $this->is_allowed_query_type( $sql ) ) { $result->add_error( sprintf( 'Only %s queries are allowed.', implode( ', ', self::ALLOWED_QUERY_TYPES ) ) ); return $result; } // Check for SQL comments that might be hiding malicious code. if ( $this->contains_suspicious_comments( $sql ) ) { $result->add_error( 'SQL query contains suspicious comment patterns.' ); return $result; } // Detect SQL injection patterns. if ( $this->contains_sql_injection_patterns( $sql ) ) { $result->add_error( 'SQL query contains potential injection patterns.' ); return $result; } // Check if the query affects protected tables. if ( $this->affects_protected_tables( $sql ) ) { $result->add_error( 'Modifications to admin users or roles are not allowed.' ); return $result; } // Check if the query affects user capabilities in wp_options. if ( $this->affects_user_capabilities( $sql ) ) { $result->add_error( 'Modifications to user roles or capabilities are not allowed.' ); return $result; } $wpdb->suppress_errors( true ); $wpdb->query( 'START TRANSACTION' ); try { $query_result = $wpdb->query( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared $last_error = $wpdb->last_error; if ( $last_error ) { $wpdb->query( 'ROLLBACK' ); $result->add_error( 'Error executing SQL: ' . $last_error ); } else { $wpdb->query( 'COMMIT' ); $result->add_debug( "Executed SQL ({$schema->sql->name}): Affected {$query_result} rows" ); } } catch ( \Throwable $e ) { $wpdb->query( 'ROLLBACK' ); $result->add_error( "Exception executing SQL: {$e->getMessage()}" ); } return $result; } /** * Returns the class name of the step this processor handles. * * @return string The class name of the step this processor handles. */ public function get_step_class(): string { return RunSql::class; } /** * Check if the current user has the required capabilities for this step. * * @param object $schema The schema to process. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities( $schema ): bool { if ( ! current_user_can( 'manage_options' ) ) { return false; } if ( ! current_user_can( 'edit_posts' ) ) { return false; } if ( ! current_user_can( 'edit_users' ) ) { return false; } return true; } /** * Check if the SQL query type is allowed. * * @param string $sql_content The SQL query to check. * @return bool True if the query type is allowed, false otherwise. */ private function is_allowed_query_type( string $sql_content ): bool { $uppercase_sql_content = strtoupper( trim( $sql_content ) ); foreach ( self::ALLOWED_QUERY_TYPES as $query_type ) { if ( 0 === stripos( $uppercase_sql_content, $query_type ) ) { return true; } } return false; } /** * Check for suspicious comment patterns that might hide malicious code. * * This method detects various types of SQL comments that might be used * to hide malicious SQL commands or bypass security filters. * * @param string $sql_content The SQL query to check. * @return bool True if suspicious comments found, false otherwise. */ private function contains_suspicious_comments( string $sql_content ): bool { // Quick check if there are any comments at all before running regex. if ( strpos( $sql_content, '--' ) === false && strpos( $sql_content, '/*' ) === false && strpos( $sql_content, '#' ) === false ) { return false; } // List of potentially dangerous SQL commands to check for in comments. $dangerous_commands = array( 'DELETE', 'DROP', 'ALTER', 'CREATE', 'TRUNCATE', 'GRANT', 'REVOKE', 'EXEC', 'EXECUTE', 'CALL', 'INTO OUTFILE', 'INTO DUMPFILE', 'LOAD_FILE', 'LOAD DATA', 'BENCHMARK', 'SLEEP', 'INFORMATION_SCHEMA', 'USER\\(', 'DATABASE\\(', 'SCHEMA\\(', ); $dangerous_pattern = implode( '|', $dangerous_commands ); // Check for SQL comments that might be hiding malicious code. $patterns = array( // Single-line comments (-- style) containing dangerous commands. '/--.*?(' . $dangerous_pattern . ')/i', // Single-line comments (# style) containing dangerous commands. '/#.*?(' . $dangerous_pattern . ')/i', // Multi-line comments hiding dangerous commands. '/\/\*.*?(' . $dangerous_pattern . ').*?\*\//is', // MySQL-specific execution comments (version-specific code execution). '/\/\*![0-9]*.*?\*\//', ); foreach ( $patterns as $pattern ) { if ( preg_match( $pattern, $sql_content ) ) { return true; } } return false; } /** * Check for common SQL injection patterns. * * @param string $sql_content The SQL query to check. * @return bool True if potential injection patterns found, false otherwise. */ private function contains_sql_injection_patterns( string $sql_content ): bool { $patterns = array( '/UNION\s+(?:ALL\s+)?SELECT/i', // UNION-based injections. '/OR\s+1\s*=\s*1/i', // OR 1=1 condition. '/AND\s+0\s*=\s*0/i', // AND 0=0 condition. '/;\s*--/i', // Inline comment terminations. '/SLEEP\s*\(/i', // Time-based injections. '/BENCHMARK\s*\(/i', // Benchmark-based injections. '/LOAD_FILE\s*\(/i', // File access. '/INTO\s+OUTFILE/i', // File write. '/INTO\s+DUMPFILE/i', // File dump. '/CREATE\s+(?:TEMPORARY\s+)?TABLE/i', // Table creation. '/DROP\s+TABLE/i', // Table deletion. '/ALTER\s+TABLE/i', // Table alteration. '/INFORMATION_SCHEMA/i', // Database metadata access. '/EXEC\s*\(/i', // Stored procedure execution. '/SCHEMA_NAME/i', // Schema access. '/DATABASE\(\)/i', // Current database name. '/CHR\s*\(/i', // Character function for evasion. '/CHAR\s*\(/i', // Character function for evasion. '/FROM\s+mysql\./i', // Direct MySQL system table access. '/FROM\s+information_schema\./i', // Direct information schema access. ); foreach ( $patterns as $pattern ) { if ( preg_match( $pattern, $sql_content ) ) { return true; } } return false; } /** * Check if the SQL query affects protected user tables. * * @param string $sql_content The SQL query to check. * @return bool True if the query affects protected tables, false otherwise. */ private function affects_protected_tables( string $sql_content ): bool { global $wpdb; $protected_tables = array( $wpdb->users, $wpdb->usermeta, ); foreach ( $protected_tables as $table ) { if ( preg_match( '/\b' . preg_quote( $table, '/' ) . '\b/i', $sql_content ) ) { return true; } } return false; } /** * Check if the SQL query affects user capabilities in wp_options. * * @param string $sql_content The SQL query to check. * @return bool True if the query affects user capabilities, false otherwise. */ private function affects_user_capabilities( string $sql_content ): bool { global $wpdb; // Check if the query affects user capabilities in wp_options. if ( stripos( $sql_content, $wpdb->prefix . 'options' ) !== false ) { $option_patterns = array( 'user_roles', 'capabilities', 'wp_user_', 'role_', 'administrator', ); foreach ( $option_patterns as $pattern ) { if ( stripos( $sql_content, $pattern ) !== false ) { return true; } } } return false; } } blueprint/src/Importers/ImportSetSiteOptions.php 0000777 00000004674 15252010675 0016210 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Importers; use Automattic\WooCommerce\Blueprint\StepProcessor; use Automattic\WooCommerce\Blueprint\StepProcessorResult; use Automattic\WooCommerce\Blueprint\Steps\SetSiteOptions; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Class ImportSetSiteOptions * * Importer for the SetSiteOptions step. * * @package Automattic\WooCommerce\Blueprint\Importers */ class ImportSetSiteOptions implements StepProcessor { use UseWPFunctions; /** * List of WordPress options that should not be modified. * * @var array<string> */ private const RESTRICTED_OPTIONS = array( 'siteurl', 'home', 'active_plugins', 'template', 'stylesheet', 'admin_email', 'unfiltered_html', 'users_can_register', 'default_role', 'db_version', 'cron', 'rewrite_rules', 'wp_user_roles', ); /** * Process the step. * * @param object $schema The schema to process. * * @return StepProcessorResult */ public function process( $schema ): StepProcessorResult { $result = StepProcessorResult::success( SetSiteOptions::get_step_name() ); foreach ( $schema->options as $key => $value ) { // Skip if the option should not be modified. if ( in_array( $key, self::RESTRICTED_OPTIONS, true ) ) { $result->add_warn( "Cannot modify '{$key}' option: Modifying is restricted for this key." ); continue; } $value = json_decode( wp_json_encode( $value ), true ); $updated = $this->wp_update_option( $key, $value ); $current_value = $this->wp_get_option( $key ); if ( $current_value !== $value ) { $result->add_warn( "{$key} was intended to be set, but the stored value may have been overridden by a hook." ); continue; } if ( $updated ) { $result->add_info( "{$key} has been updated." ); continue; } if ( $current_value === $value ) { $result->add_info( "{$key} has not been updated because the current value is already up to date." ); } } return $result; } /** * Get the step class. * * @return string */ public function get_step_class(): string { return SetSiteOptions::class; } /** * Check if the current user has the required capabilities for this step. * * @param object $schema The schema to process. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities( $schema ): bool { return current_user_can( 'manage_options' ); } } blueprint/src/Importers/ImportInstallPlugin.php 0000777 00000012456 15252010675 0016036 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Importers; use Automattic\WooCommerce\Blueprint\ResourceStorages; use Automattic\WooCommerce\Blueprint\StepProcessor; use Automattic\WooCommerce\Blueprint\StepProcessorResult; use Automattic\WooCommerce\Blueprint\Steps\InstallPlugin; use Automattic\WooCommerce\Blueprint\UseWPFunctions; use Plugin_Upgrader; /** * Class ImportInstallPlugin * * Handles the installation and activation of plugins based on a schema. */ class ImportInstallPlugin implements StepProcessor { use UseWPFunctions; /** * Resource storage instance for handling plugin files. * * @var ResourceStorages */ private ResourceStorages $storage; /** * Array of paths to installed plugins. * * @var array */ private array $installed_plugin_paths = array(); /** * Constructor. * * @param ResourceStorages $storage Resource storage instance. */ public function __construct( ResourceStorages $storage ) { $this->storage = $storage; } /** * Processes the schema to install and optionally activate a plugin. * * @param object $schema Schema object containing plugin information. * @return StepProcessorResult Result of the processing. */ public function process( $schema ): StepProcessorResult { $result = StepProcessorResult::success( InstallPlugin::get_step_name() ); $installed_plugins = $this->get_installed_plugins_paths(); // phpcs:ignore $plugin = $schema->pluginData; // We only support CorePluginReference at the moment. if ( 'wordpress.org/plugins' !== $plugin->resource ) { $result->add_info( "Skipped installing a plugin. Unsupported resource type. Only 'wordpress.org/plugins' is supported at the moment." ); return $result; } // If the plugin is already installed, skip the installation. if ( isset( $installed_plugins[ $plugin->slug ] ) ) { $result->add_info( "Skipped installing {$plugin->slug}. It is already installed." ); return $result; } // If the resource type is not supported, return an error. if ( $this->storage->is_supported_resource( $plugin->resource ) === false ) { $result->add_error( "Invalid resource type for {$plugin->slug}." ); return $result; } // Download the plugin. $downloaded_path = $this->storage->download( $plugin->slug, $plugin->resource ); if ( ! $downloaded_path ) { $result->add_error( "Unable to download {$plugin->slug} with {$plugin->resource} resource type." ); return $result; } // Install the plugin. $install = $this->install( $downloaded_path ); if ( is_wp_error( $install ) ) { $result->add_error( "Failed to install {$plugin->slug}." ); return $result; } $result->add_info( "Installed {$plugin->slug}." ); // If the plugin should be activated, activate it. $should_activate = isset( $schema->options, $schema->options->activate ) && true === $schema->options->activate; if ( $should_activate ) { $activate = $this->activate( $plugin->slug ); if ( $activate instanceof \WP_Error ) { $result->add_error( "Failed to activate {$plugin->slug}." ); return $result; } $result->add_info( "Activated {$plugin->slug}." ); } return $result; } /** * Installs a plugin from the given local path. * * @param string $local_plugin_path Path to the local plugin file. * @return bool|WP_Error True on success, WP_Error on failure. */ protected function install( $local_plugin_path ) { if ( ! class_exists( 'Plugin_Upgrader' ) ) { include_once ABSPATH . '/wp-admin/includes/class-wp-upgrader.php'; include_once ABSPATH . '/wp-admin/includes/class-plugin-upgrader.php'; } $upgrader = new \Plugin_Upgrader( new \Automatic_Upgrader_Skin() ); return $upgrader->install( $local_plugin_path ); } /** * Activates an installed plugin by its slug. * * @param string $slug Plugin slug. * @return \WP_Error|null WP_Error on failure, null on success. */ protected function activate( $slug ) { if ( empty( $this->installed_plugin_paths ) ) { $this->installed_plugin_paths = $this->get_installed_plugins_paths(); } $path = $this->installed_plugin_paths[ $slug ] ?? false; if ( ! $path ) { return new \WP_Error( 'plugin_not_installed', "Plugin {$slug} is not installed." ); } return $this->wp_activate_plugin( $path ); } /** * Retrieves an array of installed plugins and their paths. * * @return array Array of installed plugins and their paths. */ protected function get_installed_plugins_paths() { if ( ! function_exists( 'get_plugins' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin.php'; } $plugins = get_plugins(); $installed_plugins = array(); foreach ( $plugins as $path => $plugin ) { $path_parts = explode( '/', $path ); $slug = $path_parts[0]; $installed_plugins[ $slug ] = $path; } return $installed_plugins; } /** * Returns the class name of the step being processed. * * @return string Class name of the step. */ public function get_step_class(): string { return InstallPlugin::class; } /** * Check if the current user has the required capabilities for this step. * * @param object $schema The schema to process. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities( $schema ): bool { return current_user_can( 'install_plugins' ); } } blueprint/src/UsePubSub.php 0000777 00000003011 15252010675 0011732 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; trait UsePubSub { /** * Subscribers. * * @var array */ private array $subscribers = array(); /** * Subscribe to an event with a callback. * * @param string $event The event name. * @param callable $callback The callback to execute when the event is published. * @return void */ public function subscribe( string $event, callable $callback ): void { if ( ! isset( $this->subscribers[ $event ] ) ) { $this->subscribers[ $event ] = array(); } $this->subscribers[ $event ][] = $callback; } /** * Publish an event to all subscribers. * * @param string $event The event name. * @param mixed ...$args Arguments to pass to the callbacks. * @return void */ public function publish( string $event, ...$args ): void { if ( ! isset( $this->subscribers[ $event ] ) ) { return; } foreach ( $this->subscribers[ $event ] as $callback ) { call_user_func( $callback, ...$args ); } } /** * Unsubscribe a specific callback from an event. * * @param string $event The event name. * @param callable $callback The callback to remove. * @return void */ public function unsubscribe( string $event, callable $callback ): void { if ( ! isset( $this->subscribers[ $event ] ) ) { return; } $this->subscribers[ $event ] = array_filter( $this->subscribers[ $event ], fn( $subscriber ) => $subscriber !== $callback ); if ( empty( $this->subscribers[ $event ] ) ) { unset( $this->subscribers[ $event ] ); } } } blueprint/src/docs/json-examples/activatePlugin.json 0000777 00000000076 15252010675 0016743 0 ustar 00 { "step": "activatePlugin", "pluginName": "woocommerce" } blueprint/src/docs/json-examples/installTheme.json 0000777 00000000230 15252010675 0016405 0 ustar 00 { "step": "installTheme", "themeZipFile": { "resource": "wordpress.org/themes", "slug": "twentytwenty" }, "options": { "activate": true } } blueprint/src/docs/json-examples/setSiteOptions.json 0000777 00000000132 15252010675 0016751 0 ustar 00 { "step": "setSiteOptions", "options": { "woocommerce_allow_tracking": true } } blueprint/src/docs/json-examples/installPlugin.json 0000777 00000000226 15252010675 0016606 0 ustar 00 { "step": "installPlugin", "pluginZipFile": { "resource": "wordpress.org/plugins", "slug": "akismet" }, "options": { "activate": true } } blueprint/src/Schemas/JsonSchema.php 0000777 00000003676 15252010675 0013513 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Schemas; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Class JsonSchema */ class JsonSchema { use UseWPFunctions; /** * The schema. * * @var object The schema. */ protected $schema; /** * JsonSchema constructor. * * @param string $json_path The path to the JSON file. * * @throws \RuntimeException If the JSON file cannot be read. * @throws \InvalidArgumentException If the JSON is invalid or missing 'steps' field. */ public function __construct( $json_path ) { $real_path = realpath( $json_path ); if ( false === $real_path ) { throw new \InvalidArgumentException( 'Invalid schema path' ); } $contents = $this->wp_filesystem_get_contents( $real_path ); if ( false === $contents ) { throw new \RuntimeException( "Failed to read the JSON file at {$real_path}." ); } $schema = json_decode( $contents ); $this->schema = $schema; if ( ! $this->validate() ) { throw new \InvalidArgumentException( "Invalid JSON or missing 'steps' field." ); } } /** * Returns the steps from the schema. * * @return array */ public function get_steps() { return $this->schema->steps; } /** * Returns steps by name. * * @param string $name The name of the step. * * @return array */ public function get_step( $name ) { $steps = array(); foreach ( $this->schema->steps as $step ) { if ( $step->step === $name ) { $steps[] = $step; } } return $steps; } /** * Just makes sure that the JSON contains 'steps' field. * * We're going to validate 'steps' later because we can't know the exact schema * ahead of time. 3rd party plugins can add their step processors. * * @return bool[ */ public function validate() { if ( json_last_error() !== JSON_ERROR_NONE ) { return false; } if ( ! isset( $this->schema->steps ) || ! is_array( $this->schema->steps ) ) { return false; } return true; } } blueprint/src/Logger.php 0000777 00000010104 15252010675 0011275 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Class Logger */ class Logger { use UseWPFunctions; /** * WooCommerce logger class instance. * * @var \WC_Logger_Interface */ private $logger; /** * Constructor. */ public function __construct() { $this->logger = wc_get_logger(); } /** * Log a message as a debug log entry. * * @param string $message The message to log. * @param string $level The log level. * @param array $context The context of the log. */ public function log( string $message, string $level = \WC_Log_Levels::DEBUG, $context = array() ) { $this->logger->log( $level, $message, array_merge( array( 'source' => 'wc-blueprint', 'user_id' => $this->wp_get_current_user_id(), ), $context ) ); } /** * Log the start of an export operation. * * @param array $exporters Array of exporters. */ public function start_export( array $exporters ) { $export_data = $this->get_export_data( $exporters ); $this->log( sprintf( 'Starting export of %d steps', count( $export_data['steps'] ) ), \WC_Log_Levels::INFO, array( 'steps' => $export_data['steps'], 'exporters' => $export_data['exporters'], ) ); } /** * Log the completion of an export operation. * * @param array $exporters Array of exporters. */ public function complete_export( array $exporters ) { $export_data = $this->get_export_data( $exporters ); $this->log( sprintf( 'Export of %d steps completed', count( $export_data['steps'] ) ), \WC_Log_Levels::INFO, array( 'steps' => $export_data['steps'], 'exporters' => $export_data['exporters'], ) ); } /** * Extract export step names and exporter classes from exporters. * * @param array $exporters Array of exporters. * @return array Associative array with 'steps' and 'exporters' keys. */ private function get_export_data( array $exporters ) { $export_steps = array(); $exporter_classes = array(); foreach ( $exporters as $exporter ) { $step_name = method_exists( $exporter, 'get_alias' ) ? $exporter->get_alias() : $exporter->get_step_name(); $export_steps[] = $step_name; $exporter_classes[] = get_class( $exporter ); } return array( 'steps' => $export_steps, 'exporters' => $exporter_classes, ); } /** * Log an export step failure. * * @param string $step_name The name of the step that failed. * @param \Throwable $exception The exception that was thrown. */ public function export_step_failed( string $step_name, \Throwable $exception ) { $this->log( sprintf( 'Export "%s" step failed', $step_name ), \WC_Log_Levels::ERROR, array( 'error' => $exception->getMessage(), ) ); } /** * Log the start of an import step. * * @param string $step_name The name of the step being imported. * @param string $importer_class The class name of the importer. */ public function start_import( string $step_name, string $importer_class ) { $this->log( sprintf( 'Starting import "%s" step', $step_name ), \WC_Log_Levels::INFO, array( 'importer' => $importer_class, ) ); } /** * Log the successful completion of an import step. * * @param string $step_name The name of the step that was imported. * @param StepProcessorResult $result The result of the import. */ public function complete_import( string $step_name, StepProcessorResult $result ) { $this->log( sprintf( 'Import "%s" step completed', $step_name ), \WC_Log_Levels::INFO, array( 'messages' => $result->get_messages( 'info' ), ) ); } /** * Log an import step failure. * * @param string $step_name The name of the step that failed. * @param StepProcessorResult $result The result of the import. */ public function import_step_failed( string $step_name, StepProcessorResult $result ) { $this->log( sprintf( 'Import "%s" step failed', $step_name ), \WC_Log_Levels::ERROR, array( 'messages' => $result->get_messages( 'error' ), ) ); } } blueprint/src/Steps/InstallTheme.php 0000777 00000005767 15252010675 0013570 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Steps; /** * Class InstallTheme * * This class represents a step in the installation process of a WooCommerce theme. * It includes methods to prepare the data for the theme installation step and to provide * the schema for the JSON representation of this step. * * @package Automattic\WooCommerce\Blueprint\Steps */ class InstallTheme extends Step { /** * The slug of the theme to be installed. * * @var string The slug of the theme to be installed. */ private string $slug; /** * The resource URL or path to the theme's ZIP file. * * @var string The resource URL or path to the theme's ZIP file. */ private string $resource; /** * Additional options for the theme installation. * * @var array Additional options for the theme installation. */ private array $options; /** * InstallTheme constructor. * * @param string $slug The slug of the theme to be installed. * @param string $resource The resource URL or path to the theme's ZIP file. * @param array $options Additional options for the theme installation. */ // phpcs:ignore public function __construct( $slug, $resource, array $options = array() ) { $this->slug = $slug; $this->resource = $resource; $this->options = $options; } /** * Prepares an associative array for JSON encoding. * * @return array The JSON-encoded array representing this installation step. */ public function prepare_json_array(): array { return array( 'step' => static::get_step_name(), 'themeData' => array( 'resource' => $this->resource, 'slug' => $this->slug, ), 'options' => $this->options, ); } /** * Returns the schema for the JSON representation of this step. * * @param int $version The version of the schema to return. * @return array The schema array. */ public static function get_schema( int $version = 1 ): array { return array( 'type' => 'object', 'properties' => array( 'step' => array( 'type' => 'string', 'enum' => array( static::get_step_name() ), ), 'themeData' => array( 'anyOf' => array( require __DIR__ . '/schemas/definitions/VFSReference.php', require __DIR__ . '/schemas/definitions/LiteralReference.php', require __DIR__ . '/schemas/definitions/CorePluginReference.php', require __DIR__ . '/schemas/definitions/CoreThemeReference.php', require __DIR__ . '/schemas/definitions/UrlReference.php', require __DIR__ . '/schemas/definitions/GitDirectoryReference.php', require __DIR__ . '/schemas/definitions/DirectoryLiteralReference.php', ), ), 'options' => array( 'type' => 'object', 'properties' => array( 'activate' => array( 'type' => 'boolean', ), ), ), ), 'required' => array( 'step', 'themeData' ), ); } /** * Returns the name of this step. * * @return string The step name. */ public static function get_step_name(): string { return 'installTheme'; } } blueprint/src/Steps/schemas/definitions/UrlReference.php 0000777 00000001075 15252010675 0017502 0 ustar 00 <?php return array( 'type' => 'object', 'properties' => array( 'resource' => array( 'type' => 'string', 'const' => 'url', 'description' => 'Identifies the file resource as a URL', ), 'url' => array( 'type' => 'string', 'description' => 'The URL of the file', ), 'caption' => array( 'type' => 'string', 'description' => 'Optional caption for displaying a progress message', ), ), 'required' => array( 'resource', 'url', ), 'additionalProperties' => false, ); blueprint/src/Steps/schemas/definitions/DirectoryLiteralReference.php 0000777 00000000756 15252010675 0022226 0 ustar 00 <?php return array( 'type' => 'object', 'additionalProperties' => false, 'properties' => array( 'resource' => array( 'type' => 'string', 'const' => 'literal:directory', 'description' => 'Identifies the file resource as a git directory', ), 'files' => array( '$ref' => '#/definitions/FileTree', ), 'name' => array( 'type' => 'string', ), ), 'required' => array( 'files', 'name', 'resource', ), ); blueprint/src/Steps/schemas/definitions/GitDirectoryReference.php 0000777 00000001335 15252010675 0021347 0 ustar 00 <?php return array( 'type' => 'object', 'properties' => array( 'resource' => array( 'type' => 'string', 'const' => 'git:directory', 'description' => 'Identifies the file resource as a git directory', ), 'url' => array( 'type' => 'string', 'description' => 'The URL of the git repository', ), 'ref' => array( 'type' => 'string', 'description' => 'The branch of the git repository', ), 'path' => array( 'type' => 'string', 'description' => 'The path to the directory in the git repository', ), ), 'required' => array( 'resource', 'url', 'ref', 'path', ), 'additionalProperties' => false, ); blueprint/src/Steps/schemas/definitions/CorePluginReference.php 0000777 00000000760 15252010675 0021007 0 ustar 00 <?php return array( 'type' => 'object', 'properties' => array( 'resource' => array( 'type' => 'string', 'const' => 'wordpress.org/plugins', 'description' => 'Identifies the file resource as a WordPress Core plugin', ), 'slug' => array( 'type' => 'string', 'description' => 'The slug of the WordPress Core plugin', ), ), 'required' => array( 'resource', 'slug', ), 'additionalProperties' => false, ); blueprint/src/Steps/schemas/definitions/VFSReference.php 0000777 00000000724 15252010675 0017376 0 ustar 00 <?php return array( 'type' => 'object', 'properties' => array( 'resource' => array( 'type' => 'string', 'const' => 'vfs', 'description' => 'Identifies the file resource as Virtual File System (VFS)', ), 'path' => array( 'type' => 'string', 'description' => 'The path to the file in the VFS', ), ), 'required' => array( 'resource', 'path' ), 'additionalProperties' => false, ); blueprint/src/Steps/schemas/definitions/CoreThemeReference.php 0000777 00000000755 15252010675 0020617 0 ustar 00 <?php return array( 'type' => 'object', 'properties' => array( 'resource' => array( 'type' => 'string', 'const' => 'wordpress.org/themes', 'description' => 'Identifies the file resource as a WordPress Core theme', ), 'slug' => array( 'type' => 'string', 'description' => 'The slug of the WordPress Core theme', ), ), 'required' => array( 'resource', 'slug', ), 'additionalProperties' => false, ); blueprint/src/Steps/schemas/definitions/LiteralReference.php 0000777 00000003021 15252010675 0020325 0 ustar 00 <?php return array( 'type' => 'object', 'properties' => array( 'resource' => array( 'type' => 'string', 'const' => 'literal', 'description' => 'Identifies the file resource as a literal file', ), 'name' => array( 'type' => 'string', 'description' => 'The name of the file', ), 'contents' => array( 'anyOf' => array( array( 'type' => 'string', ), array( 'type' => 'object', 'properties' => array( 'BYTES_PER_ELEMENT' => array( 'type' => 'number', ), 'buffer' => array( 'type' => 'object', 'properties' => array( 'byteLength' => array( 'type' => 'number', ), ), 'required' => array( 'byteLength', ), 'additionalProperties' => false, ), 'byteLength' => array( 'type' => 'number', ), 'byteOffset' => array( 'type' => 'number', ), 'length' => array( 'type' => 'number', ), ), 'required' => array( 'BYTES_PER_ELEMENT', 'buffer', 'byteLength', 'byteOffset', 'length', ), 'additionalProperties' => array( 'type' => 'number', ), ), ), 'description' => 'The contents of the file', ), ), 'required' => array( 'resource', 'name', 'contents', ), 'additionalProperties' => false, ); blueprint/src/Steps/ActivateTheme.php 0000777 00000003041 15252010675 0013701 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Steps; /** * Class ActivateTheme * * @package Automattic\WooCommerce\Blueprint\Steps */ class ActivateTheme extends Step { /** * The name of the theme to be activated. * * @var string The name of the theme to be activated. */ private string $theme_folder_name; /** * ActivateTheme constructor. * * @param string $theme_folder_name The name of the theme to be activated. */ public function __construct( $theme_folder_name ) { $this->theme_folder_name = $theme_folder_name; } /** * Returns the name of this step. * * @return string The step name. */ public static function get_step_name(): string { return 'activateTheme'; } /** * Returns the schema for the JSON representation of this step. * * @param int $version The version of the schema to return. * @return array The schema array. */ public static function get_schema( int $version = 1 ): array { return array( 'type' => 'object', 'properties' => array( 'step' => array( 'type' => 'string', 'enum' => array( static::get_step_name() ), ), 'themeFolderName' => array( 'type' => 'string', ), ), 'required' => array( 'step', 'themeFolderName' ), ); } /** * Prepares an associative array for JSON encoding. * * @return array Array of data to be encoded as JSON. */ public function prepare_json_array(): array { return array( 'step' => static::get_step_name(), 'themeFolderName' => $this->theme_folder_name, ); } } blueprint/src/Steps/SetSiteOptions.php 0000777 00000002276 15252010675 0014123 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Steps; /** * Set site options step. */ class SetSiteOptions extends Step { /** * Site options. * * @var array site options */ private array $options; /** * Constructor. * * @param array $options site options. */ public function __construct( array $options = array() ) { $this->options = $options; } /** * Get the name of the step. * * @return string step name */ public static function get_step_name(): string { return 'setSiteOptions'; } /** * Get the schema for the step. * * @param int $version schema version. * * @return array schema for the step */ public static function get_schema( int $version = 1 ): array { return array( 'type' => 'object', 'properties' => array( 'step' => array( 'type' => 'string', 'enum' => array( static::get_step_name() ), ), ), 'required' => array( 'step' ), ); } /** * Prepare the step for JSON serialization. * * @return array array representation of the step */ public function prepare_json_array(): array { return array( 'step' => static::get_step_name(), 'options' => (object) $this->options, ); } } blueprint/src/Steps/Step.php 0000777 00000002662 15252010675 0012101 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Steps; /** * Abstract class Step * * This class defines the structure for a Step that requires arguments to perform an action. * You can think it as a function described in JSON format. * * A Step should also be capable of returning formatted data that can be imported later. * Additionally, a Step can validate data. */ abstract class Step { /** * Meta values for the step. * * @var array $meta_values */ protected array $meta_values = array(); /** * Get the step name. * * @return string */ abstract public static function get_step_name(): string; /** * Get the schema for this step. * * @param int $version The schema version. * * @return array */ abstract public static function get_schema( int $version = 1 ): array; /** * Prepare the JSON array for this step. * * @return array The JSON array for the step. */ abstract public function prepare_json_array(): array; /** * Set meta values for the step. * * @param array $meta_values The meta values. * * @return void */ public function set_meta_values( array $meta_values ) { $this->meta_values = $meta_values; } /** * Get the JSON array for the step. * * @return mixed */ public function get_json_array() { $json_array = $this->prepare_json_array(); if ( ! empty( $this->meta_values ) ) { $json_array['meta'] = $this->meta_values; } return $json_array; } } blueprint/src/Steps/RunSql.php 0000777 00000003617 15252010675 0012413 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Steps; /** * Class RunSql * * @package Automattic\WooCommerce\Blueprint\Steps */ class RunSql extends Step { /** * Sql code to run. * * @var string */ protected string $sql = ''; /** * Name of the sql file. * * @var string */ protected string $name = 'schema.sql'; /** * Constructor. * * @param string $sql Sql code to run. * @param string $name Name of the sql file. */ public function __construct( string $sql, $name = 'schema.sql' ) { $this->sql = $sql; $this->name = $name; } /** * Returns the name of this step. * * @return string The step name. */ public static function get_step_name(): string { return 'runSql'; } /** * Returns the schema for the JSON representation of this step. * * @param int $version The version of the schema to return. * @return array The schema array. */ public static function get_schema( int $version = 1 ): array { return array( 'type' => 'object', 'properties' => array( 'step' => array( 'type' => 'string', 'enum' => array( static::get_step_name() ), ), 'sql' => array( 'type' => 'object', 'required' => array( 'contents', 'resource', 'name' ), 'properties' => array( 'resource' => array( 'type' => 'string', 'enum' => array( 'literal' ), ), 'name' => array( 'type' => 'string', ), 'contents' => array( 'type' => 'string', ), ), ), ), 'required' => array( 'step', 'sql' ), ); } /** * Prepares an associative array for JSON encoding. * * @return array Array of data to be encoded as JSON. */ public function prepare_json_array(): array { return array( 'step' => static::get_step_name(), 'sql' => array( 'resource' => 'literal', 'name' => $this->name, 'contents' => $this->sql, ), ); } } blueprint/src/Steps/ActivatePlugin.php 0000777 00000003745 15252010675 0014110 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Steps; /** * Class ActivatePlugin * * @package Automattic\WooCommerce\Blueprint\Steps */ class ActivatePlugin extends Step { /** * The name of the plugin to be activated. * * @var string The name of the plugin to be activated. */ private string $plugin_name; /** * The path to the plugin file relative to the plugins directory. * * @var string The path to the plugin file relative to the plugins directory. */ private string $plugin_path; /** * ActivatePlugin constructor. * * @param string $plugin_path Path to the plugin file relative to the plugins directory. * @param string $plugin_name The name of the plugin to be activated. */ public function __construct( $plugin_path, $plugin_name = '' ) { $this->plugin_name = $plugin_name; $this->plugin_path = $plugin_path; } /** * Returns the name of this step. * * @return string The step name. */ public static function get_step_name(): string { return 'activatePlugin'; } /** * Returns the schema for the JSON representation of this step. * * @param int $version The version of the schema to return. * @return array The schema array. */ public static function get_schema( int $version = 1 ): array { return array( 'type' => 'object', 'properties' => array( 'step' => array( 'type' => 'string', 'enum' => array( static::get_step_name() ), ), 'pluginName' => array( 'type' => 'string', ), 'pluginPath' => array( 'type' => 'string', ), ), 'required' => array( 'step', 'pluginPath' ), ); } /** * Prepares an associative array for JSON encoding. * * @return array Array of data to be encoded as JSON. */ public function prepare_json_array(): array { $data = array( 'step' => static::get_step_name(), 'pluginPath' => $this->plugin_path, ); if ( ! empty( $this->plugin_name ) ) { $data['pluginName'] = $this->plugin_name; } return $data; } } blueprint/src/Steps/InstallPlugin.php 0000777 00000005774 15252010675 0013762 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\Steps; /** * Class InstallPlugin * * This class represents a step in the installation process of a WooCommerce plugin. * It includes methods to prepare the data for the plugin installation step and to provide * the schema for the JSON representation of this step. * * @package Automattic\WooCommerce\Blueprint\Steps */ class InstallPlugin extends Step { /** * The slug of the plugin to be installed. * * @var string The slug of the plugin to be installed. */ private string $slug; /** * The resource URL or path to the plugin's ZIP file. * * @var string The resource URL or path to the plugin's ZIP file. */ private string $resource; /** * Additional options for the plugin installation. * * @var array Additional options for the plugin installation. */ private array $options; /** * InstallPlugin constructor. * * @param string $slug The slug of the plugin to be installed. * @param string $resource The resource URL or path to the plugin's ZIP file. * @param array $options Additional options for the plugin installation. */ // phpcs:ignore public function __construct( $slug, $resource, array $options = array() ) { $this->slug = $slug; $this->resource = $resource; $this->options = $options; } /** * Prepares an associative array for JSON encoding. * * @return array Array representing this installation step. */ public function prepare_json_array(): array { return array( 'step' => static::get_step_name(), 'pluginData' => array( 'resource' => $this->resource, 'slug' => $this->slug, ), 'options' => $this->options, ); } /** * Returns the schema for the JSON representation of this step. * * @param int $version The version of the schema to return. * @return array The schema array. */ public static function get_schema( int $version = 1 ): array { return array( 'type' => 'object', 'properties' => array( 'step' => array( 'type' => 'string', 'enum' => array( static::get_step_name() ), ), 'pluginData' => array( 'anyOf' => array( require __DIR__ . '/schemas/definitions/VFSReference.php', require __DIR__ . '/schemas/definitions/LiteralReference.php', require __DIR__ . '/schemas/definitions/CorePluginReference.php', require __DIR__ . '/schemas/definitions/CoreThemeReference.php', require __DIR__ . '/schemas/definitions/UrlReference.php', require __DIR__ . '/schemas/definitions/GitDirectoryReference.php', require __DIR__ . '/schemas/definitions/DirectoryLiteralReference.php', ), ), 'options' => array( 'type' => 'object', 'properties' => array( 'activate' => array( 'type' => 'boolean', ), ), ), ), 'required' => array( 'step', 'pluginData' ), ); } /** * Returns the name of this step. * * @return string The step name. */ public static function get_step_name(): string { return 'installPlugin'; } } blueprint/src/BuiltInExporters.php 0000777 00000000732 15252010675 0013346 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use Automattic\WooCommerce\Blueprint\Exporters\ExportInstallPluginSteps; use Automattic\WooCommerce\Blueprint\Exporters\ExportInstallThemeSteps; /** * Built-in exporters. */ class BuiltInExporters { /** * Get all built-in exporters. * * @return array List of all built-in exporters. */ public function get_all() { return array( new ExportInstallPluginSteps(), new ExportInstallThemeSteps(), ); } } blueprint/src/Util.php 0000777 00000010613 15252010675 0011000 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use RecursiveArrayIterator; use RecursiveIteratorIterator; /** * Utility functions. */ class Util { /** * Ensure that the given path is a valid path within the WP_CONTENT_DIR. * * @param string $path The path to be validated. * * @return string * @throws \InvalidArgumentException If the path is invalid. */ public static function ensure_wp_content_path( $path ) { $path = realpath( $path ); if ( false === $path || strpos( $path, WP_CONTENT_DIR ) !== 0 ) { throw new \InvalidArgumentException( "Invalid path: $path" ); } return $path; } /** * Convert an array to an insert SQL query. * * @param array $row Array row with key and value. * @param string $table Name of the table. * @param string $type One of insert, insert ignore, replace into. * * @return false|string */ public static function array_to_insert_sql( $row, $table, $type = 'insert ignore' ) { if ( empty( $row ) || ! is_array( $row ) ) { return false; // Return false if input data is empty or not an array. } $allowed_types = array( 'insert', 'insert ignore', 'replace into' ); if ( ! in_array( $type, $allowed_types, true ) ) { return false; // Return false if input type is not valid. } // Get column names and values. $columns = '`' . implode( '`, `', array_keys( $row ) ) . '`'; $escaped_values = array_map( fn( $value ) => "'" . addslashes( $value ) . "'", $row ); $values = implode( ', ', $escaped_values ); // Construct final SQL query. return "{$type} `$table` ($columns) VALUES ($values);"; } /** * Convert a string from snake_case to camelCase. * * @param string $string_to_convert The string to be converted. * * @return string */ public static function snake_to_camel( $string_to_convert ) { // Split the string by underscores. $words = explode( '_', $string_to_convert ); // Capitalize the first letter of each word. $words = array_map( 'ucfirst', $words ); // Join the words back together. return implode( '', $words ); } /** * Flatten an array. * * @param array $array_to_flatten The array to be flattened. * * @return \RecursiveIteratorIterator */ public static function array_flatten( $array_to_flatten ) { return new RecursiveIteratorIterator( new RecursiveArrayIterator( $array_to_flatten ) ); } /** * Convert a string from camelCase to snake_case. * * @param string $input The string to be converted. * * @return string */ public static function camel_to_snake( $input ) { // Replace all uppercase letters with an underscore followed by the lowercase version of the letter. $pattern = '/([a-z])([A-Z])/'; $replacement = '$1_$2'; $snake = preg_replace( $pattern, $replacement, $input ); // Replace spaces with underscores. $snake = str_replace( ' ', '_', $snake ); // Convert the entire string to lowercase. return strtolower( $snake ); } /** * Index an array using a callback function. * * @param array $array The array to be indexed. * @param callable $callback The callback function to be called for each element. * * @return array */ // phpcs:ignore public static function index_array( $array, $callback ) { $result = array(); foreach ( $array as $key => $value ) { $new_key = $callback( $key, $value ); $result[ $new_key ] = $value; } return $result; } /** * Check to see if given string is a valid WordPress plugin slug. * * @param string $slug The slug to be validated. * * @return bool */ public static function is_valid_wp_plugin_slug( $slug ) { // Check if the slug only contains allowed characters. if ( preg_match( '/^[a-z0-9-]+$/', $slug ) ) { return true; } return false; } /** * Recursively delete a directory. * * @param string $dir_path The path to the directory. * * @return void * @throws \InvalidArgumentException If $dir_path is not a directory. */ public static function delete_dir( $dir_path ) { if ( ! is_dir( $dir_path ) ) { throw new \InvalidArgumentException( "$dir_path must be a directory" ); } if ( substr( $dir_path, strlen( $dir_path ) - 1, 1 ) !== '/' ) { $dir_path .= '/'; } $files = glob( $dir_path . '*', GLOB_MARK ); foreach ( $files as $file ) { if ( is_dir( $file ) ) { static::delete_dir( $file ); } else { // phpcs:ignore unlink( $file ); } } // phpcs:ignore rmdir( $dir_path ); } } blueprint/src/ResourceStorages/LocalPluginResourceStorage.php 0000777 00000002406 15252010675 0020631 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\ResourceStorages; /** * Class LocalPluginResourceStorage */ class LocalPluginResourceStorage implements ResourceStorage { /** * Paths to the directories containing the plugins. * * @var array The paths to the directories containing the plugins. */ protected array $paths = array(); /** * Suffix of the plugin files. * * @var string The suffix of the plugin files. */ protected string $suffix = 'plugins'; /** * LocalPluginResourceStorage constructor. * * @param string $path The path to the directory containing the plugins. */ public function __construct( $path ) { $this->paths[] = $path; } /** * Local plugins are already included (downloaded) in the zip file. * Return the full path. * * @param string $slug The slug of the plugin to be downloaded. * * @return string|null */ public function download( $slug ): ?string { foreach ( $this->paths as $path ) { $full_path = $path . "/{$this->suffix}/" . $slug . '.zip'; if ( is_file( $full_path ) ) { return $full_path; } } return null; } /** * Get the supported resource. * * @return string The supported resource. */ public function get_supported_resource(): string { return 'self/plugins'; } } blueprint/src/ResourceStorages/OrgThemeResourceStorage.php 0000777 00000001546 15252010675 0020136 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\ResourceStorages; /** * Class OrgThemeResourceStorage */ class OrgThemeResourceStorage extends OrgPluginResourceStorage { /** * Get the download link. * * @param string $slug The slug of the theme to be downloaded. * * @return string|null The download link. */ protected function get_download_link( $slug ): ?string { $info = $this->wp_themes_api( 'theme_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false, ), ) ); if ( is_wp_error( $info ) ) { return null; } if ( isset( $info->download_link ) ) { return $info->download_link; } return null; } /** * Get the supported resource. * * @return string The supported resource. */ public function get_supported_resource(): string { return 'wordpress.org/themes'; } } blueprint/src/ResourceStorages/OrgPluginResourceStorage.php 0000777 00000003632 15252010675 0020330 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\ResourceStorages; use Automattic\WooCommerce\Blueprint\UseWPFunctions; /** * Class OrgPluginResourceStorage * * This class handles the storage and downloading of plugins from wordpress.org. * * @package Automattic\WooCommerce\Blueprint\ResourceStorages */ class OrgPluginResourceStorage implements ResourceStorage { use UseWPFunctions; /** * Download the plugin from wordpress.org * * @param string $slug The slug of the plugin to be downloaded. * * @return string|false The path to the downloaded plugin file, or false on failure. */ public function download( $slug ): ?string { $download_link = $this->get_download_link( $slug ); if ( ! $download_link ) { return false; } $result = $this->download_url( $download_link ); if ( is_wp_error( $result ) ) { return false; } return $result; } /** * Download the file from the given URL. * * @param string $url The URL to download the file from. * * @return string|WP_Error The path to the downloaded file, or WP_Error on failure. */ protected function download_url( $url ) { return $this->wp_download_url( $url ); } /** * Get the download link for a plugin from wordpress.org. * * @param string $slug The slug of the plugin. * * @return string|null The download link, or null if not found. */ protected function get_download_link( $slug ): ?string { $info = $this->wp_plugins_api( 'plugin_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false, ), ) ); if ( is_wp_error( $info ) ) { return null; } if ( is_object( $info ) && isset( $info->download_link ) ) { return $info->download_link; } return null; } /** * Get the supported resource type. * * @return string The supported resource type. */ public function get_supported_resource(): string { return 'wordpress.org/plugins'; } } blueprint/src/ResourceStorages/LocalThemeResourceStorage.php 0000777 00000000700 15252010675 0020430 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\ResourceStorages; /** * Class LocalThemeResourceStorage */ class LocalThemeResourceStorage extends LocalPluginResourceStorage { /** * The suffix. * * @var string The suffix. */ protected string $suffix = 'themes'; /** * Get the supported resource. * * @return string The supported resource. */ public function get_supported_resource(): string { return 'self/themes'; } } blueprint/src/ResourceStorages/ResourceStorage.php 0000777 00000001321 15252010675 0016472 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint\ResourceStorages; /** * Interface ResourceStorage * * ResourceStorage is an abstraction layer for various storages for WordPress files * such as plugins and themes. It provides a common interface for downloading * the files whether they are stored locally or remotely. * * @package Automattic\WooCommerce\Blueprint\ResourceStorages */ interface ResourceStorage { /** * Return supported resource type. * * @return string */ public function get_supported_resource(): string; /** * Download the resource. * * @param string $slug resource slug. * * @return string|null downloaded local path. */ public function download( $slug ): ?string; } blueprint/src/ImportStep.php 0000777 00000010734 15252010675 0012175 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use Opis\JsonSchema\Errors\ErrorFormatter; use Opis\JsonSchema\Validator; use Automattic\WooCommerce\Blueprint\Logger; /** * Class ImportStep * * Import a single step from a JSON definition. * * @package Automattic\WooCommerce\Blueprint */ class ImportStep { use UseWPFunctions; /** * Step definition. * * @var object The step definition. */ private object $step_definition; /** * Validator object. * * @var Validator The JSON schema validator instance. */ private Validator $validator; /** * Built-in step processors. * * @var BuiltInStepProcessors The built-in step processors instance. */ private BuiltInStepProcessors $builtin_step_processors; /** * Importers. * * @var array|mixed The importers. */ private array $importers; /** * Indexed importers. * * @var array The indexed importers by step name. */ private array $indexed_importers; /** * ImportStep constructor. * * @param object $step_definition The step definition. * @param Validator|null $validator The validator instance, optional. */ public function __construct( $step_definition, ?Validator $validator = null ) { $this->step_definition = $step_definition; if ( null === $validator ) { $validator = new Validator(); } $this->validator = $validator; $this->importers = $this->wp_apply_filters( 'wooblueprint_importers', ( ( new BuiltInStepProcessors() )->get_all() ) ); $this->indexed_importers = Util::index_array( $this->importers, function ( $key, $importer ) { return $importer->get_step_class()::get_step_name(); } ); } /** * Import the schema steps. * * @return StepProcessorResult */ public function import() { $result = StepProcessorResult::success( $this->step_definition->step ); if ( ! $this->can_import( $result ) ) { return $result; } $importer = $this->indexed_importers[ $this->step_definition->step ]; $logger = new Logger(); $logger->start_import( $this->step_definition->step, get_class( $importer ) ); $importer_result = $importer->process( $this->step_definition ); if ( $importer_result->is_success() ) { $logger->complete_import( $this->step_definition->step, $importer_result ); } else { $logger->import_step_failed( $this->step_definition->step, $importer_result ); } $result->merge_messages( $importer_result ); return $result; } /** * Check if the step can be imported. * * @param StepProcessorResult $result The result object to add messages to. * * @return bool True if the step can be imported, false otherwise. */ protected function can_import( &$result ) { // Check if the importer exists. if ( ! isset( $this->indexed_importers[ $this->step_definition->step ] ) ) { $result->add_error( 'Unable to find an importer' ); return false; } $importer = $this->indexed_importers[ $this->step_definition->step ]; // Validate importer is a step processor before processing. if ( ! $importer instanceof StepProcessor ) { $result->add_error( 'Incorrect importer type' ); return false; } // Validate steps schemas before processing. if ( ! $this->validate_step_schemas( $importer, $result ) ) { $result->add_error( 'Schema validation failed for step' ); return false; } // Validate step capabilities before processing. if ( ! $importer->check_step_capabilities( $this->step_definition ) ) { $result->add_error( 'User does not have the required capabilities to run step' ); return false; } return true; } /** * Validate the step schemas. * * @param StepProcessor $importer The importer. * @param StepProcessorResult $result The result object to add messages to. * * @return bool True if the step schemas are valid, false otherwise. */ protected function validate_step_schemas( StepProcessor $importer, StepProcessorResult $result ) { $step_schema = call_user_func( array( $importer->get_step_class(), 'get_schema' ) ); $validate = $this->validator->validate( $this->step_definition, wp_json_encode( $step_schema ) ); if ( ! $validate->isValid() ) { $result->add_error( "Schema validation failed for step {$this->step_definition->step}" ); $errors = ( new ErrorFormatter() )->format( $validate->error() ); $formatted_errors = array(); foreach ( $errors as $value ) { $formatted_errors[] = implode( "\n", $value ); } $result->add_error( implode( "\n", $formatted_errors ) ); return false; } return true; } } blueprint/src/Cli.php 0000777 00000003437 15252010675 0010600 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use Automattic\WooCommerce\Blueprint\Cli\ExportCli; use Automattic\WooCommerce\Blueprint\Cli\ImportCli; $autoload_path = __DIR__ . '/../vendor/autoload.php'; if ( file_exists( $autoload_path ) ) { require_once $autoload_path; } /** * Class Cli. * * This class is included and execute from WC_CLI(class-wc-cli.php) to register * WP CLI commands. */ class Cli { /** * Register WP CLI commands. * * @return void */ public static function register_commands() { \WP_CLI::add_command( 'wc blueprint import', function ( $args, $assoc_args ) { $import = new ImportCli( $args[0] ); $import->run( $assoc_args ); }, array( 'synopsis' => array( array( 'type' => 'positional', 'name' => 'schema-path', 'optional' => false, ), array( 'type' => 'assoc', 'name' => 'show-messages', 'optional' => true, 'options' => array( 'all', 'error', 'info', 'debug' ), ), ), 'when' => 'after_wp_load', ) ); \WP_CLI::add_command( 'wc blueprint export', function ( $args, $assoc_args ) { $export = new ExportCli( $args[0] ); $steps = array(); if ( isset( $assoc_args['steps'] ) ) { $steps = array_map( function ( $step ) { return trim( $step ); }, explode( ',', $assoc_args['steps'] ) ); } $export->run( array( 'steps' => $steps, 'format' => 'json', ) ); }, array( 'synopsis' => array( array( 'type' => 'positional', 'name' => 'save-to', 'optional' => false, ), array( 'type' => 'assoc', 'name' => 'steps', 'optional' => true, ), ), 'when' => 'after_wp_load', ) ); } } blueprint/src/BuiltInStepProcessors.php 0000777 00000003474 15252010675 0014357 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use Automattic\WooCommerce\Blueprint\Importers\ImportActivatePlugin; use Automattic\WooCommerce\Blueprint\Importers\ImportActivateTheme; use Automattic\WooCommerce\Blueprint\Importers\ImportInstallPlugin; use Automattic\WooCommerce\Blueprint\Importers\ImportInstallTheme; use Automattic\WooCommerce\Blueprint\Importers\ImportRunSql; use Automattic\WooCommerce\Blueprint\Importers\ImportSetSiteOptions; use Automattic\WooCommerce\Blueprint\ResourceStorages\OrgPluginResourceStorage; use Automattic\WooCommerce\Blueprint\ResourceStorages\OrgThemeResourceStorage; /** * Class BuiltInStepProcessors * * @package Automattic\WooCommerce\Blueprint */ class BuiltInStepProcessors { /** * BuiltInStepProcessors constructor. */ public function __construct() { } /** * Returns an array of all step processors. * * @return array The array of step processors. */ public function get_all() { return array( $this->create_install_plugins_processor(), $this->create_install_themes_processor(), new ImportSetSiteOptions(), new ImportActivatePlugin(), new ImportActivateTheme(), new ImportRunSql(), ); } /** * Creates the processor for installing plugins. * * @return ImportInstallPlugin The processor for installing plugins. */ private function create_install_plugins_processor() { $storages = new ResourceStorages(); $storages->add_storage( new OrgPluginResourceStorage() ); return new ImportInstallPlugin( $storages ); } /** * Creates the processor for installing themes. * * @return ImportInstallTheme The processor for installing themes. */ private function create_install_themes_processor() { $storage = new ResourceStorages(); $storage->add_storage( new OrgThemeResourceStorage() ); return new ImportInstallTheme( $storage ); } } blueprint/src/ExportSchema.php 0000777 00000010464 15252010675 0012471 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use Automattic\WooCommerce\Blueprint\Exporters\StepExporter; use Automattic\WooCommerce\Blueprint\Exporters\HasAlias; use Automattic\WooCommerce\Blueprint\Logger; use Automattic\WooCommerce\Blueprint\Steps\Step; use WP_Error; /** * Class ExportSchema * * Handles the export schema functionality for WooCommerce. * * @package Automattic\WooCommerce\Blueprint */ class ExportSchema { use UseWPFunctions; use UsePubSub; /** * Step exporters. * * @var StepExporter[] Array of step exporters. */ protected array $exporters = array(); /** * ExportSchema constructor. * * @param StepExporter[] $exporters Array of step exporters. */ public function __construct( $exporters = array() ) { $this->exporters = $exporters; } /** * Export the schema steps. * * @param string[] $steps Array of step names to export, optional. * * @return array|WP_Error The exported schema array or a WP_Error if the export fails. */ public function export( $steps = array() ) { $loading_page_path = $this->wp_apply_filters( 'wooblueprint_export_landingpage', '/' ); /** * Validate that the landing page path is a valid relative local URL path. * * Accepts: * - / * - /path/to/page * * Rejects: * - http://example.com/path/to/page * - invalid-path */ if ( ! preg_match( '#^/$|^/[^/].*#', $loading_page_path ) ) { return new WP_Error( 'wooblueprint_invalid_landing_page_path', 'Invalid loading page path.' ); } $schema = array( 'landingPage' => $loading_page_path, 'steps' => array(), ); $built_in_exporters = ( new BuiltInExporters() )->get_all(); /** * Filters the step exporters. * * Allows adding/removing custom step exporters. * * @param StepExporter[] $exporters Array of step exporters. * * @since 0.0.1 */ $exporters = $this->wp_apply_filters( 'wooblueprint_exporters', array_merge( $this->exporters, $built_in_exporters ) ); // Validate that the exporters are instances of StepExporter. $exporters = array_filter( $exporters, function ( $exporter ) { return $exporter instanceof StepExporter; } ); // Filter out any exporters that are not in the list of steps to export. if ( count( $steps ) ) { foreach ( $exporters as $key => $exporter ) { $name = $exporter->get_step_name(); $alias = $exporter instanceof HasAlias ? $exporter->get_alias() : $name; if ( ! in_array( $name, $steps, true ) && ! in_array( $alias, $steps, true ) ) { unset( $exporters[ $key ] ); } } } // Make sure the user has the required capabilities to export the steps. foreach ( $exporters as $exporter ) { if ( ! $exporter->check_step_capabilities() ) { return new WP_Error( 'wooblueprint_insufficient_permissions', 'Insufficient permissions to export for step: ' . $exporter->get_step_name() ); } } $logger = new Logger(); $logger->start_export( $exporters ); foreach ( $exporters as $exporter ) { try { $this->publish( 'onBeforeExport', $exporter ); $step = $exporter->export(); $this->add_result_to_schema( $schema, $step ); } catch ( \Throwable $e ) { $step_name = $exporter instanceof HasAlias ? $exporter->get_alias() : $exporter->get_step_name(); $logger->export_step_failed( $step_name, $e ); return new WP_Error( 'wooblueprint_export_step_failed', 'Export step failed: ' . $e->getMessage() ); } } $logger->complete_export( $exporters ); return $schema; } /** * Subscribe to the onBeforeExport event. * * @param string $step_name The step name to subscribe to. * @param callable $callback The callback to execute. */ public function on_before_export( $step_name, $callback ) { $this->subscribe( 'onBeforeExport', function ( $exporter ) use ( $step_name, $callback ) { if ( $step_name === $exporter->get_step_name() ) { $callback( $exporter ); } } ); } /** * Add export result to the schema array. * * @param array $schema Schema array to add steps to. * @param array|Step $step Step or array of steps to add. */ private function add_result_to_schema( array &$schema, $step ): void { if ( is_array( $step ) ) { foreach ( $step as $_step ) { $schema['steps'][] = $_step->get_json_array(); } return; } $schema['steps'][] = $step->get_json_array(); } } blueprint/src/StepProcessor.php 0000777 00000001250 15252010675 0012673 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; /** * Interface StepProcessor */ interface StepProcessor { /** * Process the schema. * * @param object $schema The schema to process. * * @return StepProcessorResult */ public function process( $schema ): StepProcessorResult; /** * Get the step class. * * @return string */ public function get_step_class(): string; /** * Check if the current user has the required capabilities for this step. * * @param object $schema The schema to process. * * @return bool True if the user has the required capabilities. False otherwise. */ public function check_step_capabilities( $schema ): bool; } blueprint/src/ResourceStorages.php 0000777 00000002717 15252010675 0013370 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use Automattic\WooCommerce\Blueprint\ResourceStorages\ResourceStorage; /** * Class ResourceStorages */ class ResourceStorages { /** * Storage collection. * * @var ResourceStorages[] */ protected array $storages = array(); /** * Add a downloader. * * @param ResourceStorage $downloader The downloader to add. * * @return void */ public function add_storage( ResourceStorage $downloader ) { $supported_resource = $downloader->get_supported_resource(); if ( ! isset( $this->storages[ $supported_resource ] ) ) { $this->storages[ $supported_resource ] = array(); } $this->storages[ $supported_resource ][] = $downloader; } /** * Check if the resource is supported. * * @param string $resource_type The resource type to check. * * @return bool */ public function is_supported_resource( $resource_type ) { return isset( $this->storages[ $resource_type ] ); } /** * Download the resource. * * @param string $slug The slug of the resource to download. * @param string $resource_type The resource type to download. * * @return false|string */ public function download( $slug, $resource_type ) { if ( ! isset( $this->storages[ $resource_type ] ) ) { return false; } $storages = $this->storages[ $resource_type ]; foreach ( $storages as $storage ) { $found = $storage->download( $slug ); if ( $found ) { return $found; } } return false; } } blueprint/src/UsePluginHelpers.php 0000777 00000006202 15252010675 0013320 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; trait UsePluginHelpers { use UseWPFunctions; /** * Activate a plugin by its slug. * * Searches for the plugin with the specified slug in the installed plugins * and activates it. * * @param string $slug The slug of the plugin to activate. * * @return false|null|WP_Error Null on success, WP_Error on invalid file, false if not found. */ public function activate_plugin_by_slug( $slug ) { // Get all installed plugins. $all_plugins = $this->wp_get_plugins(); // Loop through all plugins to find the one with the specified slug. foreach ( $all_plugins as $plugin_path => $plugin_info ) { // Check if the plugin path contains the slug. if ( strpos( $plugin_path, $slug . '/' ) === 0 ) { // Deactivate the plugin. return $this->wp_activate_plugin( $plugin_path ); } } return false; } /** * Check if a plugin with the specified slug is installed. * * @param string $slug The slug of the plugin to check. * * @return bool */ public function is_plugin_dir( $slug ) { $all_plugins = $this->wp_get_plugins(); foreach ( $all_plugins as $plugin_file => $plugin_data ) { // Extract the directory name from the plugin file path. $plugin_dir = explode( '/', $plugin_file )[0]; // Check for an exact match with the slug. if ( $plugin_dir === $slug ) { return true; } } return false; } /** * Deactivate and delete a plugin by its slug. * * Searches for the plugin with the specified slug in the installed plugins, * deactivates it if active, and then deletes it. * * @param string $slug The slug of the plugin to delete. * * @return bool|WP_Error True if the plugin was deleted, false otherwise. */ public function delete_plugin_by_slug( $slug ) { // Get all installed plugins. $all_plugins = $this->wp_get_plugins(); // Loop through all plugins to find the one with the specified slug. foreach ( $all_plugins as $plugin_path => $plugin_info ) { // Check if the plugin path contains the slug. if ( strpos( $plugin_path, $slug . '/' ) === 0 ) { // Deactivate the plugin. if ( $this->deactivate_plugin_by_slug( $slug ) ) { // Delete the plugin. return $this->wp_delete_plugins( array( $plugin_path ) ); } } } return false; } /** * Deactivate a plugin by its slug. * * Searches for the plugin with the specified slug in the installed plugins * and deactivates it. * * @param string $slug The slug of the plugin to deactivate. * * @return bool True if the plugin was deactivated, false otherwise. */ public function deactivate_plugin_by_slug( $slug ) { // Get all installed plugins. $all_plugins = $this->wp_get_plugins(); // Loop through all plugins to find the one with the specified slug. foreach ( $all_plugins as $plugin_path => $plugin_info ) { // Check if the plugin path contains the slug. if ( strpos( $plugin_path, $slug . '/' ) === 0 ) { // Deactivate the plugin. deactivate_plugins( $plugin_path ); // Check if the plugin has been deactivated. if ( ! is_plugin_active( $plugin_path ) ) { return true; } } } return false; } } blueprint/src/ClassExtractor.php 0000777 00000014070 15252010675 0013025 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; /** * Class ClassExtractor * * Provides functionality to manipulate PHP class files by replacing variables, * adding prefixes, and removing strict types declarations. * * This class is used to generate 'code' part for runPHP step from a template file. */ class ClassExtractor { /** * Path to the PHP file being processed. * * @var string */ private string $file_path; /** * Whether the file contains a strict types declaration. * * @var bool */ private bool $has_strict_types_declaration = false; /** * PHP code to prefix to the final output. * * @var string */ private string $prefix = ''; /** * Replacements for class variables. * * @var array */ private array $class_variable_replacements = array(); /** * Replacements for method variables. * * @var array */ private array $method_variable_replacements = array(); /** * Constructor. * * @param string $file_path Path to the PHP file to process. * * @throws \InvalidArgumentException If the file does not exist. */ public function __construct( string $file_path ) { if ( ! file_exists( $file_path ) ) { throw new \InvalidArgumentException( "File not found: $file_path" ); } $this->file_path = $file_path; } /** * Adds a prefix to include the WordPress wp-load.php file. * * @return $this */ public function with_wp_load() { $this->prefix .= "<?php require_once 'wordpress/wp-load.php'; "; return $this; } /** * Replaces a class variable with a new value. * * @param string $variable_name Name of the class variable. * @param mixed $new_value The new value to assign to the variable. * * @return $this */ public function replace_class_variable( $variable_name, $new_value ) { $this->class_variable_replacements[ $variable_name ] = $new_value; return $this; } /** * Replaces a variable inside a method with a new value. * * @param string $method_name Name of the method. * @param string $variable_name Name of the variable to replace. * @param mixed $new_value The new value to assign to the variable. * * @return $this */ public function replace_method_variable( $method_name, $variable_name, $new_value ) { $this->method_variable_replacements[] = array( 'method' => $method_name, 'variable' => $variable_name, 'value' => $new_value, ); return $this; } /** * Generates the processed PHP code with applied replacements and prefixes. * * @return string The modified PHP code. */ public function get_code() { // Security check: Check if we can replace this with a more secure function. $file_content = file_get_contents( $this->file_path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents $file_content = preg_replace( '/<\?php\s*/', '', $file_content ); if ( preg_match( '/declare\s*\(\s*strict_types\s*=\s*1\s*\)\s*;/', $file_content ) ) { $this->has_strict_types_declaration = true; $file_content = preg_replace( '/declare\s*\(\s*strict_types\s*=\s*1\s*\)\s*;/', '', $file_content ); } $file_content = preg_replace( '/\/\*.*?\*\/|\/\/.*?(?=\r?\n)/s', '', $file_content ); foreach ( $this->class_variable_replacements as $variable => $value ) { $file_content = $this->apply_class_variable_replacement( $file_content, $variable, $value ); } foreach ( $this->method_variable_replacements as $replacement ) { $file_content = $this->apply_variable_replacement( $file_content, $replacement['method'], $replacement['variable'], $replacement['value'] ); } return $this->prefix . trim( $file_content ); } /** * Applies a replacement to a class variable in the file content. * * @param string $file_content The content of the PHP file. * @param string $variable_name The name of the variable to replace. * @param mixed $new_value The new value for the variable. * * @return string The updated file content. */ private function apply_class_variable_replacement( $file_content, $variable_name, $new_value ) { // Security check: Check if it's necessary to use var_export. $replacement_value = var_export( $new_value, true ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export $pattern = '/(protected|private|public)\s+\$' . preg_quote( $variable_name, '/' ) . '\s*=\s*.*?;|' . '(protected|private|public)\s+\$' . preg_quote( $variable_name, '/' ) . '\s*;?/'; $replacement = "$1 \$$variable_name = $replacement_value;"; return preg_replace( $pattern, $replacement, $file_content, 1 ); } /** * Applies a replacement to a variable in a specific method. * * @param string $file_content The content of the PHP file. * @param string $method_name The name of the method containing the variable. * @param string $variable_name The name of the variable to replace. * @param mixed $new_value The new value for the variable. * * @return string The updated file content. */ private function apply_variable_replacement( $file_content, $method_name, $variable_name, $new_value ) { $pattern = '/function\s+' . preg_quote( $method_name, '/' ) . '\s*\([^)]*\)\s*\{\s*(.*?)\s*\}/s'; if ( preg_match( $pattern, $file_content, $matches ) ) { $method_body = $matches[1]; // Security check: Check if it's necessary to use var_export. $new_value_exported = var_export( $new_value, true ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export $variable_pattern = '/\$' . preg_quote( $variable_name, '/' ) . '\s*=\s*[^;]+;/'; $replacement = '$' . $variable_name . ' = ' . $new_value_exported . ';'; $updated_method_body = preg_replace( $variable_pattern, $replacement, $method_body, 1 ); if ( null !== $updated_method_body ) { $file_content = str_replace( $method_body, $updated_method_body, $file_content ); } } return $file_content; } /** * Checks if the file has a strict types declaration. * * @return bool True if the file has a strict types declaration, false otherwise. */ public function has_strict_type_declaration() { return $this->has_strict_types_declaration; } } blueprint/src/UseWPFunctions.php 0000777 00000023336 15252010675 0012765 0 ustar 00 <?php namespace Automattic\WooCommerce\Blueprint; use WP_Error; use WP_Theme; /** * Trait UseWPFunctions */ trait UseWPFunctions { /** * Whether the filesystem has been initialized. * * @var bool */ private $filesystem_initialized = false; /** * Adds a filter to a specified tag. * * @param string $tag The name of the filter to hook the $function_to_add to. * @param callable $function_to_add The callback to be run when the filter is applied. * @param int $priority Optional. Used to specify the order in which the functions * associated with a particular action are executed. Default 10. * @param int $accepted_args Optional. The number of arguments the function accepts. Default 1. */ public function wp_add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) { add_filter( $tag, $function_to_add, $priority, $accepted_args ); } /** * Adds an action to a specified tag. * * @param string $tag The name of the action to hook the $function_to_add to. * @param callable $function_to_add The callback to be run when the action is triggered. * @param int $priority Optional. Used to specify the order in which the functions * associated with a particular action are executed. Default 10. * @param int $accepted_args Optional. The number of arguments the function accepts. Default 1. */ public function wp_add_action( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) { add_action( $tag, $function_to_add, $priority, $accepted_args ); } /** * Calls the functions added to a filter hook. * * @param string $tag The name of the filter hook. * @param mixed $value The value on which the filters hooked to $tag are applied on. * @return mixed The filtered value after all hooked functions are applied to it. */ // phpcs:ignore public function wp_apply_filters( $tag, $value ) { $args = func_get_args(); return call_user_func_array( 'apply_filters', $args ); } /** * Executes the functions hooked on a specific action hook. * * @param string $tag The name of the action to be executed. * @param mixed ...$args Optional. Additional arguments which are passed on to the functions hooked to the action. */ public function wp_do_action( $tag, ...$args ) { // phpcs:ignore do_action( $tag, ...$args ); } /** * Checks if a plugin is active. * * @param string $plugin Path to the plugin file relative to the plugins directory. * @return bool True if the plugin is active, false otherwise. */ public function wp_is_plugin_active( string $plugin ) { if ( ! function_exists( 'is_plugin_active' ) || ! function_exists( 'get_plugins' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin.php'; } return is_plugin_active( $plugin ); } /** * Retrieves plugin information from the WordPress Plugin API. * * @param string $action The type of information to retrieve from the API. * @param array $args Optional. Arguments to pass to the API. * @return object|WP_Error The API response object or WP_Error on failure. */ public function wp_plugins_api( $action, $args = array() ) { if ( ! function_exists( 'plugins_api' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin-install.php'; } return plugins_api( $action, $args ); } /** * Retrieves all plugins. * * @param string $plugin_folder Optional. Path to the plugin folder to scan. * @return array Array of plugins. */ public function wp_get_plugins( string $plugin_folder = '' ) { if ( ! function_exists( 'get_plugins' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin.php'; } return get_plugins( $plugin_folder ); } /** * Retrieves all themes. * * @param array $args Optional. Arguments to pass to the API. * @return array Array of themes. */ public function wp_get_themes( $args = array() ) { return wp_get_themes( $args ); } /** * Retrieves a theme. * * @param string|null $stylesheet Optional. The theme's stylesheet name. * @return WP_Theme The theme object. */ public function wp_get_theme( $stylesheet = null ) { if ( ! function_exists( 'wp_get_theme' ) ) { require_once ABSPATH . 'wp-admin/includes/theme.php'; } return wp_get_theme( $stylesheet ); } /** * Retrieves theme information from the WordPress Theme API. * * @param string $action The type of information to retrieve from the API. * @param array $args Optional. Arguments to pass to the API. * @return object|WP_Error The API response object or WP_Error on failure. */ public function wp_themes_api( $action, $args = array() ) { if ( ! function_exists( 'themes_api' ) ) { require_once ABSPATH . 'wp-admin/includes/theme.php'; } return themes_api( $action, $args ); } /** * Activates a plugin. * * @param string $plugin Path to the plugin file relative to the plugins directory. * @param string $redirect Optional. URL to redirect to after activation. * @param bool $network_wide Optional. Whether to enable the plugin for all sites in the network. * @param bool $silent Optional. Whether to prevent calling activation hooks. * @return WP_Error|null WP_Error on failure, null on success. */ public function wp_activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) { if ( ! function_exists( 'activate_plugin' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin.php'; } return activate_plugin( $plugin, $redirect, $network_wide, $silent ); } /** * Deletes plugins. * * @param array $plugins List of plugins to delete. * @return array|WP_Error|null Array of results or WP_Error on failure, null if filesystem credentials are required to proceed. */ public function wp_delete_plugins( $plugins ) { if ( ! function_exists( 'delete_plugins' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin.php'; } return delete_plugins( $plugins ); } /** * Updates an option in the database. * * @param string $option Name of the option to update. * @param mixed $value New value for the option. * @param string|null $autoload Optional. Whether to load the option when WordPress starts up. * @return bool True if option was updated, false otherwise. */ public function wp_update_option( $option, $value, $autoload = null ) { return update_option( $option, $value, $autoload ); } /** * Retrieves an option from the database. * * @param string $option Name of the option to retrieve. * @param mixed $default_value Optional. Default value to return if the option does not exist. * @return mixed Value of the option or $default if the option does not exist. */ public function wp_get_option( $option, $default_value = false ) { return get_option( $option, $default_value ); } /** * Switches the current theme. * * @param string $name The name of the theme to switch to. */ public function wp_switch_theme( $name ) { if ( ! function_exists( 'switch_theme' ) ) { require_once ABSPATH . 'wp-admin/includes/theme.php'; } switch_theme( $name ); } /** * Initializes the WordPress filesystem. * * @return bool */ public function wp_init_filesystem() { if ( ! $this->filesystem_initialized ) { if ( ! class_exists( 'WP_Filesystem' ) ) { require_once ABSPATH . 'wp-admin/includes/file.php'; } $initialized = WP_Filesystem(); $this->filesystem_initialized = $initialized; return $initialized; } return true; } /** * Unzips a file to a specified location. * * @param string $path Path to the ZIP file. * @param string $to Destination directory. * @return bool|WP_Error True on success, WP_Error on failure. */ public function wp_unzip_file( $path, $to ) { $this->wp_init_filesystem(); return unzip_file( $path, $to ); } /** * Retrieves the upload directory information. * * @return array Array of upload directory information. */ public function wp_upload_dir() { return \wp_upload_dir(); } /** * Retrieves the root directory of the current theme. * * @return string The root directory of the current theme. */ public function wp_get_theme_root() { return \get_theme_root(); } /** * Checks if a variable is a WP_Error. * * @param mixed $thing Variable to check. * @return bool True if the variable is a WP_Error, false otherwise. */ public function is_wp_error( $thing ) { return is_wp_error( $thing ); } /** * Downloads a file from a URL. * * @param string $url The URL of the file to download. * @return string|WP_Error The local file path on success, WP_Error on failure. */ public function wp_download_url( $url ) { if ( ! function_exists( 'download_url' ) ) { include ABSPATH . '/wp-admin/includes/file.php'; } return download_url( $url ); } /** * Alias for WP_Filesystem::put_contents(). * * @param string $file_path The path to the file to write. * @param mixed $content The data to write to the file. * * @return bool True on success, false on failure. */ public function wp_filesystem_put_contents( $file_path, $content ) { global $wp_filesystem; if ( ! $this->wp_init_filesystem() ) { return false; } return $wp_filesystem->put_contents( $file_path, $content ); } /** * Alias for WP_Filesystem::get_contents(). * * @param string $file_path The path to the file to read. * @return string|false The contents of the file, or false on failure. */ public function wp_filesystem_get_contents( $file_path ) { global $wp_filesystem; if ( ! $this->wp_init_filesystem() ) { return false; } return $wp_filesystem->get_contents( $file_path ); } /** * Retrieves the current user's ID. * * @return int The current user's ID. */ public function wp_get_current_user_id() { return get_current_user_id(); } } blueprint/composer.json 0000777 00000002475 15252010675 0011314 0 ustar 00 { "name": "woocommerce/blueprint", "version": "0.0.1", "type": "wordpress-plugin", "autoload": { "psr-4": { "Automattic\\WooCommerce\\Blueprint\\": "src/" } }, "autoload-dev": { "psr-4": { "Automattic\\WooCommerce\\Blueprint\\Tests\\": "tests/" } }, "require": { "opis/json-schema": "^2.3" }, "scripts": { "test:setup": "wp-env start", "test:unit": "wp-env run tests-cli --env-cwd=wp-content/plugins/blueprint ./vendor/bin/phpunit", "phpcs": [ "phpcs -s -p" ], "phpcbf": [ "phpcbf -p" ] }, "require-dev": { "phpunit/phpunit": "^9", "mockery/mockery": "^1.6", "automattic/jetpack-changelogger": "3.3.0", "woocommerce/woocommerce-sniffs": "^1.0.0", "yoast/phpunit-polyfills": "^2.0" }, "extra": { "changelogger": { "formatter": { "filename": "../../../tools/changelogger/class-legacy-core-formatter.php" }, "types": { "fix": "Fixes an existing bug", "add": "Adds functionality", "update": "Update existing functionality", "dev": "Development related task", "tweak": "A minor adjustment to the codebase", "performance": "Address performance issues", "enhancement": "Improve existing functionality" }, "changelog": "changelog.md" } }, "config": { "allow-plugins": { "dealerdirect/phpcodesniffer-composer-installer": true } } } woocommerce-admin/woocommerce-admin.php 0000777 00000000313 15252010675 0014276 0 ustar 00 <?php /** * WooCommerce Admin Dummy File * * This file is here only for bw compatibility: https://github.com/woocommerce/woocommerce/pull/32869 * * @package WooCommerce\Admin * @version 6.9.0 */ Symfony/Polyfill/Php80/LICENSE 0000777 00000002054 15252673315 0011727 0 ustar 00 Copyright (c) 2020-present Fabien Potencier Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Symfony/Polyfill/Php80/Php80.php 0000777 00000007027 15252673315 0012337 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Polyfill\Php80; /** * @author Ion Bazan <ion.bazan@gmail.com> * @author Nico Oelgart <nicoswd@gmail.com> * @author Nicolas Grekas <p@tchwork.com> * * @internal */ final class Php80 { public static function fdiv(float $dividend, float $divisor): float { return @($dividend / $divisor); } public static function get_debug_type($value): string { switch (true) { case null === $value: return 'null'; case \is_bool($value): return 'bool'; case \is_string($value): return 'string'; case \is_array($value): return 'array'; case \is_int($value): return 'int'; case \is_float($value): return 'float'; case \is_object($value): break; case $value instanceof \__PHP_Incomplete_Class: return '__PHP_Incomplete_Class'; default: if (null === $type = @get_resource_type($value)) { return 'unknown'; } if ('Unknown' === $type) { $type = 'closed'; } return "resource ($type)"; } $class = \get_class($value); if (false === strpos($class, '@')) { return $class; } return (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous'; } public static function get_resource_id($res): int { if (!\is_resource($res) && null === @get_resource_type($res)) { throw new \TypeError(sprintf('Argument 1 passed to get_resource_id() must be of the type resource, %s given', get_debug_type($res))); } return (int) $res; } public static function preg_last_error_msg(): string { switch (preg_last_error()) { case \PREG_INTERNAL_ERROR: return 'Internal error'; case \PREG_BAD_UTF8_ERROR: return 'Malformed UTF-8 characters, possibly incorrectly encoded'; case \PREG_BAD_UTF8_OFFSET_ERROR: return 'The offset did not correspond to the beginning of a valid UTF-8 code point'; case \PREG_BACKTRACK_LIMIT_ERROR: return 'Backtrack limit exhausted'; case \PREG_RECURSION_LIMIT_ERROR: return 'Recursion limit exhausted'; case \PREG_JIT_STACKLIMIT_ERROR: return 'JIT stack limit exhausted'; case \PREG_NO_ERROR: return 'No error'; default: return 'Unknown error'; } } public static function str_contains(string $haystack, string $needle): bool { return '' === $needle || false !== strpos($haystack, $needle); } public static function str_starts_with(string $haystack, string $needle): bool { return 0 === strncmp($haystack, $needle, \strlen($needle)); } public static function str_ends_with(string $haystack, string $needle): bool { if ('' === $needle || $needle === $haystack) { return true; } if ('' === $haystack) { return false; } $needleLength = \strlen($needle); return $needleLength <= \strlen($haystack) && 0 === substr_compare($haystack, $needle, -$needleLength); } } Symfony/Polyfill/Php80/Resources/stubs/PhpToken.php 0000777 00000000625 15252673315 0016277 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000 && extension_loaded('tokenizer')) { class PhpToken extends Automattic\WooCommerce\Vendor\Symfony\Polyfill\Php80\PhpToken { } } Symfony/Polyfill/Php80/Resources/stubs/Stringable.php 0000777 00000000614 15252673315 0016637 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000) { interface Stringable { /** * @return string */ public function __toString(); } } Symfony/Polyfill/Php80/Resources/stubs/ValueError.php 0000777 00000000476 15252673315 0016641 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000) { class ValueError extends Error { } } Symfony/Polyfill/Php80/Resources/stubs/UnhandledMatchError.php 0000777 00000000507 15252673315 0020437 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ if (\PHP_VERSION_ID < 80000) { class UnhandledMatchError extends Error { } } Symfony/Polyfill/Php80/Resources/stubs/Attribute.php 0000777 00000001360 15252673315 0016507 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ #[Attribute(Attribute::TARGET_CLASS)] final class Attribute { public const TARGET_CLASS = 1; public const TARGET_FUNCTION = 2; public const TARGET_METHOD = 4; public const TARGET_PROPERTY = 8; public const TARGET_CLASS_CONSTANT = 16; public const TARGET_PARAMETER = 32; public const TARGET_ALL = 63; public const IS_REPEATABLE = 64; /** @var int */ public $flags; public function __construct(int $flags = self::TARGET_ALL) { $this->flags = $flags; } } Symfony/Polyfill/Php80/PhpToken.php 0000777 00000004353 15252673315 0013167 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Polyfill\Php80; /** * @author Fedonyuk Anton <info@ensostudio.ru> * * @internal */ class PhpToken implements \Stringable { /** * @var int */ public $id; /** * @var string */ public $text; /** * @var -1|positive-int */ public $line; /** * @var int */ public $pos; /** * @param -1|positive-int $line */ public function __construct(int $id, string $text, int $line = -1, int $position = -1) { $this->id = $id; $this->text = $text; $this->line = $line; $this->pos = $position; } public function getTokenName(): ?string { if ('UNKNOWN' === $name = token_name($this->id)) { $name = \strlen($this->text) > 1 || \ord($this->text) < 32 ? null : $this->text; } return $name; } /** * @param int|string|array $kind */ public function is($kind): bool { foreach ((array) $kind as $value) { if (\in_array($value, [$this->id, $this->text], true)) { return true; } } return false; } public function isIgnorable(): bool { return \in_array($this->id, [\T_WHITESPACE, \T_COMMENT, \T_DOC_COMMENT, \T_OPEN_TAG], true); } public function __toString(): string { return (string) $this->text; } /** * @return list<static> */ public static function tokenize(string $code, int $flags = 0): array { $line = 1; $position = 0; $tokens = token_get_all($code, $flags); foreach ($tokens as $index => $token) { if (\is_string($token)) { $id = \ord($token); $text = $token; } else { [$id, $text, $line] = $token; } $tokens[$index] = new static($id, $text, $line, $position); $position += \strlen($text); } return $tokens; } } Symfony/Polyfill/Php80/bootstrap.php 0000777 00000003032 15252673315 0013445 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ use Automattic\WooCommerce\Vendor\Symfony\Polyfill\Php80 as p; if (\PHP_VERSION_ID >= 80000) { return; } if (!defined('FILTER_VALIDATE_BOOL') && defined('FILTER_VALIDATE_BOOLEAN')) { define('FILTER_VALIDATE_BOOL', \FILTER_VALIDATE_BOOLEAN); } if (!function_exists('fdiv')) { function fdiv(float $num1, float $num2): float { return p\Php80::fdiv($num1, $num2); } } if (!function_exists('preg_last_error_msg')) { function preg_last_error_msg(): string { return p\Php80::preg_last_error_msg(); } } if (!function_exists('str_contains')) { function str_contains(?string $haystack, ?string $needle): bool { return p\Php80::str_contains($haystack ?? '', $needle ?? ''); } } if (!function_exists('str_starts_with')) { function str_starts_with(?string $haystack, ?string $needle): bool { return p\Php80::str_starts_with($haystack ?? '', $needle ?? ''); } } if (!function_exists('str_ends_with')) { function str_ends_with(?string $haystack, ?string $needle): bool { return p\Php80::str_ends_with($haystack ?? '', $needle ?? ''); } } if (!function_exists('get_debug_type')) { function get_debug_type($value): string { return p\Php80::get_debug_type($value); } } if (!function_exists('get_resource_id')) { function get_resource_id($resource): int { return p\Php80::get_resource_id($resource); } } Symfony/Polyfill/Php80/composer.json 0000777 00000001765 15252673315 0013454 0 ustar 00 { "name": "symfony/polyfill-php80", "type": "library", "description": "Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions", "keywords": ["polyfill", "shim", "compatibility", "portable"], "homepage": "https://symfony.com", "license": "MIT", "authors": [ { "name": "Ion Bazan", "email": "ion.bazan@gmail.com" }, { "name": "Nicolas Grekas", "email": "p@tchwork.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "require": { "php": ">=7.2" }, "autoload": { "psr-4": { "Symfony\\Polyfill\\Php80\\": "" }, "files": [ "bootstrap.php" ], "classmap": [ "Resources/stubs" ] }, "minimum-stability": "dev", "extra": { "thanks": { "name": "symfony/polyfill", "url": "https://github.com/symfony/polyfill" } } } Symfony/Component/CssSelector/XPath/Extension/PseudoClassExtension.php 0000777 00000006657 15252673315 0022274 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\ExpressionErrorException; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator pseudo-class extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class PseudoClassExtension extends AbstractExtension { /** * {@inheritdoc} */ public function getPseudoClassTranslators(): array { return [ 'root' => [$this, 'translateRoot'], 'first-child' => [$this, 'translateFirstChild'], 'last-child' => [$this, 'translateLastChild'], 'first-of-type' => [$this, 'translateFirstOfType'], 'last-of-type' => [$this, 'translateLastOfType'], 'only-child' => [$this, 'translateOnlyChild'], 'only-of-type' => [$this, 'translateOnlyOfType'], 'empty' => [$this, 'translateEmpty'], ]; } public function translateRoot(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('not(parent::*)'); } public function translateFirstChild(XPathExpr $xpath): XPathExpr { return $xpath ->addStarPrefix() ->addNameTest() ->addCondition('position() = 1'); } public function translateLastChild(XPathExpr $xpath): XPathExpr { return $xpath ->addStarPrefix() ->addNameTest() ->addCondition('position() = last()'); } /** * @throws ExpressionErrorException */ public function translateFirstOfType(XPathExpr $xpath): XPathExpr { if ('*' === $xpath->getElement()) { throw new ExpressionErrorException('"*:first-of-type" is not implemented.'); } return $xpath ->addStarPrefix() ->addCondition('position() = 1'); } /** * @throws ExpressionErrorException */ public function translateLastOfType(XPathExpr $xpath): XPathExpr { if ('*' === $xpath->getElement()) { throw new ExpressionErrorException('"*:last-of-type" is not implemented.'); } return $xpath ->addStarPrefix() ->addCondition('position() = last()'); } public function translateOnlyChild(XPathExpr $xpath): XPathExpr { return $xpath ->addStarPrefix() ->addNameTest() ->addCondition('last() = 1'); } public function translateOnlyOfType(XPathExpr $xpath): XPathExpr { $element = $xpath->getElement(); return $xpath->addCondition(sprintf('count(preceding-sibling::%s)=0 and count(following-sibling::%s)=0', $element, $element)); } public function translateEmpty(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('not(*) and not(string-length())'); } /** * {@inheritdoc} */ public function getName(): string { return 'pseudo-class'; } } Symfony/Component/CssSelector/XPath/Extension/NodeExtension.php 0000777 00000013575 15252673315 0020731 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Translator; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator node extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class NodeExtension extends AbstractExtension { public const ELEMENT_NAME_IN_LOWER_CASE = 1; public const ATTRIBUTE_NAME_IN_LOWER_CASE = 2; public const ATTRIBUTE_VALUE_IN_LOWER_CASE = 4; private $flags; public function __construct(int $flags = 0) { $this->flags = $flags; } /** * @return $this */ public function setFlag(int $flag, bool $on): self { if ($on && !$this->hasFlag($flag)) { $this->flags += $flag; } if (!$on && $this->hasFlag($flag)) { $this->flags -= $flag; } return $this; } public function hasFlag(int $flag): bool { return (bool) ($this->flags & $flag); } /** * {@inheritdoc} */ public function getNodeTranslators(): array { return [ 'Selector' => [$this, 'translateSelector'], 'CombinedSelector' => [$this, 'translateCombinedSelector'], 'Negation' => [$this, 'translateNegation'], 'Function' => [$this, 'translateFunction'], 'Pseudo' => [$this, 'translatePseudo'], 'WC_Vendor_Attribute' => [$this, 'translateAttribute'], 'Class' => [$this, 'translateClass'], 'Hash' => [$this, 'translateHash'], 'Element' => [$this, 'translateElement'], ]; } public function translateSelector(Node\SelectorNode $node, Translator $translator): XPathExpr { return $translator->nodeToXPath($node->getTree()); } public function translateCombinedSelector(Node\CombinedSelectorNode $node, Translator $translator): XPathExpr { return $translator->addCombination($node->getCombinator(), $node->getSelector(), $node->getSubSelector()); } public function translateNegation(Node\NegationNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); $subXpath = $translator->nodeToXPath($node->getSubSelector()); $subXpath->addNameTest(); if ($subXpath->getCondition()) { return $xpath->addCondition(sprintf('not(%s)', $subXpath->getCondition())); } return $xpath->addCondition('0'); } public function translateFunction(Node\FunctionNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); return $translator->addFunction($xpath, $node); } public function translatePseudo(Node\PseudoNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); return $translator->addPseudoClass($xpath, $node->getIdentifier()); } public function translateAttribute(Node\AttributeNode $node, Translator $translator): XPathExpr { $name = $node->getAttribute(); $safe = $this->isSafeName($name); if ($this->hasFlag(self::ATTRIBUTE_NAME_IN_LOWER_CASE)) { $name = strtolower($name); } if ($node->getNamespace()) { $name = sprintf('%s:%s', $node->getNamespace(), $name); $safe = $safe && $this->isSafeName($node->getNamespace()); } $attribute = $safe ? '@'.$name : sprintf('attribute::*[name() = %s]', Translator::getXpathLiteral($name)); $value = $node->getValue(); $xpath = $translator->nodeToXPath($node->getSelector()); if ($this->hasFlag(self::ATTRIBUTE_VALUE_IN_LOWER_CASE)) { $value = strtolower($value); } return $translator->addAttributeMatching($xpath, $node->getOperator(), $attribute, $value); } public function translateClass(Node\ClassNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); return $translator->addAttributeMatching($xpath, '~=', '@class', $node->getName()); } public function translateHash(Node\HashNode $node, Translator $translator): XPathExpr { $xpath = $translator->nodeToXPath($node->getSelector()); return $translator->addAttributeMatching($xpath, '=', '@id', $node->getId()); } public function translateElement(Node\ElementNode $node): XPathExpr { $element = $node->getElement(); if ($element && $this->hasFlag(self::ELEMENT_NAME_IN_LOWER_CASE)) { $element = strtolower($element); } if ($element) { $safe = $this->isSafeName($element); } else { $element = '*'; $safe = true; } if ($node->getNamespace()) { $element = sprintf('%s:%s', $node->getNamespace(), $element); $safe = $safe && $this->isSafeName($node->getNamespace()); } $xpath = new XPathExpr('', $element); if (!$safe) { $xpath->addNameTest(); } return $xpath; } /** * {@inheritdoc} */ public function getName(): string { return 'node'; } private function isSafeName(string $name): bool { return 0 < preg_match('~^[a-zA-Z_][a-zA-Z0-9_.-]*$~', $name); } } Symfony/Component/CssSelector/XPath/Extension/CombinationExtension.php 0000777 00000003721 15252673315 0022276 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator combination extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class CombinationExtension extends AbstractExtension { /** * {@inheritdoc} */ public function getCombinationTranslators(): array { return [ ' ' => [$this, 'translateDescendant'], '>' => [$this, 'translateChild'], '+' => [$this, 'translateDirectAdjacent'], '~' => [$this, 'translateIndirectAdjacent'], ]; } public function translateDescendant(XPathExpr $xpath, XPathExpr $combinedXpath): XPathExpr { return $xpath->join('/descendant-or-self::*/', $combinedXpath); } public function translateChild(XPathExpr $xpath, XPathExpr $combinedXpath): XPathExpr { return $xpath->join('/', $combinedXpath); } public function translateDirectAdjacent(XPathExpr $xpath, XPathExpr $combinedXpath): XPathExpr { return $xpath ->join('/following-sibling::', $combinedXpath) ->addNameTest() ->addCondition('position() = 1'); } public function translateIndirectAdjacent(XPathExpr $xpath, XPathExpr $combinedXpath): XPathExpr { return $xpath->join('/following-sibling::', $combinedXpath); } /** * {@inheritdoc} */ public function getName(): string { return 'combination'; } } Symfony/Component/CssSelector/XPath/Extension/HtmlExtension.php 0000777 00000013654 15252673315 0020746 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\ExpressionErrorException; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\FunctionNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Translator; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator HTML extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class HtmlExtension extends AbstractExtension { public function __construct(Translator $translator) { $translator ->getExtension('node') ->setFlag(NodeExtension::ELEMENT_NAME_IN_LOWER_CASE, true) ->setFlag(NodeExtension::ATTRIBUTE_NAME_IN_LOWER_CASE, true); } /** * {@inheritdoc} */ public function getPseudoClassTranslators(): array { return [ 'checked' => [$this, 'translateChecked'], 'link' => [$this, 'translateLink'], 'disabled' => [$this, 'translateDisabled'], 'enabled' => [$this, 'translateEnabled'], 'selected' => [$this, 'translateSelected'], 'invalid' => [$this, 'translateInvalid'], 'hover' => [$this, 'translateHover'], 'visited' => [$this, 'translateVisited'], ]; } /** * {@inheritdoc} */ public function getFunctionTranslators(): array { return [ 'lang' => [$this, 'translateLang'], ]; } public function translateChecked(XPathExpr $xpath): XPathExpr { return $xpath->addCondition( '(@checked ' ."and (name(.) = 'input' or name(.) = 'command')" ."and (@type = 'checkbox' or @type = 'radio'))" ); } public function translateLink(XPathExpr $xpath): XPathExpr { return $xpath->addCondition("@href and (name(.) = 'a' or name(.) = 'link' or name(.) = 'area')"); } public function translateDisabled(XPathExpr $xpath): XPathExpr { return $xpath->addCondition( '(' .'@disabled and' .'(' ."(name(.) = 'input' and @type != 'hidden')" ." or name(.) = 'button'" ." or name(.) = 'select'" ." or name(.) = 'textarea'" ." or name(.) = 'command'" ." or name(.) = 'fieldset'" ." or name(.) = 'optgroup'" ." or name(.) = 'option'" .')' .') or (' ."(name(.) = 'input' and @type != 'hidden')" ." or name(.) = 'button'" ." or name(.) = 'select'" ." or name(.) = 'textarea'" .')' .' and ancestor::fieldset[@disabled]' ); // todo: in the second half, add "and is not a descendant of that fieldset element's first legend element child, if any." } public function translateEnabled(XPathExpr $xpath): XPathExpr { return $xpath->addCondition( '(' .'@href and (' ."name(.) = 'a'" ." or name(.) = 'link'" ." or name(.) = 'area'" .')' .') or (' .'(' ."name(.) = 'command'" ." or name(.) = 'fieldset'" ." or name(.) = 'optgroup'" .')' .' and not(@disabled)' .') or (' .'(' ."(name(.) = 'input' and @type != 'hidden')" ." or name(.) = 'button'" ." or name(.) = 'select'" ." or name(.) = 'textarea'" ." or name(.) = 'keygen'" .')' .' and not (@disabled or ancestor::fieldset[@disabled])' .') or (' ."name(.) = 'option' and not(" .'@disabled or ancestor::optgroup[@disabled]' .')' .')' ); } /** * @throws ExpressionErrorException */ public function translateLang(XPathExpr $xpath, FunctionNode $function): XPathExpr { $arguments = $function->getArguments(); foreach ($arguments as $token) { if (!($token->isString() || $token->isIdentifier())) { throw new ExpressionErrorException('Expected a single string or identifier for :lang(), got '.implode(', ', $arguments)); } } return $xpath->addCondition(sprintf( 'ancestor-or-self::*[@lang][1][starts-with(concat(' ."translate(@%s, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'), '-')" .', %s)]', 'lang', Translator::getXpathLiteral(strtolower($arguments[0]->getValue()).'-') )); } public function translateSelected(XPathExpr $xpath): XPathExpr { return $xpath->addCondition("(@selected and name(.) = 'option')"); } public function translateInvalid(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('0'); } public function translateHover(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('0'); } public function translateVisited(XPathExpr $xpath): XPathExpr { return $xpath->addCondition('0'); } /** * {@inheritdoc} */ public function getName(): string { return 'html'; } } Symfony/Component/CssSelector/XPath/Extension/AbstractExtension.php 0000777 00000002423 15252673315 0021575 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Extension; /** * XPath expression translator abstract extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ abstract class AbstractExtension implements ExtensionInterface { /** * {@inheritdoc} */ public function getNodeTranslators(): array { return []; } /** * {@inheritdoc} */ public function getCombinationTranslators(): array { return []; } /** * {@inheritdoc} */ public function getFunctionTranslators(): array { return []; } /** * {@inheritdoc} */ public function getPseudoClassTranslators(): array { return []; } /** * {@inheritdoc} */ public function getAttributeMatchingTranslators(): array { return []; } } Symfony/Component/CssSelector/XPath/Extension/FunctionExtension.php 0000777 00000012476 15252673315 0021630 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\ExpressionErrorException; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\SyntaxErrorException; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\FunctionNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Parser; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Translator; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator function extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class FunctionExtension extends AbstractExtension { /** * {@inheritdoc} */ public function getFunctionTranslators(): array { return [ 'nth-child' => [$this, 'translateNthChild'], 'nth-last-child' => [$this, 'translateNthLastChild'], 'nth-of-type' => [$this, 'translateNthOfType'], 'nth-last-of-type' => [$this, 'translateNthLastOfType'], 'contains' => [$this, 'translateContains'], 'lang' => [$this, 'translateLang'], ]; } /** * @throws ExpressionErrorException */ public function translateNthChild(XPathExpr $xpath, FunctionNode $function, bool $last = false, bool $addNameTest = true): XPathExpr { try { [$a, $b] = Parser::parseSeries($function->getArguments()); } catch (SyntaxErrorException $e) { throw new ExpressionErrorException(sprintf('Invalid series: "%s".', implode('", "', $function->getArguments())), 0, $e); } $xpath->addStarPrefix(); if ($addNameTest) { $xpath->addNameTest(); } if (0 === $a) { return $xpath->addCondition('position() = '.($last ? 'last() - '.($b - 1) : $b)); } if ($a < 0) { if ($b < 1) { return $xpath->addCondition('false()'); } $sign = '<='; } else { $sign = '>='; } $expr = 'position()'; if ($last) { $expr = 'last() - '.$expr; --$b; } if (0 !== $b) { $expr .= ' - '.$b; } $conditions = [sprintf('%s %s 0', $expr, $sign)]; if (1 !== $a && -1 !== $a) { $conditions[] = sprintf('(%s) mod %d = 0', $expr, $a); } return $xpath->addCondition(implode(' and ', $conditions)); // todo: handle an+b, odd, even // an+b means every-a, plus b, e.g., 2n+1 means odd // 0n+b means b // n+0 means a=1, i.e., all elements // an means every a elements, i.e., 2n means even // -n means -1n // -1n+6 means elements 6 and previous } public function translateNthLastChild(XPathExpr $xpath, FunctionNode $function): XPathExpr { return $this->translateNthChild($xpath, $function, true); } public function translateNthOfType(XPathExpr $xpath, FunctionNode $function): XPathExpr { return $this->translateNthChild($xpath, $function, false, false); } /** * @throws ExpressionErrorException */ public function translateNthLastOfType(XPathExpr $xpath, FunctionNode $function): XPathExpr { if ('*' === $xpath->getElement()) { throw new ExpressionErrorException('"*:nth-of-type()" is not implemented.'); } return $this->translateNthChild($xpath, $function, true, false); } /** * @throws ExpressionErrorException */ public function translateContains(XPathExpr $xpath, FunctionNode $function): XPathExpr { $arguments = $function->getArguments(); foreach ($arguments as $token) { if (!($token->isString() || $token->isIdentifier())) { throw new ExpressionErrorException('Expected a single string or identifier for :contains(), got '.implode(', ', $arguments)); } } return $xpath->addCondition(sprintf( 'contains(string(.), %s)', Translator::getXpathLiteral($arguments[0]->getValue()) )); } /** * @throws ExpressionErrorException */ public function translateLang(XPathExpr $xpath, FunctionNode $function): XPathExpr { $arguments = $function->getArguments(); foreach ($arguments as $token) { if (!($token->isString() || $token->isIdentifier())) { throw new ExpressionErrorException('Expected a single string or identifier for :lang(), got '.implode(', ', $arguments)); } } return $xpath->addCondition(sprintf( 'lang(%s)', Translator::getXpathLiteral($arguments[0]->getValue()) )); } /** * {@inheritdoc} */ public function getName(): string { return 'function'; } } Symfony/Component/CssSelector/XPath/Extension/AttributeMatchingExtension.php 0000777 00000007510 15252673315 0023452 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Extension; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Translator; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\XPathExpr; /** * XPath expression translator attribute extension. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class AttributeMatchingExtension extends AbstractExtension { /** * {@inheritdoc} */ public function getAttributeMatchingTranslators(): array { return [ 'exists' => [$this, 'translateExists'], '=' => [$this, 'translateEquals'], '~=' => [$this, 'translateIncludes'], '|=' => [$this, 'translateDashMatch'], '^=' => [$this, 'translatePrefixMatch'], '$=' => [$this, 'translateSuffixMatch'], '*=' => [$this, 'translateSubstringMatch'], '!=' => [$this, 'translateDifferent'], ]; } public function translateExists(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($attribute); } public function translateEquals(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition(sprintf('%s = %s', $attribute, Translator::getXpathLiteral($value))); } public function translateIncludes(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($value ? sprintf( '%1$s and contains(concat(\' \', normalize-space(%1$s), \' \'), %2$s)', $attribute, Translator::getXpathLiteral(' '.$value.' ') ) : '0'); } public function translateDashMatch(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition(sprintf( '%1$s and (%1$s = %2$s or starts-with(%1$s, %3$s))', $attribute, Translator::getXpathLiteral($value), Translator::getXpathLiteral($value.'-') )); } public function translatePrefixMatch(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($value ? sprintf( '%1$s and starts-with(%1$s, %2$s)', $attribute, Translator::getXpathLiteral($value) ) : '0'); } public function translateSuffixMatch(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($value ? sprintf( '%1$s and substring(%1$s, string-length(%1$s)-%2$s) = %3$s', $attribute, \strlen($value) - 1, Translator::getXpathLiteral($value) ) : '0'); } public function translateSubstringMatch(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition($value ? sprintf( '%1$s and contains(%1$s, %2$s)', $attribute, Translator::getXpathLiteral($value) ) : '0'); } public function translateDifferent(XPathExpr $xpath, string $attribute, ?string $value): XPathExpr { return $xpath->addCondition(sprintf( $value ? 'not(%1$s) or %1$s != %2$s' : '%s != %s', $attribute, Translator::getXpathLiteral($value) )); } /** * {@inheritdoc} */ public function getName(): string { return 'attribute-matching'; } } Symfony/Component/CssSelector/XPath/Extension/ExtensionInterface.php 0000777 00000003043 15252673315 0021731 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Extension; /** * XPath expression translator extension interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface ExtensionInterface { /** * Returns node translators. * * These callables will receive the node as first argument and the translator as second argument. * * @return callable[] */ public function getNodeTranslators(): array; /** * Returns combination translators. * * @return callable[] */ public function getCombinationTranslators(): array; /** * Returns function translators. * * @return callable[] */ public function getFunctionTranslators(): array; /** * Returns pseudo-class translators. * * @return callable[] */ public function getPseudoClassTranslators(): array; /** * Returns attribute operation translators. * * @return callable[] */ public function getAttributeMatchingTranslators(): array; /** * Returns extension name. */ public function getName(): string; } Symfony/Component/CssSelector/XPath/XPathExpr.php 0000777 00000004726 15252673315 0016054 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath; /** * XPath expression translator interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class XPathExpr { private $path; private $element; private $condition; public function __construct(string $path = '', string $element = '*', string $condition = '', bool $starPrefix = false) { $this->path = $path; $this->element = $element; $this->condition = $condition; if ($starPrefix) { $this->addStarPrefix(); } } public function getElement(): string { return $this->element; } /** * @return $this */ public function addCondition(string $condition): self { $this->condition = $this->condition ? sprintf('(%s) and (%s)', $this->condition, $condition) : $condition; return $this; } public function getCondition(): string { return $this->condition; } /** * @return $this */ public function addNameTest(): self { if ('*' !== $this->element) { $this->addCondition('name() = '.Translator::getXpathLiteral($this->element)); $this->element = '*'; } return $this; } /** * @return $this */ public function addStarPrefix(): self { $this->path .= '*/'; return $this; } /** * Joins another XPathExpr with a combiner. * * @return $this */ public function join(string $combiner, self $expr): self { $path = $this->__toString().$combiner; if ('*/' !== $expr->path) { $path .= $expr->path; } $this->path = $path; $this->element = $expr->element; $this->condition = $expr->condition; return $this; } public function __toString(): string { $path = $this->path.$this->element; $condition = null === $this->condition || '' === $this->condition ? '' : '['.$this->condition.']'; return $path.$condition; } } Symfony/Component/CssSelector/XPath/Translator.php 0000777 00000016574 15252673315 0016326 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\ExpressionErrorException; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\FunctionNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\NodeInterface; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Parser; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * XPath expression translator interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Translator implements TranslatorInterface { private $mainParser; /** * @var ParserInterface[] */ private $shortcutParsers = []; /** * @var Extension\ExtensionInterface[] */ private $extensions = []; private $nodeTranslators = []; private $combinationTranslators = []; private $functionTranslators = []; private $pseudoClassTranslators = []; private $attributeMatchingTranslators = []; public function __construct(?ParserInterface $parser = null) { $this->mainParser = $parser ?? new Parser(); $this ->registerExtension(new Extension\NodeExtension()) ->registerExtension(new Extension\CombinationExtension()) ->registerExtension(new Extension\FunctionExtension()) ->registerExtension(new Extension\PseudoClassExtension()) ->registerExtension(new Extension\AttributeMatchingExtension()) ; } public static function getXpathLiteral(string $element): string { if (!str_contains($element, "'")) { return "'".$element."'"; } if (!str_contains($element, '"')) { return '"'.$element.'"'; } $string = $element; $parts = []; while (true) { if (false !== $pos = strpos($string, "'")) { $parts[] = sprintf("'%s'", substr($string, 0, $pos)); $parts[] = "\"'\""; $string = substr($string, $pos + 1); } else { $parts[] = "'$string'"; break; } } return sprintf('concat(%s)', implode(', ', $parts)); } /** * {@inheritdoc} */ public function cssToXPath(string $cssExpr, string $prefix = 'descendant-or-self::'): string { $selectors = $this->parseSelectors($cssExpr); /** @var SelectorNode $selector */ foreach ($selectors as $index => $selector) { if (null !== $selector->getPseudoElement()) { throw new ExpressionErrorException('Pseudo-elements are not supported.'); } $selectors[$index] = $this->selectorToXPath($selector, $prefix); } return implode(' | ', $selectors); } /** * {@inheritdoc} */ public function selectorToXPath(SelectorNode $selector, string $prefix = 'descendant-or-self::'): string { return ($prefix ?: '').$this->nodeToXPath($selector); } /** * @return $this */ public function registerExtension(Extension\ExtensionInterface $extension): self { $this->extensions[$extension->getName()] = $extension; $this->nodeTranslators = array_merge($this->nodeTranslators, $extension->getNodeTranslators()); $this->combinationTranslators = array_merge($this->combinationTranslators, $extension->getCombinationTranslators()); $this->functionTranslators = array_merge($this->functionTranslators, $extension->getFunctionTranslators()); $this->pseudoClassTranslators = array_merge($this->pseudoClassTranslators, $extension->getPseudoClassTranslators()); $this->attributeMatchingTranslators = array_merge($this->attributeMatchingTranslators, $extension->getAttributeMatchingTranslators()); return $this; } /** * @throws ExpressionErrorException */ public function getExtension(string $name): Extension\ExtensionInterface { if (!isset($this->extensions[$name])) { throw new ExpressionErrorException(sprintf('Extension "%s" not registered.', $name)); } return $this->extensions[$name]; } /** * @return $this */ public function registerParserShortcut(ParserInterface $shortcut): self { $this->shortcutParsers[] = $shortcut; return $this; } /** * @throws ExpressionErrorException */ public function nodeToXPath(NodeInterface $node): XPathExpr { if (!isset($this->nodeTranslators[$node->getNodeName()])) { throw new ExpressionErrorException(sprintf('Node "%s" not supported.', $node->getNodeName())); } return $this->nodeTranslators[$node->getNodeName()]($node, $this); } /** * @throws ExpressionErrorException */ public function addCombination(string $combiner, NodeInterface $xpath, NodeInterface $combinedXpath): XPathExpr { if (!isset($this->combinationTranslators[$combiner])) { throw new ExpressionErrorException(sprintf('Combiner "%s" not supported.', $combiner)); } return $this->combinationTranslators[$combiner]($this->nodeToXPath($xpath), $this->nodeToXPath($combinedXpath)); } /** * @throws ExpressionErrorException */ public function addFunction(XPathExpr $xpath, FunctionNode $function): XPathExpr { if (!isset($this->functionTranslators[$function->getName()])) { throw new ExpressionErrorException(sprintf('Function "%s" not supported.', $function->getName())); } return $this->functionTranslators[$function->getName()]($xpath, $function); } /** * @throws ExpressionErrorException */ public function addPseudoClass(XPathExpr $xpath, string $pseudoClass): XPathExpr { if (!isset($this->pseudoClassTranslators[$pseudoClass])) { throw new ExpressionErrorException(sprintf('Pseudo-class "%s" not supported.', $pseudoClass)); } return $this->pseudoClassTranslators[$pseudoClass]($xpath); } /** * @throws ExpressionErrorException */ public function addAttributeMatching(XPathExpr $xpath, string $operator, string $attribute, ?string $value): XPathExpr { if (!isset($this->attributeMatchingTranslators[$operator])) { throw new ExpressionErrorException(sprintf('WC_Vendor_Attribute matcher operator "%s" not supported.', $operator)); } return $this->attributeMatchingTranslators[$operator]($xpath, $attribute, $value); } /** * @return SelectorNode[] */ private function parseSelectors(string $css): array { foreach ($this->shortcutParsers as $shortcut) { $tokens = $shortcut->parse($css); if (!empty($tokens)) { return $tokens; } } return $this->mainParser->parse($css); } } Symfony/Component/CssSelector/XPath/TranslatorInterface.php 0000777 00000002067 15252673315 0020137 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\SelectorNode; /** * XPath expression translator interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface TranslatorInterface { /** * Translates a CSS selector to an XPath expression. */ public function cssToXPath(string $cssExpr, string $prefix = 'descendant-or-self::'): string; /** * Translates a parsed selector node to an XPath expression. */ public function selectorToXPath(SelectorNode $selector, string $prefix = 'descendant-or-self::'): string; } Symfony/Component/CssSelector/Exception/ExpressionErrorException.php 0000777 00000001237 15252673315 0022125 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception; /** * ParseException is thrown when a CSS selector syntax is not valid. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> */ class ExpressionErrorException extends ParseException { } Symfony/Component/CssSelector/Exception/ExceptionInterface.php 0000777 00000001161 15252673315 0020650 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception; /** * Interface for exceptions. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> */ interface ExceptionInterface extends \Throwable { } Symfony/Component/CssSelector/Exception/InternalErrorException.php 0000777 00000001235 15252673315 0021540 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception; /** * ParseException is thrown when a CSS selector syntax is not valid. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> */ class InternalErrorException extends ParseException { } Symfony/Component/CssSelector/Exception/SyntaxErrorException.php 0000777 00000003300 15252673315 0021245 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Token; /** * ParseException is thrown when a CSS selector syntax is not valid. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> */ class SyntaxErrorException extends ParseException { /** * @return self */ public static function unexpectedToken(string $expectedValue, Token $foundToken) { return new self(sprintf('Expected %s, but %s found.', $expectedValue, $foundToken)); } /** * @return self */ public static function pseudoElementFound(string $pseudoElement, string $unexpectedLocation) { return new self(sprintf('Unexpected pseudo-element "::%s" found %s.', $pseudoElement, $unexpectedLocation)); } /** * @return self */ public static function unclosedString(int $position) { return new self(sprintf('Unclosed/invalid string at %s.', $position)); } /** * @return self */ public static function nestedNot() { return new self('Got nested ::not().'); } /** * @return self */ public static function stringAsFunctionArgument() { return new self('String not allowed as function argument.'); } } Symfony/Component/CssSelector/Exception/ParseException.php 0000777 00000001234 15252673315 0020023 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception; /** * ParseException is thrown when a CSS selector syntax is not valid. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Fabien Potencier <fabien@symfony.com> */ class ParseException extends \Exception implements ExceptionInterface { } Symfony/Component/CssSelector/Node/SelectorNode.php 0000777 00000002710 15252673315 0016407 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>(::|:)<pseudoElement>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class SelectorNode extends AbstractNode { private $tree; private $pseudoElement; public function __construct(NodeInterface $tree, ?string $pseudoElement = null) { $this->tree = $tree; $this->pseudoElement = $pseudoElement ? strtolower($pseudoElement) : null; } public function getTree(): NodeInterface { return $this->tree; } public function getPseudoElement(): ?string { return $this->pseudoElement; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->tree->getSpecificity()->plus(new Specificity(0, 0, $this->pseudoElement ? 1 : 0)); } public function __toString(): string { return sprintf('%s[%s%s]', $this->getNodeName(), $this->tree, $this->pseudoElement ? '::'.$this->pseudoElement : ''); } } Symfony/Component/CssSelector/Node/NodeInterface.php 0000777 00000001351 15252673315 0016527 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Interface for nodes. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface NodeInterface { public function getNodeName(): string; public function getSpecificity(): Specificity; public function __toString(): string; } Symfony/Component/CssSelector/Node/AbstractNode.php 0000777 00000001641 15252673315 0016374 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Abstract base node class. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ abstract class AbstractNode implements NodeInterface { /** * @var string */ private $nodeName; public function getNodeName(): string { if (null === $this->nodeName) { $this->nodeName = preg_replace('~.*\\\\([^\\\\]+)Node$~', '$1', static::class); } return $this->nodeName; } } Symfony/Component/CssSelector/Node/PseudoNode.php 0000777 00000002555 15252673315 0016075 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>:<identifier>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class PseudoNode extends AbstractNode { private $selector; private $identifier; public function __construct(NodeInterface $selector, string $identifier) { $this->selector = $selector; $this->identifier = strtolower($identifier); } public function getSelector(): NodeInterface { return $this->selector; } public function getIdentifier(): string { return $this->identifier; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0)); } public function __toString(): string { return sprintf('%s[%s:%s]', $this->getNodeName(), $this->selector, $this->identifier); } } Symfony/Component/CssSelector/Node/HashNode.php 0000777 00000002437 15252673315 0015520 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>#<id>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class HashNode extends AbstractNode { private $selector; private $id; public function __construct(NodeInterface $selector, string $id) { $this->selector = $selector; $this->id = $id; } public function getSelector(): NodeInterface { return $this->selector; } public function getId(): string { return $this->id; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(1, 0, 0)); } public function __toString(): string { return sprintf('%s[%s#%s]', $this->getNodeName(), $this->selector, $this->id); } } Symfony/Component/CssSelector/Node/CombinedSelectorNode.php 0000777 00000003221 15252673315 0020046 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Represents a combined node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class CombinedSelectorNode extends AbstractNode { private $selector; private $combinator; private $subSelector; public function __construct(NodeInterface $selector, string $combinator, NodeInterface $subSelector) { $this->selector = $selector; $this->combinator = $combinator; $this->subSelector = $subSelector; } public function getSelector(): NodeInterface { return $this->selector; } public function getCombinator(): string { return $this->combinator; } public function getSubSelector(): NodeInterface { return $this->subSelector; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity()); } public function __toString(): string { $combinator = ' ' === $this->combinator ? '<followed>' : $this->combinator; return sprintf('%s[%s %s %s]', $this->getNodeName(), $this->selector, $combinator, $this->subSelector); } } Symfony/Component/CssSelector/Node/ElementNode.php 0000777 00000002605 15252673315 0016223 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Represents a "<namespace>|<element>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class ElementNode extends AbstractNode { private $namespace; private $element; public function __construct(?string $namespace = null, ?string $element = null) { $this->namespace = $namespace; $this->element = $element; } public function getNamespace(): ?string { return $this->namespace; } public function getElement(): ?string { return $this->element; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return new Specificity(0, 0, $this->element ? 1 : 0); } public function __toString(): string { $element = $this->element ?: '*'; return sprintf('%s[%s]', $this->getNodeName(), $this->namespace ? $this->namespace.'|'.$element : $element); } } Symfony/Component/CssSelector/Node/AttributeNode.php 0000777 00000004152 15252673315 0016574 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>[<namespace>|<attribute> <operator> <value>]" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class AttributeNode extends AbstractNode { private $selector; private $namespace; private $attribute; private $operator; private $value; public function __construct(NodeInterface $selector, ?string $namespace, string $attribute, string $operator, ?string $value) { $this->selector = $selector; $this->namespace = $namespace; $this->attribute = $attribute; $this->operator = $operator; $this->value = $value; } public function getSelector(): NodeInterface { return $this->selector; } public function getNamespace(): ?string { return $this->namespace; } public function getAttribute(): string { return $this->attribute; } public function getOperator(): string { return $this->operator; } public function getValue(): ?string { return $this->value; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0)); } public function __toString(): string { $attribute = $this->namespace ? $this->namespace.'|'.$this->attribute : $this->attribute; return 'exists' === $this->operator ? sprintf('%s[%s[%s]]', $this->getNodeName(), $this->selector, $attribute) : sprintf("%s[%s[%s %s '%s']]", $this->getNodeName(), $this->selector, $attribute, $this->operator, $this->value); } } Symfony/Component/CssSelector/Node/Specificity.php 0000777 00000003452 15252673315 0016300 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Represents a node specificity. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @see http://www.w3.org/TR/selectors/#specificity * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Specificity { public const A_FACTOR = 100; public const B_FACTOR = 10; public const C_FACTOR = 1; private $a; private $b; private $c; public function __construct(int $a, int $b, int $c) { $this->a = $a; $this->b = $b; $this->c = $c; } public function plus(self $specificity): self { return new self($this->a + $specificity->a, $this->b + $specificity->b, $this->c + $specificity->c); } public function getValue(): int { return $this->a * self::A_FACTOR + $this->b * self::B_FACTOR + $this->c * self::C_FACTOR; } /** * Returns -1 if the object specificity is lower than the argument, * 0 if they are equal, and 1 if the argument is lower. */ public function compareTo(self $specificity): int { if ($this->a !== $specificity->a) { return $this->a > $specificity->a ? 1 : -1; } if ($this->b !== $specificity->b) { return $this->b > $specificity->b ? 1 : -1; } if ($this->c !== $specificity->c) { return $this->c > $specificity->c ? 1 : -1; } return 0; } } Symfony/Component/CssSelector/Node/FunctionNode.php 0000777 00000003541 15252673315 0016417 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Token; /** * Represents a "<selector>:<name>(<arguments>)" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class FunctionNode extends AbstractNode { private $selector; private $name; private $arguments; /** * @param Token[] $arguments */ public function __construct(NodeInterface $selector, string $name, array $arguments = []) { $this->selector = $selector; $this->name = strtolower($name); $this->arguments = $arguments; } public function getSelector(): NodeInterface { return $this->selector; } public function getName(): string { return $this->name; } /** * @return Token[] */ public function getArguments(): array { return $this->arguments; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0)); } public function __toString(): string { $arguments = implode(', ', array_map(function (Token $token) { return "'".$token->getValue()."'"; }, $this->arguments)); return sprintf('%s[%s:%s(%s)]', $this->getNodeName(), $this->selector, $this->name, $arguments ? '['.$arguments.']' : ''); } } Symfony/Component/CssSelector/Node/NegationNode.php 0000777 00000002616 15252673315 0016400 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>:not(<identifier>)" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class NegationNode extends AbstractNode { private $selector; private $subSelector; public function __construct(NodeInterface $selector, NodeInterface $subSelector) { $this->selector = $selector; $this->subSelector = $subSelector; } public function getSelector(): NodeInterface { return $this->selector; } public function getSubSelector(): NodeInterface { return $this->subSelector; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity()); } public function __toString(): string { return sprintf('%s[%s:not(%s)]', $this->getNodeName(), $this->selector, $this->subSelector); } } Symfony/Component/CssSelector/Node/ClassNode.php 0000777 00000002460 15252673315 0015676 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; /** * Represents a "<selector>.<name>" node. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class ClassNode extends AbstractNode { private $selector; private $name; public function __construct(NodeInterface $selector, string $name) { $this->selector = $selector; $this->name = $name; } public function getSelector(): NodeInterface { return $this->selector; } public function getName(): string { return $this->name; } /** * {@inheritdoc} */ public function getSpecificity(): Specificity { return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0)); } public function __toString(): string { return sprintf('%s[%s.%s]', $this->getNodeName(), $this->selector, $this->name); } } Symfony/Component/CssSelector/composer.json 0000777 00000001530 15252673315 0015144 0 ustar 00 { "name": "symfony/css-selector", "type": "library", "description": "Converts CSS selectors to XPath expressions", "keywords": [], "homepage": "https://symfony.com", "license": "MIT", "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Jean-François Simon", "email": "jeanfrancois.simon@sensiolabs.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "require": { "php": ">=7.2.5", "symfony/polyfill-php80": "^1.16" }, "autoload": { "psr-4": { "Symfony\\Component\\CssSelector\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "minimum-stability": "dev" } Symfony/Component/CssSelector/CssSelectorConverter.php 0000777 00000004473 15252673315 0017265 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Shortcut\ClassParser; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Shortcut\ElementParser; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Shortcut\EmptyStringParser; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Shortcut\HashParser; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Extension\HtmlExtension; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\XPath\Translator; /** * CssSelectorConverter is the main entry point of the component and can convert CSS * selectors to XPath expressions. * * @author Christophe Coevoet <stof@notk.org> */ class CssSelectorConverter { private $translator; private $cache; private static $xmlCache = []; private static $htmlCache = []; /** * @param bool $html Whether HTML support should be enabled. Disable it for XML documents */ public function __construct(bool $html = true) { $this->translator = new Translator(); if ($html) { $this->translator->registerExtension(new HtmlExtension($this->translator)); $this->cache = &self::$htmlCache; } else { $this->cache = &self::$xmlCache; } $this->translator ->registerParserShortcut(new EmptyStringParser()) ->registerParserShortcut(new ElementParser()) ->registerParserShortcut(new ClassParser()) ->registerParserShortcut(new HashParser()) ; } /** * Translates a CSS expression to its XPath equivalent. * * Optionally, a prefix can be added to the resulting XPath * expression with the $prefix parameter. * * @return string */ public function toXPath(string $cssExpr, string $prefix = 'descendant-or-self::') { return $this->cache[$prefix][$cssExpr] ?? $this->cache[$prefix][$cssExpr] = $this->translator->cssToXPath($cssExpr, $prefix); } } Symfony/Component/CssSelector/LICENSE 0000777 00000002054 15252673315 0013431 0 ustar 00 Copyright (c) 2004-present Fabien Potencier Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Symfony/Component/CssSelector/Parser/Tokenizer/TokenizerPatterns.php 0000777 00000005370 15252673315 0022042 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer; /** * CSS selector tokenizer patterns builder. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class TokenizerPatterns { private $unicodeEscapePattern; private $simpleEscapePattern; private $newLineEscapePattern; private $escapePattern; private $stringEscapePattern; private $nonAsciiPattern; private $nmCharPattern; private $nmStartPattern; private $identifierPattern; private $hashPattern; private $numberPattern; private $quotedStringPattern; public function __construct() { $this->unicodeEscapePattern = '\\\\([0-9a-f]{1,6})(?:\r\n|[ \n\r\t\f])?'; $this->simpleEscapePattern = '\\\\(.)'; $this->newLineEscapePattern = '\\\\(?:\n|\r\n|\r|\f)'; $this->escapePattern = $this->unicodeEscapePattern.'|\\\\[^\n\r\f0-9a-f]'; $this->stringEscapePattern = $this->newLineEscapePattern.'|'.$this->escapePattern; $this->nonAsciiPattern = '[^\x00-\x7F]'; $this->nmCharPattern = '[_a-z0-9-]|'.$this->escapePattern.'|'.$this->nonAsciiPattern; $this->nmStartPattern = '[_a-z]|'.$this->escapePattern.'|'.$this->nonAsciiPattern; $this->identifierPattern = '-?(?:'.$this->nmStartPattern.')(?:'.$this->nmCharPattern.')*'; $this->hashPattern = '#((?:'.$this->nmCharPattern.')+)'; $this->numberPattern = '[+-]?(?:[0-9]*\.[0-9]+|[0-9]+)'; $this->quotedStringPattern = '([^\n\r\f\\\\%s]|'.$this->stringEscapePattern.')*'; } public function getNewLineEscapePattern(): string { return '~'.$this->newLineEscapePattern.'~'; } public function getSimpleEscapePattern(): string { return '~'.$this->simpleEscapePattern.'~'; } public function getUnicodeEscapePattern(): string { return '~'.$this->unicodeEscapePattern.'~i'; } public function getIdentifierPattern(): string { return '~^'.$this->identifierPattern.'~i'; } public function getHashPattern(): string { return '~^'.$this->hashPattern.'~i'; } public function getNumberPattern(): string { return '~^'.$this->numberPattern.'~'; } public function getQuotedStringPattern(string $quote): string { return '~^'.sprintf($this->quotedStringPattern, $quote).'~i'; } } Symfony/Component/CssSelector/Parser/Tokenizer/TokenizerEscaping.php 0000777 00000003416 15252673315 0021772 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer; /** * CSS selector tokenizer escaping applier. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class TokenizerEscaping { private $patterns; public function __construct(TokenizerPatterns $patterns) { $this->patterns = $patterns; } public function escapeUnicode(string $value): string { $value = $this->replaceUnicodeSequences($value); return preg_replace($this->patterns->getSimpleEscapePattern(), '$1', $value); } public function escapeUnicodeAndNewLine(string $value): string { $value = preg_replace($this->patterns->getNewLineEscapePattern(), '', $value); return $this->escapeUnicode($value); } private function replaceUnicodeSequences(string $value): string { return preg_replace_callback($this->patterns->getUnicodeEscapePattern(), function ($match) { $c = hexdec($match[1]); if (0x80 > $c %= 0x200000) { return \chr($c); } if (0x800 > $c) { return \chr(0xC0 | $c >> 6).\chr(0x80 | $c & 0x3F); } if (0x10000 > $c) { return \chr(0xE0 | $c >> 12).\chr(0x80 | $c >> 6 & 0x3F).\chr(0x80 | $c & 0x3F); } return ''; }, $value); } } Symfony/Component/CssSelector/Parser/Tokenizer/Tokenizer.php 0000777 00000004210 15252673315 0020311 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector tokenizer. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Tokenizer { /** * @var Handler\HandlerInterface[] */ private $handlers; public function __construct() { $patterns = new TokenizerPatterns(); $escaping = new TokenizerEscaping($patterns); $this->handlers = [ new Handler\WhitespaceHandler(), new Handler\IdentifierHandler($patterns, $escaping), new Handler\HashHandler($patterns, $escaping), new Handler\StringHandler($patterns, $escaping), new Handler\NumberHandler($patterns), new Handler\CommentHandler(), ]; } /** * Tokenize selector source code. */ public function tokenize(Reader $reader): TokenStream { $stream = new TokenStream(); while (!$reader->isEOF()) { foreach ($this->handlers as $handler) { if ($handler->handle($reader, $stream)) { continue 2; } } $stream->push(new Token(Token::TYPE_DELIMITER, $reader->getSubstring(1), $reader->getPosition())); $reader->moveForward(1); } return $stream ->push(new Token(Token::TYPE_FILE_END, null, $reader->getPosition())) ->freeze(); } } Symfony/Component/CssSelector/Parser/Shortcut/ElementParser.php 0000777 00000002744 15252673315 0020760 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Shortcut; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\ElementNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * CSS selector element parser shortcut. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class ElementParser implements ParserInterface { /** * {@inheritdoc} */ public function parse(string $source): array { // Matches an optional namespace, required element or `*` // $source = 'testns|testel'; // $matches = array (size=3) // 0 => string 'testns|testel' (length=13) // 1 => string 'testns' (length=6) // 2 => string 'testel' (length=6) if (preg_match('/^(?:([a-z]++)\|)?([\w-]++|\*)$/i', trim($source), $matches)) { return [new SelectorNode(new ElementNode($matches[1] ?: null, $matches[2]))]; } return []; } } Symfony/Component/CssSelector/Parser/Shortcut/ClassParser.php 0000777 00000003322 15252673315 0020425 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Shortcut; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\ClassNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\ElementNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * CSS selector class parser shortcut. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class ClassParser implements ParserInterface { /** * {@inheritdoc} */ public function parse(string $source): array { // Matches an optional namespace, optional element, and required class // $source = 'test|input.ab6bd_field'; // $matches = array (size=4) // 0 => string 'test|input.ab6bd_field' (length=22) // 1 => string 'test' (length=4) // 2 => string 'input' (length=5) // 3 => string 'ab6bd_field' (length=11) if (preg_match('/^(?:([a-z]++)\|)?+([\w-]++|\*)?+\.([\w-]++)$/i', trim($source), $matches)) { return [ new SelectorNode(new ClassNode(new ElementNode($matches[1] ?: null, $matches[2] ?: null), $matches[3])), ]; } return []; } } Symfony/Component/CssSelector/Parser/Shortcut/EmptyStringParser.php 0000777 00000002506 15252673315 0021650 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Shortcut; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\ElementNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * CSS selector class parser shortcut. * * This shortcut ensure compatibility with previous version. * - The parser fails to parse an empty string. * - In the previous version, an empty string matches each tags. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class EmptyStringParser implements ParserInterface { /** * {@inheritdoc} */ public function parse(string $source): array { // Matches an empty string if ('' == $source) { return [new SelectorNode(new ElementNode(null, '*'))]; } return []; } } Symfony/Component/CssSelector/Parser/Shortcut/HashParser.php 0000777 00000003312 15252673315 0020242 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Shortcut; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\ElementNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\HashNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\SelectorNode; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\ParserInterface; /** * CSS selector hash parser shortcut. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class HashParser implements ParserInterface { /** * {@inheritdoc} */ public function parse(string $source): array { // Matches an optional namespace, optional element, and required id // $source = 'test|input#ab6bd_field'; // $matches = array (size=4) // 0 => string 'test|input#ab6bd_field' (length=22) // 1 => string 'test' (length=4) // 2 => string 'input' (length=5) // 3 => string 'ab6bd_field' (length=11) if (preg_match('/^(?:([a-z]++)\|)?+([\w-]++|\*)?+#([\w-]++)$/i', trim($source), $matches)) { return [ new SelectorNode(new HashNode(new ElementNode($matches[1] ?: null, $matches[2] ?: null), $matches[3])), ]; } return []; } } Symfony/Component/CssSelector/Parser/Handler/IdentifierHandler.php 0000777 00000003412 15252673315 0021325 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerEscaping; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerPatterns; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class IdentifierHandler implements HandlerInterface { private $patterns; private $escaping; public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $escaping) { $this->patterns = $patterns; $this->escaping = $escaping; } /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $match = $reader->findPattern($this->patterns->getIdentifierPattern()); if (!$match) { return false; } $value = $this->escaping->escapeUnicode($match[0]); $stream->push(new Token(Token::TYPE_IDENTIFIER, $value, $reader->getPosition())); $reader->moveForward(\strlen($match[0])); return true; } } Symfony/Component/CssSelector/Parser/Handler/CommentHandler.php 0000777 00000002314 15252673315 0020645 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class CommentHandler implements HandlerInterface { /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { if ('/*' !== $reader->getSubstring(2)) { return false; } $offset = $reader->getOffset('*/'); if (false === $offset) { $reader->moveToEnd(); } else { $reader->moveForward($offset + 2); } return true; } } Symfony/Component/CssSelector/Parser/Handler/HashHandler.php 0000777 00000003370 15252673315 0020131 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerEscaping; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerPatterns; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class HashHandler implements HandlerInterface { private $patterns; private $escaping; public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $escaping) { $this->patterns = $patterns; $this->escaping = $escaping; } /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $match = $reader->findPattern($this->patterns->getHashPattern()); if (!$match) { return false; } $value = $this->escaping->escapeUnicode($match[1]); $stream->push(new Token(Token::TYPE_HASH, $value, $reader->getPosition())); $reader->moveForward(\strlen($match[0])); return true; } } Symfony/Component/CssSelector/Parser/Handler/NumberHandler.php 0000777 00000003010 15252673315 0020465 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerPatterns; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class NumberHandler implements HandlerInterface { private $patterns; public function __construct(TokenizerPatterns $patterns) { $this->patterns = $patterns; } /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $match = $reader->findPattern($this->patterns->getNumberPattern()); if (!$match) { return false; } $stream->push(new Token(Token::TYPE_NUMBER, $match[0], $reader->getPosition())); $reader->moveForward(\strlen($match[0])); return true; } } Symfony/Component/CssSelector/Parser/Handler/StringHandler.php 0000777 00000005167 15252673315 0020522 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\InternalErrorException; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\SyntaxErrorException; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerEscaping; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer\TokenizerPatterns; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector comment handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class StringHandler implements HandlerInterface { private $patterns; private $escaping; public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $escaping) { $this->patterns = $patterns; $this->escaping = $escaping; } /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $quote = $reader->getSubstring(1); if (!\in_array($quote, ["'", '"'])) { return false; } $reader->moveForward(1); $match = $reader->findPattern($this->patterns->getQuotedStringPattern($quote)); if (!$match) { throw new InternalErrorException(sprintf('Should have found at least an empty match at %d.', $reader->getPosition())); } // check unclosed strings if (\strlen($match[0]) === $reader->getRemainingLength()) { throw SyntaxErrorException::unclosedString($reader->getPosition() - 1); } // check quotes pairs validity if ($quote !== $reader->getSubstring(1, \strlen($match[0]))) { throw SyntaxErrorException::unclosedString($reader->getPosition() - 1); } $string = $this->escaping->escapeUnicodeAndNewLine($match[0]); $stream->push(new Token(Token::TYPE_STRING, $string, $reader->getPosition())); $reader->moveForward(\strlen($match[0]) + 1); return true; } } Symfony/Component/CssSelector/Parser/Handler/HandlerInterface.php 0000777 00000001542 15252673315 0021145 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector handler interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface HandlerInterface { public function handle(Reader $reader, TokenStream $stream): bool; } Symfony/Component/CssSelector/Parser/Handler/WhitespaceHandler.php 0000777 00000002437 15252673315 0021345 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Handler; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Reader; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Token; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\TokenStream; /** * CSS selector whitespace handler. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class WhitespaceHandler implements HandlerInterface { /** * {@inheritdoc} */ public function handle(Reader $reader, TokenStream $stream): bool { $match = $reader->findPattern('~^[ \t\r\n\f]+~'); if (false === $match) { return false; } $stream->push(new Token(Token::TYPE_WHITESPACE, $match[0], $reader->getPosition())); $reader->moveForward(\strlen($match[0])); return true; } } Symfony/Component/CssSelector/Parser/Reader.php 0000777 00000003570 15252673315 0015577 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser; /** * CSS selector reader. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Reader { private $source; private $length; private $position = 0; public function __construct(string $source) { $this->source = $source; $this->length = \strlen($source); } public function isEOF(): bool { return $this->position >= $this->length; } public function getPosition(): int { return $this->position; } public function getRemainingLength(): int { return $this->length - $this->position; } public function getSubstring(int $length, int $offset = 0): string { return substr($this->source, $this->position + $offset, $length); } public function getOffset(string $string) { $position = strpos($this->source, $string, $this->position); return false === $position ? false : $position - $this->position; } /** * @return array|false */ public function findPattern(string $pattern) { $source = substr($this->source, $this->position); if (preg_match($pattern, $source, $matches)) { return $matches; } return false; } public function moveForward(int $length) { $this->position += $length; } public function moveToEnd() { $this->position = $this->length; } } Symfony/Component/CssSelector/Parser/Token.php 0000777 00000004752 15252673315 0015460 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser; /** * CSS selector token. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Token { public const TYPE_FILE_END = 'eof'; public const TYPE_DELIMITER = 'delimiter'; public const TYPE_WHITESPACE = 'whitespace'; public const TYPE_IDENTIFIER = 'identifier'; public const TYPE_HASH = 'hash'; public const TYPE_NUMBER = 'number'; public const TYPE_STRING = 'string'; private $type; private $value; private $position; public function __construct(?string $type, ?string $value, ?int $position) { $this->type = $type; $this->value = $value; $this->position = $position; } public function getType(): ?int { return $this->type; } public function getValue(): ?string { return $this->value; } public function getPosition(): ?int { return $this->position; } public function isFileEnd(): bool { return self::TYPE_FILE_END === $this->type; } public function isDelimiter(array $values = []): bool { if (self::TYPE_DELIMITER !== $this->type) { return false; } if (empty($values)) { return true; } return \in_array($this->value, $values); } public function isWhitespace(): bool { return self::TYPE_WHITESPACE === $this->type; } public function isIdentifier(): bool { return self::TYPE_IDENTIFIER === $this->type; } public function isHash(): bool { return self::TYPE_HASH === $this->type; } public function isNumber(): bool { return self::TYPE_NUMBER === $this->type; } public function isString(): bool { return self::TYPE_STRING === $this->type; } public function __toString(): string { if ($this->value) { return sprintf('<%s "%s" at %s>', $this->type, $this->value, $this->position); } return sprintf('<%s at %s>', $this->type, $this->position); } } Symfony/Component/CssSelector/Parser/ParserInterface.php 0000777 00000001545 15252673315 0017452 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node\SelectorNode; /** * CSS selector parser interface. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ interface ParserInterface { /** * Parses given selector source into an array of tokens. * * @return SelectorNode[] */ public function parse(string $source): array; } Symfony/Component/CssSelector/Parser/TokenStream.php 0000777 00000006622 15252673315 0016632 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\InternalErrorException; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\SyntaxErrorException; /** * CSS selector token stream. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class TokenStream { /** * @var Token[] */ private $tokens = []; /** * @var Token[] */ private $used = []; /** * @var int */ private $cursor = 0; /** * @var Token|null */ private $peeked; /** * @var bool */ private $peeking = false; /** * Pushes a token. * * @return $this */ public function push(Token $token): self { $this->tokens[] = $token; return $this; } /** * Freezes stream. * * @return $this */ public function freeze(): self { return $this; } /** * Returns next token. * * @throws InternalErrorException If there is no more token */ public function getNext(): Token { if ($this->peeking) { $this->peeking = false; $this->used[] = $this->peeked; return $this->peeked; } if (!isset($this->tokens[$this->cursor])) { throw new InternalErrorException('Unexpected token stream end.'); } return $this->tokens[$this->cursor++]; } /** * Returns peeked token. */ public function getPeek(): Token { if (!$this->peeking) { $this->peeked = $this->getNext(); $this->peeking = true; } return $this->peeked; } /** * Returns used tokens. * * @return Token[] */ public function getUsed(): array { return $this->used; } /** * Returns next identifier token. * * @throws SyntaxErrorException If next token is not an identifier */ public function getNextIdentifier(): string { $next = $this->getNext(); if (!$next->isIdentifier()) { throw SyntaxErrorException::unexpectedToken('identifier', $next); } return $next->getValue(); } /** * Returns next identifier or null if star delimiter token is found. * * @throws SyntaxErrorException If next token is not an identifier or a star delimiter */ public function getNextIdentifierOrStar(): ?string { $next = $this->getNext(); if ($next->isIdentifier()) { return $next->getValue(); } if ($next->isDelimiter(['*'])) { return null; } throw SyntaxErrorException::unexpectedToken('identifier or "*"', $next); } /** * Skips next whitespace if any. */ public function skipWhitespace() { $peek = $this->getPeek(); if ($peek->isWhitespace()) { $this->getNext(); } } } Symfony/Component/CssSelector/Parser/Parser.php 0000777 00000026733 15252673315 0015637 0 ustar 00 <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\SyntaxErrorException; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Node; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Parser\Tokenizer\Tokenizer; /** * CSS selector parser. * * This component is a port of the Python cssselect library, * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. * * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> * * @internal */ class Parser implements ParserInterface { private $tokenizer; public function __construct(?Tokenizer $tokenizer = null) { $this->tokenizer = $tokenizer ?? new Tokenizer(); } /** * {@inheritdoc} */ public function parse(string $source): array { $reader = new Reader($source); $stream = $this->tokenizer->tokenize($reader); return $this->parseSelectorList($stream); } /** * Parses the arguments for ":nth-child()" and friends. * * @param Token[] $tokens * * @throws SyntaxErrorException */ public static function parseSeries(array $tokens): array { foreach ($tokens as $token) { if ($token->isString()) { throw SyntaxErrorException::stringAsFunctionArgument(); } } $joined = trim(implode('', array_map(function (Token $token) { return $token->getValue(); }, $tokens))); $int = function ($string) { if (!is_numeric($string)) { throw SyntaxErrorException::stringAsFunctionArgument(); } return (int) $string; }; switch (true) { case 'odd' === $joined: return [2, 1]; case 'even' === $joined: return [2, 0]; case 'n' === $joined: return [1, 0]; case !str_contains($joined, 'n'): return [0, $int($joined)]; } $split = explode('n', $joined); $first = $split[0] ?? null; return [ $first ? ('-' === $first || '+' === $first ? $int($first.'1') : $int($first)) : 1, isset($split[1]) && $split[1] ? $int($split[1]) : 0, ]; } private function parseSelectorList(TokenStream $stream): array { $stream->skipWhitespace(); $selectors = []; while (true) { $selectors[] = $this->parserSelectorNode($stream); if ($stream->getPeek()->isDelimiter([','])) { $stream->getNext(); $stream->skipWhitespace(); } else { break; } } return $selectors; } private function parserSelectorNode(TokenStream $stream): Node\SelectorNode { [$result, $pseudoElement] = $this->parseSimpleSelector($stream); while (true) { $stream->skipWhitespace(); $peek = $stream->getPeek(); if ($peek->isFileEnd() || $peek->isDelimiter([','])) { break; } if (null !== $pseudoElement) { throw SyntaxErrorException::pseudoElementFound($pseudoElement, 'not at the end of a selector'); } if ($peek->isDelimiter(['+', '>', '~'])) { $combinator = $stream->getNext()->getValue(); $stream->skipWhitespace(); } else { $combinator = ' '; } [$nextSelector, $pseudoElement] = $this->parseSimpleSelector($stream); $result = new Node\CombinedSelectorNode($result, $combinator, $nextSelector); } return new Node\SelectorNode($result, $pseudoElement); } /** * Parses next simple node (hash, class, pseudo, negation). * * @throws SyntaxErrorException */ private function parseSimpleSelector(TokenStream $stream, bool $insideNegation = false): array { $stream->skipWhitespace(); $selectorStart = \count($stream->getUsed()); $result = $this->parseElementNode($stream); $pseudoElement = null; while (true) { $peek = $stream->getPeek(); if ($peek->isWhitespace() || $peek->isFileEnd() || $peek->isDelimiter([',', '+', '>', '~']) || ($insideNegation && $peek->isDelimiter([')'])) ) { break; } if (null !== $pseudoElement) { throw SyntaxErrorException::pseudoElementFound($pseudoElement, 'not at the end of a selector'); } if ($peek->isHash()) { $result = new Node\HashNode($result, $stream->getNext()->getValue()); } elseif ($peek->isDelimiter(['.'])) { $stream->getNext(); $result = new Node\ClassNode($result, $stream->getNextIdentifier()); } elseif ($peek->isDelimiter(['['])) { $stream->getNext(); $result = $this->parseAttributeNode($result, $stream); } elseif ($peek->isDelimiter([':'])) { $stream->getNext(); if ($stream->getPeek()->isDelimiter([':'])) { $stream->getNext(); $pseudoElement = $stream->getNextIdentifier(); continue; } $identifier = $stream->getNextIdentifier(); if (\in_array(strtolower($identifier), ['first-line', 'first-letter', 'before', 'after'])) { // Special case: CSS 2.1 pseudo-elements can have a single ':'. // Any new pseudo-element must have two. $pseudoElement = $identifier; continue; } if (!$stream->getPeek()->isDelimiter(['('])) { $result = new Node\PseudoNode($result, $identifier); continue; } $stream->getNext(); $stream->skipWhitespace(); if ('not' === strtolower($identifier)) { if ($insideNegation) { throw SyntaxErrorException::nestedNot(); } [$argument, $argumentPseudoElement] = $this->parseSimpleSelector($stream, true); $next = $stream->getNext(); if (null !== $argumentPseudoElement) { throw SyntaxErrorException::pseudoElementFound($argumentPseudoElement, 'inside ::not()'); } if (!$next->isDelimiter([')'])) { throw SyntaxErrorException::unexpectedToken('")"', $next); } $result = new Node\NegationNode($result, $argument); } else { $arguments = []; $next = null; while (true) { $stream->skipWhitespace(); $next = $stream->getNext(); if ($next->isIdentifier() || $next->isString() || $next->isNumber() || $next->isDelimiter(['+', '-']) ) { $arguments[] = $next; } elseif ($next->isDelimiter([')'])) { break; } else { throw SyntaxErrorException::unexpectedToken('an argument', $next); } } if (empty($arguments)) { throw SyntaxErrorException::unexpectedToken('at least one argument', $next); } $result = new Node\FunctionNode($result, $identifier, $arguments); } } else { throw SyntaxErrorException::unexpectedToken('selector', $peek); } } if (\count($stream->getUsed()) === $selectorStart) { throw SyntaxErrorException::unexpectedToken('selector', $stream->getPeek()); } return [$result, $pseudoElement]; } private function parseElementNode(TokenStream $stream): Node\ElementNode { $peek = $stream->getPeek(); if ($peek->isIdentifier() || $peek->isDelimiter(['*'])) { if ($peek->isIdentifier()) { $namespace = $stream->getNext()->getValue(); } else { $stream->getNext(); $namespace = null; } if ($stream->getPeek()->isDelimiter(['|'])) { $stream->getNext(); $element = $stream->getNextIdentifierOrStar(); } else { $element = $namespace; $namespace = null; } } else { $element = $namespace = null; } return new Node\ElementNode($namespace, $element); } private function parseAttributeNode(Node\NodeInterface $selector, TokenStream $stream): Node\AttributeNode { $stream->skipWhitespace(); $attribute = $stream->getNextIdentifierOrStar(); if (null === $attribute && !$stream->getPeek()->isDelimiter(['|'])) { throw SyntaxErrorException::unexpectedToken('"|"', $stream->getPeek()); } if ($stream->getPeek()->isDelimiter(['|'])) { $stream->getNext(); if ($stream->getPeek()->isDelimiter(['='])) { $namespace = null; $stream->getNext(); $operator = '|='; } else { $namespace = $attribute; $attribute = $stream->getNextIdentifier(); $operator = null; } } else { $namespace = $operator = null; } if (null === $operator) { $stream->skipWhitespace(); $next = $stream->getNext(); if ($next->isDelimiter([']'])) { return new Node\AttributeNode($selector, $namespace, $attribute, 'exists', null); } elseif ($next->isDelimiter(['='])) { $operator = '='; } elseif ($next->isDelimiter(['^', '$', '*', '~', '|', '!']) && $stream->getPeek()->isDelimiter(['=']) ) { $operator = $next->getValue().'='; $stream->getNext(); } else { throw SyntaxErrorException::unexpectedToken('operator', $next); } } $stream->skipWhitespace(); $value = $stream->getNext(); if ($value->isNumber()) { // if the value is a number, it's casted into a string $value = new Token(Token::TYPE_STRING, (string) $value->getValue(), $value->getPosition()); } if (!($value->isIdentifier() || $value->isString())) { throw SyntaxErrorException::unexpectedToken('string or identifier', $value); } $stream->skipWhitespace(); $next = $stream->getNext(); if (!$next->isDelimiter([']'])) { throw SyntaxErrorException::unexpectedToken('"]"', $next); } return new Node\AttributeNode($selector, $namespace, $attribute, $operator, $value->getValue()); } } League/ISO3166/ISO3166DataValidator.php 0000777 00000003446 15252673315 0013072 0 ustar 00 <?php declare(strict_types=1); /* * (c) Rob Bast <rob.bast@gmail.com> * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\League\ISO3166; use Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException; final class ISO3166DataValidator { /** * @param array<array<string, mixed>> $data * * @return array<array<string, mixed>> */ public function validate(array $data): array { foreach ($data as $entry) { $this->assertEntryHasRequiredKeys($entry); } return $data; } /** * @param array<string, mixed> $entry * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException if given data entry does not have all the required keys */ private function assertEntryHasRequiredKeys(array $entry): void { if (!isset($entry[ISO3166::KEY_NAME])) { throw new DomainException('Each data entry must have a name key.'); } Guards::guardAgainstInvalidName($entry[ISO3166::KEY_NAME]); if (!isset($entry[ISO3166::KEY_ALPHA2])) { throw new DomainException('Each data entry must have a alpha2 key.'); } Guards::guardAgainstInvalidAlpha2($entry[ISO3166::KEY_ALPHA2]); if (!isset($entry[ISO3166::KEY_ALPHA3])) { throw new DomainException('Each data entry must have a alpha3 key.'); } Guards::guardAgainstInvalidAlpha3($entry[ISO3166::KEY_ALPHA3]); if (!isset($entry[ISO3166::KEY_NUMERIC])) { throw new DomainException('Each data entry must have a numeric key.'); } Guards::guardAgainstInvalidNumeric($entry[ISO3166::KEY_NUMERIC]); } } League/ISO3166/ISO3166WithAliases.php 0000777 00000004555 15252673315 0012572 0 ustar 00 <?php declare(strict_types=1); /* * (c) Rob Bast <rob.bast@gmail.com> * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\League\ISO3166; class ISO3166WithAliases implements ISO3166DataProvider { private ISO3166DataProvider $source; /** @type array<string, string> */ public const aliases = [ 'Bolivia' => 'Bolivia (Plurinational State of)', 'Bolivia, Plurinational State of' => 'Bolivia (Plurinational State of)', 'Congo-Kinshasa' => 'Congo (Democratic Republic of the)', 'Congo, Democratic Republic of the' => 'Congo (Democratic Republic of the)', 'Czech Republic' => 'Czechia', 'Iran' => 'Iran (Islamic Republic of)', 'North Korea' => 'Korea (Democratic People\'s Republic of)', 'South Korea' => 'Korea (Republic of)', 'Laos' => 'Lao People\'s Democratic Republic', 'Micronesia' => 'Micronesia (Federated States of)', 'Moldova' => 'Moldova (Republic of)', 'Palestine' => 'Palestine, State of', 'Russia' => 'Russian Federation', 'Saint Martin' => 'Saint Martin (French part)', 'Sint Maarten' => 'Sint Maarten (Dutch part)', 'Taiwan' => 'Taiwan (Province of China)', 'Tanzania' => 'Tanzania, United Republic of', 'United Kingdom' => 'United Kingdom of Great Britain and Northern Ireland', 'United States' => 'United States of America', 'USA' => 'United States of America', 'Venezuela' => 'Venezuela (Bolivarian Republic of)', 'Vietnam' => 'Viet Nam', ]; public function __construct(ISO3166DataProvider $iso3166) { $this->source = $iso3166; } public function name(string $name): array { foreach (self::aliases as $alias => $original) { if (0 === strcasecmp($alias, $name)) { $name = $original; break; } } return $this->source->name($name); } public function alpha2(string $alpha2): array { return $this->source->alpha2($alpha2); } public function alpha3(string $alpha3): array { return $this->source->alpha3($alpha3); } public function numeric(string $numeric): array { return $this->source->numeric($numeric); } } League/ISO3166/Exception/ISO3166Exception.php 0000777 00000000505 15252673315 0014240 0 ustar 00 <?php declare(strict_types=1); /* * (c) Rob Bast <rob.bast@gmail.com> * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\League\ISO3166\Exception; interface ISO3166Exception extends \Throwable { } League/ISO3166/Exception/OutOfBoundsException.php 0000777 00000000562 15252673315 0015500 0 ustar 00 <?php declare(strict_types=1); /* * (c) Rob Bast <rob.bast@gmail.com> * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\League\ISO3166\Exception; final class OutOfBoundsException extends \OutOfBoundsException implements ISO3166Exception { } League/ISO3166/Exception/DomainException.php 0000777 00000000550 15252673315 0014475 0 ustar 00 <?php declare(strict_types=1); /* * (c) Rob Bast <rob.bast@gmail.com> * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\League\ISO3166\Exception; final class DomainException extends \DomainException implements ISO3166Exception { } League/ISO3166/ISO3166.php 0000777 00000166500 15252673315 0010433 0 ustar 00 <?php declare(strict_types=1); /* * (c) Rob Bast <rob.bast@gmail.com> * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\League\ISO3166; use Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException; use Automattic\WooCommerce\Vendor\League\ISO3166\Exception\OutOfBoundsException; /** @implements \IteratorAggregate<string, array> */ final class ISO3166 implements \Countable, \IteratorAggregate, ISO3166DataProvider { /** @var string */ public const KEY_ALPHA2 = 'alpha2'; /** @var string */ public const KEY_ALPHA3 = 'alpha3'; /** @var string */ public const KEY_NUMERIC = 'numeric'; /** @var string */ public const KEY_NAME = 'name'; /** @var string[] */ private array $keys = [self::KEY_ALPHA2, self::KEY_ALPHA3, self::KEY_NUMERIC, self::KEY_NAME]; /** * @param array<array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]}> $countries replace default dataset with given array */ public function __construct(array $countries = []) { if ([] !== $countries) { $this->countries = $countries; } } /** * @return array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]} */ public function name(string $name): array { Guards::guardAgainstInvalidName($name); return $this->lookup(self::KEY_NAME, $name); } /** * @return array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]} */ public function alpha2(string $alpha2): array { Guards::guardAgainstInvalidAlpha2($alpha2); return $this->lookup(self::KEY_ALPHA2, $alpha2); } /** * @return array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]} */ public function alpha3(string $alpha3): array { Guards::guardAgainstInvalidAlpha3($alpha3); return $this->lookup(self::KEY_ALPHA3, $alpha3); } /** * @return array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]} */ public function numeric(string $numeric): array { Guards::guardAgainstInvalidNumeric($numeric); return $this->lookup(self::KEY_NUMERIC, $numeric); } /** * @return array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]} */ public function exactName(string $name): array { Guards::guardAgainstInvalidName($name); $value = mb_strtolower($name); foreach ($this->countries as $country) { $comparison = mb_strtolower($country[self::KEY_NAME]); if ($value === $comparison) { return $country; } } throw new OutOfBoundsException(sprintf('No "%s" key found matching: %s', self::KEY_NAME, $value)); } /** * @return array<array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]}> */ public function all(): array { return $this->countries; } /** * @param 'name'|'alpha2'|'alpha3'|'numeric' $key * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException if an invalid key is specified * * @return \Generator<string, array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]}> */ public function iterator(string $key = self::KEY_ALPHA2): \Generator { if (!in_array($key, $this->keys, true)) { throw new DomainException(sprintf('Invalid value for $key, got "%s", expected one of: %s', $key, implode(', ', $this->keys))); } foreach ($this->countries as $country) { yield $country[$key] => $country; } } /** * @see \Countable * * @internal */ public function count(): int { return count($this->countries); } /** * @return \Generator<array<string, string|array<string>>> * * @see \IteratorAggregate * * @internal */ public function getIterator(): \Generator { foreach ($this->countries as $country) { yield $country; } } /** * Lookup ISO3166-1 data by given identifier. * * Looks for a match against the given key for each entry in the dataset. * * @param 'name'|'alpha2'|'alpha3'|'numeric' $key * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\OutOfBoundsException if key does not exist in dataset * * @return array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]} */ private function lookup(string $key, string $value): array { $value = mb_strtolower($value); foreach ($this->countries as $country) { $comparison = mb_strtolower($country[$key]); if ($value === $comparison || $value === mb_substr($comparison, 0, mb_strlen($value))) { return $country; } } throw new OutOfBoundsException(sprintf('No "%s" key found matching: %s', $key, $value)); } /** * Default dataset. * * @var array<array{name: string, alpha2: string, alpha3: string, numeric: numeric-string, currency: string[]}>> */ private array $countries = [ [ 'name' => 'Afghanistan', 'alpha2' => 'AF', 'alpha3' => 'AFG', 'numeric' => '004', 'currency' => [ 'AFN', ], ], [ 'name' => 'Åland Islands', 'alpha2' => 'AX', 'alpha3' => 'ALA', 'numeric' => '248', 'currency' => [ 'EUR', ], ], [ 'name' => 'Albania', 'alpha2' => 'AL', 'alpha3' => 'ALB', 'numeric' => '008', 'currency' => [ 'ALL', ], ], [ 'name' => 'Algeria', 'alpha2' => 'DZ', 'alpha3' => 'DZA', 'numeric' => '012', 'currency' => [ 'DZD', ], ], [ 'name' => 'American Samoa', 'alpha2' => 'AS', 'alpha3' => 'ASM', 'numeric' => '016', 'currency' => [ 'USD', ], ], [ 'name' => 'Andorra', 'alpha2' => 'AD', 'alpha3' => 'AND', 'numeric' => '020', 'currency' => [ 'EUR', ], ], [ 'name' => 'Angola', 'alpha2' => 'AO', 'alpha3' => 'AGO', 'numeric' => '024', 'currency' => [ 'AOA', ], ], [ 'name' => 'Anguilla', 'alpha2' => 'AI', 'alpha3' => 'AIA', 'numeric' => '660', 'currency' => [ 'XCD', ], ], [ 'name' => 'Antarctica', 'alpha2' => 'AQ', 'alpha3' => 'ATA', 'numeric' => '010', 'currency' => [ 'ARS', 'AUD', 'BGN', 'BRL', 'BYR', 'CLP', 'CNY', 'CZK', 'EUR', 'GBP', 'INR', 'JPY', 'KRW', 'NOK', 'NZD', 'PEN', 'PKR', 'PLN', 'RON', 'RUB', 'SEK', 'UAH', 'USD', 'UYU', 'ZAR', ], ], [ 'name' => 'Antigua and Barbuda', 'alpha2' => 'AG', 'alpha3' => 'ATG', 'numeric' => '028', 'currency' => [ 'XCD', ], ], [ 'name' => 'Argentina', 'alpha2' => 'AR', 'alpha3' => 'ARG', 'numeric' => '032', 'currency' => [ 'ARS', ], ], [ 'name' => 'Armenia', 'alpha2' => 'AM', 'alpha3' => 'ARM', 'numeric' => '051', 'currency' => [ 'AMD', ], ], [ 'name' => 'Aruba', 'alpha2' => 'AW', 'alpha3' => 'ABW', 'numeric' => '533', 'currency' => [ 'AWG', ], ], [ 'name' => 'Australia', 'alpha2' => 'AU', 'alpha3' => 'AUS', 'numeric' => '036', 'currency' => [ 'AUD', ], ], [ 'name' => 'Austria', 'alpha2' => 'AT', 'alpha3' => 'AUT', 'numeric' => '040', 'currency' => [ 'EUR', ], ], [ 'name' => 'Azerbaijan', 'alpha2' => 'AZ', 'alpha3' => 'AZE', 'numeric' => '031', 'currency' => [ 'AZN', ], ], [ 'name' => 'Bahamas', 'alpha2' => 'BS', 'alpha3' => 'BHS', 'numeric' => '044', 'currency' => [ 'BSD', ], ], [ 'name' => 'Bahrain', 'alpha2' => 'BH', 'alpha3' => 'BHR', 'numeric' => '048', 'currency' => [ 'BHD', ], ], [ 'name' => 'Bangladesh', 'alpha2' => 'BD', 'alpha3' => 'BGD', 'numeric' => '050', 'currency' => [ 'BDT', ], ], [ 'name' => 'Barbados', 'alpha2' => 'BB', 'alpha3' => 'BRB', 'numeric' => '052', 'currency' => [ 'BBD', ], ], [ 'name' => 'Belarus', 'alpha2' => 'BY', 'alpha3' => 'BLR', 'numeric' => '112', 'currency' => [ 'BYN', ], ], [ 'name' => 'Belgium', 'alpha2' => 'BE', 'alpha3' => 'BEL', 'numeric' => '056', 'currency' => [ 'EUR', ], ], [ 'name' => 'Belize', 'alpha2' => 'BZ', 'alpha3' => 'BLZ', 'numeric' => '084', 'currency' => [ 'BZD', ], ], [ 'name' => 'Benin', 'alpha2' => 'BJ', 'alpha3' => 'BEN', 'numeric' => '204', 'currency' => [ 'XOF', ], ], [ 'name' => 'Bermuda', 'alpha2' => 'BM', 'alpha3' => 'BMU', 'numeric' => '060', 'currency' => [ 'BMD', ], ], [ 'name' => 'Bhutan', 'alpha2' => 'BT', 'alpha3' => 'BTN', 'numeric' => '064', 'currency' => [ 'BTN', ], ], [ 'name' => 'Bolivia (Plurinational State of)', 'alpha2' => 'BO', 'alpha3' => 'BOL', 'numeric' => '068', 'currency' => [ 'BOB', ], ], [ 'name' => 'Bonaire, Sint Eustatius and Saba', 'alpha2' => 'BQ', 'alpha3' => 'BES', 'numeric' => '535', 'currency' => [ 'USD', ], ], [ 'name' => 'Bosnia and Herzegovina', 'alpha2' => 'BA', 'alpha3' => 'BIH', 'numeric' => '070', 'currency' => [ 'BAM', ], ], [ 'name' => 'Botswana', 'alpha2' => 'BW', 'alpha3' => 'BWA', 'numeric' => '072', 'currency' => [ 'BWP', ], ], [ 'name' => 'Bouvet Island', 'alpha2' => 'BV', 'alpha3' => 'BVT', 'numeric' => '074', 'currency' => [ 'NOK', ], ], [ 'name' => 'Brazil', 'alpha2' => 'BR', 'alpha3' => 'BRA', 'numeric' => '076', 'currency' => [ 'BRL', ], ], [ 'name' => 'British Indian Ocean Territory', 'alpha2' => 'IO', 'alpha3' => 'IOT', 'numeric' => '086', 'currency' => [ 'GBP', ], ], [ 'name' => 'Brunei Darussalam', 'alpha2' => 'BN', 'alpha3' => 'BRN', 'numeric' => '096', 'currency' => [ 'BND', 'SGD', ], ], [ 'name' => 'Bulgaria', 'alpha2' => 'BG', 'alpha3' => 'BGR', 'numeric' => '100', 'currency' => [ 'BGN', ], ], [ 'name' => 'Burkina Faso', 'alpha2' => 'BF', 'alpha3' => 'BFA', 'numeric' => '854', 'currency' => [ 'XOF', ], ], [ 'name' => 'Burundi', 'alpha2' => 'BI', 'alpha3' => 'BDI', 'numeric' => '108', 'currency' => [ 'BIF', ], ], [ 'name' => 'Cabo Verde', 'alpha2' => 'CV', 'alpha3' => 'CPV', 'numeric' => '132', 'currency' => [ 'CVE', ], ], [ 'name' => 'Cambodia', 'alpha2' => 'KH', 'alpha3' => 'KHM', 'numeric' => '116', 'currency' => [ 'KHR', ], ], [ 'name' => 'Cameroon', 'alpha2' => 'CM', 'alpha3' => 'CMR', 'numeric' => '120', 'currency' => [ 'XAF', ], ], [ 'name' => 'Canada', 'alpha2' => 'CA', 'alpha3' => 'CAN', 'numeric' => '124', 'currency' => [ 'CAD', ], ], [ 'name' => 'Cayman Islands', 'alpha2' => 'KY', 'alpha3' => 'CYM', 'numeric' => '136', 'currency' => [ 'KYD', ], ], [ 'name' => 'Central African Republic', 'alpha2' => 'CF', 'alpha3' => 'CAF', 'numeric' => '140', 'currency' => [ 'XAF', ], ], [ 'name' => 'Chad', 'alpha2' => 'TD', 'alpha3' => 'TCD', 'numeric' => '148', 'currency' => [ 'XAF', ], ], [ 'name' => 'Chile', 'alpha2' => 'CL', 'alpha3' => 'CHL', 'numeric' => '152', 'currency' => [ 'CLP', ], ], [ 'name' => 'China', 'alpha2' => 'CN', 'alpha3' => 'CHN', 'numeric' => '156', 'currency' => [ 'CNY', ], ], [ 'name' => 'Christmas Island', 'alpha2' => 'CX', 'alpha3' => 'CXR', 'numeric' => '162', 'currency' => [ 'AUD', ], ], [ 'name' => 'Cocos (Keeling) Islands', 'alpha2' => 'CC', 'alpha3' => 'CCK', 'numeric' => '166', 'currency' => [ 'AUD', ], ], [ 'name' => 'Colombia', 'alpha2' => 'CO', 'alpha3' => 'COL', 'numeric' => '170', 'currency' => [ 'COP', ], ], [ 'name' => 'Comoros', 'alpha2' => 'KM', 'alpha3' => 'COM', 'numeric' => '174', 'currency' => [ 'KMF', ], ], [ 'name' => 'Congo', 'alpha2' => 'CG', 'alpha3' => 'COG', 'numeric' => '178', 'currency' => [ 'XAF', ], ], [ 'name' => 'Congo (Democratic Republic of the)', 'alpha2' => 'CD', 'alpha3' => 'COD', 'numeric' => '180', 'currency' => [ 'CDF', ], ], [ 'name' => 'Cook Islands', 'alpha2' => 'CK', 'alpha3' => 'COK', 'numeric' => '184', 'currency' => [ 'NZD', ], ], [ 'name' => 'Costa Rica', 'alpha2' => 'CR', 'alpha3' => 'CRI', 'numeric' => '188', 'currency' => [ 'CRC', ], ], [ 'name' => 'Côte d\'Ivoire', 'alpha2' => 'CI', 'alpha3' => 'CIV', 'numeric' => '384', 'currency' => [ 'XOF', ], ], [ 'name' => 'Croatia', 'alpha2' => 'HR', 'alpha3' => 'HRV', 'numeric' => '191', 'currency' => [ 'EUR', ], ], [ 'name' => 'Cuba', 'alpha2' => 'CU', 'alpha3' => 'CUB', 'numeric' => '192', 'currency' => [ 'CUC', 'CUP', ], ], [ 'name' => 'Curaçao', 'alpha2' => 'CW', 'alpha3' => 'CUW', 'numeric' => '531', 'currency' => [ 'ANG', ], ], [ 'name' => 'Cyprus', 'alpha2' => 'CY', 'alpha3' => 'CYP', 'numeric' => '196', 'currency' => [ 'EUR', ], ], [ 'name' => 'Czechia', 'alpha2' => 'CZ', 'alpha3' => 'CZE', 'numeric' => '203', 'currency' => [ 'CZK', ], ], [ 'name' => 'Denmark', 'alpha2' => 'DK', 'alpha3' => 'DNK', 'numeric' => '208', 'currency' => [ 'DKK', ], ], [ 'name' => 'Djibouti', 'alpha2' => 'DJ', 'alpha3' => 'DJI', 'numeric' => '262', 'currency' => [ 'DJF', ], ], [ 'name' => 'Dominica', 'alpha2' => 'DM', 'alpha3' => 'DMA', 'numeric' => '212', 'currency' => [ 'XCD', ], ], [ 'name' => 'Dominican Republic', 'alpha2' => 'DO', 'alpha3' => 'DOM', 'numeric' => '214', 'currency' => [ 'DOP', ], ], [ 'name' => 'Ecuador', 'alpha2' => 'EC', 'alpha3' => 'ECU', 'numeric' => '218', 'currency' => [ 'USD', ], ], [ 'name' => 'Egypt', 'alpha2' => 'EG', 'alpha3' => 'EGY', 'numeric' => '818', 'currency' => [ 'EGP', ], ], [ 'name' => 'El Salvador', 'alpha2' => 'SV', 'alpha3' => 'SLV', 'numeric' => '222', 'currency' => [ 'USD', ], ], [ 'name' => 'Equatorial Guinea', 'alpha2' => 'GQ', 'alpha3' => 'GNQ', 'numeric' => '226', 'currency' => [ 'XAF', ], ], [ 'name' => 'Eritrea', 'alpha2' => 'ER', 'alpha3' => 'ERI', 'numeric' => '232', 'currency' => [ 'ERN', ], ], [ 'name' => 'Estonia', 'alpha2' => 'EE', 'alpha3' => 'EST', 'numeric' => '233', 'currency' => [ 'EUR', ], ], [ 'name' => 'Ethiopia', 'alpha2' => 'ET', 'alpha3' => 'ETH', 'numeric' => '231', 'currency' => [ 'ETB', ], ], [ 'name' => 'Eswatini', 'alpha2' => 'SZ', 'alpha3' => 'SWZ', 'numeric' => '748', 'currency' => [ 'SZL', 'ZAR', ], ], [ 'name' => 'Falkland Islands (Malvinas)', 'alpha2' => 'FK', 'alpha3' => 'FLK', 'numeric' => '238', 'currency' => [ 'FKP', ], ], [ 'name' => 'Faroe Islands', 'alpha2' => 'FO', 'alpha3' => 'FRO', 'numeric' => '234', 'currency' => [ 'DKK', ], ], [ 'name' => 'Fiji', 'alpha2' => 'FJ', 'alpha3' => 'FJI', 'numeric' => '242', 'currency' => [ 'FJD', ], ], [ 'name' => 'Finland', 'alpha2' => 'FI', 'alpha3' => 'FIN', 'numeric' => '246', 'currency' => [ 'EUR', ], ], [ 'name' => 'France', 'alpha2' => 'FR', 'alpha3' => 'FRA', 'numeric' => '250', 'currency' => [ 'EUR', ], ], [ 'name' => 'French Guiana', 'alpha2' => 'GF', 'alpha3' => 'GUF', 'numeric' => '254', 'currency' => [ 'EUR', ], ], [ 'name' => 'French Polynesia', 'alpha2' => 'PF', 'alpha3' => 'PYF', 'numeric' => '258', 'currency' => [ 'XPF', ], ], [ 'name' => 'French Southern Territories', 'alpha2' => 'TF', 'alpha3' => 'ATF', 'numeric' => '260', 'currency' => [ 'EUR', ], ], [ 'name' => 'Gabon', 'alpha2' => 'GA', 'alpha3' => 'GAB', 'numeric' => '266', 'currency' => [ 'XAF', ], ], [ 'name' => 'Gambia', 'alpha2' => 'GM', 'alpha3' => 'GMB', 'numeric' => '270', 'currency' => [ 'GMD', ], ], [ 'name' => 'Georgia', 'alpha2' => 'GE', 'alpha3' => 'GEO', 'numeric' => '268', 'currency' => [ 'GEL', ], ], [ 'name' => 'Germany', 'alpha2' => 'DE', 'alpha3' => 'DEU', 'numeric' => '276', 'currency' => [ 'EUR', ], ], [ 'name' => 'Ghana', 'alpha2' => 'GH', 'alpha3' => 'GHA', 'numeric' => '288', 'currency' => [ 'GHS', ], ], [ 'name' => 'Gibraltar', 'alpha2' => 'GI', 'alpha3' => 'GIB', 'numeric' => '292', 'currency' => [ 'GIP', ], ], [ 'name' => 'Greece', 'alpha2' => 'GR', 'alpha3' => 'GRC', 'numeric' => '300', 'currency' => [ 'EUR', ], ], [ 'name' => 'Greenland', 'alpha2' => 'GL', 'alpha3' => 'GRL', 'numeric' => '304', 'currency' => [ 'DKK', ], ], [ 'name' => 'Grenada', 'alpha2' => 'GD', 'alpha3' => 'GRD', 'numeric' => '308', 'currency' => [ 'XCD', ], ], [ 'name' => 'Guadeloupe', 'alpha2' => 'GP', 'alpha3' => 'GLP', 'numeric' => '312', 'currency' => [ 'EUR', ], ], [ 'name' => 'Guam', 'alpha2' => 'GU', 'alpha3' => 'GUM', 'numeric' => '316', 'currency' => [ 'USD', ], ], [ 'name' => 'Guatemala', 'alpha2' => 'GT', 'alpha3' => 'GTM', 'numeric' => '320', 'currency' => [ 'GTQ', ], ], [ 'name' => 'Guernsey', 'alpha2' => 'GG', 'alpha3' => 'GGY', 'numeric' => '831', 'currency' => [ 'GBP', ], ], [ 'name' => 'Guinea', 'alpha2' => 'GN', 'alpha3' => 'GIN', 'numeric' => '324', 'currency' => [ 'GNF', ], ], [ 'name' => 'Guinea-Bissau', 'alpha2' => 'GW', 'alpha3' => 'GNB', 'numeric' => '624', 'currency' => [ 'XOF', ], ], [ 'name' => 'Guyana', 'alpha2' => 'GY', 'alpha3' => 'GUY', 'numeric' => '328', 'currency' => [ 'GYD', ], ], [ 'name' => 'Haiti', 'alpha2' => 'HT', 'alpha3' => 'HTI', 'numeric' => '332', 'currency' => [ 'HTG', ], ], [ 'name' => 'Heard Island and McDonald Islands', 'alpha2' => 'HM', 'alpha3' => 'HMD', 'numeric' => '334', 'currency' => [ 'AUD', ], ], [ 'name' => 'Holy See', 'alpha2' => 'VA', 'alpha3' => 'VAT', 'numeric' => '336', 'currency' => [ 'EUR', ], ], [ 'name' => 'Honduras', 'alpha2' => 'HN', 'alpha3' => 'HND', 'numeric' => '340', 'currency' => [ 'HNL', ], ], [ 'name' => 'Hong Kong', 'alpha2' => 'HK', 'alpha3' => 'HKG', 'numeric' => '344', 'currency' => [ 'HKD', ], ], [ 'name' => 'Hungary', 'alpha2' => 'HU', 'alpha3' => 'HUN', 'numeric' => '348', 'currency' => [ 'HUF', ], ], [ 'name' => 'Iceland', 'alpha2' => 'IS', 'alpha3' => 'ISL', 'numeric' => '352', 'currency' => [ 'ISK', ], ], [ 'name' => 'India', 'alpha2' => 'IN', 'alpha3' => 'IND', 'numeric' => '356', 'currency' => [ 'INR', ], ], [ 'name' => 'Indonesia', 'alpha2' => 'ID', 'alpha3' => 'IDN', 'numeric' => '360', 'currency' => [ 'IDR', ], ], [ 'name' => 'Iran (Islamic Republic of)', 'alpha2' => 'IR', 'alpha3' => 'IRN', 'numeric' => '364', 'currency' => [ 'IRR', ], ], [ 'name' => 'Iraq', 'alpha2' => 'IQ', 'alpha3' => 'IRQ', 'numeric' => '368', 'currency' => [ 'IQD', ], ], [ 'name' => 'Ireland', 'alpha2' => 'IE', 'alpha3' => 'IRL', 'numeric' => '372', 'currency' => [ 'EUR', ], ], [ 'name' => 'Isle of Man', 'alpha2' => 'IM', 'alpha3' => 'IMN', 'numeric' => '833', 'currency' => [ 'GBP', ], ], [ 'name' => 'Israel', 'alpha2' => 'IL', 'alpha3' => 'ISR', 'numeric' => '376', 'currency' => [ 'ILS', ], ], [ 'name' => 'Italy', 'alpha2' => 'IT', 'alpha3' => 'ITA', 'numeric' => '380', 'currency' => [ 'EUR', ], ], [ 'name' => 'Jamaica', 'alpha2' => 'JM', 'alpha3' => 'JAM', 'numeric' => '388', 'currency' => [ 'JMD', ], ], [ 'name' => 'Japan', 'alpha2' => 'JP', 'alpha3' => 'JPN', 'numeric' => '392', 'currency' => [ 'JPY', ], ], [ 'name' => 'Jersey', 'alpha2' => 'JE', 'alpha3' => 'JEY', 'numeric' => '832', 'currency' => [ 'GBP', ], ], [ 'name' => 'Jordan', 'alpha2' => 'JO', 'alpha3' => 'JOR', 'numeric' => '400', 'currency' => [ 'JOD', ], ], [ 'name' => 'Kazakhstan', 'alpha2' => 'KZ', 'alpha3' => 'KAZ', 'numeric' => '398', 'currency' => [ 'KZT', ], ], [ 'name' => 'Kenya', 'alpha2' => 'KE', 'alpha3' => 'KEN', 'numeric' => '404', 'currency' => [ 'KES', ], ], [ 'name' => 'Kiribati', 'alpha2' => 'KI', 'alpha3' => 'KIR', 'numeric' => '296', 'currency' => [ 'AUD', ], ], [ 'name' => 'Korea (Democratic People\'s Republic of)', 'alpha2' => 'KP', 'alpha3' => 'PRK', 'numeric' => '408', 'currency' => [ 'KPW', ], ], [ 'name' => 'Korea (Republic of)', 'alpha2' => 'KR', 'alpha3' => 'KOR', 'numeric' => '410', 'currency' => [ 'KRW', ], ], [ 'name' => 'Kosovo', 'alpha2' => 'XK', 'alpha3' => 'XKX', 'numeric' => '412', 'currency' => [ 'EUR', ], ], [ 'name' => 'Kuwait', 'alpha2' => 'KW', 'alpha3' => 'KWT', 'numeric' => '414', 'currency' => [ 'KWD', ], ], [ 'name' => 'Kyrgyzstan', 'alpha2' => 'KG', 'alpha3' => 'KGZ', 'numeric' => '417', 'currency' => [ 'KGS', ], ], [ 'name' => 'Lao People\'s Democratic Republic', 'alpha2' => 'LA', 'alpha3' => 'LAO', 'numeric' => '418', 'currency' => [ 'LAK', ], ], [ 'name' => 'Latvia', 'alpha2' => 'LV', 'alpha3' => 'LVA', 'numeric' => '428', 'currency' => [ 'EUR', ], ], [ 'name' => 'Lebanon', 'alpha2' => 'LB', 'alpha3' => 'LBN', 'numeric' => '422', 'currency' => [ 'LBP', ], ], [ 'name' => 'Lesotho', 'alpha2' => 'LS', 'alpha3' => 'LSO', 'numeric' => '426', 'currency' => [ 'LSL', 'ZAR', ], ], [ 'name' => 'Liberia', 'alpha2' => 'LR', 'alpha3' => 'LBR', 'numeric' => '430', 'currency' => [ 'LRD', ], ], [ 'name' => 'Libya', 'alpha2' => 'LY', 'alpha3' => 'LBY', 'numeric' => '434', 'currency' => [ 'LYD', ], ], [ 'name' => 'Liechtenstein', 'alpha2' => 'LI', 'alpha3' => 'LIE', 'numeric' => '438', 'currency' => [ 'CHF', ], ], [ 'name' => 'Lithuania', 'alpha2' => 'LT', 'alpha3' => 'LTU', 'numeric' => '440', 'currency' => [ 'EUR', ], ], [ 'name' => 'Luxembourg', 'alpha2' => 'LU', 'alpha3' => 'LUX', 'numeric' => '442', 'currency' => [ 'EUR', ], ], [ 'name' => 'Macao', 'alpha2' => 'MO', 'alpha3' => 'MAC', 'numeric' => '446', 'currency' => [ 'MOP', ], ], [ 'name' => 'North Macedonia', 'alpha2' => 'MK', 'alpha3' => 'MKD', 'numeric' => '807', 'currency' => [ 'MKD', ], ], [ 'name' => 'Madagascar', 'alpha2' => 'MG', 'alpha3' => 'MDG', 'numeric' => '450', 'currency' => [ 'MGA', ], ], [ 'name' => 'Malawi', 'alpha2' => 'MW', 'alpha3' => 'MWI', 'numeric' => '454', 'currency' => [ 'MWK', ], ], [ 'name' => 'Malaysia', 'alpha2' => 'MY', 'alpha3' => 'MYS', 'numeric' => '458', 'currency' => [ 'MYR', ], ], [ 'name' => 'Maldives', 'alpha2' => 'MV', 'alpha3' => 'MDV', 'numeric' => '462', 'currency' => [ 'MVR', ], ], [ 'name' => 'Mali', 'alpha2' => 'ML', 'alpha3' => 'MLI', 'numeric' => '466', 'currency' => [ 'XOF', ], ], [ 'name' => 'Malta', 'alpha2' => 'MT', 'alpha3' => 'MLT', 'numeric' => '470', 'currency' => [ 'EUR', ], ], [ 'name' => 'Marshall Islands', 'alpha2' => 'MH', 'alpha3' => 'MHL', 'numeric' => '584', 'currency' => [ 'USD', ], ], [ 'name' => 'Martinique', 'alpha2' => 'MQ', 'alpha3' => 'MTQ', 'numeric' => '474', 'currency' => [ 'EUR', ], ], [ 'name' => 'Mauritania', 'alpha2' => 'MR', 'alpha3' => 'MRT', 'numeric' => '478', 'currency' => [ 'MRO', ], ], [ 'name' => 'Mauritius', 'alpha2' => 'MU', 'alpha3' => 'MUS', 'numeric' => '480', 'currency' => [ 'MUR', ], ], [ 'name' => 'Mayotte', 'alpha2' => 'YT', 'alpha3' => 'MYT', 'numeric' => '175', 'currency' => [ 'EUR', ], ], [ 'name' => 'Mexico', 'alpha2' => 'MX', 'alpha3' => 'MEX', 'numeric' => '484', 'currency' => [ 'MXN', ], ], [ 'name' => 'Micronesia (Federated States of)', 'alpha2' => 'FM', 'alpha3' => 'FSM', 'numeric' => '583', 'currency' => [ 'USD', ], ], [ 'name' => 'Moldova (Republic of)', 'alpha2' => 'MD', 'alpha3' => 'MDA', 'numeric' => '498', 'currency' => [ 'MDL', ], ], [ 'name' => 'Monaco', 'alpha2' => 'MC', 'alpha3' => 'MCO', 'numeric' => '492', 'currency' => [ 'EUR', ], ], [ 'name' => 'Mongolia', 'alpha2' => 'MN', 'alpha3' => 'MNG', 'numeric' => '496', 'currency' => [ 'MNT', ], ], [ 'name' => 'Montenegro', 'alpha2' => 'ME', 'alpha3' => 'MNE', 'numeric' => '499', 'currency' => [ 'EUR', ], ], [ 'name' => 'Montserrat', 'alpha2' => 'MS', 'alpha3' => 'MSR', 'numeric' => '500', 'currency' => [ 'XCD', ], ], [ 'name' => 'Morocco', 'alpha2' => 'MA', 'alpha3' => 'MAR', 'numeric' => '504', 'currency' => [ 'MAD', ], ], [ 'name' => 'Mozambique', 'alpha2' => 'MZ', 'alpha3' => 'MOZ', 'numeric' => '508', 'currency' => [ 'MZN', ], ], [ 'name' => 'Myanmar', 'alpha2' => 'MM', 'alpha3' => 'MMR', 'numeric' => '104', 'currency' => [ 'MMK', ], ], [ 'name' => 'Namibia', 'alpha2' => 'NA', 'alpha3' => 'NAM', 'numeric' => '516', 'currency' => [ 'NAD', 'ZAR', ], ], [ 'name' => 'Nauru', 'alpha2' => 'NR', 'alpha3' => 'NRU', 'numeric' => '520', 'currency' => [ 'AUD', ], ], [ 'name' => 'Nepal', 'alpha2' => 'NP', 'alpha3' => 'NPL', 'numeric' => '524', 'currency' => [ 'NPR', ], ], [ 'name' => 'Netherlands', 'alpha2' => 'NL', 'alpha3' => 'NLD', 'numeric' => '528', 'currency' => [ 'EUR', ], ], [ 'name' => 'New Caledonia', 'alpha2' => 'NC', 'alpha3' => 'NCL', 'numeric' => '540', 'currency' => [ 'XPF', ], ], [ 'name' => 'New Zealand', 'alpha2' => 'NZ', 'alpha3' => 'NZL', 'numeric' => '554', 'currency' => [ 'NZD', ], ], [ 'name' => 'Nicaragua', 'alpha2' => 'NI', 'alpha3' => 'NIC', 'numeric' => '558', 'currency' => [ 'NIO', ], ], [ 'name' => 'Niger', 'alpha2' => 'NE', 'alpha3' => 'NER', 'numeric' => '562', 'currency' => [ 'XOF', ], ], [ 'name' => 'Nigeria', 'alpha2' => 'NG', 'alpha3' => 'NGA', 'numeric' => '566', 'currency' => [ 'NGN', ], ], [ 'name' => 'Niue', 'alpha2' => 'NU', 'alpha3' => 'NIU', 'numeric' => '570', 'currency' => [ 'NZD', ], ], [ 'name' => 'Norfolk Island', 'alpha2' => 'NF', 'alpha3' => 'NFK', 'numeric' => '574', 'currency' => [ 'AUD', ], ], [ 'name' => 'Northern Mariana Islands', 'alpha2' => 'MP', 'alpha3' => 'MNP', 'numeric' => '580', 'currency' => [ 'USD', ], ], [ 'name' => 'Norway', 'alpha2' => 'NO', 'alpha3' => 'NOR', 'numeric' => '578', 'currency' => [ 'NOK', ], ], [ 'name' => 'Oman', 'alpha2' => 'OM', 'alpha3' => 'OMN', 'numeric' => '512', 'currency' => [ 'OMR', ], ], [ 'name' => 'Pakistan', 'alpha2' => 'PK', 'alpha3' => 'PAK', 'numeric' => '586', 'currency' => [ 'PKR', ], ], [ 'name' => 'Palau', 'alpha2' => 'PW', 'alpha3' => 'PLW', 'numeric' => '585', 'currency' => [ 'USD', ], ], [ 'name' => 'Palestine, State of', 'alpha2' => 'PS', 'alpha3' => 'PSE', 'numeric' => '275', 'currency' => [ 'ILS', ], ], [ 'name' => 'Panama', 'alpha2' => 'PA', 'alpha3' => 'PAN', 'numeric' => '591', 'currency' => [ 'PAB', ], ], [ 'name' => 'Papua New Guinea', 'alpha2' => 'PG', 'alpha3' => 'PNG', 'numeric' => '598', 'currency' => [ 'PGK', ], ], [ 'name' => 'Paraguay', 'alpha2' => 'PY', 'alpha3' => 'PRY', 'numeric' => '600', 'currency' => [ 'PYG', ], ], [ 'name' => 'Peru', 'alpha2' => 'PE', 'alpha3' => 'PER', 'numeric' => '604', 'currency' => [ 'PEN', ], ], [ 'name' => 'Philippines', 'alpha2' => 'PH', 'alpha3' => 'PHL', 'numeric' => '608', 'currency' => [ 'PHP', ], ], [ 'name' => 'Pitcairn', 'alpha2' => 'PN', 'alpha3' => 'PCN', 'numeric' => '612', 'currency' => [ 'NZD', ], ], [ 'name' => 'Poland', 'alpha2' => 'PL', 'alpha3' => 'POL', 'numeric' => '616', 'currency' => [ 'PLN', ], ], [ 'name' => 'Portugal', 'alpha2' => 'PT', 'alpha3' => 'PRT', 'numeric' => '620', 'currency' => [ 'EUR', ], ], [ 'name' => 'Puerto Rico', 'alpha2' => 'PR', 'alpha3' => 'PRI', 'numeric' => '630', 'currency' => [ 'USD', ], ], [ 'name' => 'Qatar', 'alpha2' => 'QA', 'alpha3' => 'QAT', 'numeric' => '634', 'currency' => [ 'QAR', ], ], [ 'name' => 'Réunion', 'alpha2' => 'RE', 'alpha3' => 'REU', 'numeric' => '638', 'currency' => [ 'EUR', ], ], [ 'name' => 'Romania', 'alpha2' => 'RO', 'alpha3' => 'ROU', 'numeric' => '642', 'currency' => [ 'RON', ], ], [ 'name' => 'Russian Federation', 'alpha2' => 'RU', 'alpha3' => 'RUS', 'numeric' => '643', 'currency' => [ 'RUB', ], ], [ 'name' => 'Rwanda', 'alpha2' => 'RW', 'alpha3' => 'RWA', 'numeric' => '646', 'currency' => [ 'RWF', ], ], [ 'name' => 'Saint Barthélemy', 'alpha2' => 'BL', 'alpha3' => 'BLM', 'numeric' => '652', 'currency' => [ 'EUR', ], ], [ 'name' => 'Saint Helena, Ascension and Tristan da Cunha', 'alpha2' => 'SH', 'alpha3' => 'SHN', 'numeric' => '654', 'currency' => [ 'SHP', ], ], [ 'name' => 'Saint Kitts and Nevis', 'alpha2' => 'KN', 'alpha3' => 'KNA', 'numeric' => '659', 'currency' => [ 'XCD', ], ], [ 'name' => 'Saint Lucia', 'alpha2' => 'LC', 'alpha3' => 'LCA', 'numeric' => '662', 'currency' => [ 'XCD', ], ], [ 'name' => 'Saint Martin (French part)', 'alpha2' => 'MF', 'alpha3' => 'MAF', 'numeric' => '663', 'currency' => [ 'EUR', 'USD', ], ], [ 'name' => 'Saint Pierre and Miquelon', 'alpha2' => 'PM', 'alpha3' => 'SPM', 'numeric' => '666', 'currency' => [ 'EUR', ], ], [ 'name' => 'Saint Vincent and the Grenadines', 'alpha2' => 'VC', 'alpha3' => 'VCT', 'numeric' => '670', 'currency' => [ 'XCD', ], ], [ 'name' => 'Samoa', 'alpha2' => 'WS', 'alpha3' => 'WSM', 'numeric' => '882', 'currency' => [ 'WST', ], ], [ 'name' => 'San Marino', 'alpha2' => 'SM', 'alpha3' => 'SMR', 'numeric' => '674', 'currency' => [ 'EUR', ], ], [ 'name' => 'Sao Tome and Principe', 'alpha2' => 'ST', 'alpha3' => 'STP', 'numeric' => '678', 'currency' => [ 'STD', ], ], [ 'name' => 'Saudi Arabia', 'alpha2' => 'SA', 'alpha3' => 'SAU', 'numeric' => '682', 'currency' => [ 'SAR', ], ], [ 'name' => 'Senegal', 'alpha2' => 'SN', 'alpha3' => 'SEN', 'numeric' => '686', 'currency' => [ 'XOF', ], ], [ 'name' => 'Serbia', 'alpha2' => 'RS', 'alpha3' => 'SRB', 'numeric' => '688', 'currency' => [ 'RSD', ], ], [ 'name' => 'Seychelles', 'alpha2' => 'SC', 'alpha3' => 'SYC', 'numeric' => '690', 'currency' => [ 'SCR', ], ], [ 'name' => 'Sierra Leone', 'alpha2' => 'SL', 'alpha3' => 'SLE', 'numeric' => '694', 'currency' => [ 'SLL', ], ], [ 'name' => 'Singapore', 'alpha2' => 'SG', 'alpha3' => 'SGP', 'numeric' => '702', 'currency' => [ 'SGD', ], ], [ 'name' => 'Sint Maarten (Dutch part)', 'alpha2' => 'SX', 'alpha3' => 'SXM', 'numeric' => '534', 'currency' => [ 'ANG', ], ], [ 'name' => 'Slovakia', 'alpha2' => 'SK', 'alpha3' => 'SVK', 'numeric' => '703', 'currency' => [ 'EUR', ], ], [ 'name' => 'Slovenia', 'alpha2' => 'SI', 'alpha3' => 'SVN', 'numeric' => '705', 'currency' => [ 'EUR', ], ], [ 'name' => 'Solomon Islands', 'alpha2' => 'SB', 'alpha3' => 'SLB', 'numeric' => '090', 'currency' => [ 'SBD', ], ], [ 'name' => 'Somalia', 'alpha2' => 'SO', 'alpha3' => 'SOM', 'numeric' => '706', 'currency' => [ 'SOS', ], ], [ 'name' => 'South Africa', 'alpha2' => 'ZA', 'alpha3' => 'ZAF', 'numeric' => '710', 'currency' => [ 'ZAR', ], ], [ 'name' => 'South Georgia and the South Sandwich Islands', 'alpha2' => 'GS', 'alpha3' => 'SGS', 'numeric' => '239', 'currency' => [ 'GBP', ], ], [ 'name' => 'South Sudan', 'alpha2' => 'SS', 'alpha3' => 'SSD', 'numeric' => '728', 'currency' => [ 'SSP', ], ], [ 'name' => 'Spain', 'alpha2' => 'ES', 'alpha3' => 'ESP', 'numeric' => '724', 'currency' => [ 'EUR', ], ], [ 'name' => 'Sri Lanka', 'alpha2' => 'LK', 'alpha3' => 'LKA', 'numeric' => '144', 'currency' => [ 'LKR', ], ], [ 'name' => 'Sudan', 'alpha2' => 'SD', 'alpha3' => 'SDN', 'numeric' => '729', 'currency' => [ 'SDG', ], ], [ 'name' => 'Suriname', 'alpha2' => 'SR', 'alpha3' => 'SUR', 'numeric' => '740', 'currency' => [ 'SRD', ], ], [ 'name' => 'Svalbard and Jan Mayen', 'alpha2' => 'SJ', 'alpha3' => 'SJM', 'numeric' => '744', 'currency' => [ 'NOK', ], ], [ 'name' => 'Sweden', 'alpha2' => 'SE', 'alpha3' => 'SWE', 'numeric' => '752', 'currency' => [ 'SEK', ], ], [ 'name' => 'Switzerland', 'alpha2' => 'CH', 'alpha3' => 'CHE', 'numeric' => '756', 'currency' => [ 'CHF', ], ], [ 'name' => 'Syrian Arab Republic', 'alpha2' => 'SY', 'alpha3' => 'SYR', 'numeric' => '760', 'currency' => [ 'SYP', ], ], [ 'name' => 'Taiwan (Province of China)', 'alpha2' => 'TW', 'alpha3' => 'TWN', 'numeric' => '158', 'currency' => [ 'TWD', ], ], [ 'name' => 'Tajikistan', 'alpha2' => 'TJ', 'alpha3' => 'TJK', 'numeric' => '762', 'currency' => [ 'TJS', ], ], [ 'name' => 'Tanzania, United Republic of', 'alpha2' => 'TZ', 'alpha3' => 'TZA', 'numeric' => '834', 'currency' => [ 'TZS', ], ], [ 'name' => 'Thailand', 'alpha2' => 'TH', 'alpha3' => 'THA', 'numeric' => '764', 'currency' => [ 'THB', ], ], [ 'name' => 'Timor-Leste', 'alpha2' => 'TL', 'alpha3' => 'TLS', 'numeric' => '626', 'currency' => [ 'USD', ], ], [ 'name' => 'Togo', 'alpha2' => 'TG', 'alpha3' => 'TGO', 'numeric' => '768', 'currency' => [ 'XOF', ], ], [ 'name' => 'Tokelau', 'alpha2' => 'TK', 'alpha3' => 'TKL', 'numeric' => '772', 'currency' => [ 'NZD', ], ], [ 'name' => 'Tonga', 'alpha2' => 'TO', 'alpha3' => 'TON', 'numeric' => '776', 'currency' => [ 'TOP', ], ], [ 'name' => 'Trinidad and Tobago', 'alpha2' => 'TT', 'alpha3' => 'TTO', 'numeric' => '780', 'currency' => [ 'TTD', ], ], [ 'name' => 'Tunisia', 'alpha2' => 'TN', 'alpha3' => 'TUN', 'numeric' => '788', 'currency' => [ 'TND', ], ], [ 'name' => 'Türkiye', 'alpha2' => 'TR', 'alpha3' => 'TUR', 'numeric' => '792', 'currency' => [ 'TRY', ], ], [ 'name' => 'Turkmenistan', 'alpha2' => 'TM', 'alpha3' => 'TKM', 'numeric' => '795', 'currency' => [ 'TMT', ], ], [ 'name' => 'Turks and Caicos Islands', 'alpha2' => 'TC', 'alpha3' => 'TCA', 'numeric' => '796', 'currency' => [ 'USD', ], ], [ 'name' => 'Tuvalu', 'alpha2' => 'TV', 'alpha3' => 'TUV', 'numeric' => '798', 'currency' => [ 'AUD', ], ], [ 'name' => 'Uganda', 'alpha2' => 'UG', 'alpha3' => 'UGA', 'numeric' => '800', 'currency' => [ 'UGX', ], ], [ 'name' => 'Ukraine', 'alpha2' => 'UA', 'alpha3' => 'UKR', 'numeric' => '804', 'currency' => [ 'UAH', ], ], [ 'name' => 'United Arab Emirates', 'alpha2' => 'AE', 'alpha3' => 'ARE', 'numeric' => '784', 'currency' => [ 'AED', ], ], [ 'name' => 'United Kingdom of Great Britain and Northern Ireland', 'alpha2' => 'GB', 'alpha3' => 'GBR', 'numeric' => '826', 'currency' => [ 'GBP', ], ], [ 'name' => 'United States of America', 'alpha2' => 'US', 'alpha3' => 'USA', 'numeric' => '840', 'currency' => [ 'USD', ], ], [ 'name' => 'United States Minor Outlying Islands', 'alpha2' => 'UM', 'alpha3' => 'UMI', 'numeric' => '581', 'currency' => [ 'USD', ], ], [ 'name' => 'Uruguay', 'alpha2' => 'UY', 'alpha3' => 'URY', 'numeric' => '858', 'currency' => [ 'UYU', ], ], [ 'name' => 'Uzbekistan', 'alpha2' => 'UZ', 'alpha3' => 'UZB', 'numeric' => '860', 'currency' => [ 'UZS', ], ], [ 'name' => 'Vanuatu', 'alpha2' => 'VU', 'alpha3' => 'VUT', 'numeric' => '548', 'currency' => [ 'VUV', ], ], [ 'name' => 'Venezuela (Bolivarian Republic of)', 'alpha2' => 'VE', 'alpha3' => 'VEN', 'numeric' => '862', 'currency' => [ 'VEF', ], ], [ 'name' => 'Viet Nam', 'alpha2' => 'VN', 'alpha3' => 'VNM', 'numeric' => '704', 'currency' => [ 'VND', ], ], [ 'name' => 'Virgin Islands (British)', 'alpha2' => 'VG', 'alpha3' => 'VGB', 'numeric' => '092', 'currency' => [ 'USD', ], ], [ 'name' => 'Virgin Islands (U.S.)', 'alpha2' => 'VI', 'alpha3' => 'VIR', 'numeric' => '850', 'currency' => [ 'USD', ], ], [ 'name' => 'Wallis and Futuna', 'alpha2' => 'WF', 'alpha3' => 'WLF', 'numeric' => '876', 'currency' => [ 'XPF', ], ], [ 'name' => 'Western Sahara', 'alpha2' => 'EH', 'alpha3' => 'ESH', 'numeric' => '732', 'currency' => [ 'MAD', ], ], [ 'name' => 'Yemen', 'alpha2' => 'YE', 'alpha3' => 'YEM', 'numeric' => '887', 'currency' => [ 'YER', ], ], [ 'name' => 'Zambia', 'alpha2' => 'ZM', 'alpha3' => 'ZMB', 'numeric' => '894', 'currency' => [ 'ZMW', ], ], [ 'name' => 'Zimbabwe', 'alpha2' => 'ZW', 'alpha3' => 'ZWE', 'numeric' => '716', 'currency' => [ 'BWP', 'EUR', 'GBP', 'USD', 'ZAR', ], ], ]; } League/ISO3166/Guards.php 0000777 00000004062 15252673315 0010700 0 ustar 00 <?php declare(strict_types=1); /* * (c) Rob Bast <rob.bast@gmail.com> * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\League\ISO3166; use Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException; final class Guards { /** * Assert that input is not an empty string. * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException if input is an empty string */ public static function guardAgainstInvalidName(string $name): void { if ('' === trim($name)) { throw new DomainException('Expected string, got empty string'); } } /** * Assert that input looks like an alpha2 key. * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException if input does not look like an alpha2 key */ public static function guardAgainstInvalidAlpha2(string $alpha2): void { if (1 !== preg_match('/^[a-zA-Z]{2}$/', $alpha2)) { throw new DomainException(sprintf('Not a valid alpha2 key: %s', $alpha2)); } } /** * Assert that input looks like an alpha3 key. * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException if input does not look like an alpha3 key */ public static function guardAgainstInvalidAlpha3(string $alpha3): void { if (1 !== preg_match('/^[a-zA-Z]{3}$/', $alpha3)) { throw new DomainException(sprintf('Not a valid alpha3 key: %s', $alpha3)); } } /** * Assert that input looks like a numeric key. * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException if input does not look like a numeric key */ public static function guardAgainstInvalidNumeric(string $numeric): void { if (1 !== preg_match('/^\d{3}$/', $numeric)) { throw new DomainException(sprintf('Not a valid numeric key: %s', $numeric)); } } } League/ISO3166/ISO3166DataProvider.php 0000777 00000003662 15252673315 0012737 0 ustar 00 <?php declare(strict_types=1); /* * (c) Rob Bast <rob.bast@gmail.com> * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace Automattic\WooCommerce\Vendor\League\ISO3166; interface ISO3166DataProvider { /** * Lookup ISO3166-1 data by name identifier. * * @api * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\OutOfBoundsException if input does not exist in dataset * * @return array<string, mixed> */ public function name(string $name): array; /** * Lookup ISO3166-1 data by alpha2 identifier. * * @api * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException if input does not look like an alpha2 key * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\OutOfBoundsException if input does not exist in dataset * * @return array<string, mixed> */ public function alpha2(string $alpha2): array; /** * Lookup ISO3166-1 data by alpha3 identifier. * * @api * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException if input does not look like an alpha3 key * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\OutOfBoundsException if input does not exist in dataset * * @return array<string, mixed> */ public function alpha3(string $alpha3): array; /** * Lookup ISO3166-1 data by numeric identifier (numerical string, that is). * * @api * * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\DomainException if input does not look like a numeric key * @throws \Automattic\WooCommerce\Vendor\League\ISO3166\Exception\OutOfBoundsException if input does not exist in dataset * * @return array<string, mixed> */ public function numeric(string $numeric): array; } Pelago/Emogrifier/Utilities/DeclarationBlockParser.php 0000777 00000005467 15252673315 0017140 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities; /** * Provides a common method for parsing CSS declaration blocks. * These might be from actual CSS, or from the `style` attribute of an HTML DOM element. * * Caches results globally. * * @internal */ final class DeclarationBlockParser { /** * @var array<string, array<non-empty-string, string>> */ private static $cache = []; /** * CSS custom properties (variables) have case-sensitive names, so their case must be preserved. * Standard CSS properties have case-insensitive names, which are converted to lowercase. * * @param non-empty-string $name * * @return non-empty-string */ public function normalizePropertyName(string $name): string { if (\substr($name, 0, 2) === '--') { return $name; } else { return \strtolower($name); } } /** * Parses a CSS declaration block into property name/value pairs. * * Example: * * The declaration block * * "color: #000; font-weight: bold;" * * will be parsed into the following array: * * "color" => "#000" * "font-weight" => "bold" * * @param string $declarationBlock the CSS declarations block without the curly braces, may be empty * * @return array<non-empty-string, string> * the CSS declarations with the property names as array keys and the property values as array values * * @throws \UnexpectedValueException if an empty property name is encountered (which cannot happen) */ public function parse(string $declarationBlock): array { if (isset(self::$cache[$declarationBlock])) { return self::$cache[$declarationBlock]; } $preg = new Preg(); $declarations = $preg->split('/;(?!base64|charset)/', $declarationBlock); $properties = []; foreach ($declarations as $declaration) { $matches = []; if ( $preg->match( '/^([A-Za-z\\-]+)\\s*:\\s*(.+)$/s', \trim($declaration), $matches ) === 0 ) { continue; } $propertyName = $matches[1]; if ($propertyName === '') { // This cannot happen since the regular epression matches one or more characters. throw new \UnexpectedValueException('An empty property name was encountered.', 1727046409); } $propertyValue = $matches[2]; $properties[$this->normalizePropertyName($propertyName)] = $propertyValue; } self::$cache[$declarationBlock] = $properties; return $properties; } } Pelago/Emogrifier/Utilities/ArrayIntersector.php 0000777 00000003624 15252673315 0016054 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities; /** * When computing many array intersections using the same array, it is more efficient to use `array_flip()` first and * then `array_intersect_key()`, than `array_intersect()`. See the discussion at * {@link https://stackoverflow.com/questions/6329211/php-array-intersect-efficiency Stack Overflow} for more * information. * * Of course, this is only possible if the arrays contain integer or string values, and either don't contain duplicates, * or that fact that duplicates will be removed does not matter. * * This class takes care of the detail. * * @internal */ final class ArrayIntersector { /** * the array with which the object was constructed, with all its keys exchanged with their associated values * * @var array<array-key, array-key> */ private $invertedArray; /** * Constructs the object with the array that will be reused for many intersection computations. * * @param array<array-key, array-key> $array */ public function __construct(array $array) { $this->invertedArray = \array_flip($array); } /** * Computes the intersection of `$array` and the array with which this object was constructed. * * @param array<array-key, array-key> $array * * @return array<array-key, array-key> * Returns an array containing all of the values in `$array` whose values exist in the array * with which this object was constructed. Note that keys are preserved, order is maintained, but * duplicates are removed. */ public function intersectWith(array $array): array { $invertedArray = \array_flip($array); $invertedIntersection = \array_intersect_key($invertedArray, $this->invertedArray); return \array_flip($invertedIntersection); } } Pelago/Emogrifier/Utilities/CssConcatenator.php 0000777 00000015164 15252673315 0015647 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities; /** * Facilitates building a CSS string by appending rule blocks one at a time, checking whether the media query, * selectors, or declarations block are the same as those from the preceding block and combining blocks in such cases. * * Example: * $concatenator = new CssConcatenator(); * $concatenator->append(['body'], 'color: blue;'); * $concatenator->append(['body'], 'font-size: 16px;'); * $concatenator->append(['p'], 'margin: 1em 0;'); * $concatenator->append(['ul', 'ol'], 'margin: 1em 0;'); * $concatenator->append(['body'], 'font-size: 14px;', '@media screen and (max-width: 400px)'); * $concatenator->append(['ul', 'ol'], 'margin: 0.75em 0;', '@media screen and (max-width: 400px)'); * $css = $concatenator->getCss(); * * `$css` (if unminified) would contain the following CSS: * ` body { * ` color: blue; * ` font-size: 16px; * ` } * ` p, ul, ol { * ` margin: 1em 0; * ` } * ` @media screen and (max-width: 400px) { * ` body { * ` font-size: 14px; * ` } * ` ul, ol { * ` margin: 0.75em 0; * ` } * ` } * * @internal */ final class CssConcatenator { /** * Array of media rules in order. Each element is an object with the following properties: * - string `media` - The media query string, e.g. "@media screen and (max-width:639px)", or an empty string for * rules not within a media query block; * - object[] `ruleBlocks` - Array of rule blocks in order, where each element is an object with the following * properties: * - mixed[] `selectorsAsKeys` - Array whose keys are selectors for the rule block (values are of no * significance); * - string `declarationsBlock` - The property declarations, e.g. "margin-top: 0.5em; padding: 0". * * @var array<int, object{ * media: string, * ruleBlocks: array<int, object{ * selectorsAsKeys: array<string, array-key>, * declarationsBlock: string * }> * }> */ private $mediaRules = []; /** * Appends a declaration block to the CSS. * * @param array<array-key, string> $selectors * array of selectors for the rule, e.g. ["ul", "ol", "p:first-child"] * @param string $declarationsBlock * the property declarations, e.g. "margin-top: 0.5em; padding: 0" * @param string $media * the media query for the rule, e.g. "@media screen and (max-width:639px)", or an empty string if none */ public function append(array $selectors, string $declarationsBlock, string $media = ''): void { $selectorsAsKeys = \array_flip($selectors); $mediaRule = $this->getOrCreateMediaRuleToAppendTo($media); $ruleBlocks = $mediaRule->ruleBlocks; $lastRuleBlock = \end($ruleBlocks); $hasSameDeclarationsAsLastRule = \is_object($lastRuleBlock) && $declarationsBlock === $lastRuleBlock->declarationsBlock; if ($hasSameDeclarationsAsLastRule) { $lastRuleBlock->selectorsAsKeys += $selectorsAsKeys; } else { $lastRuleBlockSelectors = \is_object($lastRuleBlock) ? $lastRuleBlock->selectorsAsKeys : []; $hasSameSelectorsAsLastRule = \is_object($lastRuleBlock) && self::hasEquivalentSelectors($selectorsAsKeys, $lastRuleBlockSelectors); if ($hasSameSelectorsAsLastRule) { $lastDeclarationsBlockWithoutSemicolon = \rtrim(\rtrim($lastRuleBlock->declarationsBlock), ';'); $lastRuleBlock->declarationsBlock = $lastDeclarationsBlockWithoutSemicolon . ';' . $declarationsBlock; } else { $mediaRule->ruleBlocks[] = (object) \compact('selectorsAsKeys', 'declarationsBlock'); } } } /** * @return string */ public function getCss(): string { return \implode('', \array_map([self::class, 'getMediaRuleCss'], $this->mediaRules)); } /** * @param string $media The media query for rules to be appended, e.g. "@media screen and (max-width:639px)", * or an empty string if none. * * @return object{ * media: string, * ruleBlocks: array<int, object{ * selectorsAsKeys: array<string, array-key>, * declarationsBlock: string * }> * } */ private function getOrCreateMediaRuleToAppendTo(string $media): object { $lastMediaRule = \end($this->mediaRules); if (\is_object($lastMediaRule) && $media === $lastMediaRule->media) { return $lastMediaRule; } $newMediaRule = (object) [ 'media' => $media, 'ruleBlocks' => [], ]; $this->mediaRules[] = $newMediaRule; return $newMediaRule; } /** * Tests if two sets of selectors are equivalent (i.e. the same selectors, possibly in a different order). * * @param array<string, array-key> $selectorsAsKeys1 * array in which the selectors are the keys, and the values are of no significance * @param array<string, array-key> $selectorsAsKeys2 another such array * * @return bool */ private static function hasEquivalentSelectors(array $selectorsAsKeys1, array $selectorsAsKeys2): bool { return \count($selectorsAsKeys1) === \count($selectorsAsKeys2) && \count($selectorsAsKeys1) === \count($selectorsAsKeys1 + $selectorsAsKeys2); } /** * @param object{ * media: string, * ruleBlocks: array<int, object{ * selectorsAsKeys: array<string, array-key>, * declarationsBlock: string * }> * } $mediaRule * * @return string CSS for the media rule. */ private static function getMediaRuleCss(object $mediaRule): string { $ruleBlocks = $mediaRule->ruleBlocks; $css = \implode('', \array_map([self::class, 'getRuleBlockCss'], $ruleBlocks)); $media = $mediaRule->media; if ($media !== '') { $css = $media . '{' . $css . '}'; } return $css; } /** * @param object{selectorsAsKeys: array<string, array-key>, declarationsBlock: string} $ruleBlock * * @return string CSS for the rule block. */ private static function getRuleBlockCss(object $ruleBlock): string { $selectorsAsKeys = $ruleBlock->selectorsAsKeys; $selectors = \array_keys($selectorsAsKeys); $declarationsBlock = $ruleBlock->declarationsBlock; return \implode(',', $selectors) . '{' . $declarationsBlock . '}'; } } Pelago/Emogrifier/Utilities/Preg.php 0000777 00000015555 15252673315 0013457 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities; /** * PHP's `preg_*` functions can return `false` on failure. * Failure is rare but may occur with a complex pattern applied to a long subject. * Catastrophic backtracking may occur ({@see https://www.regular-expressions.info/catastrophic.html}). * Failure may also occur due to programmer error, if an invalid pattern is provided. * * Catering for failure in each case clutters up the code with error handling. * This class provides wrappers for some `preg_*` functions, with errors handled either * - by throwing an exception, or * - by triggering a user error and providing fallback logic (e.g. returning the subject string unmodified). * * @internal */ final class Preg { /** * whether to throw exceptions on errors (or call `trigger_error` and implement fallback) * * @var bool */ private $throwExceptions = false; /** * Sets whether exceptions should be thrown if an error occurs. */ public function throwExceptions(bool $throw): self { $this->throwExceptions = $throw; return $this; } /** * Wraps `preg_replace`, though does not support `$subject` being an array. * If an error occurs, and exceptions are not being thrown, the original `$subject` is returned. * * @param non-empty-string|non-empty-array<non-empty-string> $pattern * @param string|non-empty-array<string> $replacement * * @throws \RuntimeException */ public function replace($pattern, $replacement, string $subject, int $limit = -1, ?int &$count = null): string { $result = \preg_replace($pattern, $replacement, $subject, $limit, $count); if ($result === null) { $this->logOrThrowPregLastError(); $result = $subject; } return $result; } /** * Wraps `preg_replace_callback`, though does not support `$subject` being an array. * If an error occurs, and exceptions are not being thrown, the original `$subject` is returned. * * Note that (unlike when calling `preg_replace_callback`), `$callback` cannot be a non-public method * represented by an array comprising an object or class name and the method name. * To circumvent that, use `\Closure::fromCallable([$objectOrClassName, 'method'])`. * * @param non-empty-string|non-empty-array<non-empty-string> $pattern * * @throws \RuntimeException */ public function replaceCallback( $pattern, callable $callback, string $subject, int $limit = -1, ?int &$count = null ): string { $result = \preg_replace_callback($pattern, $callback, $subject, $limit, $count); if ($result === null) { $this->logOrThrowPregLastError(); $result = $subject; } return $result; } /** * Wraps `preg_split`. * If an error occurs, and exceptions are not being thrown, * a single-element array containing the original `$subject` is returned. * This method does not support the `PREG_SPLIT_OFFSET_CAPTURE` flag and will throw an exception if it is specified. * * @param non-empty-string $pattern * * @return array<int, string> * * @throws \RuntimeException */ public function split(string $pattern, string $subject, int $limit = -1, int $flags = 0): array { if (($flags & PREG_SPLIT_OFFSET_CAPTURE) !== 0) { throw new \RuntimeException('PREG_SPLIT_OFFSET_CAPTURE is not supported by Preg::split', 1726506348); } $result = \preg_split($pattern, $subject, $limit, $flags); if ($result === false) { $this->logOrThrowPregLastError(); $result = [$subject]; } return $result; } /** * Wraps `preg_match`. * If an error occurs, and exceptions are not being thrown, * zero (`0`) is returned, and if the `$matches` parameter is provided, it is set to an empty array. * This method does not currently support the `$flags` or `$offset` parameters. * * @param non-empty-string $pattern * @param array<int, string> $matches * * @return 0|1 * * @throws \RuntimeException */ public function match(string $pattern, string $subject, ?array &$matches = null): int { $result = \preg_match($pattern, $subject, $matches); if ($result === false) { $this->logOrThrowPregLastError(); $result = 0; $matches = []; } return $result; } /** * Wraps `preg_match_all`. * * If an error occurs, and exceptions are not being thrown, zero (`0`) is returned. * * In the error case, if the `$matches` parameter is provided, it is set to an array containing empty arrays for the * full pattern match and any possible subpattern match that might be expected. * The algorithm to determine the length of this array simply counts the number of opening parentheses in the * `$pattern`, which may result in a longer array than expected, but guarantees that it is at least as long as * expected. * * This method does not currently support the `$flags` or `$offset` parameters. * * @param non-empty-string $pattern * @param array<int, array<int, string>> $matches * * @throws \RuntimeException */ public function matchAll(string $pattern, string $subject, ?array &$matches = null): int { $result = \preg_match_all($pattern, $subject, $matches); if ($result === false) { $this->logOrThrowPregLastError(); $result = 0; $matches = \array_fill(0, \substr_count($pattern, '(') + 1, []); } return $result; } /** * Obtains the name of the error constant for `preg_last_error` * (based on code posted at {@see https://www.php.net/manual/en/function.preg-last-error.php#124124}) * and puts it into an error message which is either passed to `trigger_error` * or used in the exception which is thrown (depending on the `$throwExceptions` property). * * @throws \RuntimeException */ private function logOrThrowPregLastError(): void { $pcreConstants = \get_defined_constants(true)['pcre']; $pcreErrorConstantNames = \array_flip(\array_filter( $pcreConstants, static function (string $key): bool { return \substr($key, -6) === '_ERROR'; }, ARRAY_FILTER_USE_KEY )); $pregLastError = \preg_last_error(); $message = 'PCRE regex execution error `' . (string) ($pcreErrorConstantNames[$pregLastError] ?? $pregLastError) . '`'; if ($this->throwExceptions) { throw new \RuntimeException($message, 1592870147); } \trigger_error($message); } } Pelago/Emogrifier/Caching/SimpleStringCache.php 0000777 00000004075 15252673315 0015502 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Caching; /** * This cache caches string values with string keys. It is not PSR-6-compliant. * * Usage: * * ```php * $cache = new SimpleStringCache(); * $cache->set($key, $value); * … * if ($cache->has($key) { * $cachedValue = $cache->get($value); * } * ``` * * @internal */ final class SimpleStringCache { /** * @var array<string, string> */ private $values = []; /** * Checks whether there is an entry stored for the given key. * * @param string $key the key to check; must not be empty * * @throws \InvalidArgumentException */ public function has(string $key): bool { $this->assertNotEmptyKey($key); return isset($this->values[$key]); } /** * Returns the entry stored for the given key, and throws an exception if the value does not exist * (which helps keep the return type simple). * * @param string $key the key to of the item to retrieve; must not be empty * * @return string the retrieved value; may be empty * * @throws \BadMethodCallException */ public function get(string $key): string { if (!$this->has($key)) { throw new \BadMethodCallException('You can only call `get` with a key for an existing value.', 1625996246); } return $this->values[$key]; } /** * Sets or overwrites an entry. * * @param string $key the key to of the item to set; must not be empty * @param string $value the value to set; can be empty * * @throws \BadMethodCallException */ public function set(string $key, string $value): void { $this->assertNotEmptyKey($key); $this->values[$key] = $value; } /** * @throws \InvalidArgumentException */ private function assertNotEmptyKey(string $key): void { if ($key === '') { throw new \InvalidArgumentException('Please provide a non-empty key.', 1625995840); } } } Pelago/Emogrifier/Css/CssDocument.php 0000777 00000017362 15252673315 0013564 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Css; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\Preg; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList\AtRuleBlockList as CssAtRuleBlockList; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList\Document as SabberwormCssDocument; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parser as CssParser; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\AtRule as CssAtRule; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\Charset as CssCharset; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\Import as CssImport; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Renderable as CssRenderable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\DeclarationBlock as CssDeclarationBlock; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\RuleSet as CssRuleSet; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Settings as ParserSettings; /** * Parses and stores a CSS document from a string of CSS, and provides methods to obtain the CSS in parts or as data * structures. * * @internal */ final class CssDocument { /** * @var SabberwormCssDocument */ private $sabberwormCssDocument; /** * `@import` rules must precede all other types of rules, except `@charset` rules. This property is used while * rendering at-rules to enforce that. * * @var bool */ private $isImportRuleAllowed = true; /** * @param string $css * @param bool $debug * If this is `true`, an exception will be thrown if invalid CSS is encountered. * Otherwise the parser will try to do the best it can. */ public function __construct(string $css, bool $debug) { // CSS Parser currently throws exception with nested at-rules (like `@media`) in strict parsing mode $parserSettings = ParserSettings::create()->withLenientParsing(!$debug || $this->hasNestedAtRule($css)); // CSS Parser currently throws exception with non-empty whitespace-only CSS in strict parsing mode, so `trim()` // @see https://github.com/sabberworm/PHP-CSS-Parser/issues/349 $this->sabberwormCssDocument = (new CssParser(\trim($css), $parserSettings))->parse(); } /** * Tests if a string of CSS appears to contain an at-rule with nested rules * (`@media`, `@supports`, `@keyframes`, `@document`, * the latter two additionally with vendor prefixes that may commonly be used). * * @see https://github.com/sabberworm/PHP-CSS-Parser/issues/127 */ private function hasNestedAtRule(string $css): bool { return (new Preg()) ->match('/@(?:media|supports|(?:-webkit-|-moz-|-ms-|-o-)?+(keyframes|document))\\b/', $css) !== 0; } /** * Collates the media query, selectors and declarations for individual rules from the parsed CSS, in order. * * @param array<array-key, string> $allowedMediaTypes * * @return list<StyleRule> */ public function getStyleRulesData(array $allowedMediaTypes): array { $ruleMatches = []; /** @var CssRenderable $rule */ foreach ($this->sabberwormCssDocument->getContents() as $rule) { if ($rule instanceof CssAtRuleBlockList) { $containingAtRule = $this->getFilteredAtIdentifierAndRule($rule, $allowedMediaTypes); if (\is_string($containingAtRule)) { /** @var CssRenderable $nestedRule */ foreach ($rule->getContents() as $nestedRule) { if ($nestedRule instanceof CssDeclarationBlock) { $ruleMatches[] = new StyleRule($nestedRule, $containingAtRule); } } } } elseif ($rule instanceof CssDeclarationBlock) { $ruleMatches[] = new StyleRule($rule); } } return $ruleMatches; } /** * Renders at-rules from the parsed CSS that are valid and not conditional group rules (i.e. not rules such as * `@media` which contain style rules whose data is returned by {@see getStyleRulesData}). Also does not render * `@charset` rules; these are discarded (only UTF-8 is supported). * * @return string */ public function renderNonConditionalAtRules(): string { $this->isImportRuleAllowed = true; $cssContents = $this->sabberwormCssDocument->getContents(); $atRules = \array_filter($cssContents, [$this, 'isValidAtRuleToRender']); if ($atRules === []) { return ''; } $atRulesDocument = new SabberwormCssDocument(); $atRulesDocument->setContents($atRules); return $atRulesDocument->render(); } /** * @param CssAtRuleBlockList $rule * @param array<array-key, string> $allowedMediaTypes * * @return ?string * If the nested at-rule is supported, it's opening declaration (e.g. "@media (max-width: 768px)") is * returned; otherwise the return value is null. */ private function getFilteredAtIdentifierAndRule(CssAtRuleBlockList $rule, array $allowedMediaTypes): ?string { $result = null; if ($rule->atRuleName() === 'media') { $mediaQueryList = $rule->atRuleArgs(); [$mediaType] = \explode('(', $mediaQueryList, 2); if (\trim($mediaType) !== '') { $escapedAllowedMediaTypes = \array_map( static function (string $allowedMediaType): string { return \preg_quote($allowedMediaType, '/'); }, $allowedMediaTypes ); $mediaTypesMatcher = \implode('|', $escapedAllowedMediaTypes); $isAllowed = (new Preg())->match('/^\\s*+(?:only\\s++)?+(?:' . $mediaTypesMatcher . ')/i', $mediaType) !== 0; } else { $isAllowed = true; } if ($isAllowed) { $result = '@media ' . $mediaQueryList; } } return $result; } /** * Tests if a CSS rule is an at-rule that should be passed though and copied to a `<style>` element unmodified: * - `@charset` rules are discarded - only UTF-8 is supported - `false` is returned; * - `@import` rules are passed through only if they satisfy the specification ("user agents must ignore any * '@import' rule that occurs inside a block or after any non-ignored statement other than an '@charset' or an * '@import' rule"); * - `@media` rules are processed separately to see if their nested rules apply - `false` is returned; * - `@font-face` rules are checked for validity - they must contain both a `src` and `font-family` property; * - other at-rules are assumed to be valid and treated as a black box - `true` is returned. * * @param CssRenderable $rule * * @return bool */ private function isValidAtRuleToRender(CssRenderable $rule): bool { if ($rule instanceof CssCharset) { return false; } if ($rule instanceof CssImport) { return $this->isImportRuleAllowed; } $this->isImportRuleAllowed = false; if (!$rule instanceof CssAtRule) { return false; } switch ($rule->atRuleName()) { case 'media': $result = false; break; case 'font-face': $result = $rule instanceof CssRuleSet && $rule->getRules('font-family') !== [] && $rule->getRules('src') !== []; break; default: $result = true; } return $result; } } Pelago/Emogrifier/Css/StyleRule.php 0000777 00000004335 15252673315 0013261 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Css; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\DeclarationBlock; /** * This class represents a CSS style rule, including selectors, a declaration block, and an optional containing at-rule. * * @internal */ final class StyleRule { /** * @var DeclarationBlock */ private $declarationBlock; /** * @var string */ private $containingAtRule; /** * @param DeclarationBlock $declarationBlock * @param string $containingAtRule e.g. `@media screen and (max-width: 480px)` */ public function __construct(DeclarationBlock $declarationBlock, string $containingAtRule = '') { $this->declarationBlock = $declarationBlock; $this->containingAtRule = \trim($containingAtRule); } /** * @return array<int, string> the selectors, e.g. `["h1", "p"]` */ public function getSelectors(): array { /** @var array<int, Selector> $selectors */ $selectors = $this->declarationBlock->getSelectors(); return \array_map( static function (Selector $selector): string { return (string) $selector; }, $selectors ); } /** * @return string the CSS declarations, separated and followed by a semicolon, e.g., `color: red; height: 4px;` */ public function getDeclarationAsText(): string { return \implode(' ', $this->declarationBlock->getRules()); } /** * Checks whether the declaration block has at least one declaration. */ public function hasAtLeastOneDeclaration(): bool { return $this->declarationBlock->getRules() !== []; } /** * @returns string e.g. `@media screen and (max-width: 480px)`, or an empty string */ public function getContainingAtRule(): string { return $this->containingAtRule; } /** * Checks whether the containing at-rule is non-empty and has any non-whitespace characters. */ public function hasContainingAtRule(): bool { return $this->getContainingAtRule() !== ''; } } Pelago/Emogrifier/HtmlProcessor/HtmlNormalizer.php 0000777 00000000545 15252673315 0016353 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\HtmlProcessor; /** * Normalizes HTML: * - add a document type (HTML5) if missing * - disentangle incorrectly nested tags * - add HEAD and BODY elements (if they are missing) * - reformat the HTML */ final class HtmlNormalizer extends AbstractHtmlProcessor {} Pelago/Emogrifier/HtmlProcessor/CssVariableEvaluator.php 0000777 00000016263 15252673315 0017471 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\HtmlProcessor; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\DeclarationBlockParser; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\Preg; /** * This class can evaluate CSS custom properties that are defined and used in inline style attributes. */ final class CssVariableEvaluator extends AbstractHtmlProcessor { /** * temporary collection used by {@see replaceVariablesInDeclarations} and callee methods * * @var array<non-empty-string, string> */ private $currentVariableDefinitions = []; /** * Replaces all CSS custom property references in inline style attributes with their corresponding values where * defined in inline style attributes (either from the element itself or the nearest ancestor). * * @return $this * * @throws \UnexpectedValueException */ public function evaluateVariables(): self { return $this->evaluateVariablesInElementAndDescendants($this->getHtmlElement(), []); } /** * @param array<non-empty-string, string> $declarations * * @return array<non-empty-string, string> */ private function getVariableDefinitionsFromDeclarations(array $declarations): array { return \array_filter( $declarations, static function (string $key): bool { return \substr($key, 0, 2) === '--'; }, ARRAY_FILTER_USE_KEY ); } /** * Callback function for {@see replaceVariablesInPropertyValue} performing regular expression replacement. * * @param array<int, string> $matches */ private function getPropertyValueReplacement(array $matches): string { $variableName = $matches[1]; if (isset($this->currentVariableDefinitions[$variableName])) { $variableValue = $this->currentVariableDefinitions[$variableName]; } else { $fallbackValueSeparator = $matches[2] ?? ''; if ($fallbackValueSeparator !== '') { $fallbackValue = $matches[3]; // The fallback value may use other CSS variables, so recurse $variableValue = $this->replaceVariablesInPropertyValue($fallbackValue); } else { $variableValue = $matches[0]; } } return $variableValue; } /** * Regular expression based on {@see https://stackoverflow.com/a/54143883/2511031 a StackOverflow answer}. */ private function replaceVariablesInPropertyValue(string $propertyValue): string { return (new Preg())->replaceCallback( '/ var\\( \\s*+ # capture variable name including `--` prefix ( --[^\\s\\),]++ ) \\s*+ # capture optional fallback value (?: # capture separator to confirm there is a fallback value (,)\\s* # begin capture with named group that can be used recursively (?<recursable> # begin named group to match sequence without parentheses, except in strings (?<noparentheses> # repeated zero or more times: (?: # sequence without parentheses or quotes [^\\(\\)\'"]++ | # string in double quotes "(?>[^"\\\\]++|\\\\.)*" | # string in single quotes \'(?>[^\'\\\\]++|\\\\.)*\' )*+ ) # repeated zero or more times: (?: # sequence in parentheses \\( # using the named recursable pattern (?&recursable) \\) # sequence without parentheses, except in strings (?&noparentheses) )*+ ) )?+ \\) /x', \Closure::fromCallable([$this, 'getPropertyValueReplacement']), $propertyValue ); } /** * @param array<non-empty-string, string> $declarations * * @return ?array<non-empty-string, string> `null` is returned if no substitutions were made. */ private function replaceVariablesInDeclarations(array $declarations): ?array { $substitutionsMade = false; $result = \array_map( function (string $propertyValue) use (&$substitutionsMade): string { $newPropertyValue = $this->replaceVariablesInPropertyValue($propertyValue); if ($newPropertyValue !== $propertyValue) { $substitutionsMade = true; } return $newPropertyValue; }, $declarations ); return $substitutionsMade ? $result : null; } /** * @param array<non-empty-string, string> $declarations */ private function getDeclarationsAsString(array $declarations): string { $declarationStrings = \array_map( static function (string $key, string $value): string { return $key . ': ' . $value; }, \array_keys($declarations), \array_values($declarations) ); return \implode('; ', $declarationStrings) . ';'; } /** * @param array<non-empty-string, string> $ancestorVariableDefinitions * * @return $this */ private function evaluateVariablesInElementAndDescendants( \DOMElement $element, array $ancestorVariableDefinitions ): self { $style = $element->getAttribute('style'); // Avoid parsing declarations if none use or define a variable if ((new Preg())->match('/(?<![\\w\\-])--[\\w\\-]/', $style) !== 0) { $declarations = (new DeclarationBlockParser())->parse($style); $variableDefinitions = $this->currentVariableDefinitions = $this->getVariableDefinitionsFromDeclarations($declarations) + $ancestorVariableDefinitions; $newDeclarations = $this->replaceVariablesInDeclarations($declarations); if ($newDeclarations !== null) { $element->setAttribute('style', $this->getDeclarationsAsString($newDeclarations)); } } else { $variableDefinitions = $ancestorVariableDefinitions; } foreach ($element->childNodes as $child) { if ($child instanceof \DOMElement) { $this->evaluateVariablesInElementAndDescendants($child, $variableDefinitions); } } return $this; } } Pelago/Emogrifier/HtmlProcessor/HtmlPruner.php 0000777 00000012266 15252673315 0015507 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\HtmlProcessor; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\CssInliner; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\ArrayIntersector; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\Preg; /** * This class can remove things from HTML. */ final class HtmlPruner extends AbstractHtmlProcessor { /** * We need to look for display:none, but we need to do a case-insensitive search. Since DOMDocument only * supports XPath 1.0, lower-case() isn't available to us. We've thus far only set attributes to lowercase, * not attribute values. Consequently, we need to translate() the letters that would be in 'NONE' ("NOE") * to lowercase. * * @var string */ private const DISPLAY_NONE_MATCHER = '//*[@style and contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")' . ' and not(@class and contains(concat(" ", normalize-space(@class), " "), " -emogrifier-keep "))]'; /** * Removes elements that have a "display: none;" style. * * @return $this */ public function removeElementsWithDisplayNone(): self { $elementsWithStyleDisplayNone = $this->getXPath()->query(self::DISPLAY_NONE_MATCHER); if ($elementsWithStyleDisplayNone->length === 0) { return $this; } foreach ($elementsWithStyleDisplayNone as $element) { $parentNode = $element->parentNode; if ($parentNode !== null) { $parentNode->removeChild($element); } } return $this; } /** * Removes classes that are no longer required (e.g. because there are no longer any CSS rules that reference them) * from `class` attributes. * * Note that this does not inspect the CSS, but expects to be provided with a list of classes that are still in use. * * This method also has the (presumably beneficial) side-effect of minifying (removing superfluous whitespace from) * `class` attributes. * * @param array<array-key, string> $classesToKeep names of classes that should not be removed * * @return $this */ public function removeRedundantClasses(array $classesToKeep = []): self { $elementsWithClassAttribute = $this->getXPath()->query('//*[@class]'); if ($classesToKeep !== []) { $this->removeClassesFromElements($elementsWithClassAttribute, $classesToKeep); } else { // Avoid unnecessary processing if there are no classes to keep. $this->removeClassAttributeFromElements($elementsWithClassAttribute); } return $this; } /** * Removes classes from the `class` attribute of each element in `$elements`, except any in `$classesToKeep`, * removing the `class` attribute itself if the resultant list is empty. * * @param \DOMNodeList $elements * @param array<array-key, string> $classesToKeep */ private function removeClassesFromElements(\DOMNodeList $elements, array $classesToKeep): void { $classesToKeepIntersector = new ArrayIntersector($classesToKeep); $preg = new Preg(); /** @var \DOMElement $element */ foreach ($elements as $element) { $elementClasses = $preg->split('/\\s++/', \trim($element->getAttribute('class'))); $elementClassesToKeep = $classesToKeepIntersector->intersectWith($elementClasses); if ($elementClassesToKeep !== []) { $element->setAttribute('class', \implode(' ', $elementClassesToKeep)); } else { $element->removeAttribute('class'); } } } /** * Removes the `class` attribute from each element in `$elements`. * * @param \DOMNodeList $elements */ private function removeClassAttributeFromElements(\DOMNodeList $elements): void { /** @var \DOMElement $element */ foreach ($elements as $element) { $element->removeAttribute('class'); } } /** * After CSS has been inlined, there will likely be some classes in `class` attributes that are no longer referenced * by any remaining (uninlinable) CSS. This method removes such classes. * * Note that it does not inspect the remaining CSS, but uses information readily available from the `CssInliner` * instance about the CSS rules that could not be inlined. * * @param CssInliner $cssInliner object instance that performed the CSS inlining * * @return $this * * @throws \BadMethodCallException if `inlineCss` has not first been called on `$cssInliner` */ public function removeRedundantClassesAfterCssInlined(CssInliner $cssInliner): self { $preg = new Preg(); $classesToKeepAsKeys = []; foreach ($cssInliner->getMatchingUninlinableSelectors() as $selector) { $preg->matchAll('/\\.(-?+[_a-zA-Z][\\w\\-]*+)/', $selector, $matches); $classesToKeepAsKeys += \array_fill_keys($matches[1], true); } $this->removeRedundantClasses(\array_keys($classesToKeepAsKeys)); return $this; } } Pelago/Emogrifier/HtmlProcessor/AbstractHtmlProcessor.php 0000777 00000035711 15252673315 0017677 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\HtmlProcessor; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\Preg; /** * Base class for HTML processor that e.g., can remove, add or modify nodes or attributes. * * The "vanilla" subclass is the HtmlNormalizer. */ abstract class AbstractHtmlProcessor { /** * @var string */ protected const DEFAULT_DOCUMENT_TYPE = '<!DOCTYPE html>'; /** * @var string */ protected const CONTENT_TYPE_META_TAG = '<meta http-equiv="Content-Type" content="text/html; charset=utf-8">'; /** * @var string Regular expression part to match tag names that PHP's DOMDocument implementation is not aware are * self-closing. These are mostly HTML5 elements, but for completeness <command> (obsolete) and <keygen> * (deprecated) are also included. * * @see https://bugs.php.net/bug.php?id=73175 */ protected const PHP_UNRECOGNIZED_VOID_TAGNAME_MATCHER = '(?:command|embed|keygen|source|track|wbr)'; /** * Regular expression part to match tag names that may appear before the start of the `<body>` element. A start tag * for any other element would implicitly start the `<body>` element due to tag omission rules. * * @var string */ protected const TAGNAME_ALLOWED_BEFORE_BODY_MATCHER = '(?:html|head|base|command|link|meta|noscript|script|style|template|title)'; /** * regular expression pattern to match an HTML comment, including delimiters and modifiers * * @var string */ protected const HTML_COMMENT_PATTERN = '/<!--[^-]*+(?:-(?!->)[^-]*+)*+(?:-->|$)/'; /** * regular expression pattern to match an HTML `<template>` element, including delimiters and modifiers * * @var string */ protected const HTML_TEMPLATE_ELEMENT_PATTERN = '%<template[\\s>][^<]*+(?:<(?!/template>)[^<]*+)*+(?:</template>|$)%i'; /** * @var ?\DOMDocument */ protected $domDocument = null; /** * @var ?\DOMXPath */ private $xPath = null; /** * The constructor. * * Please use `::fromHtml` or `::fromDomDocument` instead. */ private function __construct() {} /** * Builds a new instance from the given HTML. * * @param string $unprocessedHtml raw HTML, must be UTF-encoded, must not be empty * * @return static * * @throws \InvalidArgumentException if $unprocessedHtml is anything other than a non-empty string */ public static function fromHtml(string $unprocessedHtml): self { if ($unprocessedHtml === '') { throw new \InvalidArgumentException('The provided HTML must not be empty.', 1515763647); } $instance = new static(); $instance->setHtml($unprocessedHtml); return $instance; } /** * Builds a new instance from the given DOM document. * * @param \DOMDocument $document a DOM document returned by getDomDocument() of another instance * * @return static */ public static function fromDomDocument(\DOMDocument $document): self { $instance = new static(); $instance->setDomDocument($document); return $instance; } /** * Sets the HTML to process. * * @param string $html the HTML to process, must be UTF-8-encoded */ private function setHtml(string $html): void { $this->createUnifiedDomDocument($html); } /** * Provides access to the internal DOMDocument representation of the HTML in its current state. * * @return \DOMDocument * * @throws \UnexpectedValueException */ public function getDomDocument(): \DOMDocument { if (!$this->domDocument instanceof \DOMDocument) { $message = self::class . '::setDomDocument() has not yet been called on ' . static::class; throw new \UnexpectedValueException($message, 1570472239); } return $this->domDocument; } /** * @param \DOMDocument $domDocument */ private function setDomDocument(\DOMDocument $domDocument): void { $this->domDocument = $domDocument; $this->xPath = new \DOMXPath($this->domDocument); } /** * @return \DOMXPath * * @throws \UnexpectedValueException */ protected function getXPath(): \DOMXPath { if (!$this->xPath instanceof \DOMXPath) { $message = self::class . '::setDomDocument() has not yet been called on ' . static::class; throw new \UnexpectedValueException($message, 1617819086); } return $this->xPath; } /** * Renders the normalized and processed HTML. * * @return string */ public function render(): string { $htmlWithPossibleErroneousClosingTags = $this->getDomDocument()->saveHTML(); return $this->removeSelfClosingTagsClosingTags($htmlWithPossibleErroneousClosingTags); } /** * Renders the content of the BODY element of the normalized and processed HTML. * * @return string */ public function renderBodyContent(): string { $htmlWithPossibleErroneousClosingTags = $this->getDomDocument()->saveHTML($this->getBodyElement()); $bodyNodeHtml = $this->removeSelfClosingTagsClosingTags($htmlWithPossibleErroneousClosingTags); return (new Preg())->replace('%</?+body(?:\\s[^>]*+)?+>%', '', $bodyNodeHtml); } /** * Eliminates any invalid closing tags for void elements from the given HTML. * * @param string $html * * @return string */ private function removeSelfClosingTagsClosingTags(string $html): string { return (new Preg())->replace('%</' . self::PHP_UNRECOGNIZED_VOID_TAGNAME_MATCHER . '>%', '', $html); } /** * Returns the HTML element. * * This method assumes that there always is an HTML element, throwing an exception otherwise. * * @throws \UnexpectedValueException */ protected function getHtmlElement(): \DOMElement { $htmlElement = $this->getDomDocument()->getElementsByTagName('html')->item(0); if (!$htmlElement instanceof \DOMElement) { throw new \UnexpectedValueException('There is no HTML element although there should be one.', 1569930853); } return $htmlElement; } /** * Returns the BODY element. * * This method assumes that there always is a BODY element. * * @return \DOMElement * * @throws \RuntimeException */ private function getBodyElement(): \DOMElement { $node = $this->getDomDocument()->getElementsByTagName('body')->item(0); if (!$node instanceof \DOMElement) { throw new \RuntimeException('There is no body element.', 1617922607); } return $node; } /** * Creates a DOM document from the given HTML and stores it in $this->domDocument. * * The DOM document will always have a BODY element and a document type. * * @param string $html */ private function createUnifiedDomDocument(string $html): void { $this->createRawDomDocument($html); $this->ensureExistenceOfBodyElement(); } /** * Creates a DOMDocument instance from the given HTML and stores it in $this->domDocument. * * @param string $html */ private function createRawDomDocument(string $html): void { $domDocument = new \DOMDocument(); $domDocument->strictErrorChecking = false; $domDocument->formatOutput = false; $libXmlState = \libxml_use_internal_errors(true); $domDocument->loadHTML($this->prepareHtmlForDomConversion($html)); \libxml_clear_errors(); \libxml_use_internal_errors($libXmlState); $this->setDomDocument($domDocument); } /** * Returns the HTML with added document type, Content-Type meta tag, and self-closing slashes, if needed, * ensuring that the HTML will be good for creating a DOM document from it. * * @param string $html * * @return string the unified HTML */ private function prepareHtmlForDomConversion(string $html): string { $htmlWithSelfClosingSlashes = $this->ensurePhpUnrecognizedSelfClosingTagsAreXml($html); $htmlWithDocumentType = $this->ensureDocumentType($htmlWithSelfClosingSlashes); return $this->addContentTypeMetaTag($htmlWithDocumentType); } /** * Makes sure that the passed HTML has a document type, with lowercase "html". * * @param string $html * * @return string HTML with document type */ private function ensureDocumentType(string $html): string { $hasDocumentType = \stripos($html, '<!DOCTYPE') !== false; if ($hasDocumentType) { return $this->normalizeDocumentType($html); } return self::DEFAULT_DOCUMENT_TYPE . $html; } /** * Makes sure the document type in the passed HTML has lowercase "html". * * @param string $html * * @return string HTML with normalized document type */ private function normalizeDocumentType(string $html): string { // Limit to replacing the first occurrence: as an optimization; and in case an example exists as unescaped text. return (new Preg())->replace( '/<!DOCTYPE\\s++html(?=[\\s>])/i', '<!DOCTYPE html', $html, 1 ); } /** * Adds a Content-Type meta tag for the charset. * * This method also ensures that there is a HEAD element. * * @param string $html * * @return string the HTML with the meta tag added */ private function addContentTypeMetaTag(string $html): string { if ($this->hasContentTypeMetaTagInHead($html)) { return $html; } // We are trying to insert the meta tag to the right spot in the DOM. // If we just prepended it to the HTML, we would lose attributes set to the HTML tag. $hasHeadTag = (new Preg())->match('/<head[\\s>]/i', $html) !== 0; $hasHtmlTag = \stripos($html, '<html') !== false; if ($hasHeadTag) { $reworkedHtml = (new Preg())->replace( '/<head(?=[\\s>])([^>]*+)>/i', '<head$1>' . self::CONTENT_TYPE_META_TAG, $html ); } elseif ($hasHtmlTag) { $reworkedHtml = (new Preg())->replace( '/<html(.*?)>/is', '<html$1><head>' . self::CONTENT_TYPE_META_TAG . '</head>', $html ); } else { $reworkedHtml = self::CONTENT_TYPE_META_TAG . $html; } return $reworkedHtml; } /** * Tests whether the given HTML has a valid `Content-Type` metadata element within the `<head>` element. Due to tag * omission rules, HTML parsers are expected to end the `<head>` element and start the `<body>` element upon * encountering a start tag for any element which is permitted only within the `<body>`. * * @param string $html * * @return bool */ private function hasContentTypeMetaTagInHead(string $html): bool { (new Preg())->match( '%^.*?(?=<meta(?=\\s)[^>]*\\shttp-equiv=(["\']?+)Content-Type\\g{-1}[\\s/>])%is', $html, $matches ); if (isset($matches[0])) { $htmlBefore = $matches[0]; try { $hasContentTypeMetaTagInHead = !$this->hasEndOfHeadElement($htmlBefore); } catch (\RuntimeException $exception) { // If something unexpected occurs, assume the `Content-Type` that was found is valid. \trigger_error($exception->getMessage()); $hasContentTypeMetaTagInHead = true; } } else { $hasContentTypeMetaTagInHead = false; } return $hasContentTypeMetaTagInHead; } /** * Tests whether the `<head>` element ends within the given HTML. Due to tag omission rules, HTML parsers are * expected to end the `<head>` element and start the `<body>` element upon encountering a start tag for any element * which is permitted only within the `<body>`. * * @param string $html * * @return bool * * @throws \RuntimeException */ private function hasEndOfHeadElement(string $html): bool { if ( (new Preg())->match('%<(?!' . self::TAGNAME_ALLOWED_BEFORE_BODY_MATCHER . '[\\s/>])\\w|</head>%i', $html) !== 0 ) { // An exception to the implicit end of the `<head>` is any content within a `<template>` element, as well in // comments. As an optimization, this is only checked for if a potential `<head>` end tag is found. $htmlWithoutCommentsOrTemplates = $this->removeHtmlTemplateElements($this->removeHtmlComments($html)); $hasEndOfHeadElement = $htmlWithoutCommentsOrTemplates === $html || $this->hasEndOfHeadElement($htmlWithoutCommentsOrTemplates); } else { $hasEndOfHeadElement = false; } return $hasEndOfHeadElement; } /** * Removes comments from the given HTML, including any which are unterminated, for which the remainder of the string * is removed. * * @param string $html * * @return string * * @throws \RuntimeException */ private function removeHtmlComments(string $html): string { return (new Preg())->throwExceptions(true)->replace(self::HTML_COMMENT_PATTERN, '', $html); } /** * Removes `<template>` elements from the given HTML, including any without an end tag, for which the remainder of * the string is removed. * * @param string $html * * @return string * * @throws \RuntimeException */ private function removeHtmlTemplateElements(string $html): string { return (new Preg())->throwExceptions(true)->replace(self::HTML_TEMPLATE_ELEMENT_PATTERN, '', $html); } /** * Makes sure that any self-closing tags not recognized as such by PHP's DOMDocument implementation have a * self-closing slash. * * @param string $html * * @return string HTML with problematic tags converted. */ private function ensurePhpUnrecognizedSelfClosingTagsAreXml(string $html): string { return (new Preg())->replace( '%<' . self::PHP_UNRECOGNIZED_VOID_TAGNAME_MATCHER . '\\b[^>]*+(?<!/)(?=>)%', '$0/', $html ); } /** * Checks that $this->domDocument has a BODY element and adds it if it is missing. * * @throws \UnexpectedValueException */ private function ensureExistenceOfBodyElement(): void { if ($this->getDomDocument()->getElementsByTagName('body')->item(0) instanceof \DOMElement) { return; } $this->getHtmlElement()->appendChild($this->getDomDocument()->createElement('body')); } } Pelago/Emogrifier/HtmlProcessor/CssToAttributeConverter.php 0000777 00000021451 15252673315 0020212 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier\HtmlProcessor; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\DeclarationBlockParser; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\Preg; /** * This HtmlProcessor can convert style HTML attributes to the corresponding other visual HTML attributes, * e.g. it converts style="width: 100px" to width="100". * * It will only add attributes, but leaves the style attribute untouched. * * To trigger the conversion, call the convertCssToVisualAttributes method. */ final class CssToAttributeConverter extends AbstractHtmlProcessor { /** * This multi-level array contains simple mappings of CSS properties to * HTML attributes. If a mapping only applies to certain HTML nodes or * only for certain values, the mapping is an object with an allowlist * of nodes and values. * * @var array<string, array{attribute: string, nodes?: array<int, string>, values?: array<int, string>}> */ private $cssToHtmlMap = [ 'background-color' => [ 'attribute' => 'bgcolor', ], 'text-align' => [ 'attribute' => 'align', 'nodes' => ['p', 'div', 'td', 'th'], 'values' => ['left', 'right', 'center', 'justify'], ], 'float' => [ 'attribute' => 'align', 'nodes' => ['table', 'img'], 'values' => ['left', 'right'], ], 'border-spacing' => [ 'attribute' => 'cellspacing', 'nodes' => ['table'], ], ]; /** * Maps the CSS from the style nodes to visual HTML attributes. * * @return $this */ public function convertCssToVisualAttributes(): self { $declarationBlockParser = new DeclarationBlockParser(); /** @var \DOMElement $node */ foreach ($this->getAllNodesWithStyleAttribute() as $node) { $inlineStyleDeclarations = $declarationBlockParser->parse($node->getAttribute('style')); $this->mapCssToHtmlAttributes($inlineStyleDeclarations, $node); } return $this; } /** * Returns a list with all DOM nodes that have a style attribute. * * @return \DOMNodeList */ private function getAllNodesWithStyleAttribute(): \DOMNodeList { return $this->getXPath()->query('//*[@style]'); } /** * Applies $styles to $node. * * This method maps CSS styles to HTML attributes and adds those to the * node. * * @param array<string, string> $styles the new CSS styles taken from the global styles to be applied to this node * @param \DOMElement $node node to apply styles to */ private function mapCssToHtmlAttributes(array $styles, \DOMElement $node): void { foreach ($styles as $property => $value) { // Strip !important indicator $value = \trim(\str_replace('!important', '', $value)); $this->mapCssToHtmlAttribute($property, $value, $node); } } /** * Tries to apply the CSS style to $node as an attribute. * * This method maps a CSS rule to HTML attributes and adds those to the node. * * @param string $property the name of the CSS property to map * @param string $value the value of the style rule to map * @param \DOMElement $node node to apply styles to */ private function mapCssToHtmlAttribute(string $property, string $value, \DOMElement $node): void { if (!$this->mapSimpleCssProperty($property, $value, $node)) { $this->mapComplexCssProperty($property, $value, $node); } } /** * Looks up the CSS property in the mapping table and maps it if it matches the conditions. * * @param string $property the name of the CSS property to map * @param string $value the value of the style rule to map * @param \DOMElement $node node to apply styles to * * @return bool true if the property can be mapped using the simple mapping table */ private function mapSimpleCssProperty(string $property, string $value, \DOMElement $node): bool { if (!isset($this->cssToHtmlMap[$property])) { return false; } $mapping = $this->cssToHtmlMap[$property]; $nodesMatch = !isset($mapping['nodes']) || \in_array($node->nodeName, $mapping['nodes'], true); $valuesMatch = !isset($mapping['values']) || \in_array($value, $mapping['values'], true); $canBeMapped = $nodesMatch && $valuesMatch; if ($canBeMapped) { $node->setAttribute($mapping['attribute'], $value); } return $canBeMapped; } /** * Maps CSS properties that need special transformation to an HTML attribute. * * @param string $property the name of the CSS property to map * @param string $value the value of the style rule to map * @param \DOMElement $node node to apply styles to */ private function mapComplexCssProperty(string $property, string $value, \DOMElement $node): void { switch ($property) { case 'background': $this->mapBackgroundProperty($node, $value); break; case 'width': // intentional fall-through case 'height': $this->mapWidthOrHeightProperty($node, $value, $property); break; case 'margin': $this->mapMarginProperty($node, $value); break; case 'border': $this->mapBorderProperty($node, $value); break; default: } } /** * @param \DOMElement $node node to apply styles to * @param string $value the value of the style rule to map */ private function mapBackgroundProperty(\DOMElement $node, string $value): void { // parse out the color, if any /** @var array<int, string> $styles */ $styles = \explode(' ', $value, 2); $first = $styles[0]; if (\is_numeric($first[0]) || \strncmp($first, 'url', 3) === 0) { return; } // as this is not a position or image, assume it's a color $node->setAttribute('bgcolor', $first); } /** * @param \DOMElement $node node to apply styles to * @param string $value the value of the style rule to map * @param string $property the name of the CSS property to map */ private function mapWidthOrHeightProperty(\DOMElement $node, string $value, string $property): void { $preg = new Preg(); // only parse values in px and %, but not values like "auto" if ($preg->match('/^(\\d+)(\\.(\\d+))?(px|%)$/', $value) === 0) { return; } $number = $preg->replace('/[^0-9.%]/', '', $value); $node->setAttribute($property, $number); } /** * @param \DOMElement $node node to apply styles to * @param string $value the value of the style rule to map */ private function mapMarginProperty(\DOMElement $node, string $value): void { if (!$this->isTableOrImageNode($node)) { return; } $margins = $this->parseCssShorthandValue($value); if ($margins['left'] === 'auto' && $margins['right'] === 'auto') { $node->setAttribute('align', 'center'); } } /** * @param \DOMElement $node node to apply styles to * @param string $value the value of the style rule to map */ private function mapBorderProperty(\DOMElement $node, string $value): void { if (!$this->isTableOrImageNode($node)) { return; } if ($value === 'none' || $value === '0') { $node->setAttribute('border', '0'); } } /** * @param \DOMElement $node * * @return bool */ private function isTableOrImageNode(\DOMElement $node): bool { return $node->nodeName === 'table' || $node->nodeName === 'img'; } /** * Parses a shorthand CSS value and splits it into individual values. For example: `padding: 0 auto;` - `0 auto` is * split into top: 0, left: auto, bottom: 0, right: auto. * * @param string $value a CSS property value with 1, 2, 3 or 4 sizes * * @return array<string, string> * an array of values for top, right, bottom and left (using these as associative array keys) */ private function parseCssShorthandValue(string $value): array { $values = (new Preg())->split('/\\s+/', $value); $css = []; $css['top'] = $values[0]; $css['right'] = (\count($values) > 1) ? $values[1] : $css['top']; $css['bottom'] = (\count($values) > 2) ? $values[2] : $css['top']; $css['left'] = (\count($values) > 3) ? $values[3] : $css['right']; return $css; } } Pelago/Emogrifier/CssInliner.php 0000777 00000126735 15252673315 0012663 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Pelago\Emogrifier; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Css\CssDocument; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\HtmlProcessor\AbstractHtmlProcessor; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\CssConcatenator; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\DeclarationBlockParser; use Automattic\WooCommerce\Vendor\Pelago\Emogrifier\Utilities\Preg; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\CssSelectorConverter; use Automattic\WooCommerce\Vendor\Symfony\Component\CssSelector\Exception\ParseException; /** * This class provides functions for converting CSS styles into inline style attributes in your HTML code. */ final class CssInliner extends AbstractHtmlProcessor { /** * @var int */ private const CACHE_KEY_SELECTOR = 0; /** * @var int */ private const CACHE_KEY_COMBINED_STYLES = 1; /** * Regular expression component matching a static pseudo class in a selector, without the preceding ":", * for which the applicable elements can be determined (by converting the selector to an XPath expression). * (Contains alternation without a group and is intended to be placed within a capturing, non-capturing or lookahead * group, as appropriate for the usage context.) * * @var string */ private const PSEUDO_CLASS_MATCHER = 'empty|(?:first|last|nth(?:-last)?+|only)-(?:child|of-type)|not\\([[:ascii:]]*\\)|root'; /** * This regular expression componenet matches an `...of-type` pseudo class name, without the preceding ":". These * pseudo-classes can currently online be inlined if they have an associated type in the selector expression. * * @var string */ private const OF_TYPE_PSEUDO_CLASS_MATCHER = '(?:first|last|nth(?:-last)?+|only)-of-type'; /** * regular expression component to match a selector combinator * * @var string */ private const COMBINATOR_MATCHER = '(?:\\s++|\\s*+[>+~]\\s*+)(?=[[:alpha:]_\\-.#*:\\[])'; /** * options array key for `querySelectorAll` * * @var string */ private const QSA_ALWAYS_THROW_PARSE_EXCEPTION = 'alwaysThrowParseException'; /** * @var array<string, bool> */ private $excludedSelectors = []; /** * @var array<non-empty-string, bool> */ private $excludedCssSelectors = []; /** * @var array<string, bool> */ private $allowedMediaTypes = ['all' => true, 'screen' => true, 'print' => true]; /** * @var array{ * 0: array<string, int>, * 1: array<string, string> * } */ private $caches = [ self::CACHE_KEY_SELECTOR => [], self::CACHE_KEY_COMBINED_STYLES => [], ]; /** * @var ?CssSelectorConverter */ private $cssSelectorConverter = null; /** * the visited nodes with the XPath paths as array keys * * @var array<string, \DOMElement> */ private $visitedNodes = []; /** * the styles to apply to the nodes with the XPath paths as array keys for the outer array * and the attribute names/values as key/value pairs for the inner array * * @var array<string, array<string, string>> */ private $styleAttributesForNodes = []; /** * Determines whether the "style" attributes of tags in the the HTML passed to this class should be preserved. * If set to false, the value of the style attributes will be discarded. * * @var bool */ private $isInlineStyleAttributesParsingEnabled = true; /** * Determines whether the `<style>` blocks in the HTML passed to this class should be parsed. * * If set to true, the `<style>` blocks will be removed from the HTML and their contents will be applied to the HTML * via inline styles. * * If set to false, the `<style>` blocks will be left as they are in the HTML. * * @var bool */ private $isStyleBlocksParsingEnabled = true; /** * For calculating selector precedence order. * Keys are a regular expression part to match before a CSS name. * Values are a multiplier factor per match to weight specificity. * * @var array<string, int> */ private $selectorPrecedenceMatchers = [ // IDs: worth 10000 '\\#' => 10000, // classes, attributes, pseudo-classes (not pseudo-elements) except `:not`: worth 100 '(?:\\.|\\[|(?<!:):(?!not\\())' => 100, // elements (not attribute values or `:not`), pseudo-elements: worth 1 '(?:(?<![="\':\\w\\-])|::)' => 1, ]; /** * array of data describing CSS rules which apply to the document but cannot be inlined, in the format returned by * {@see collateCssRules} * * @var array<array-key, array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * }>|null */ private $matchingUninlinableCssRules = null; /** * Emogrifier will throw Exceptions when it encounters an error instead of silently ignoring them. * * @var bool */ private $debug = false; /** * Inlines the given CSS into the existing HTML. * * @param string $css the CSS to inline, must be UTF-8-encoded * * @return $this * * @throws ParseException in debug mode, if an invalid selector is encountered * @throws \RuntimeException * in debug mode, if an internal PCRE error occurs * or `CssSelectorConverter::toXPath` returns an invalid XPath expression * @throws \UnexpectedValueException * if a selector query result includes a node which is not a `DOMElement` */ public function inlineCss(string $css = ''): self { $this->clearAllCaches(); $this->purgeVisitedNodes(); $this->normalizeStyleAttributesOfAllNodes(); $combinedCss = $css; // grab any existing style blocks from the HTML and append them to the existing CSS // (these blocks should be appended so as to have precedence over conflicting styles in the existing CSS) if ($this->isStyleBlocksParsingEnabled) { $combinedCss .= $this->getCssFromAllStyleNodes(); } $parsedCss = new CssDocument($combinedCss, $this->debug); $excludedNodes = $this->getNodesToExclude(); $cssRules = $this->collateCssRules($parsedCss); foreach ($cssRules['inlinable'] as $cssRule) { foreach ($this->querySelectorAll($cssRule['selector']) as $node) { if (\in_array($node, $excludedNodes, true)) { continue; } $this->copyInlinableCssToStyleAttribute($this->ensureNodeIsElement($node), $cssRule); } } if ($this->isInlineStyleAttributesParsingEnabled) { $this->fillStyleAttributesWithMergedStyles(); } $this->removeImportantAnnotationFromAllInlineStyles(); $this->determineMatchingUninlinableCssRules($cssRules['uninlinable']); $this->copyUninlinableCssToStyleNode($parsedCss); return $this; } /** * Disables the parsing of inline styles. * * @return $this */ public function disableInlineStyleAttributesParsing(): self { $this->isInlineStyleAttributesParsingEnabled = false; return $this; } /** * Disables the parsing of `<style>` blocks. * * @return $this */ public function disableStyleBlocksParsing(): self { $this->isStyleBlocksParsingEnabled = false; return $this; } /** * Marks a media query type to keep. * * @param string $mediaName the media type name, e.g., "braille" * * @return $this */ public function addAllowedMediaType(string $mediaName): self { $this->allowedMediaTypes[$mediaName] = true; return $this; } /** * Drops a media query type from the allowed list. * * @param string $mediaName the tag name, e.g., "braille" * * @return $this */ public function removeAllowedMediaType(string $mediaName): self { if (isset($this->allowedMediaTypes[$mediaName])) { unset($this->allowedMediaTypes[$mediaName]); } return $this; } /** * Adds a selector to exclude nodes from emogrification. * * Any nodes that match the selector will not have their style altered. * * @param string $selector the selector to exclude, e.g., ".editor" * * @return $this */ public function addExcludedSelector(string $selector): self { $this->excludedSelectors[$selector] = true; return $this; } /** * No longer excludes the nodes matching this selector from emogrification. * * @param string $selector the selector to no longer exclude, e.g., ".editor" * * @return $this */ public function removeExcludedSelector(string $selector): self { if (isset($this->excludedSelectors[$selector])) { unset($this->excludedSelectors[$selector]); } return $this; } /** * Adds a selector to exclude CSS selector from emogrification. * * @param non-empty-string $selector the selector to exclude, e.g., `.editor` * * @return $this */ public function addExcludedCssSelector(string $selector): self { $this->excludedCssSelectors[$selector] = true; return $this; } /** * No longer excludes the CSS selector from emogrification. * * @param non-empty-string $selector the selector to no longer exclude, e.g., `.editor` * * @return $this */ public function removeExcludedCssSelector(string $selector): self { if (isset($this->excludedCssSelectors[$selector])) { unset($this->excludedCssSelectors[$selector]); } return $this; } /** * Sets the debug mode. * * @param bool $debug set to true to enable debug mode * * @return $this */ public function setDebug(bool $debug): self { $this->debug = $debug; return $this; } /** * Gets the array of selectors present in the CSS provided to `inlineCss()` for which the declarations could not be * applied as inline styles, but which may affect elements in the HTML. The relevant CSS will have been placed in a * `<style>` element. The selectors may include those used within `@media` rules or those involving dynamic * pseudo-classes (such as `:hover`) or pseudo-elements (such as `::after`). * * @return array<array-key, string> * * @throws \BadMethodCallException if `inlineCss` has not been called first */ public function getMatchingUninlinableSelectors(): array { return \array_column($this->getMatchingUninlinableCssRules(), 'selector'); } /** * @return array<array-key, array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * }> * * @throws \BadMethodCallException if `inlineCss` has not been called first */ private function getMatchingUninlinableCssRules(): array { if (!\is_array($this->matchingUninlinableCssRules)) { throw new \BadMethodCallException('inlineCss must be called first', 1568385221); } return $this->matchingUninlinableCssRules; } /** * Clears all caches. */ private function clearAllCaches(): void { $this->caches = [ self::CACHE_KEY_SELECTOR => [], self::CACHE_KEY_COMBINED_STYLES => [], ]; } /** * Purges the visited nodes. */ private function purgeVisitedNodes(): void { $this->visitedNodes = []; $this->styleAttributesForNodes = []; } /** * Parses the document and normalizes all existing CSS attributes. * This changes 'DISPLAY: none' to 'display: none'. * We wouldn't have to do this if DOMXPath supported XPath 2.0. * Also stores a reference of nodes with existing inline styles so we don't overwrite them. */ private function normalizeStyleAttributesOfAllNodes(): void { /** @var \DOMElement $node */ foreach ($this->getAllNodesWithStyleAttribute() as $node) { if ($this->isInlineStyleAttributesParsingEnabled) { $this->normalizeStyleAttributes($node); } // Remove style attribute in every case, so we can add them back (if inline style attributes // parsing is enabled) to the end of the style list, thus keeping the right priority of CSS rules; // else original inline style rules may remain at the beginning of the final inline style definition // of a node, which may give not the desired results $node->removeAttribute('style'); } } /** * Returns a list with all DOM nodes that have a style attribute. * * @return \DOMNodeList * * @throws \RuntimeException */ private function getAllNodesWithStyleAttribute(): \DOMNodeList { $query = '//*[@style]'; $matches = $this->getXPath()->query($query); if (!$matches instanceof \DOMNodeList) { throw new \RuntimeException('XPatch query failed: ' . $query, 1618577797); } return $matches; } /** * Normalizes the value of the "style" attribute and saves it. * * @param \DOMElement $node */ private function normalizeStyleAttributes(\DOMElement $node): void { $declarationBlockParser = new DeclarationBlockParser(); $normalizedOriginalStyle = (new Preg())->throwExceptions($this->debug)->replaceCallback( '/-{0,2}+[_a-zA-Z][\\w\\-]*+(?=:)/S', /** @param array<array-key, string> $propertyNameMatches */ static function (array $propertyNameMatches) use ($declarationBlockParser): string { return $declarationBlockParser->normalizePropertyName($propertyNameMatches[0]); }, $node->getAttribute('style') ); // In order to not overwrite existing style attributes in the HTML, we have to save the original HTML styles. $nodePath = $node->getNodePath(); if (\is_string($nodePath) && !isset($this->styleAttributesForNodes[$nodePath])) { $this->styleAttributesForNodes[$nodePath] = $declarationBlockParser->parse($normalizedOriginalStyle); $this->visitedNodes[$nodePath] = $node; } $node->setAttribute('style', $normalizedOriginalStyle); } /** * Returns CSS content. * * @return string */ private function getCssFromAllStyleNodes(): string { $styleNodes = $this->getXPath()->query('//style'); if ($styleNodes === false) { return ''; } $css = ''; foreach ($styleNodes as $styleNode) { if (\is_string($styleNode->nodeValue)) { $css .= "\n\n" . $styleNode->nodeValue; } $parentNode = $styleNode->parentNode; if ($parentNode instanceof \DOMNode) { $parentNode->removeChild($styleNode); } } return $css; } /** * Find the nodes that are not to be emogrified. * * @return list<\DOMElement> * * @throws ParseException in debug mode, if an invalid selector is encountered * @throws \RuntimeException in debug mode, if `CssSelectorConverter::toXPath` returns an invalid XPath expression * @throws \UnexpectedValueException if the selector query result includes a node which is not a `DOMElement` */ private function getNodesToExclude(): array { $excludedNodes = []; foreach (\array_keys($this->excludedSelectors) as $selectorToExclude) { foreach ($this->querySelectorAll($selectorToExclude) as $node) { $excludedNodes[] = $this->ensureNodeIsElement($node); } } return $excludedNodes; } /** * @param array{}|array{alwaysThrowParseException: bool} $options * This is an array of option values to control behaviour: * - `QSA_ALWAYS_THROW_PARSE_EXCEPTION` - `bool` - throw any `ParseException` regardless of debug setting. * * @return \DOMNodeList<\DOMNode> the HTML elements that match the provided CSS `$selectors` * * @throws ParseException * in debug mode (or with `QSA_ALWAYS_THROW_PARSE_EXCEPTION` option), if an invalid selector is encountered * @throws \RuntimeException in debug mode, if `CssSelectorConverter::toXPath` returns an invalid XPath expression */ private function querySelectorAll(string $selectors, array $options = []): \DOMNodeList { try { $result = $this->getXPath()->query($this->getCssSelectorConverter()->toXPath($selectors)); if ($result === false) { throw new \RuntimeException('query failed with selector \'' . $selectors . '\'', 1726533051); } return $result; } catch (ParseException $exception) { $alwaysThrowParseException = $options[self::QSA_ALWAYS_THROW_PARSE_EXCEPTION] ?? false; if ($this->debug || $alwaysThrowParseException) { throw $exception; } return new \DOMNodeList(); } catch (\RuntimeException $exception) { if ( $this->debug ) { throw $exception; } // `RuntimeException` indicates a bug in CssSelector so pass the message to the error handler. \trigger_error($exception->getMessage()); return new \DOMNodeList(); } } /** * @throws \UnexpectedValueException if `$node` is not a `DOMElement` */ private function ensureNodeIsElement(\DOMNode $node): \DOMElement { if (!$node instanceof \DOMElement) { $path = $node->getNodePath() ?? '$node'; throw new \UnexpectedValueException($path . ' is not a DOMElement.', 1617975914); } return $node; } /** * @return CssSelectorConverter */ private function getCssSelectorConverter(): CssSelectorConverter { if (!$this->cssSelectorConverter instanceof CssSelectorConverter) { $this->cssSelectorConverter = new CssSelectorConverter(); } return $this->cssSelectorConverter; } /** * Collates the individual rules from a `CssDocument` object. * * @param CssDocument $parsedCss * * @return array<string, array<array-key, array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * }>> * This 2-entry array has the key "inlinable" containing rules which can be inlined as `style` attributes * and the key "uninlinable" containing rules which cannot. Each value is an array of sub-arrays with the * following keys: * - "media" (the media query string, e.g. "@media screen and (max-width: 480px)", * or an empty string if not from a `@media` rule); * - "selector" (the CSS selector, e.g., "*" or "header h1"); * - "hasUnmatchablePseudo" (`true` if that selector contains pseudo-elements or dynamic pseudo-classes such * that the declarations cannot be applied inline); * - "declarationsBlock" (the semicolon-separated CSS declarations for that selector, * e.g., `color: red; height: 4px;`); * - "line" (the line number, e.g. 42). */ private function collateCssRules(CssDocument $parsedCss): array { $matches = $parsedCss->getStyleRulesData(\array_keys($this->allowedMediaTypes)); $preg = (new Preg())->throwExceptions($this->debug); $cssRules = [ 'inlinable' => [], 'uninlinable' => [], ]; foreach ($matches as $key => $cssRule) { if (!$cssRule->hasAtLeastOneDeclaration()) { continue; } $mediaQuery = $cssRule->getContainingAtRule(); $declarationsBlock = $cssRule->getDeclarationAsText(); $selectors = $cssRule->getSelectors(); // Maybe exclude CSS selectors if (\count($this->excludedCssSelectors) > 0) { // Normalize spaces, line breaks & tabs $selectorsNormalized = \array_map(static function (string $selector) use ($preg): string { return $preg->replace('@\\s++@u', ' ', $selector); }, $selectors); $selectors = \array_filter($selectorsNormalized, function (string $selector): bool { return !isset($this->excludedCssSelectors[$selector]); }); } foreach ($selectors as $selector) { // don't process pseudo-elements and behavioral (dynamic) pseudo-classes; // only allow structural pseudo-classes $hasPseudoElement = \strpos($selector, '::') !== false; $hasUnmatchablePseudo = $hasPseudoElement || $this->hasUnsupportedPseudoClass($selector); $parsedCssRule = [ 'media' => $mediaQuery, 'selector' => $selector, 'hasUnmatchablePseudo' => $hasUnmatchablePseudo, 'declarationsBlock' => $declarationsBlock, // keep track of where it appears in the file, since order is important 'line' => $key, ]; $ruleType = (!$cssRule->hasContainingAtRule() && !$hasUnmatchablePseudo) ? 'inlinable' : 'uninlinable'; $cssRules[$ruleType][] = $parsedCssRule; } } \usort( $cssRules['inlinable'], /** * @param array{selector: string, line: int, ...} $first * @param array{selector: string, line: int, ...} $second */ function (array $first, array $second): int { return $this->sortBySelectorPrecedence($first, $second); } ); return $cssRules; } /** * Tests if a selector contains a pseudo-class which would mean it cannot be converted to an XPath expression for * inlining CSS declarations. * * Any pseudo class that does not match {@see PSEUDO_CLASS_MATCHER} cannot be converted. Additionally, `...of-type` * pseudo-classes cannot be converted if they are not associated with a type selector. * * @param string $selector * * @return bool */ private function hasUnsupportedPseudoClass(string $selector): bool { $preg = (new Preg())->throwExceptions($this->debug); if ($preg->match('/:(?!' . self::PSEUDO_CLASS_MATCHER . ')[\\w\\-]/i', $selector) !== 0) { return true; } if ($preg->match('/:(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')/i', $selector) === 0) { return false; } foreach ($preg->split('/' . self::COMBINATOR_MATCHER . '/', $selector) as $selectorPart) { if ($this->selectorPartHasUnsupportedOfTypePseudoClass($selectorPart)) { return true; } } return false; } /** * Tests if part of a selector contains an `...of-type` pseudo-class such that it cannot be converted to an XPath * expression. * * @param string $selectorPart part of a selector which has been split up at combinators * * @return bool `true` if the selector part does not have a type but does have an `...of-type` pseudo-class */ private function selectorPartHasUnsupportedOfTypePseudoClass(string $selectorPart): bool { $preg = (new Preg())->throwExceptions($this->debug); if ($preg->match('/^[\\w\\-]/', $selectorPart) !== 0) { return false; } return $preg->match('/:(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')/i', $selectorPart) !== 0; } /** * @param array{selector: string, line: int, ...} $first * @param array{selector: string, line: int, ...} $second * * @return int */ private function sortBySelectorPrecedence(array $first, array $second): int { $precedenceOfFirst = $this->getCssSelectorPrecedence($first['selector']); $precedenceOfSecond = $this->getCssSelectorPrecedence($second['selector']); // We want these sorted in ascending order so selectors with lesser precedence get processed first and // selectors with greater precedence get sorted last. $precedenceForEquals = $first['line'] < $second['line'] ? -1 : 1; $precedenceForNotEquals = $precedenceOfFirst < $precedenceOfSecond ? -1 : 1; return ($precedenceOfFirst === $precedenceOfSecond) ? $precedenceForEquals : $precedenceForNotEquals; } /** * @param string $selector * * @return int */ private function getCssSelectorPrecedence(string $selector): int { $selectorKey = $selector; if (isset($this->caches[self::CACHE_KEY_SELECTOR][$selectorKey])) { return $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey]; } $preg = (new Preg())->throwExceptions($this->debug); $precedence = 0; foreach ($this->selectorPrecedenceMatchers as $matcher => $value) { if (\trim($selector) === '') { break; } $count = 0; $selector = $preg->replace('/' . $matcher . '\\w+/', '', $selector, -1, $count); $precedence += ($value * $count); } $this->caches[self::CACHE_KEY_SELECTOR][$selectorKey] = $precedence; return $precedence; } /** * Copies $cssRule into the style attribute of $node. * * Note: This method does not check whether $cssRule matches $node. * * @param \DOMElement $node * @param array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * } $cssRule */ private function copyInlinableCssToStyleAttribute(\DOMElement $node, array $cssRule): void { $declarationsBlock = $cssRule['declarationsBlock']; $declarationBlockParser = new DeclarationBlockParser(); $newStyleDeclarations = $declarationBlockParser->parse($declarationsBlock); if ($newStyleDeclarations === []) { return; } // if it has a style attribute, get it, process it, and append (overwrite) new stuff if ($node->hasAttribute('style')) { // break it up into an associative array $oldStyleDeclarations = $declarationBlockParser->parse($node->getAttribute('style')); } else { $oldStyleDeclarations = []; } $node->setAttribute( 'style', $this->generateStyleStringFromDeclarationsArrays($oldStyleDeclarations, $newStyleDeclarations) ); } /** * This method merges old or existing name/value array with new name/value array * and then generates a string of the combined style suitable for placing inline. * This becomes the single point for CSS string generation allowing for consistent * CSS output no matter where the CSS originally came from. * * @param array<string, string> $oldStyles * @param array<string, string> $newStyles * * @return string * * @throws \UnexpectedValueException if an empty property name is encountered (which should not happen) */ private function generateStyleStringFromDeclarationsArrays(array $oldStyles, array $newStyles): string { $cacheKey = \serialize([$oldStyles, $newStyles]); if (isset($this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey])) { return $this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey]; } // Unset the overridden styles to preserve order, important if shorthand and individual properties are mixed foreach ($oldStyles as $attributeName => $attributeValue) { if (!isset($newStyles[$attributeName])) { continue; } $newAttributeValue = $newStyles[$attributeName]; if ( $this->attributeValueIsImportant($attributeValue) && !$this->attributeValueIsImportant($newAttributeValue) ) { unset($newStyles[$attributeName]); } else { unset($oldStyles[$attributeName]); } } $combinedStyles = \array_merge($oldStyles, $newStyles); $declarationBlockParser = new DeclarationBlockParser(); $style = ''; foreach ($combinedStyles as $attributeName => $attributeValue) { $trimmedAttributeName = \trim($attributeName); if ($trimmedAttributeName === '') { throw new \UnexpectedValueException('An empty property name was encountered.', 1727046078); } $propertyName = $declarationBlockParser->normalizePropertyName($trimmedAttributeName); $propertyValue = \trim($attributeValue); $style .= $propertyName . ': ' . $propertyValue . '; '; } $trimmedStyle = \rtrim($style); $this->caches[self::CACHE_KEY_COMBINED_STYLES][$cacheKey] = $trimmedStyle; return $trimmedStyle; } /** * Checks whether $attributeValue is marked as !important. * * @param string $attributeValue * * @return bool */ private function attributeValueIsImportant(string $attributeValue): bool { return (new Preg())->throwExceptions($this->debug)->match('/!\\s*+important$/i', $attributeValue) !== 0; } /** * Merges styles from styles attributes and style nodes and applies them to the attribute nodes */ private function fillStyleAttributesWithMergedStyles(): void { $declarationBlockParser = new DeclarationBlockParser(); foreach ($this->styleAttributesForNodes as $nodePath => $styleAttributesForNode) { $node = $this->visitedNodes[$nodePath]; $currentStyleAttributes = $declarationBlockParser->parse($node->getAttribute('style')); $node->setAttribute( 'style', $this->generateStyleStringFromDeclarationsArrays( $currentStyleAttributes, $styleAttributesForNode ) ); } } /** * Searches for all nodes with a style attribute and removes the "!important" annotations out of * the inline style declarations, eventually by rearranging declarations. * * @throws \RuntimeException */ private function removeImportantAnnotationFromAllInlineStyles(): void { /** @var \DOMElement $node */ foreach ($this->getAllNodesWithStyleAttribute() as $node) { $this->removeImportantAnnotationFromNodeInlineStyle($node); } } /** * Removes the "!important" annotations out of the inline style declarations, * eventually by rearranging declarations. * Rearranging needed when !important shorthand properties are followed by some of their * not !important expanded-version properties. * For example "font: 12px serif !important; font-size: 13px;" must be reordered * to "font-size: 13px; font: 12px serif;" in order to remain correct. * * @param \DOMElement $node * * @throws \RuntimeException */ private function removeImportantAnnotationFromNodeInlineStyle(\DOMElement $node): void { $style = $node->getAttribute('style'); $inlineStyleDeclarations = (new DeclarationBlockParser())->parse((bool) $style ? $style : ''); /** @var array<string, string> $regularStyleDeclarations */ $regularStyleDeclarations = []; /** @var array<string, string> $importantStyleDeclarations */ $importantStyleDeclarations = []; foreach ($inlineStyleDeclarations as $property => $value) { if ($this->attributeValueIsImportant($value)) { $importantStyleDeclarations[$property] = (new Preg())->throwExceptions($this->debug)->replace('/\\s*+!\\s*+important$/i', '', $value); } else { $regularStyleDeclarations[$property] = $value; } } $inlineStyleDeclarationsInNewOrder = \array_merge($regularStyleDeclarations, $importantStyleDeclarations); $node->setAttribute( 'style', $this->generateStyleStringFromSingleDeclarationsArray($inlineStyleDeclarationsInNewOrder) ); } /** * Generates a CSS style string suitable to be used inline from the $styleDeclarations property => value array. * * @param array<string, string> $styleDeclarations * * @return string */ private function generateStyleStringFromSingleDeclarationsArray(array $styleDeclarations): string { return $this->generateStyleStringFromDeclarationsArrays([], $styleDeclarations); } /** * Determines which of `$cssRules` actually apply to `$this->domDocument`, and sets them in * `$this->matchingUninlinableCssRules`. * * @param array<array-key, array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * }> $cssRules * the "uninlinable" array of CSS rules returned by `collateCssRules` */ private function determineMatchingUninlinableCssRules(array $cssRules): void { $this->matchingUninlinableCssRules = \array_filter( $cssRules, function (array $cssRule): bool { return $this->existsMatchForSelectorInCssRule($cssRule); } ); } /** * Checks whether there is at least one matching element for the CSS selector contained in the `selector` element * of the provided CSS rule. * * Any dynamic pseudo-classes will be assumed to apply. If the selector matches a pseudo-element, * it will test for a match with its originating element. * * @param array{ * media: string, * selector: string, * hasUnmatchablePseudo: bool, * declarationsBlock: string, * line: int * } $cssRule * * @return bool * * @throws ParseException */ private function existsMatchForSelectorInCssRule(array $cssRule): bool { $selector = $cssRule['selector']; if ($cssRule['hasUnmatchablePseudo']) { $selector = $this->removeUnmatchablePseudoComponents($selector); } return $this->existsMatchForCssSelector($selector); } /** * Checks whether there is at least one matching element for $cssSelector. * When not in debug mode, it returns true also for invalid selectors (because they may be valid, * just not implemented/recognized yet by Emogrifier). * * @param string $cssSelector * * @return bool * * @throws ParseException in debug mode, if an invalid selector is encountered * @throws \RuntimeException in debug mode, if `CssSelectorConverter::toXPath` returns an invalid XPath expression */ private function existsMatchForCssSelector(string $cssSelector): bool { try { $nodesMatchingSelector = $this->querySelectorAll($cssSelector, [self::QSA_ALWAYS_THROW_PARSE_EXCEPTION => true]); } catch (ParseException $e) { if ($this->debug) { throw $e; } return true; } return $nodesMatchingSelector->length !== 0; } /** * Removes pseudo-elements and dynamic pseudo-classes from a CSS selector, replacing them with "*" if necessary. * If such a pseudo-component is within the argument of `:not`, the entire `:not` component is removed or replaced. * * @param string $selector * * @return string * selector which will match the relevant DOM elements if the pseudo-classes are assumed to apply, or in the * case of pseudo-elements will match their originating element */ private function removeUnmatchablePseudoComponents(string $selector): string { $preg = (new Preg())->throwExceptions($this->debug); // The regex allows nested brackets via `(?2)`. // A space is temporarily prepended because the callback can't determine if the match was at the very start. $selectorWithoutNots = \ltrim((new Preg())->throwExceptions($this->debug)->replaceCallback( '/([\\s>+~]?+):not(\\([^()]*+(?:(?2)[^()]*+)*+\\))/i', /** @param array<array-key, string> $matches */ function (array $matches): string { return $this->replaceUnmatchableNotComponent($matches); }, ' ' . $selector )); $selectorWithoutUnmatchablePseudoComponents = $this->removeSelectorComponents( ':(?!' . self::PSEUDO_CLASS_MATCHER . '):?+[\\w\\-]++(?:\\([^\\)]*+\\))?+', $selectorWithoutNots ); if ( $preg->match( '/:(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')/i', $selectorWithoutUnmatchablePseudoComponents ) === 0 ) { return $selectorWithoutUnmatchablePseudoComponents; } return \implode('', \array_map( function (string $selectorPart): string { return $this->removeUnsupportedOfTypePseudoClasses($selectorPart); }, $preg->split( '/(' . self::COMBINATOR_MATCHER . ')/', $selectorWithoutUnmatchablePseudoComponents, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY ) )); } /** * Helps `removeUnmatchablePseudoComponents()` replace or remove a selector `:not(...)` component if its argument * contains pseudo-elements or dynamic pseudo-classes. * * @param array<array-key, string> $matches array of elements matched by the regular expression * * @return string * the full match if there were no unmatchable pseudo components within; otherwise, any preceding combinator * followed by "*", or an empty string if there was no preceding combinator */ private function replaceUnmatchableNotComponent(array $matches): string { [$notComponentWithAnyPrecedingCombinator, $anyPrecedingCombinator, $notArgumentInBrackets] = $matches; if ($this->hasUnsupportedPseudoClass($notArgumentInBrackets)) { return $anyPrecedingCombinator !== '' ? $anyPrecedingCombinator . '*' : ''; } return $notComponentWithAnyPrecedingCombinator; } /** * Removes components from a CSS selector, replacing them with "*" if necessary. * * @param string $matcher regular expression part to match the components to remove * @param string $selector * * @return string * selector which will match the relevant DOM elements if the removed components are assumed to apply (or in * the case of pseudo-elements will match their originating element) */ private function removeSelectorComponents(string $matcher, string $selector): string { return (new Preg())->throwExceptions($this->debug)->replace( ['/([\\s>+~]|^)' . $matcher . '/i', '/' . $matcher . '/i'], ['$1*', ''], $selector ); } /** * Removes any `...-of-type` pseudo-classes from part of a CSS selector, if it does not have a type, replacing them * with "*" if necessary. * * @param string $selectorPart part of a selector which has been split up at combinators * * @return string * selector part which will match the relevant DOM elements if the pseudo-classes are assumed to apply */ private function removeUnsupportedOfTypePseudoClasses(string $selectorPart): string { if (!$this->selectorPartHasUnsupportedOfTypePseudoClass($selectorPart)) { return $selectorPart; } return $this->removeSelectorComponents( ':(?:' . self::OF_TYPE_PSEUDO_CLASS_MATCHER . ')(?:\\([^\\)]*+\\))?+', $selectorPart ); } /** * Applies `$this->matchingUninlinableCssRules` to `$this->domDocument` by placing them as CSS in a `<style>` * element. * If there are no uninlinable CSS rules to copy there, a `<style>` element will be created containing only the * applicable at-rules from `$parsedCss`. * If there are none of either, an empty `<style>` element will not be created. * * @param CssDocument $parsedCss * This may contain various at-rules whose content `CssInliner` does not currently attempt to inline or * process in any other way, such as `@import`, `@font-face`, `@keyframes`, etc., and which should precede * the processed but found-to-be-uninlinable CSS placed in the `<style>` element. * Note that `CssInliner` processes `@media` rules so that they can be ordered correctly with respect to * other uninlinable rules; these will not be duplicated from `$parsedCss`. */ private function copyUninlinableCssToStyleNode(CssDocument $parsedCss): void { $css = $parsedCss->renderNonConditionalAtRules(); // avoid including unneeded class dependency if there are no rules if ($this->getMatchingUninlinableCssRules() !== []) { $cssConcatenator = new CssConcatenator(); foreach ($this->getMatchingUninlinableCssRules() as $cssRule) { $cssConcatenator->append([$cssRule['selector']], $cssRule['declarationsBlock'], $cssRule['media']); } $css .= $cssConcatenator->getCss(); } // avoid adding empty style element if ($css !== '') { $this->addStyleElementToDocument($css); } } /** * Adds a style element with $css to $this->domDocument. * * This method is protected to allow overriding. * * @see https://github.com/MyIntervals/emogrifier/issues/103 * * @param string $css */ protected function addStyleElementToDocument(string $css): void { $domDocument = $this->getDomDocument(); $styleElement = $domDocument->createElement('style', $css); $styleAttribute = $domDocument->createAttribute('type'); $styleAttribute->value = 'text/css'; $styleElement->appendChild($styleAttribute); $headElement = $this->getHeadElement(); $headElement->appendChild($styleElement); } /** * Returns the HEAD element. * * This method assumes that there always is a HEAD element. * * @return \DOMElement * * @throws \UnexpectedValueException */ private function getHeadElement(): \DOMElement { $node = $this->getDomDocument()->getElementsByTagName('head')->item(0); if (!$node instanceof \DOMElement) { throw new \UnexpectedValueException('There is no HEAD element. This should never happen.', 1617923227); } return $node; } } Sabberworm/CSS/Value/ValueList.php 0000777 00000005463 15252673315 0013024 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; /** * A `ValueList` represents a lists of `Value`s, separated by some separation character * (mostly `,`, whitespace, or `/`). * * There are two types of `ValueList`s: `RuleValueList` and `CSSFunction` */ abstract class ValueList extends Value { /** * @var array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> * * @internal since 8.8.0 */ protected $aComponents; /** * @var string * * @internal since 8.8.0 */ protected $sSeparator; /** * phpcs:ignore Generic.Files.LineLength * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string>|RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string $aComponents * @param string $sSeparator * @param int $iLineNo */ public function __construct($aComponents = [], $sSeparator = ',', $iLineNo = 0) { parent::__construct($iLineNo); if (!is_array($aComponents)) { $aComponents = [$aComponents]; } $this->aComponents = $aComponents; $this->sSeparator = $sSeparator; } /** * @param RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string $mComponent * * @return void */ public function addListComponent($mComponent) { $this->aComponents[] = $mComponent; } /** * @return array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> */ public function getListComponents() { return $this->aComponents; } /** * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aComponents * * @return void */ public function setListComponents(array $aComponents) { $this->aComponents = $aComponents; } /** * @return string */ public function getListSeparator() { return $this->sSeparator; } /** * @param string $sSeparator * * @return void */ public function setListSeparator($sSeparator) { $this->sSeparator = $sSeparator; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return $oOutputFormat->implode( $oOutputFormat->spaceBeforeListArgumentSeparator($this->sSeparator) . $this->sSeparator . $oOutputFormat->spaceAfterListArgumentSeparator($this->sSeparator), $this->aComponents ); } } Sabberworm/CSS/Value/CSSFunction.php 0000777 00000006016 15252673315 0013245 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * A `CSSFunction` represents a special kind of value that also contains a function name and where the values are the * function’s arguments. It also handles equals-sign-separated argument lists like `filter: alpha(opacity=90);`. */ class CSSFunction extends ValueList { /** * @var string * * @internal since 8.8.0 */ protected $sName; /** * @param string $sName * @param RuleValueList|array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aArguments * @param string $sSeparator * @param int $iLineNo */ public function __construct($sName, $aArguments, $sSeparator = ',', $iLineNo = 0) { if ($aArguments instanceof RuleValueList) { $sSeparator = $aArguments->getListSeparator(); $aArguments = $aArguments->getListComponents(); } $this->sName = $sName; $this->setPosition($iLineNo); // TODO: redundant? parent::__construct($aArguments, $sSeparator, $iLineNo); } /** * @param ParserState $oParserState * @param bool $bIgnoreCase * * @return CSSFunction * * @throws SourceException * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $bIgnoreCase = false) { $mResult = $oParserState->parseIdentifier($bIgnoreCase); $oParserState->consume('('); $aArguments = Value::parseValue($oParserState, ['=', ' ', ',']); $mResult = new CSSFunction($mResult, $aArguments, ',', $oParserState->currentLine()); $oParserState->consume(')'); return $mResult; } /** * @return string */ public function getName() { return $this->sName; } /** * @param string $sName * * @return void */ public function setName($sName) { $this->sName = $sName; } /** * @return array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> */ public function getArguments() { return $this->aComponents; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $aArguments = parent::render($oOutputFormat); return "{$this->sName}({$aArguments})"; } } Sabberworm/CSS/Value/Color.php 0000777 00000015041 15252673315 0012163 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * `Color's can be input in the form #rrggbb, #rgb or schema(val1, val2, …) but are always stored as an array of * ('s' => val1, 'c' => val2, 'h' => val3, …) and output in the second form. */ class Color extends CSSFunction { /** * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aColor * @param int $iLineNo */ public function __construct(array $aColor, $iLineNo = 0) { parent::__construct(implode('', array_keys($aColor)), $aColor, ',', $iLineNo); } /** * @param ParserState $oParserState * @param bool $bIgnoreCase * * @return Color|CSSFunction * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $bIgnoreCase = false) { $aColor = []; if ($oParserState->comes('#')) { $oParserState->consume('#'); $sValue = $oParserState->parseIdentifier(false); if ($oParserState->strlen($sValue) === 3) { $sValue = $sValue[0] . $sValue[0] . $sValue[1] . $sValue[1] . $sValue[2] . $sValue[2]; } elseif ($oParserState->strlen($sValue) === 4) { $sValue = $sValue[0] . $sValue[0] . $sValue[1] . $sValue[1] . $sValue[2] . $sValue[2] . $sValue[3] . $sValue[3]; } if ($oParserState->strlen($sValue) === 8) { $aColor = [ 'r' => new Size(intval($sValue[0] . $sValue[1], 16), null, true, $oParserState->currentLine()), 'g' => new Size(intval($sValue[2] . $sValue[3], 16), null, true, $oParserState->currentLine()), 'b' => new Size(intval($sValue[4] . $sValue[5], 16), null, true, $oParserState->currentLine()), 'a' => new Size( round(self::mapRange(intval($sValue[6] . $sValue[7], 16), 0, 255, 0, 1), 2), null, true, $oParserState->currentLine() ), ]; } elseif ($oParserState->strlen($sValue) === 6) { $aColor = [ 'r' => new Size(intval($sValue[0] . $sValue[1], 16), null, true, $oParserState->currentLine()), 'g' => new Size(intval($sValue[2] . $sValue[3], 16), null, true, $oParserState->currentLine()), 'b' => new Size(intval($sValue[4] . $sValue[5], 16), null, true, $oParserState->currentLine()), ]; } else { throw new UnexpectedTokenException( 'Invalid hex color value', $sValue, 'custom', $oParserState->currentLine() ); } } else { $sColorMode = $oParserState->parseIdentifier(true); $oParserState->consumeWhiteSpace(); $oParserState->consume('('); $bContainsVar = false; $iLength = $oParserState->strlen($sColorMode); for ($i = 0; $i < $iLength; ++$i) { $oParserState->consumeWhiteSpace(); if ($oParserState->comes('var')) { $aColor[$sColorMode[$i]] = CSSFunction::parseIdentifierOrFunction($oParserState); $bContainsVar = true; } else { $aColor[$sColorMode[$i]] = Size::parse($oParserState, true); } if ($bContainsVar && $oParserState->comes(')')) { // With a var argument the function can have fewer arguments break; } $oParserState->consumeWhiteSpace(); if ($i < ($iLength - 1)) { $oParserState->consume(','); } } $oParserState->consume(')'); if ($bContainsVar) { return new CSSFunction($sColorMode, array_values($aColor), ',', $oParserState->currentLine()); } } return new Color($aColor, $oParserState->currentLine()); } /** * @param float $fVal * @param float $fFromMin * @param float $fFromMax * @param float $fToMin * @param float $fToMax * * @return float */ private static function mapRange($fVal, $fFromMin, $fFromMax, $fToMin, $fToMax) { $fFromRange = $fFromMax - $fFromMin; $fToRange = $fToMax - $fToMin; $fMultiplier = $fToRange / $fFromRange; $fNewVal = $fVal - $fFromMin; $fNewVal *= $fMultiplier; return $fNewVal + $fToMin; } /** * @return array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> */ public function getColor() { return $this->aComponents; } /** * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aColor * * @return void */ public function setColor(array $aColor) { $this->setName(implode('', array_keys($aColor))); $this->aComponents = $aColor; } /** * @return string */ public function getColorDescription() { return $this->getName(); } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { // Shorthand RGB color values if ($oOutputFormat->getRGBHashNotation() && implode('', array_keys($this->aComponents)) === 'rgb') { $sResult = sprintf( '%02x%02x%02x', $this->aComponents['r']->getSize(), $this->aComponents['g']->getSize(), $this->aComponents['b']->getSize() ); return '#' . (($sResult[0] == $sResult[1]) && ($sResult[2] == $sResult[3]) && ($sResult[4] == $sResult[5]) ? "$sResult[0]$sResult[2]$sResult[4]" : $sResult); } return parent::render($oOutputFormat); } } Sabberworm/CSS/Value/PrimitiveValue.php 0000777 00000000402 15252673315 0014045 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; abstract class PrimitiveValue extends Value { /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); } } Sabberworm/CSS/Value/LineName.php 0000777 00000004103 15252673315 0012572 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; class LineName extends ValueList { /** * @param array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aComponents * @param int $iLineNo */ public function __construct(array $aComponents = [], $iLineNo = 0) { parent::__construct($aComponents, ' ', $iLineNo); } /** * @return LineName * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState) { $oParserState->consume('['); $oParserState->consumeWhiteSpace(); $aNames = []; do { if ($oParserState->getSettings()->bLenientParsing) { try { $aNames[] = $oParserState->parseIdentifier(); } catch (UnexpectedTokenException $e) { if (!$oParserState->comes(']')) { throw $e; } } } else { $aNames[] = $oParserState->parseIdentifier(); } $oParserState->consumeWhiteSpace(); } while (!$oParserState->comes(']')); $oParserState->consume(']'); return new LineName($aNames, $oParserState->currentLine()); } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return '[' . parent::render(OutputFormat::createCompact()) . ']'; } } Sabberworm/CSS/Value/CalcFunction.php 0000777 00000010647 15252673315 0013464 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * Support for `-webkit-calc` and `-moz-calc` is deprecated in version 8.8.0, and will be removed in version 9.0.0. */ class CalcFunction extends CSSFunction { /** * @var int * * @internal */ const T_OPERAND = 1; /** * @var int * * @internal */ const T_OPERATOR = 2; /** * @param ParserState $oParserState * @param bool $bIgnoreCase * * @return CalcFunction * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $bIgnoreCase = false) { $aOperators = ['+', '-', '*', '/']; $sFunction = $oParserState->parseIdentifier(); if ($oParserState->peek() != '(') { // Found ; or end of line before an opening bracket throw new UnexpectedTokenException('(', $oParserState->peek(), 'literal', $oParserState->currentLine()); } elseif (!in_array($sFunction, ['calc', '-moz-calc', '-webkit-calc'])) { // Found invalid calc definition. Example calc (... throw new UnexpectedTokenException('calc', $sFunction, 'literal', $oParserState->currentLine()); } $oParserState->consume('('); $oCalcList = new CalcRuleValueList($oParserState->currentLine()); $oList = new RuleValueList(',', $oParserState->currentLine()); $iNestingLevel = 0; $iLastComponentType = null; while (!$oParserState->comes(')') || $iNestingLevel > 0) { if ($oParserState->isEnd() && $iNestingLevel === 0) { break; } $oParserState->consumeWhiteSpace(); if ($oParserState->comes('(')) { $iNestingLevel++; $oCalcList->addListComponent($oParserState->consume(1)); $oParserState->consumeWhiteSpace(); continue; } elseif ($oParserState->comes(')')) { $iNestingLevel--; $oCalcList->addListComponent($oParserState->consume(1)); $oParserState->consumeWhiteSpace(); continue; } if ($iLastComponentType != CalcFunction::T_OPERAND) { $oVal = Value::parsePrimitiveValue($oParserState); $oCalcList->addListComponent($oVal); $iLastComponentType = CalcFunction::T_OPERAND; } else { if (in_array($oParserState->peek(), $aOperators)) { if (($oParserState->comes('-') || $oParserState->comes('+'))) { if ( $oParserState->peek(1, -1) != ' ' || !($oParserState->comes('- ') || $oParserState->comes('+ ')) ) { throw new UnexpectedTokenException( " {$oParserState->peek()} ", $oParserState->peek(1, -1) . $oParserState->peek(2), 'literal', $oParserState->currentLine() ); } } $oCalcList->addListComponent($oParserState->consume(1)); $iLastComponentType = CalcFunction::T_OPERATOR; } else { throw new UnexpectedTokenException( sprintf( 'Next token was expected to be an operand of type %s. Instead "%s" was found.', implode(', ', $aOperators), $oParserState->peek() ), '', 'custom', $oParserState->currentLine() ); } } $oParserState->consumeWhiteSpace(); } $oList->addListComponent($oCalcList); if (!$oParserState->isEnd()) { $oParserState->consume(')'); } return new CalcFunction($sFunction, $oList, ',', $oParserState->currentLine()); } } Sabberworm/CSS/Value/CSSString.php 0000777 00000006215 15252673315 0012727 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * This class is a wrapper for quoted strings to distinguish them from keywords. * * `CSSString`s always output with double quotes. */ class CSSString extends PrimitiveValue { /** * @var string */ private $sString; /** * @param string $sString * @param int $iLineNo */ public function __construct($sString, $iLineNo = 0) { $this->sString = $sString; parent::__construct($iLineNo); } /** * @return CSSString * * @throws SourceException * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState) { $sBegin = $oParserState->peek(); $sQuote = null; if ($sBegin === "'") { $sQuote = "'"; } elseif ($sBegin === '"') { $sQuote = '"'; } if ($sQuote !== null) { $oParserState->consume($sQuote); } $sResult = ""; $sContent = null; if ($sQuote === null) { // Unquoted strings end in whitespace or with braces, brackets, parentheses while (!preg_match('/[\\s{}()<>\\[\\]]/isu', $oParserState->peek())) { $sResult .= $oParserState->parseCharacter(false); } } else { while (!$oParserState->comes($sQuote)) { $sContent = $oParserState->parseCharacter(false); if ($sContent === null) { throw new SourceException( "Non-well-formed quoted string {$oParserState->peek(3)}", $oParserState->currentLine() ); } $sResult .= $sContent; } $oParserState->consume($sQuote); } return new CSSString($sResult, $oParserState->currentLine()); } /** * @param string $sString * * @return void */ public function setString($sString) { $this->sString = $sString; } /** * @return string */ public function getString() { return $this->sString; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sString = addslashes($this->sString); $sString = str_replace("\n", '\A', $sString); return $oOutputFormat->getStringQuotingType() . $sString . $oOutputFormat->getStringQuotingType(); } } Sabberworm/CSS/Value/URL.php 0000777 00000004755 15252673315 0011561 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * This class represents URLs in CSS. `URL`s always output in `URL("")` notation. */ class URL extends PrimitiveValue { /** * @var CSSString */ private $oURL; /** * @param int $iLineNo */ public function __construct(CSSString $oURL, $iLineNo = 0) { parent::__construct($iLineNo); $this->oURL = $oURL; } /** * @return URL * * @throws SourceException * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState) { $oAnchor = $oParserState->anchor(); $sIdentifier = ''; for ($i = 0; $i < 3; $i++) { $sChar = $oParserState->parseCharacter(true); if ($sChar === null) { break; } $sIdentifier .= $sChar; } $bUseUrl = $oParserState->streql($sIdentifier, 'url'); if ($bUseUrl) { $oParserState->consumeWhiteSpace(); $oParserState->consume('('); } else { $oAnchor->backtrack(); } $oParserState->consumeWhiteSpace(); $oResult = new URL(CSSString::parse($oParserState), $oParserState->currentLine()); if ($bUseUrl) { $oParserState->consumeWhiteSpace(); $oParserState->consume(')'); } return $oResult; } /** * @return void */ public function setURL(CSSString $oURL) { $this->oURL = $oURL; } /** * @return CSSString */ public function getURL() { return $this->oURL; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return "url({$this->oURL->render($oOutputFormat)})"; } } Sabberworm/CSS/Value/CalcRuleValueList.php 0000777 00000001036 15252673315 0014427 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; class CalcRuleValueList extends RuleValueList { /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct(',', $iLineNo); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return $oOutputFormat->implode(' ', $this->aComponents); } } Sabberworm/CSS/Value/Value.php 0000777 00000020200 15252673315 0012152 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Positionable; /** * Abstract base class for specific classes of CSS values: `Size`, `Color`, `CSSString` and `URL`, and another * abstract subclass `ValueList`. */ abstract class Value implements CSSElement, Positionable { use Position; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { $this->setPosition($iLineNo); } /** * @param array<array-key, string> $aListDelimiters * * @return RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parseValue(ParserState $oParserState, array $aListDelimiters = []) { /** @var array<int, RuleValueList|CSSFunction|CSSString|LineName|Size|URL|string> $aStack */ $aStack = []; $oParserState->consumeWhiteSpace(); //Build a list of delimiters and parsed values while ( !($oParserState->comes('}') || $oParserState->comes(';') || $oParserState->comes('!') || $oParserState->comes(')') || $oParserState->comes('\\') || $oParserState->isEnd()) ) { if (count($aStack) > 0) { $bFoundDelimiter = false; foreach ($aListDelimiters as $sDelimiter) { if ($oParserState->comes($sDelimiter)) { array_push($aStack, $oParserState->consume($sDelimiter)); $oParserState->consumeWhiteSpace(); $bFoundDelimiter = true; break; } } if (!$bFoundDelimiter) { //Whitespace was the list delimiter array_push($aStack, ' '); } } array_push($aStack, self::parsePrimitiveValue($oParserState)); $oParserState->consumeWhiteSpace(); } // Convert the list to list objects foreach ($aListDelimiters as $sDelimiter) { $iStackLength = count($aStack); if ($iStackLength === 1) { return $aStack[0]; } $aNewStack = []; for ($iStartPosition = 0; $iStartPosition < $iStackLength; ++$iStartPosition) { if ($iStartPosition === ($iStackLength - 1) || $sDelimiter !== $aStack[$iStartPosition + 1]) { $aNewStack[] = $aStack[$iStartPosition]; continue; } $iLength = 2; //Number of elements to be joined for ($i = $iStartPosition + 3; $i < $iStackLength; $i += 2, ++$iLength) { if ($sDelimiter !== $aStack[$i]) { break; } } $oList = new RuleValueList($sDelimiter, $oParserState->currentLine()); for ($i = $iStartPosition; $i - $iStartPosition < $iLength * 2; $i += 2) { $oList->addListComponent($aStack[$i]); } $aNewStack[] = $oList; $iStartPosition += $iLength * 2 - 2; } $aStack = $aNewStack; } if (!isset($aStack[0])) { throw new UnexpectedTokenException( " {$oParserState->peek()} ", $oParserState->peek(1, -1) . $oParserState->peek(2), 'literal', $oParserState->currentLine() ); } return $aStack[0]; } /** * @param bool $bIgnoreCase * * @return CSSFunction|string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parseIdentifierOrFunction(ParserState $oParserState, $bIgnoreCase = false) { $oAnchor = $oParserState->anchor(); $mResult = $oParserState->parseIdentifier($bIgnoreCase); if ($oParserState->comes('(')) { $oAnchor->backtrack(); if ($oParserState->streql('url', $mResult)) { $mResult = URL::parse($oParserState); } elseif ( $oParserState->streql('calc', $mResult) || $oParserState->streql('-webkit-calc', $mResult) || $oParserState->streql('-moz-calc', $mResult) ) { $mResult = CalcFunction::parse($oParserState); } else { $mResult = CSSFunction::parse($oParserState, $bIgnoreCase); } } return $mResult; } /** * @return CSSFunction|CSSString|LineName|Size|URL|string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * @throws SourceException * * @internal since V8.8.0 */ public static function parsePrimitiveValue(ParserState $oParserState) { $oValue = null; $oParserState->consumeWhiteSpace(); if ( is_numeric($oParserState->peek()) || ($oParserState->comes('-.') && is_numeric($oParserState->peek(1, 2))) || (($oParserState->comes('-') || $oParserState->comes('.')) && is_numeric($oParserState->peek(1, 1))) ) { $oValue = Size::parse($oParserState); } elseif ($oParserState->comes('#') || $oParserState->comes('rgb', true) || $oParserState->comes('hsl', true)) { $oValue = Color::parse($oParserState); } elseif ($oParserState->comes("'") || $oParserState->comes('"')) { $oValue = CSSString::parse($oParserState); } elseif ($oParserState->comes("progid:") && $oParserState->getSettings()->bLenientParsing) { $oValue = self::parseMicrosoftFilter($oParserState); } elseif ($oParserState->comes("[")) { $oValue = LineName::parse($oParserState); } elseif ($oParserState->comes("U+")) { $oValue = self::parseUnicodeRangeValue($oParserState); } else { $sNextChar = $oParserState->peek(1); try { $oValue = self::parseIdentifierOrFunction($oParserState); } catch (UnexpectedTokenException $e) { if (\in_array($sNextChar, ['+', '-', '*', '/'], true)) { $oValue = $oParserState->consume(1); } else { throw $e; } } } $oParserState->consumeWhiteSpace(); return $oValue; } /** * @return CSSFunction * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ private static function parseMicrosoftFilter(ParserState $oParserState) { $sFunction = $oParserState->consumeUntil('(', false, true); $aArguments = Value::parseValue($oParserState, [',', '=']); return new CSSFunction($sFunction, $aArguments, ',', $oParserState->currentLine()); } /** * @return string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ private static function parseUnicodeRangeValue(ParserState $oParserState) { $iCodepointMaxLength = 6; // Code points outside BMP can use up to six digits $sRange = ""; $oParserState->consume("U+"); do { if ($oParserState->comes('-')) { $iCodepointMaxLength = 13; // Max length is 2 six digit code points + the dash(-) between them } $sRange .= $oParserState->consume(1); } while (strlen($sRange) < $iCodepointMaxLength && preg_match("/[A-Fa-f0-9\?-]/", $oParserState->peek())); return "U+{$sRange}"; } } Sabberworm/CSS/Value/Size.php 0000777 00000014412 15252673315 0012020 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; /** * A `Size` consists of a numeric `size` value and a unit. */ class Size extends PrimitiveValue { /** * vh/vw/vm(ax)/vmin/rem are absolute insofar as they don’t scale to the immediate parent (only the viewport) * * @var array<int, string> * * @internal */ const ABSOLUTE_SIZE_UNITS = [ 'px', 'pt', 'pc', 'cm', 'mm', 'mozmm', 'in', 'vh', 'dvh', 'svh', 'lvh', 'vw', 'vmin', 'vmax', 'rem', ]; /** * @var array<int, string> * * @internal */ const RELATIVE_SIZE_UNITS = ['%', 'em', 'ex', 'ch', 'fr']; /** * @var array<int, string> * * @internal */ const NON_SIZE_UNITS = ['deg', 'grad', 'rad', 's', 'ms', 'turn', 'Hz', 'kHz']; /** * @var array<int, array<string, string>>|null */ private static $SIZE_UNITS = null; /** * @var float */ private $fSize; /** * @var string|null */ private $sUnit; /** * @var bool */ private $bIsColorComponent; /** * @param float|int|string $fSize * @param string|null $sUnit * @param bool $bIsColorComponent * @param int $iLineNo */ public function __construct($fSize, $sUnit = null, $bIsColorComponent = false, $iLineNo = 0) { parent::__construct($iLineNo); $this->fSize = (float)$fSize; $this->sUnit = $sUnit; $this->bIsColorComponent = $bIsColorComponent; } /** * @param bool $bIsColorComponent * * @return Size * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $bIsColorComponent = false) { $sSize = ''; if ($oParserState->comes('-')) { $sSize .= $oParserState->consume('-'); } while (is_numeric($oParserState->peek()) || $oParserState->comes('.') || $oParserState->comes('e', true)) { if ($oParserState->comes('.')) { $sSize .= $oParserState->consume('.'); } elseif ($oParserState->comes('e', true)) { $sLookahead = $oParserState->peek(1, 1); if (is_numeric($sLookahead) || $sLookahead === '+' || $sLookahead === '-') { $sSize .= $oParserState->consume(2); } else { break; // Reached the unit part of the number like "em" or "ex" } } else { $sSize .= $oParserState->consume(1); } } $sUnit = null; $aSizeUnits = self::getSizeUnits(); foreach ($aSizeUnits as $iLength => &$aValues) { $sKey = strtolower($oParserState->peek($iLength)); if (array_key_exists($sKey, $aValues)) { if (($sUnit = $aValues[$sKey]) !== null) { $oParserState->consume($iLength); break; } } } return new Size((float)$sSize, $sUnit, $bIsColorComponent, $oParserState->currentLine()); } /** * @return array<int, array<string, string>> */ private static function getSizeUnits() { if (!is_array(self::$SIZE_UNITS)) { self::$SIZE_UNITS = []; foreach (array_merge(self::ABSOLUTE_SIZE_UNITS, self::RELATIVE_SIZE_UNITS, self::NON_SIZE_UNITS) as $val) { $iSize = strlen($val); if (!isset(self::$SIZE_UNITS[$iSize])) { self::$SIZE_UNITS[$iSize] = []; } self::$SIZE_UNITS[$iSize][strtolower($val)] = $val; } krsort(self::$SIZE_UNITS, SORT_NUMERIC); } return self::$SIZE_UNITS; } /** * @param string $sUnit * * @return void */ public function setUnit($sUnit) { $this->sUnit = $sUnit; } /** * @return string|null */ public function getUnit() { return $this->sUnit; } /** * @param float|int|string $fSize */ public function setSize($fSize) { $this->fSize = (float)$fSize; } /** * @return float */ public function getSize() { return $this->fSize; } /** * @return bool */ public function isColorComponent() { return $this->bIsColorComponent; } /** * Returns whether the number stored in this Size really represents a size (as in a length of something on screen). * * @return false if the unit an angle, a duration, a frequency or the number is a component in a Color object. */ public function isSize() { if (in_array($this->sUnit, self::NON_SIZE_UNITS, true)) { return false; } return !$this->isColorComponent(); } /** * @return bool */ public function isRelative() { if (in_array($this->sUnit, self::RELATIVE_SIZE_UNITS, true)) { return true; } if ($this->sUnit === null && $this->fSize != 0) { return true; } return false; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $l = localeconv(); $sPoint = preg_quote($l['decimal_point'], '/'); $sSize = preg_match("/[\d\.]+e[+-]?\d+/i", (string)$this->fSize) ? preg_replace("/$sPoint?0+$/", "", sprintf("%f", $this->fSize)) : (string)$this->fSize; return preg_replace(["/$sPoint/", "/^(-?)0\./"], ['.', '$1.'], $sSize) . ($this->sUnit === null ? '' : $this->sUnit); } } Sabberworm/CSS/Value/RuleValueList.php 0000777 00000001112 15252673315 0013637 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value; /** * This class is used to represent all multivalued rules like `font: bold 12px/3 Helvetica, Verdana, sans-serif;` * (where the value would be a whitespace-separated list of the primitive value `bold`, a slash-separated list * and a comma-separated list). */ class RuleValueList extends ValueList { /** * @param string $sSeparator * @param int $iLineNo */ public function __construct($sSeparator = ',', $iLineNo = 0) { parent::__construct([], $sSeparator, $iLineNo); } } Sabberworm/CSS/RuleSet/RuleSet.php 0000777 00000030310 15252673315 0012773 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Renderable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Rule\Rule; /** * This class is a container for individual 'Rule's. * * The most common form of a rule set is one constrained by a selector, i.e., a `DeclarationBlock`. * However, unknown `AtRule`s (like `@font-face`) are rule sets as well. * * If you want to manipulate a `RuleSet`, use the methods `addRule(Rule $rule)`, `getRules()` and `removeRule($rule)` * (which accepts either a `Rule` or a rule name; optionally suffixed by a dash to remove all related rules). */ abstract class RuleSet implements CSSElement, Commentable, Positionable { use Position; /** * the rules in this rule set, using the property name as the key, * with potentially multiple rules per property name. * * @var array<string, array<int<0, max>, Rule>> */ private $aRules; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { $this->aRules = []; $this->setPosition($iLineNo); $this->aComments = []; } /** * @return void * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parseRuleSet(ParserState $oParserState, RuleSet $oRuleSet) { while ($oParserState->comes(';')) { $oParserState->consume(';'); } while (true) { $commentsBeforeRule = $oParserState->consumeWhiteSpace(); if ($oParserState->comes('}')) { break; } $oRule = null; if ($oParserState->getSettings()->bLenientParsing) { try { $oRule = Rule::parse($oParserState, $commentsBeforeRule); } catch (UnexpectedTokenException $e) { try { $sConsume = $oParserState->consumeUntil(["\n", ";", '}'], true); // We need to “unfind” the matches to the end of the ruleSet as this will be matched later if ($oParserState->streql(substr($sConsume, -1), '}')) { $oParserState->backtrack(1); } else { while ($oParserState->comes(';')) { $oParserState->consume(';'); } } } catch (UnexpectedTokenException $e) { // We’ve reached the end of the document. Just close the RuleSet. return; } } } else { $oRule = Rule::parse($oParserState, $commentsBeforeRule); } if ($oRule) { $oRuleSet->addRule($oRule); } } $oParserState->consume('}'); } /** * @param Rule|null $oSibling * * @return void */ public function addRule(Rule $oRule, $oSibling = null) { $sRule = $oRule->getRule(); if (!isset($this->aRules[$sRule])) { $this->aRules[$sRule] = []; } $iPosition = count($this->aRules[$sRule]); if ($oSibling !== null) { $iSiblingPos = array_search($oSibling, $this->aRules[$sRule], true); if ($iSiblingPos !== false) { $iPosition = $iSiblingPos; $oRule->setPosition($oSibling->getLineNo(), $oSibling->getColNo() - 1); } } if ($oRule->getLineNumber() === null) { //this node is added manually, give it the next best line $columnNumber = $oRule->getColNo(); $rules = $this->getRules(); $pos = count($rules); if ($pos > 0) { $last = $rules[$pos - 1]; $oRule->setPosition($last->getLineNo() + 1, $columnNumber); } else { $oRule->setPosition(1, $columnNumber); } } elseif ($oRule->getColumnNumber() === null) { $oRule->setPosition($oRule->getLineNumber(), 0); } array_splice($this->aRules[$sRule], $iPosition, 0, [$oRule]); } /** * Returns all rules matching the given rule name * * @example $oRuleSet->getRules('font') // returns array(0 => $oRule, …) or array(). * * @example $oRuleSet->getRules('font-') * //returns an array of all rules either beginning with font- or matching font. * * @param Rule|string|null $mRule * Pattern to search for. If null, returns all rules. * If the pattern ends with a dash, all rules starting with the pattern are returned * as well as one matching the pattern with the dash excluded. * Passing a `Rule` for this parameter is deprecated in version 8.9.0, and will not work from v9.0. * Call `getRules($rule->getRule())` instead. * * @return array<int, Rule> */ public function getRules($mRule = null) { if ($mRule instanceof Rule) { $mRule = $mRule->getRule(); } /** @var array<int, Rule> $aResult */ $aResult = []; foreach ($this->aRules as $sName => $aRules) { // Either no search rule is given or the search rule matches the found rule exactly // or the search rule ends in “-” and the found rule starts with the search rule. if ( !$mRule || $sName === $mRule || ( strrpos($mRule, '-') === strlen($mRule) - strlen('-') && (strpos($sName, $mRule) === 0 || $sName === substr($mRule, 0, -1)) ) ) { $aResult = array_merge($aResult, $aRules); } } usort($aResult, function (Rule $first, Rule $second) { if ($first->getLineNo() === $second->getLineNo()) { return $first->getColNo() - $second->getColNo(); } return $first->getLineNo() - $second->getLineNo(); }); return $aResult; } /** * Overrides all the rules of this set. * * @param array<array-key, Rule> $aRules The rules to override with. * * @return void */ public function setRules(array $aRules) { $this->aRules = []; foreach ($aRules as $rule) { $this->addRule($rule); } } /** * Returns all rules matching the given pattern and returns them in an associative array with the rule’s name * as keys. This method exists mainly for backwards-compatibility and is really only partially useful. * * Note: This method loses some information: Calling this (with an argument of `background-`) on a declaration block * like `{ background-color: green; background-color; rgba(0, 127, 0, 0.7); }` will only yield an associative array * containing the rgba-valued rule while `getRules()` would yield an indexed array containing both. * * @param Rule|string|null $mRule $mRule * Pattern to search for. If null, returns all rules. If the pattern ends with a dash, * all rules starting with the pattern are returned as well as one matching the pattern with the dash * excluded. * Passing a `Rule` for this parameter is deprecated in version 8.9.0, and will not work from v9.0. * Call `getRulesAssoc($rule->getRule())` instead. * * @return array<string, Rule> */ public function getRulesAssoc($mRule = null) { /** @var array<string, Rule> $aResult */ $aResult = []; foreach ($this->getRules($mRule) as $oRule) { $aResult[$oRule->getRule()] = $oRule; } return $aResult; } /** * Removes a `Rule` from this `RuleSet` by identity. * * @param Rule|string|null $mRule * `Rule` to remove. * Passing a `string` or `null` is deprecated in version 8.9.0, and will no longer work from v9.0. * Use `removeMatchingRules()` or `removeAllRules()` instead. */ public function removeRule($mRule) { if ($mRule instanceof Rule) { $sRule = $mRule->getRule(); if (!isset($this->aRules[$sRule])) { return; } foreach ($this->aRules[$sRule] as $iKey => $oRule) { if ($oRule === $mRule) { unset($this->aRules[$sRule][$iKey]); } } } elseif ($mRule !== null) { $this->removeMatchingRules($mRule); } else { $this->removeAllRules(); } } /** * Removes rules by property name or search pattern. * * @param string $searchPattern * pattern to remove. * If the pattern ends in a dash, * all rules starting with the pattern are removed as well as one matching the pattern with the dash * excluded. */ public function removeMatchingRules($searchPattern) { foreach ($this->aRules as $propertyName => $rules) { // Either the search rule matches the found rule exactly // or the search rule ends in “-” and the found rule starts with the search rule or equals it // (without the trailing dash). if ( $propertyName === $searchPattern || (\strrpos($searchPattern, '-') === \strlen($searchPattern) - \strlen('-') && (\strpos($propertyName, $searchPattern) === 0 || $propertyName === \substr($searchPattern, 0, -1))) ) { unset($this->aRules[$propertyName]); } } } public function removeAllRules() { $this->aRules = []; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @return string */ protected function renderRules(OutputFormat $oOutputFormat) { $sResult = ''; $bIsFirst = true; $oNextLevel = $oOutputFormat->nextLevel(); foreach ($this->getRules() as $oRule) { $sRendered = $oNextLevel->safely(function () use ($oRule, $oNextLevel) { return $oRule->render($oNextLevel); }); if ($sRendered === null) { continue; } if ($bIsFirst) { $bIsFirst = false; $sResult .= $oNextLevel->spaceBeforeRules(); } else { $sResult .= $oNextLevel->spaceBetweenRules(); } $sResult .= $sRendered; } if (!$bIsFirst) { // Had some output $sResult .= $oOutputFormat->spaceAfterRules(); } return $oOutputFormat->removeLastSemicolon($sResult); } /** * @param array<string, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<string, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<string, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } Sabberworm/CSS/RuleSet/DeclarationBlock.php 0000777 00000076041 15252673315 0014623 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList\CSSList; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList\KeyFrame; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\OutputException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\KeyframeSelector; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Rule\Rule; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\Color; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\RuleValueList; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\Size; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\URL; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\Value; /** * This class represents a `RuleSet` constrained by a `Selector`. * * It contains an array of selector objects (comma-separated in the CSS) as well as the rules to be applied to the * matching elements. * * Declaration blocks usually appear directly inside a `Document` or another `CSSList` (mostly a `MediaQuery`). */ class DeclarationBlock extends RuleSet { /** * @var array<int, Selector|string> */ private $aSelectors; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); $this->aSelectors = []; } /** * @param CSSList|null $oList * * @return DeclarationBlock|false * * @throws UnexpectedTokenException * @throws UnexpectedEOFException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $oList = null) { $aComments = []; $oResult = new DeclarationBlock($oParserState->currentLine()); try { $aSelectorParts = []; $sStringWrapperChar = false; do { $aSelectorParts[] = $oParserState->consume(1) . $oParserState->consumeUntil(['{', '}', '\'', '"'], false, false, $aComments); if (in_array($oParserState->peek(), ['\'', '"']) && substr(end($aSelectorParts), -1) != "\\") { if ($sStringWrapperChar === false) { $sStringWrapperChar = $oParserState->peek(); } elseif ($sStringWrapperChar == $oParserState->peek()) { $sStringWrapperChar = false; } } } while (!in_array($oParserState->peek(), ['{', '}']) || $sStringWrapperChar !== false); $oResult->setSelectors(implode('', $aSelectorParts), $oList); if ($oParserState->comes('{')) { $oParserState->consume(1); } } catch (UnexpectedTokenException $e) { if ($oParserState->getSettings()->bLenientParsing) { if (!$oParserState->comes('}')) { $oParserState->consumeUntil('}', false, true); } return false; } else { throw $e; } } $oResult->setComments($aComments); RuleSet::parseRuleSet($oParserState, $oResult); return $oResult; } /** * @param array<int, Selector|string>|string $mSelector * @param CSSList|null $oList * * @throws UnexpectedTokenException */ public function setSelectors($mSelector, $oList = null) { if (is_array($mSelector)) { $this->aSelectors = $mSelector; } else { $this->aSelectors = explode(',', $mSelector); } foreach ($this->aSelectors as $iKey => $mSelector) { if (!($mSelector instanceof Selector)) { if ($oList === null || !($oList instanceof KeyFrame)) { if (!Selector::isValid($mSelector)) { throw new UnexpectedTokenException( "Selector did not match '" . Selector::SELECTOR_VALIDATION_RX . "'.", $mSelector, "custom" ); } $this->aSelectors[$iKey] = new Selector($mSelector); } else { if (!KeyframeSelector::isValid($mSelector)) { throw new UnexpectedTokenException( "Selector did not match '" . KeyframeSelector::SELECTOR_VALIDATION_RX . "'.", $mSelector, "custom" ); } $this->aSelectors[$iKey] = new KeyframeSelector($mSelector); } } } } /** * Remove one of the selectors of the block. * * @param Selector|string $mSelector * * @return bool */ public function removeSelector($mSelector) { if ($mSelector instanceof Selector) { $mSelector = $mSelector->getSelector(); } foreach ($this->aSelectors as $iKey => $oSelector) { if ($oSelector->getSelector() === $mSelector) { unset($this->aSelectors[$iKey]); return true; } } return false; } /** * @return array<int, Selector|string> * * @deprecated will be removed in version 9.0; use `getSelectors()` instead */ public function getSelector() { return $this->getSelectors(); } /** * @param Selector|string $mSelector * @param CSSList|null $oList * * @return void * * @deprecated will be removed in version 9.0; use `setSelectors()` instead */ public function setSelector($mSelector, $oList = null) { $this->setSelectors($mSelector, $oList); } /** * @return array<int, Selector|string> */ public function getSelectors() { return $this->aSelectors; } /** * Splits shorthand declarations (e.g. `margin` or `font`) into their constituent parts. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandShorthands() { // border must be expanded before dimensions $this->expandBorderShorthand(); $this->expandDimensionsShorthand(); $this->expandFontShorthand(); $this->expandBackgroundShorthand(); $this->expandListStyleShorthand(); } /** * Creates shorthand declarations (e.g. `margin` or `font`) whenever possible. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createShorthands() { $this->createBackgroundShorthand(); $this->createDimensionsShorthand(); // border must be shortened after dimensions $this->createBorderShorthand(); $this->createFontShorthand(); $this->createListStyleShorthand(); } /** * Splits shorthand border declarations (e.g. `border: 1px red;`). * * Additional splitting happens in expandDimensionsShorthand. * * Multiple borders are not yet supported as of 3. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandBorderShorthand() { $aBorderRules = [ 'border', 'border-left', 'border-right', 'border-top', 'border-bottom', ]; $aBorderSizes = [ 'thin', 'medium', 'thick', ]; $aRules = $this->getRulesAssoc(); foreach ($aBorderRules as $sBorderRule) { if (!isset($aRules[$sBorderRule])) { continue; } $oRule = $aRules[$sBorderRule]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } foreach ($aValues as $mValue) { if ($mValue instanceof Value) { $mNewValue = clone $mValue; } else { $mNewValue = $mValue; } if ($mValue instanceof Size) { $sNewRuleName = $sBorderRule . "-width"; } elseif ($mValue instanceof Color) { $sNewRuleName = $sBorderRule . "-color"; } else { if (in_array($mValue, $aBorderSizes)) { $sNewRuleName = $sBorderRule . "-width"; } else { $sNewRuleName = $sBorderRule . "-style"; } } $oNewRule = new Rule($sNewRuleName, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->setIsImportant($oRule->getIsImportant()); $oNewRule->addValue([$mNewValue]); $this->addRule($oNewRule); } $this->removeRule($sBorderRule); } } /** * Splits shorthand dimensional declarations (e.g. `margin: 0px auto;`) * into their constituent parts. * * Handles `margin`, `padding`, `border-color`, `border-style` and `border-width`. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandDimensionsShorthand() { $aExpansions = [ 'margin' => 'margin-%s', 'padding' => 'padding-%s', 'border-color' => 'border-%s-color', 'border-style' => 'border-%s-style', 'border-width' => 'border-%s-width', ]; $aRules = $this->getRulesAssoc(); foreach ($aExpansions as $sProperty => $sExpanded) { if (!isset($aRules[$sProperty])) { continue; } $oRule = $aRules[$sProperty]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } $top = $right = $bottom = $left = null; switch (count($aValues)) { case 1: $top = $right = $bottom = $left = $aValues[0]; break; case 2: $top = $bottom = $aValues[0]; $left = $right = $aValues[1]; break; case 3: $top = $aValues[0]; $left = $right = $aValues[1]; $bottom = $aValues[2]; break; case 4: $top = $aValues[0]; $right = $aValues[1]; $bottom = $aValues[2]; $left = $aValues[3]; break; } foreach (['top', 'right', 'bottom', 'left'] as $sPosition) { $oNewRule = new Rule(sprintf($sExpanded, $sPosition), $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->setIsImportant($oRule->getIsImportant()); $oNewRule->addValue(${$sPosition}); $this->addRule($oNewRule); } $this->removeRule($sProperty); } } /** * Converts shorthand font declarations * (e.g. `font: 300 italic 11px/14px verdana, helvetica, sans-serif;`) * into their constituent parts. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandFontShorthand() { $aRules = $this->getRulesAssoc(); if (!isset($aRules['font'])) { return; } $oRule = $aRules['font']; // reset properties to 'normal' per http://www.w3.org/TR/21/fonts.html#font-shorthand $aFontProperties = [ 'font-style' => 'normal', 'font-variant' => 'normal', 'font-weight' => 'normal', 'font-size' => 'normal', 'line-height' => 'normal', ]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } foreach ($aValues as $mValue) { if (!$mValue instanceof Value) { $mValue = mb_strtolower($mValue); } if (in_array($mValue, ['normal', 'inherit'])) { foreach (['font-style', 'font-weight', 'font-variant'] as $sProperty) { if (!isset($aFontProperties[$sProperty])) { $aFontProperties[$sProperty] = $mValue; } } } elseif (in_array($mValue, ['italic', 'oblique'])) { $aFontProperties['font-style'] = $mValue; } elseif ($mValue == 'small-caps') { $aFontProperties['font-variant'] = $mValue; } elseif ( in_array($mValue, ['bold', 'bolder', 'lighter']) || ($mValue instanceof Size && in_array($mValue->getSize(), range(100, 900, 100))) ) { $aFontProperties['font-weight'] = $mValue; } elseif ($mValue instanceof RuleValueList && $mValue->getListSeparator() == '/') { list($oSize, $oHeight) = $mValue->getListComponents(); $aFontProperties['font-size'] = $oSize; $aFontProperties['line-height'] = $oHeight; } elseif ($mValue instanceof Size && $mValue->getUnit() !== null) { $aFontProperties['font-size'] = $mValue; } else { $aFontProperties['font-family'] = $mValue; } } foreach ($aFontProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->addValue($mValue); $oNewRule->setIsImportant($oRule->getIsImportant()); $this->addRule($oNewRule); } $this->removeRule('font'); } /** * Converts shorthand background declarations * (e.g. `background: url("chess.png") gray 50% repeat fixed;`) * into their constituent parts. * * @see http://www.w3.org/TR/21/colors.html#propdef-background * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandBackgroundShorthand() { $aRules = $this->getRulesAssoc(); if (!isset($aRules['background'])) { return; } $oRule = $aRules['background']; $aBgProperties = [ 'background-color' => ['transparent'], 'background-image' => ['none'], 'background-repeat' => ['repeat'], 'background-attachment' => ['scroll'], 'background-position' => [ new Size(0, '%', false, $this->getLineNo()), new Size(0, '%', false, $this->getLineNo()), ], ]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } if (count($aValues) == 1 && $aValues[0] == 'inherit') { foreach ($aBgProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->addValue('inherit'); $oNewRule->setIsImportant($oRule->getIsImportant()); $this->addRule($oNewRule); } $this->removeRule('background'); return; } $iNumBgPos = 0; foreach ($aValues as $mValue) { if (!$mValue instanceof Value) { $mValue = mb_strtolower($mValue); } if ($mValue instanceof URL) { $aBgProperties['background-image'] = $mValue; } elseif ($mValue instanceof Color) { $aBgProperties['background-color'] = $mValue; } elseif (in_array($mValue, ['scroll', 'fixed'])) { $aBgProperties['background-attachment'] = $mValue; } elseif (in_array($mValue, ['repeat', 'no-repeat', 'repeat-x', 'repeat-y'])) { $aBgProperties['background-repeat'] = $mValue; } elseif ( in_array($mValue, ['left', 'center', 'right', 'top', 'bottom']) || $mValue instanceof Size ) { if ($iNumBgPos == 0) { $aBgProperties['background-position'][0] = $mValue; $aBgProperties['background-position'][1] = 'center'; } else { $aBgProperties['background-position'][$iNumBgPos] = $mValue; } $iNumBgPos++; } } foreach ($aBgProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->setIsImportant($oRule->getIsImportant()); $oNewRule->addValue($mValue); $this->addRule($oNewRule); } $this->removeRule('background'); } /** * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandListStyleShorthand() { $aListProperties = [ 'list-style-type' => 'disc', 'list-style-position' => 'outside', 'list-style-image' => 'none', ]; $aListStyleTypes = [ 'none', 'disc', 'circle', 'square', 'decimal-leading-zero', 'decimal', 'lower-roman', 'upper-roman', 'lower-greek', 'lower-alpha', 'lower-latin', 'upper-alpha', 'upper-latin', 'hebrew', 'armenian', 'georgian', 'cjk-ideographic', 'hiragana', 'hira-gana-iroha', 'katakana-iroha', 'katakana', ]; $aListStylePositions = [ 'inside', 'outside', ]; $aRules = $this->getRulesAssoc(); if (!isset($aRules['list-style'])) { return; } $oRule = $aRules['list-style']; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } if (count($aValues) == 1 && $aValues[0] == 'inherit') { foreach ($aListProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->addValue('inherit'); $oNewRule->setIsImportant($oRule->getIsImportant()); $this->addRule($oNewRule); } $this->removeRule('list-style'); return; } foreach ($aValues as $mValue) { if (!$mValue instanceof Value) { $mValue = mb_strtolower($mValue); } if ($mValue instanceof Url) { $aListProperties['list-style-image'] = $mValue; } elseif (in_array($mValue, $aListStyleTypes)) { $aListProperties['list-style-types'] = $mValue; } elseif (in_array($mValue, $aListStylePositions)) { $aListProperties['list-style-position'] = $mValue; } } foreach ($aListProperties as $sProperty => $mValue) { $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); $oNewRule->setIsImportant($oRule->getIsImportant()); $oNewRule->addValue($mValue); $this->addRule($oNewRule); } $this->removeRule('list-style'); } /** * @param array<array-key, string> $aProperties * @param string $sShorthand * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createShorthandProperties(array $aProperties, $sShorthand) { $aRules = $this->getRulesAssoc(); $oRule = null; $aNewValues = []; foreach ($aProperties as $sProperty) { if (!isset($aRules[$sProperty])) { continue; } $oRule = $aRules[$sProperty]; if (!$oRule->getIsImportant()) { $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } foreach ($aValues as $mValue) { $aNewValues[] = $mValue; } $this->removeRule($sProperty); } } if ($aNewValues !== [] && $oRule instanceof Rule) { $oNewRule = new Rule($sShorthand, $oRule->getLineNo(), $oRule->getColNo()); foreach ($aNewValues as $mValue) { $oNewRule->addValue($mValue); } $this->addRule($oNewRule); } } /** * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createBackgroundShorthand() { $aProperties = [ 'background-color', 'background-image', 'background-repeat', 'background-position', 'background-attachment', ]; $this->createShorthandProperties($aProperties, 'background'); } /** * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createListStyleShorthand() { $aProperties = [ 'list-style-type', 'list-style-position', 'list-style-image', ]; $this->createShorthandProperties($aProperties, 'list-style'); } /** * Combines `border-color`, `border-style` and `border-width` into `border`. * * Should be run after `create_dimensions_shorthand`! * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createBorderShorthand() { $aProperties = [ 'border-width', 'border-style', 'border-color', ]; $this->createShorthandProperties($aProperties, 'border'); } /** * Looks for long format CSS dimensional properties * (margin, padding, border-color, border-style and border-width) * and converts them into shorthand CSS properties. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createDimensionsShorthand() { $aPositions = ['top', 'right', 'bottom', 'left']; $aExpansions = [ 'margin' => 'margin-%s', 'padding' => 'padding-%s', 'border-color' => 'border-%s-color', 'border-style' => 'border-%s-style', 'border-width' => 'border-%s-width', ]; $aRules = $this->getRulesAssoc(); foreach ($aExpansions as $sProperty => $sExpanded) { $aFoldable = []; foreach ($aRules as $sRuleName => $oRule) { foreach ($aPositions as $sPosition) { if ($sRuleName == sprintf($sExpanded, $sPosition)) { $aFoldable[$sRuleName] = $oRule; } } } // All four dimensions must be present if (count($aFoldable) == 4) { $aValues = []; foreach ($aPositions as $sPosition) { $oRule = $aRules[sprintf($sExpanded, $sPosition)]; $mRuleValue = $oRule->getValue(); $aRuleValues = []; if (!$mRuleValue instanceof RuleValueList) { $aRuleValues[] = $mRuleValue; } else { $aRuleValues = $mRuleValue->getListComponents(); } $aValues[$sPosition] = $aRuleValues; } $oNewRule = new Rule($sProperty, $oRule->getLineNo(), $oRule->getColNo()); if ((string)$aValues['left'][0] == (string)$aValues['right'][0]) { if ((string)$aValues['top'][0] == (string)$aValues['bottom'][0]) { if ((string)$aValues['top'][0] == (string)$aValues['left'][0]) { // All 4 sides are equal $oNewRule->addValue($aValues['top']); } else { // Top and bottom are equal, left and right are equal $oNewRule->addValue($aValues['top']); $oNewRule->addValue($aValues['left']); } } else { // Only left and right are equal $oNewRule->addValue($aValues['top']); $oNewRule->addValue($aValues['left']); $oNewRule->addValue($aValues['bottom']); } } else { // No sides are equal $oNewRule->addValue($aValues['top']); $oNewRule->addValue($aValues['left']); $oNewRule->addValue($aValues['bottom']); $oNewRule->addValue($aValues['right']); } $this->addRule($oNewRule); foreach ($aPositions as $sPosition) { $this->removeRule(sprintf($sExpanded, $sPosition)); } } } } /** * Looks for long format CSS font properties (e.g. `font-weight`) and * tries to convert them into a shorthand CSS `font` property. * * At least `font-size` AND `font-family` must be present in order to create a shorthand declaration. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createFontShorthand() { $aFontProperties = [ 'font-style', 'font-variant', 'font-weight', 'font-size', 'line-height', 'font-family', ]; $aRules = $this->getRulesAssoc(); if (!isset($aRules['font-size']) || !isset($aRules['font-family'])) { return; } $oOldRule = isset($aRules['font-size']) ? $aRules['font-size'] : $aRules['font-family']; $oNewRule = new Rule('font', $oOldRule->getLineNo(), $oOldRule->getColNo()); unset($oOldRule); foreach (['font-style', 'font-variant', 'font-weight'] as $sProperty) { if (isset($aRules[$sProperty])) { $oRule = $aRules[$sProperty]; $mRuleValue = $oRule->getValue(); $aValues = []; if (!$mRuleValue instanceof RuleValueList) { $aValues[] = $mRuleValue; } else { $aValues = $mRuleValue->getListComponents(); } if ($aValues[0] !== 'normal') { $oNewRule->addValue($aValues[0]); } } } // Get the font-size value $oRule = $aRules['font-size']; $mRuleValue = $oRule->getValue(); $aFSValues = []; if (!$mRuleValue instanceof RuleValueList) { $aFSValues[] = $mRuleValue; } else { $aFSValues = $mRuleValue->getListComponents(); } // But wait to know if we have line-height to add it if (isset($aRules['line-height'])) { $oRule = $aRules['line-height']; $mRuleValue = $oRule->getValue(); $aLHValues = []; if (!$mRuleValue instanceof RuleValueList) { $aLHValues[] = $mRuleValue; } else { $aLHValues = $mRuleValue->getListComponents(); } if ($aLHValues[0] !== 'normal') { $val = new RuleValueList('/', $this->getLineNo()); $val->addListComponent($aFSValues[0]); $val->addListComponent($aLHValues[0]); $oNewRule->addValue($val); } } else { $oNewRule->addValue($aFSValues[0]); } $oRule = $aRules['font-family']; $mRuleValue = $oRule->getValue(); $aFFValues = []; if (!$mRuleValue instanceof RuleValueList) { $aFFValues[] = $mRuleValue; } else { $aFFValues = $mRuleValue->getListComponents(); } $oFFValue = new RuleValueList(',', $this->getLineNo()); $oFFValue->setListComponents($aFFValues); $oNewRule->addValue($oFFValue); $this->addRule($oNewRule); foreach ($aFontProperties as $sProperty) { $this->removeRule($sProperty); } } /** * @return string * * @throws OutputException * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string * * @throws OutputException */ public function render($oOutputFormat) { $sResult = $oOutputFormat->comments($this); if (count($this->aSelectors) === 0) { // If all the selectors have been removed, this declaration block becomes invalid throw new OutputException( 'Attempt to print declaration block with missing selector', $this->getLineNumber() ); } $sResult .= $oOutputFormat->sBeforeDeclarationBlock; $sResult .= $oOutputFormat->implode( $oOutputFormat->spaceBeforeSelectorSeparator() . ',' . $oOutputFormat->spaceAfterSelectorSeparator(), $this->aSelectors ); $sResult .= $oOutputFormat->sAfterDeclarationBlockSelectors; $sResult .= $oOutputFormat->spaceBeforeOpeningBrace() . '{'; $sResult .= $this->renderRules($oOutputFormat); $sResult .= '}'; $sResult .= $oOutputFormat->sAfterDeclarationBlock; return $sResult; } } Sabberworm/CSS/RuleSet/AtRuleSet.php 0000777 00000003376 15252673315 0013274 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\AtRule; /** * This class represents rule sets for generic at-rules which are not covered by specific classes, i.e., not * `@import`, `@charset` or `@media`. * * A common example for this is `@font-face`. */ class AtRuleSet extends RuleSet implements AtRule { /** * @var string */ private $sType; /** * @var string */ private $sArgs; /** * @param string $sType * @param string $sArgs * @param int $iLineNo */ public function __construct($sType, $sArgs = '', $iLineNo = 0) { parent::__construct($iLineNo); $this->sType = $sType; $this->sArgs = $sArgs; } /** * @return string */ public function atRuleName() { return $this->sType; } /** * @return string */ public function atRuleArgs() { return $this->sArgs; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sResult = $oOutputFormat->comments($this); $sArgs = $this->sArgs; if ($sArgs) { $sArgs = ' ' . $sArgs; } $sResult .= "@{$this->sType}$sArgs{$oOutputFormat->spaceBeforeOpeningBrace()}{"; $sResult .= $this->renderRules($oOutputFormat); $sResult .= '}'; return $sResult; } } Sabberworm/CSS/Comment/Comment.php 0000777 00000002622 15252673315 0013036 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Renderable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Positionable; class Comment implements Positionable, Renderable { use Position; /** * @var string * * @internal since 8.8.0 */ protected $sComment; /** * @param string $sComment * @param int $iLineNo */ public function __construct($sComment = '', $iLineNo = 0) { $this->sComment = $sComment; $this->setPosition($iLineNo); } /** * @return string */ public function getComment() { return $this->sComment; } /** * @param string $sComment * * @return void */ public function setComment($sComment) { $this->sComment = $sComment; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return '/*' . $this->sComment . '*/'; } } Sabberworm/CSS/Comment/Commentable.php 0000777 00000000742 15252673315 0013663 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment; interface Commentable { /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments); /** * @return array<array-key, Comment> */ public function getComments(); /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments); } Sabberworm/CSS/OutputFormatter.php 0000777 00000014625 15252673315 0013224 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\OutputException; /** * @internal since 8.8.0 */ class OutputFormatter { /** * @var OutputFormat */ private $oFormat; public function __construct(OutputFormat $oFormat) { $this->oFormat = $oFormat; } /** * @param string $sName * @param string|null $sType * * @return string */ public function space($sName, $sType = null) { $sSpaceString = $this->oFormat->get("Space$sName"); // If $sSpaceString is an array, we have multiple values configured // depending on the type of object the space applies to if (is_array($sSpaceString)) { if ($sType !== null && isset($sSpaceString[$sType])) { $sSpaceString = $sSpaceString[$sType]; } else { $sSpaceString = reset($sSpaceString); } } return $this->prepareSpace($sSpaceString); } /** * @return string */ public function spaceAfterRuleName() { return $this->space('AfterRuleName'); } /** * @return string */ public function spaceBeforeRules() { return $this->space('BeforeRules'); } /** * @return string */ public function spaceAfterRules() { return $this->space('AfterRules'); } /** * @return string */ public function spaceBetweenRules() { return $this->space('BetweenRules'); } /** * @return string */ public function spaceBeforeBlocks() { return $this->space('BeforeBlocks'); } /** * @return string */ public function spaceAfterBlocks() { return $this->space('AfterBlocks'); } /** * @return string */ public function spaceBetweenBlocks() { return $this->space('BetweenBlocks'); } /** * @return string */ public function spaceBeforeSelectorSeparator() { return $this->space('BeforeSelectorSeparator'); } /** * @return string */ public function spaceAfterSelectorSeparator() { return $this->space('AfterSelectorSeparator'); } /** * @param string $sSeparator * * @return string */ public function spaceBeforeListArgumentSeparator($sSeparator) { $spaceForSeparator = $this->oFormat->getSpaceBeforeListArgumentSeparators(); if (isset($spaceForSeparator[$sSeparator])) { return $spaceForSeparator[$sSeparator]; } return $this->space('BeforeListArgumentSeparator', $sSeparator); } /** * @param string $sSeparator * * @return string */ public function spaceAfterListArgumentSeparator($sSeparator) { $spaceForSeparator = $this->oFormat->getSpaceAfterListArgumentSeparators(); if (isset($spaceForSeparator[$sSeparator])) { return $spaceForSeparator[$sSeparator]; } return $this->space('AfterListArgumentSeparator', $sSeparator); } /** * @return string */ public function spaceBeforeOpeningBrace() { return $this->space('BeforeOpeningBrace'); } /** * Runs the given code, either swallowing or passing exceptions, depending on the `bIgnoreExceptions` setting. * * @param string $cCode the name of the function to call * * @return string|null */ public function safely($cCode) { if ($this->oFormat->get('IgnoreExceptions')) { // If output exceptions are ignored, run the code with exception guards try { return $cCode(); } catch (OutputException $e) { return null; } // Do nothing } else { // Run the code as-is return $cCode(); } } /** * Clone of the `implode` function, but calls `render` with the current output format instead of `__toString()`. * * @param string $sSeparator * @param array<array-key, Renderable|string> $aValues * @param bool $bIncreaseLevel * * @return string */ public function implode($sSeparator, array $aValues, $bIncreaseLevel = false) { $sResult = ''; $oFormat = $this->oFormat; if ($bIncreaseLevel) { $oFormat = $oFormat->nextLevel(); } $bIsFirst = true; foreach ($aValues as $mValue) { if ($bIsFirst) { $bIsFirst = false; } else { $sResult .= $sSeparator; } if ($mValue instanceof Renderable) { $sResult .= $mValue->render($oFormat); } else { $sResult .= $mValue; } } return $sResult; } /** * @param string $sString * * @return string */ public function removeLastSemicolon($sString) { if ($this->oFormat->get('SemicolonAfterLastRule')) { return $sString; } $sString = explode(';', $sString); if (count($sString) < 2) { return $sString[0]; } $sLast = array_pop($sString); $sNextToLast = array_pop($sString); array_push($sString, $sNextToLast . $sLast); return implode(';', $sString); } /** * * @param array<Commentable> $aComments * * @return string */ public function comments(Commentable $oCommentable) { if (!$this->oFormat->bRenderComments) { return ''; } $sResult = ''; $aComments = $oCommentable->getComments(); $iLastCommentIndex = count($aComments) - 1; foreach ($aComments as $i => $oComment) { $sResult .= $oComment->render($this->oFormat); $sResult .= $i === $iLastCommentIndex ? $this->spaceAfterBlocks() : $this->spaceBetweenBlocks(); } return $sResult; } /** * @param string $sSpaceString * * @return string */ private function prepareSpace($sSpaceString) { return str_replace("\n", "\n" . $this->indent(), $sSpaceString); } /** * @return string */ private function indent() { return str_repeat($this->oFormat->sIndentation, $this->oFormat->getIndentationLevel()); } } Sabberworm/CSS/CSSList/Document.php 0000777 00000010454 15252673315 0013076 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\DeclarationBlock; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\RuleSet; /** * This class represents the root of a parsed CSS file. It contains all top-level CSS contents: mostly declaration * blocks, but also any at-rules encountered (`Import` and `Charset`). */ class Document extends CSSBlockList { /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); } /** * @return Document * * @throws SourceException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState) { $oDocument = new Document($oParserState->currentLine()); CSSList::parseList($oParserState, $oDocument); return $oDocument; } /** * Gets all `DeclarationBlock` objects recursively, no matter how deeply nested the selectors are. * Aliased as `getAllSelectors()`. * * @return array<int, DeclarationBlock> */ public function getAllDeclarationBlocks() { /** @var array<int, DeclarationBlock> $aResult */ $aResult = []; $this->allDeclarationBlocks($aResult); return $aResult; } /** * Gets all `DeclarationBlock` objects recursively. * * @return array<int, DeclarationBlock> * * @deprecated will be removed in version 9.0; use `getAllDeclarationBlocks()` instead */ public function getAllSelectors() { return $this->getAllDeclarationBlocks(); } /** * Returns all `RuleSet` objects recursively found in the tree, no matter how deeply nested the rule sets are. * * @return array<int, RuleSet> */ public function getAllRuleSets() { /** @var array<int, RuleSet> $aResult */ $aResult = []; $this->allRuleSets($aResult); return $aResult; } /** * Returns all `Selector` objects with the requested specificity found recursively in the tree. * * Note that this does not yield the full `DeclarationBlock` that the selector belongs to * (and, currently, there is no way to get to that). * * @param string|null $sSpecificitySearch * An optional filter by specificity. * May contain a comparison operator and a number or just a number (defaults to "=="). * * @return array<int, Selector> * @example `getSelectorsBySpecificity('>= 100')` * */ public function getSelectorsBySpecificity($sSpecificitySearch = null) { /** @var array<int, Selector> $aResult */ $aResult = []; $this->allSelectors($aResult, $sSpecificitySearch); return $aResult; } /** * Expands all shorthand properties to their long value. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function expandShorthands() { foreach ($this->getAllDeclarationBlocks() as $oDeclaration) { $oDeclaration->expandShorthands(); } } /** * Create shorthands properties whenever possible. * * @return void * * @deprecated since 8.7.0, will be removed without substitution in version 9.0 in #511 */ public function createShorthands() { foreach ($this->getAllDeclarationBlocks() as $oDeclaration) { $oDeclaration->createShorthands(); } } /** * Overrides `render()` to make format argument optional. * * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat = null) { if ($oOutputFormat === null) { $oOutputFormat = new OutputFormat(); } return $oOutputFormat->comments($this) . $this->renderListContents($oOutputFormat); } /** * @return bool */ public function isRootList() { return true; } } Sabberworm/CSS/CSSList/AtRuleBlockList.php 0000777 00000003623 15252673315 0014323 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\AtRule; /** * A `BlockList` constructed by an unknown at-rule. `@media` rules are rendered into `AtRuleBlockList` objects. */ class AtRuleBlockList extends CSSBlockList implements AtRule { /** * @var string */ private $sType; /** * @var string */ private $sArgs; /** * @param string $sType * @param string $sArgs * @param int $iLineNo */ public function __construct($sType, $sArgs = '', $iLineNo = 0) { parent::__construct($iLineNo); $this->sType = $sType; $this->sArgs = $sArgs; } /** * @return string */ public function atRuleName() { return $this->sType; } /** * @return string */ public function atRuleArgs() { return $this->sArgs; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sResult = $oOutputFormat->comments($this); $sResult .= $oOutputFormat->sBeforeAtRuleBlock; $sArgs = $this->sArgs; if ($sArgs) { $sArgs = ' ' . $sArgs; } $sResult .= "@{$this->sType}$sArgs{$oOutputFormat->spaceBeforeOpeningBrace()}{"; $sResult .= $this->renderListContents($oOutputFormat); $sResult .= '}'; $sResult .= $oOutputFormat->sAfterAtRuleBlock; return $sResult; } /** * @return bool */ public function isRootList() { return false; } } Sabberworm/CSS/CSSList/CSSBlockList.php 0000777 00000017013 15252673315 0013555 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Rule\Rule; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\DeclarationBlock; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\RuleSet; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\CSSFunction; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\Value; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\ValueList; /** * A `CSSBlockList` is a `CSSList` whose `DeclarationBlock`s are guaranteed to contain valid declaration blocks or * at-rules. * * Most `CSSList`s conform to this category but some at-rules (such as `@keyframes`) do not. */ abstract class CSSBlockList extends CSSList { /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); } /** * @param array<int, DeclarationBlock> $aResult * * @return void */ protected function allDeclarationBlocks(array &$aResult) { foreach ($this->aContents as $mContent) { if ($mContent instanceof DeclarationBlock) { $aResult[] = $mContent; } elseif ($mContent instanceof CSSBlockList) { $mContent->allDeclarationBlocks($aResult); } } } /** * @param array<int, RuleSet> $aResult * * @return void */ protected function allRuleSets(array &$aResult) { foreach ($this->aContents as $mContent) { if ($mContent instanceof RuleSet) { $aResult[] = $mContent; } elseif ($mContent instanceof CSSBlockList) { $mContent->allRuleSets($aResult); } } } /** * Returns all `Value` objects found recursively in `Rule`s in the tree. * * @param CSSElement|string|null $element * This is the `CSSList` or `RuleSet` to start the search from (defaults to the whole document). * If a string is given, it is used as a rule name filter. * Passing a string for this parameter is deprecated in version 8.9.0, and will not work from v9.0; * use the following parameter to pass a rule name filter instead. * @param string|bool|null $ruleSearchPatternOrSearchInFunctionArguments * This allows filtering rules by property name * (e.g. if "color" is passed, only `Value`s from `color` properties will be returned, * or if "font-" is provided, `Value`s from all font rules, like `font-size`, and including `font` itself, * will be returned). * If a Boolean is provided, it is treated as the `$searchInFunctionArguments` argument. * Passing a Boolean for this parameter is deprecated in version 8.9.0, and will not work from v9.0; * use the `$searchInFunctionArguments` parameter instead. * @param bool $searchInFunctionArguments whether to also return Value objects used as Function arguments. * * @return array<int, Value> * * @see RuleSet->getRules() */ public function getAllValues( $element = null, $ruleSearchPatternOrSearchInFunctionArguments = null, $searchInFunctionArguments = false ) { if (\is_bool($ruleSearchPatternOrSearchInFunctionArguments)) { $searchInFunctionArguments = $ruleSearchPatternOrSearchInFunctionArguments; $searchString = null; } else { $searchString = $ruleSearchPatternOrSearchInFunctionArguments; } if ($element === null) { $element = $this; } elseif (\is_string($element)) { $searchString = $element; $element = $this; } $result = []; $this->allValues($element, $result, $searchString, $searchInFunctionArguments); return $result; } /** * @param CSSElement|string $oElement * @param array<int, Value> $aResult * @param string|null $sSearchString * @param bool $bSearchInFunctionArguments * * @return void */ protected function allValues($oElement, array &$aResult, $sSearchString = null, $bSearchInFunctionArguments = false) { if ($oElement instanceof CSSBlockList) { foreach ($oElement->getContents() as $oContent) { $this->allValues($oContent, $aResult, $sSearchString, $bSearchInFunctionArguments); } } elseif ($oElement instanceof RuleSet) { foreach ($oElement->getRules($sSearchString) as $oRule) { $this->allValues($oRule, $aResult, $sSearchString, $bSearchInFunctionArguments); } } elseif ($oElement instanceof Rule) { $this->allValues($oElement->getValue(), $aResult, $sSearchString, $bSearchInFunctionArguments); } elseif ($oElement instanceof ValueList) { if ($bSearchInFunctionArguments || !($oElement instanceof CSSFunction)) { foreach ($oElement->getListComponents() as $mComponent) { $this->allValues($mComponent, $aResult, $sSearchString, $bSearchInFunctionArguments); } } } else { // Non-List `Value` or `CSSString` (CSS identifier) $aResult[] = $oElement; } } /** * @param array<int, Selector> $aResult * @param string|null $sSpecificitySearch * * @return void */ protected function allSelectors(array &$aResult, $sSpecificitySearch = null) { /** @var array<int, DeclarationBlock> $aDeclarationBlocks */ $aDeclarationBlocks = []; $this->allDeclarationBlocks($aDeclarationBlocks); foreach ($aDeclarationBlocks as $oBlock) { foreach ($oBlock->getSelectors() as $oSelector) { if ($sSpecificitySearch === null) { $aResult[] = $oSelector; } else { $sComparator = '==='; $aSpecificitySearch = explode(' ', $sSpecificitySearch); $iTargetSpecificity = $aSpecificitySearch[0]; if (count($aSpecificitySearch) > 1) { $sComparator = $aSpecificitySearch[0]; $iTargetSpecificity = $aSpecificitySearch[1]; } $iTargetSpecificity = (int)$iTargetSpecificity; $iSelectorSpecificity = $oSelector->getSpecificity(); $bMatches = false; switch ($sComparator) { case '<=': $bMatches = $iSelectorSpecificity <= $iTargetSpecificity; break; case '<': $bMatches = $iSelectorSpecificity < $iTargetSpecificity; break; case '>=': $bMatches = $iSelectorSpecificity >= $iTargetSpecificity; break; case '>': $bMatches = $iSelectorSpecificity > $iTargetSpecificity; break; default: $bMatches = $iSelectorSpecificity === $iTargetSpecificity; break; } if ($bMatches) { $aResult[] = $oSelector; } } } } } } Sabberworm/CSS/CSSList/CSSList.php 0000777 00000041153 15252673315 0012604 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\SourceException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\AtRule; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\Charset; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\CSSNamespace; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\Import; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\Selector; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Renderable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\AtRuleSet; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\DeclarationBlock; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\RuleSet\RuleSet; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Settings; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\CSSString; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\URL; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\Value; /** * This is the most generic container available. It can contain `DeclarationBlock`s (rule sets with a selector), * `RuleSet`s as well as other `CSSList` objects. * * It can also contain `Import` and `Charset` objects stemming from at-rules. */ abstract class CSSList implements Commentable, CSSElement, Positionable { use Position; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @var array<int, RuleSet|CSSList|Import|Charset> * * @internal since 8.8.0 */ protected $aContents; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { $this->aComments = []; $this->aContents = []; $this->setPosition($iLineNo); } /** * @return void * * @throws UnexpectedTokenException * @throws SourceException * * @internal since V8.8.0 */ public static function parseList(ParserState $oParserState, CSSList $oList) { $bIsRoot = $oList instanceof Document; if (is_string($oParserState)) { $oParserState = new ParserState($oParserState, Settings::create()); } $bLenientParsing = $oParserState->getSettings()->bLenientParsing; $aComments = []; while (!$oParserState->isEnd()) { $aComments = array_merge($aComments, $oParserState->consumeWhiteSpace()); $oListItem = null; if ($bLenientParsing) { try { $oListItem = self::parseListItem($oParserState, $oList); } catch (UnexpectedTokenException $e) { $oListItem = false; } } else { $oListItem = self::parseListItem($oParserState, $oList); } if ($oListItem === null) { // List parsing finished return; } if ($oListItem) { $oListItem->addComments($aComments); $oList->append($oListItem); } $aComments = $oParserState->consumeWhiteSpace(); } $oList->addComments($aComments); if (!$bIsRoot && !$bLenientParsing) { throw new SourceException("Unexpected end of document", $oParserState->currentLine()); } } /** * @return AtRuleBlockList|KeyFrame|Charset|CSSNamespace|Import|AtRuleSet|DeclarationBlock|null|false * * @throws SourceException * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ private static function parseListItem(ParserState $oParserState, CSSList $oList) { $bIsRoot = $oList instanceof Document; if ($oParserState->comes('@')) { $oAtRule = self::parseAtRule($oParserState); if ($oAtRule instanceof Charset) { if (!$bIsRoot) { throw new UnexpectedTokenException( '@charset may only occur in root document', '', 'custom', $oParserState->currentLine() ); } if (count($oList->getContents()) > 0) { throw new UnexpectedTokenException( '@charset must be the first parseable token in a document', '', 'custom', $oParserState->currentLine() ); } $oParserState->setCharset($oAtRule->getCharset()); } return $oAtRule; } elseif ($oParserState->comes('}')) { if ($bIsRoot) { if ($oParserState->getSettings()->bLenientParsing) { return DeclarationBlock::parse($oParserState); } else { throw new SourceException("Unopened {", $oParserState->currentLine()); } } else { // End of list return null; } } else { return DeclarationBlock::parse($oParserState, $oList); } } /** * @param ParserState $oParserState * * @return AtRuleBlockList|KeyFrame|Charset|CSSNamespace|Import|AtRuleSet|null * * @throws SourceException * @throws UnexpectedTokenException * @throws UnexpectedEOFException */ private static function parseAtRule(ParserState $oParserState) { $oParserState->consume('@'); $sIdentifier = $oParserState->parseIdentifier(); $iIdentifierLineNum = $oParserState->currentLine(); $oParserState->consumeWhiteSpace(); if ($sIdentifier === 'import') { $oLocation = URL::parse($oParserState); $oParserState->consumeWhiteSpace(); $sMediaQuery = null; if (!$oParserState->comes(';')) { $sMediaQuery = trim($oParserState->consumeUntil([';', ParserState::EOF])); } $oParserState->consumeUntil([';', ParserState::EOF], true, true); return new Import($oLocation, $sMediaQuery ?: null, $iIdentifierLineNum); } elseif ($sIdentifier === 'charset') { $oCharsetString = CSSString::parse($oParserState); $oParserState->consumeWhiteSpace(); $oParserState->consumeUntil([';', ParserState::EOF], true, true); return new Charset($oCharsetString, $iIdentifierLineNum); } elseif (self::identifierIs($sIdentifier, 'keyframes')) { $oResult = new KeyFrame($iIdentifierLineNum); $oResult->setVendorKeyFrame($sIdentifier); $oResult->setAnimationName(trim($oParserState->consumeUntil('{', false, true))); CSSList::parseList($oParserState, $oResult); if ($oParserState->comes('}')) { $oParserState->consume('}'); } return $oResult; } elseif ($sIdentifier === 'namespace') { $sPrefix = null; $mUrl = Value::parsePrimitiveValue($oParserState); if (!$oParserState->comes(';')) { $sPrefix = $mUrl; $mUrl = Value::parsePrimitiveValue($oParserState); } $oParserState->consumeUntil([';', ParserState::EOF], true, true); if ($sPrefix !== null && !is_string($sPrefix)) { throw new UnexpectedTokenException('Wrong namespace prefix', $sPrefix, 'custom', $iIdentifierLineNum); } if (!($mUrl instanceof CSSString || $mUrl instanceof URL)) { throw new UnexpectedTokenException( 'Wrong namespace url of invalid type', $mUrl, 'custom', $iIdentifierLineNum ); } return new CSSNamespace($mUrl, $sPrefix, $iIdentifierLineNum); } else { // Unknown other at rule (font-face or such) $sArgs = trim($oParserState->consumeUntil('{', false, true)); if (substr_count($sArgs, "(") != substr_count($sArgs, ")")) { if ($oParserState->getSettings()->bLenientParsing) { return null; } else { throw new SourceException("Unmatched brace count in media query", $oParserState->currentLine()); } } $bUseRuleSet = true; foreach (explode('/', AtRule::BLOCK_RULES) as $sBlockRuleName) { if (self::identifierIs($sIdentifier, $sBlockRuleName)) { $bUseRuleSet = false; break; } } if ($bUseRuleSet) { $oAtRule = new AtRuleSet($sIdentifier, $sArgs, $iIdentifierLineNum); RuleSet::parseRuleSet($oParserState, $oAtRule); } else { $oAtRule = new AtRuleBlockList($sIdentifier, $sArgs, $iIdentifierLineNum); CSSList::parseList($oParserState, $oAtRule); if ($oParserState->comes('}')) { $oParserState->consume('}'); } } return $oAtRule; } } /** * Tests an identifier for a given value. Since identifiers are all keywords, they can be vendor-prefixed. * We need to check for these versions too. * * @param string $sIdentifier * @param string $sMatch * * @return bool */ private static function identifierIs($sIdentifier, $sMatch) { return (strcasecmp($sIdentifier, $sMatch) === 0) ?: preg_match("/^(-\\w+-)?$sMatch$/i", $sIdentifier) === 1; } /** * Prepends an item to the list of contents. * * @param RuleSet|CSSList|Import|Charset $oItem * * @return void */ public function prepend($oItem) { array_unshift($this->aContents, $oItem); } /** * Appends an item to the list of contents. * * @param RuleSet|CSSList|Import|Charset $oItem * * @return void */ public function append($oItem) { $this->aContents[] = $oItem; } /** * Splices the list of contents. * * @param int $iOffset * @param int $iLength * @param array<int, RuleSet|CSSList|Import|Charset> $mReplacement * * @return void */ public function splice($iOffset, $iLength = null, $mReplacement = null) { array_splice($this->aContents, $iOffset, $iLength, $mReplacement); } /** * Inserts an item in the CSS list before its sibling. If the desired sibling cannot be found, * the item is appended at the end. * * @param RuleSet|CSSList|Import|Charset $item * @param RuleSet|CSSList|Import|Charset $sibling */ public function insertBefore($item, $sibling) { if (in_array($sibling, $this->aContents, true)) { $this->replace($sibling, [$item, $sibling]); } else { $this->append($item); } } /** * Removes an item from the CSS list. * * @param RuleSet|Import|Charset|CSSList $oItemToRemove * May be a RuleSet (most likely a DeclarationBlock), a Import, * a Charset or another CSSList (most likely a MediaQuery) * * @return bool whether the item was removed */ public function remove($oItemToRemove) { $iKey = array_search($oItemToRemove, $this->aContents, true); if ($iKey !== false) { unset($this->aContents[$iKey]); return true; } return false; } /** * Replaces an item from the CSS list. * * @param RuleSet|Import|Charset|CSSList $oOldItem * May be a `RuleSet` (most likely a `DeclarationBlock`), an `Import`, a `Charset` * or another `CSSList` (most likely a `MediaQuery`) * * @return bool */ public function replace($oOldItem, $mNewItem) { $iKey = array_search($oOldItem, $this->aContents, true); if ($iKey !== false) { if (is_array($mNewItem)) { array_splice($this->aContents, $iKey, 1, $mNewItem); } else { array_splice($this->aContents, $iKey, 1, [$mNewItem]); } return true; } return false; } /** * @param array<int, RuleSet|Import|Charset|CSSList> $aContents */ public function setContents(array $aContents) { $this->aContents = []; foreach ($aContents as $content) { $this->append($content); } } /** * Removes a declaration block from the CSS list if it matches all given selectors. * * @param DeclarationBlock|array<array-key, Selector>|string $mSelector the selectors to match * @param bool $bRemoveAll whether to stop at the first declaration block found or remove all blocks * * @return void */ public function removeDeclarationBlockBySelector($mSelector, $bRemoveAll = false) { if ($mSelector instanceof DeclarationBlock) { $mSelector = $mSelector->getSelectors(); } if (!is_array($mSelector)) { $mSelector = explode(',', $mSelector); } foreach ($mSelector as $iKey => &$mSel) { if (!($mSel instanceof Selector)) { if (!Selector::isValid($mSel)) { throw new UnexpectedTokenException( "Selector did not match '" . Selector::SELECTOR_VALIDATION_RX . "'.", $mSel, "custom" ); } $mSel = new Selector($mSel); } } foreach ($this->aContents as $iKey => $mItem) { if (!($mItem instanceof DeclarationBlock)) { continue; } if ($mItem->getSelectors() == $mSelector) { unset($this->aContents[$iKey]); if (!$bRemoveAll) { return; } } } } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @return string */ protected function renderListContents(OutputFormat $oOutputFormat) { $sResult = ''; $bIsFirst = true; $oNextLevel = $oOutputFormat; if (!$this->isRootList()) { $oNextLevel = $oOutputFormat->nextLevel(); } foreach ($this->aContents as $oContent) { $sRendered = $oOutputFormat->safely(function () use ($oNextLevel, $oContent) { return $oContent->render($oNextLevel); }); if ($sRendered === null) { continue; } if ($bIsFirst) { $bIsFirst = false; $sResult .= $oNextLevel->spaceBeforeBlocks(); } else { $sResult .= $oNextLevel->spaceBetweenBlocks(); } $sResult .= $sRendered; } if (!$bIsFirst) { // Had some output $sResult .= $oOutputFormat->spaceAfterBlocks(); } return $sResult; } /** * Return true if the list can not be further outdented. Only important when rendering. * * @return bool */ abstract public function isRootList(); /** * Returns the stored items. * * @return array<int, RuleSet|Import|Charset|CSSList> */ public function getContents() { return $this->aContents; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } Sabberworm/CSS/CSSList/KeyFrame.php 0000777 00000004247 15252673315 0013026 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property\AtRule; class KeyFrame extends CSSList implements AtRule { /** * @var string|null */ private $vendorKeyFrame; /** * @var string|null */ private $animationName; /** * @param int $iLineNo */ public function __construct($iLineNo = 0) { parent::__construct($iLineNo); $this->vendorKeyFrame = null; $this->animationName = null; } /** * @param string $vendorKeyFrame */ public function setVendorKeyFrame($vendorKeyFrame) { $this->vendorKeyFrame = $vendorKeyFrame; } /** * @return string|null */ public function getVendorKeyFrame() { return $this->vendorKeyFrame; } /** * @param string $animationName */ public function setAnimationName($animationName) { $this->animationName = $animationName; } /** * @return string|null */ public function getAnimationName() { return $this->animationName; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sResult = $oOutputFormat->comments($this); $sResult .= "@{$this->vendorKeyFrame} {$this->animationName}{$oOutputFormat->spaceBeforeOpeningBrace()}{"; $sResult .= $this->renderListContents($oOutputFormat); $sResult .= '}'; return $sResult; } /** * @return bool */ public function isRootList() { return false; } /** * @return string|null */ public function atRuleName() { return $this->vendorKeyFrame; } /** * @return string|null */ public function atRuleArgs() { return $this->animationName; } } Sabberworm/CSS/Parser.php 0000777 00000003650 15252673315 0011270 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSList\Document; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\SourceException; /** * This class parses CSS from text into a data structure. */ class Parser { /** * @var ParserState */ private $oParserState; /** * @param string $sText the complete CSS as text (i.e., usually the contents of a CSS file) * @param Settings|null $oParserSettings * @param int $iLineNo the line number (starting from 1, not from 0) */ public function __construct($sText, $oParserSettings = null, $iLineNo = 1) { if ($oParserSettings === null) { $oParserSettings = Settings::create(); } $this->oParserState = new ParserState($sText, $oParserSettings, $iLineNo); } /** * Sets the charset to be used if the CSS does not contain an `@charset` declaration. * * @param string $sCharset * * @return void * * @deprecated since 8.7.0, will be removed in version 9.0.0 with #687 */ public function setCharset($sCharset) { $this->oParserState->setCharset($sCharset); } /** * Returns the charset that is used if the CSS does not contain an `@charset` declaration. * * @return void * * @deprecated since 8.7.0, will be removed in version 9.0.0 with #687 */ public function getCharset() { // Note: The `return` statement is missing here. This is a bug that needs to be fixed. $this->oParserState->getCharset(); } /** * Parses the CSS provided to the constructor and creates a `Document` from it. * * @return Document * * @throws SourceException */ public function parse() { return Document::parse($this->oParserState); } } Sabberworm/CSS/Position/Positionable.php 0000777 00000002312 15252673315 0014262 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position; /** * Represents a CSS item that may have a position in the source CSS document (line number and possibly column number). * * A standard implementation of this interface is available in the `Position` trait. */ interface Positionable { /** * @return int<1, max>|null */ public function getLineNumber(); /** * @return int<0, max> * * @deprecated in version 8.9.0, will be removed in v9.0. Use `getLineNumber()` instead. */ public function getLineNo(); /** * @return int<0, max>|null */ public function getColumnNumber(); /** * @return int<0, max> * * @deprecated in version 8.9.0, will be removed in v9.0. Use `getColumnNumber()` instead. */ public function getColNo(); /** * @param int<0, max>|null $lineNumber * Providing zero for this parameter is deprecated in version 8.9.0, and will not be supported from v9.0. * Use `null` instead when no line number is available. * @param int<0, max>|null $columnNumber */ public function setPosition($lineNumber, $columnNumber = null); } Sabberworm/CSS/Position/Position.php 0000777 00000002663 15252673315 0013447 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position; /** * Provides a standard reusable implementation of `Positionable`. * * @internal * * @phpstan-require-implements Positionable */ trait Position { /** * @var int<1, max>|null */ protected $lineNumber; /** * @var int<0, max>|null */ protected $columnNumber; /** * @return int<1, max>|null */ public function getLineNumber() { return $this->lineNumber; } /** * @return int<0, max> */ public function getLineNo() { $lineNumber = $this->getLineNumber(); return $lineNumber !== null ? $lineNumber : 0; } /** * @return int<0, max>|null */ public function getColumnNumber() { return $this->columnNumber; } /** * @return int<0, max> */ public function getColNo() { $columnNumber = $this->getColumnNumber(); return $columnNumber !== null ? $columnNumber : 0; } /** * @param int<0, max>|null $lineNumber * @param int<0, max>|null $columnNumber */ public function setPosition($lineNumber, $columnNumber = null) { // The conditional is for backwards compatibility (backcompat); `0` will not be allowed in future. $this->lineNumber = $lineNumber !== 0 ? $lineNumber : null; $this->columnNumber = $columnNumber; } } Sabberworm/CSS/Renderable.php 0000777 00000000705 15252673315 0012075 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS; interface Renderable { /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString(); /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat); /** * @return int */ public function getLineNo(); } Sabberworm/CSS/CSSElement.php 0000777 00000001050 15252673315 0011766 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS; /** * Represents any entity in the CSS that is encapsulated by a class. * * Its primary purpose is to provide a type for use with `Document::getAllValues()` * when a subset of values from a particular part of the document is required. * * Thus, elements which don't contain `Value`s (such as statement at-rules) don't need to implement this. * * It extends `Renderable` because every element is renderable. */ interface CSSElement extends Renderable {} Sabberworm/CSS/OutputFormat.php 0000777 00000026412 15252673315 0012506 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS; /** * Extending this class is deprecated in version 8.8.0; it will be made `final` in version 9.0.0. * * @method OutputFormat setSemicolonAfterLastRule(bool $bSemicolonAfterLastRule) Set whether semicolons are added after * last rule. */ class OutputFormat { /** * Value format: `"` means double-quote, `'` means single-quote * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sStringQuotingType = '"'; /** * Output RGB colors in hash notation if possible * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bRGBHashNotation = true; /** * Declaration format * * Semicolon after the last rule of a declaration block can be omitted. To do that, set this false. * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bSemicolonAfterLastRule = true; /** * Spacing * Note that these strings are not sanity-checked: the value should only consist of whitespace * Any newline character will be indented according to the current level. * The triples (After, Before, Between) can be set using a wildcard (e.g. `$oFormat->set('Space*Rules', "\n");`) * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterRuleName = ' '; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeRules = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterRules = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBetweenRules = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeBlocks = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterBlocks = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBetweenBlocks = "\n"; /** * Content injected in and around at-rule blocks. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sBeforeAtRuleBlock = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sAfterAtRuleBlock = ''; /** * This is what’s printed before and after the comma if a declaration block contains multiple selectors. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeSelectorSeparator = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterSelectorSeparator = ' '; /** * This is what’s inserted before the separator in value lists, by default. * * `array` is deprecated in version 8.8.0, and will be removed in version 9.0.0. * To set the spacing for specific separators, use {@see $aSpaceBeforeListArgumentSeparators} instead. * * @var string|array<non-empty-string, string> * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeListArgumentSeparator = ''; /** * Keys are separators (e.g. `,`). Values are the space sequence to insert, or an empty string. * * @var array<non-empty-string, string> * * @internal since 8.8.0, will be made private in 9.0.0 */ public $aSpaceBeforeListArgumentSeparators = []; /** * This is what’s inserted after the separator in value lists, by default. * * `array` is deprecated in version 8.8.0, and will be removed in version 9.0.0. * To set the spacing for specific separators, use {@see $aSpaceAfterListArgumentSeparators} instead. * * @var string|array<non-empty-string, string> * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceAfterListArgumentSeparator = ''; /** * Keys are separators (e.g. `,`). Values are the space sequence to insert, or an empty string. * * @var array<non-empty-string, string> * * @internal since 8.8.0, will be made private in 9.0.0 */ public $aSpaceAfterListArgumentSeparators = []; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sSpaceBeforeOpeningBrace = ' '; /** * Content injected in and around declaration blocks. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sBeforeDeclarationBlock = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sAfterDeclarationBlockSelectors = ''; /** * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sAfterDeclarationBlock = ''; /** * Indentation character(s) per level. Only applicable if newlines are used in any of the spacing settings. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sIndentation = "\t"; /** * Output exceptions. * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bIgnoreExceptions = false; /** * Render comments for lists and RuleSets * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bRenderComments = false; /** * @var OutputFormatter|null */ private $oFormatter = null; /** * @var OutputFormat|null */ private $oNextLevelFormat = null; /** * @var int */ private $iIndentationLevel = 0; /** * @internal since V8.8.0. Use the factory methods `create()`, `createCompact()`, or `createPretty()` instead. */ public function __construct() { } /** * @param string $sName * * @return string|null * * @deprecated since 8.8.0, will be removed in 9.0.0. Use specific getters instead. */ public function get($sName) { $aVarPrefixes = ['a', 's', 'm', 'b', 'f', 'o', 'c', 'i']; foreach ($aVarPrefixes as $sPrefix) { $sFieldName = $sPrefix . ucfirst($sName); if (isset($this->$sFieldName)) { return $this->$sFieldName; } } return null; } /** * @param array<array-key, string>|string $aNames * @param mixed $mValue * * @return self|false * * @deprecated since 8.8.0, will be removed in 9.0.0. Use specific setters instead. */ public function set($aNames, $mValue) { $aVarPrefixes = ['a', 's', 'm', 'b', 'f', 'o', 'c', 'i']; if (is_string($aNames) && strpos($aNames, '*') !== false) { $aNames = [ str_replace('*', 'Before', $aNames), str_replace('*', 'Between', $aNames), str_replace('*', 'After', $aNames), ]; } elseif (!is_array($aNames)) { $aNames = [$aNames]; } foreach ($aVarPrefixes as $sPrefix) { $bDidReplace = false; foreach ($aNames as $sName) { $sFieldName = $sPrefix . ucfirst($sName); if (isset($this->$sFieldName)) { $this->$sFieldName = $mValue; $bDidReplace = true; } } if ($bDidReplace) { return $this; } } // Break the chain so the user knows this option is invalid return false; } /** * @param string $sMethodName * @param array<array-key, mixed> $aArguments * * @return mixed * * @throws \Exception */ public function __call($sMethodName, array $aArguments) { if (strpos($sMethodName, 'set') === 0) { return $this->set(substr($sMethodName, 3), $aArguments[0]); } elseif (strpos($sMethodName, 'get') === 0) { return $this->get(substr($sMethodName, 3)); } elseif (method_exists(OutputFormatter::class, $sMethodName)) { // @deprecated since 8.8.0, will be removed in 9.0.0. Call the method on the formatter directly instead. return call_user_func_array([$this->getFormatter(), $sMethodName], $aArguments); } else { throw new \Exception('Unknown OutputFormat method called: ' . $sMethodName); } } /** * @param int $iNumber * * @return self */ public function indentWithTabs($iNumber = 1) { return $this->setIndentation(str_repeat("\t", $iNumber)); } /** * @param int $iNumber * * @return self */ public function indentWithSpaces($iNumber = 2) { return $this->setIndentation(str_repeat(" ", $iNumber)); } /** * @return OutputFormat * * @internal since V8.8.0 */ public function nextLevel() { if ($this->oNextLevelFormat === null) { $this->oNextLevelFormat = clone $this; $this->oNextLevelFormat->iIndentationLevel++; $this->oNextLevelFormat->oFormatter = null; } return $this->oNextLevelFormat; } /** * @return void */ public function beLenient() { $this->bIgnoreExceptions = true; } /** * @return OutputFormatter * * @internal since 8.8.0 */ public function getFormatter() { if ($this->oFormatter === null) { $this->oFormatter = new OutputFormatter($this); } return $this->oFormatter; } /** * @return int * * @deprecated #869 since version V8.8.0, will be removed in V9.0.0. Use `getIndentationLevel()` instead. */ public function level() { return $this->iIndentationLevel; } /** * Creates an instance of this class without any particular formatting settings. * * @return self */ public static function create() { return new OutputFormat(); } /** * Creates an instance of this class with a preset for compact formatting. * * @return self */ public static function createCompact() { $format = self::create(); $format->set('Space*Rules', "") ->set('Space*Blocks', "") ->setSpaceAfterRuleName('') ->setSpaceBeforeOpeningBrace('') ->setSpaceAfterSelectorSeparator('') ->setRenderComments(false); return $format; } /** * Creates an instance of this class with a preset for pretty formatting. * * @return self */ public static function createPretty() { $format = self::create(); $format->set('Space*Rules', "\n") ->set('Space*Blocks', "\n") ->setSpaceBetweenBlocks("\n\n") ->set('SpaceAfterListArgumentSeparators', [',' => ' ']) ->setRenderComments(true); return $format; } } Sabberworm/CSS/Parsing/UnexpectedEOFException.php 0000777 00000000457 15252673315 0015756 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing; /** * Thrown if the CSS parser encounters end of file it did not expect. * * Extends `UnexpectedTokenException` in order to preserve backwards compatibility. */ class UnexpectedEOFException extends UnexpectedTokenException { } Sabberworm/CSS/Parsing/UnexpectedTokenException.php 0000777 00000002742 15252673315 0016424 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing; /** * Thrown if the CSS parser encounters a token it did not expect. */ class UnexpectedTokenException extends SourceException { /** * @var string */ private $sExpected; /** * @var string */ private $sFound; /** * Possible values: literal, identifier, count, expression, search * * @var string */ private $sMatchType; /** * @param string $sExpected * @param string $sFound * @param string $sMatchType * @param int $iLineNo */ public function __construct($sExpected, $sFound, $sMatchType = 'literal', $iLineNo = 0) { $this->sExpected = $sExpected; $this->sFound = $sFound; $this->sMatchType = $sMatchType; $sMessage = "Token “{$sExpected}” ({$sMatchType}) not found. Got “{$sFound}”."; if ($this->sMatchType === 'search') { $sMessage = "Search for “{$sExpected}” returned no results. Context: “{$sFound}”."; } elseif ($this->sMatchType === 'count') { $sMessage = "Next token was expected to have {$sExpected} chars. Context: “{$sFound}”."; } elseif ($this->sMatchType === 'identifier') { $sMessage = "Identifier expected. Got “{$sFound}”"; } elseif ($this->sMatchType === 'custom') { $sMessage = trim("$sExpected $sFound"); } parent::__construct($sMessage, $iLineNo); } } Sabberworm/CSS/Parsing/ParserState.php 0000777 00000034341 15252673315 0013675 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Settings; /** * @internal since 8.7.0 */ class ParserState { /** * @var null * * @internal since 8.5.2 */ const EOF = null; /** * @var Settings */ private $oParserSettings; /** * @var string */ private $sText; /** * @var array<int, string> */ private $aText; /** * @var int */ private $iCurrentPosition; /** * will only be used if the CSS does not contain an `@charset` declaration * * @var string */ private $sCharset; /** * @var int */ private $iLength; /** * @var int */ private $iLineNo; /** * @param string $sText the complete CSS as text (i.e., usually the contents of a CSS file) * @param int $iLineNo */ public function __construct($sText, Settings $oParserSettings, $iLineNo = 1) { $this->oParserSettings = $oParserSettings; $this->sText = $sText; $this->iCurrentPosition = 0; $this->iLineNo = $iLineNo; $this->setCharset($this->oParserSettings->sDefaultCharset); } /** * Sets the charset to be used if the CSS does not contain an `@charset` declaration. * * @param string $sCharset * * @return void */ public function setCharset($sCharset) { $this->sCharset = $sCharset; $this->aText = $this->strsplit($this->sText); if (is_array($this->aText)) { $this->iLength = count($this->aText); } } /** * Returns the charset that is used if the CSS does not contain an `@charset` declaration. * * @return string */ public function getCharset() { return $this->sCharset; } /** * @return int */ public function currentLine() { return $this->iLineNo; } /** * @return int */ public function currentColumn() { return $this->iCurrentPosition; } /** * @return Settings */ public function getSettings() { return $this->oParserSettings; } /** * @return \Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\Anchor */ public function anchor() { return new Anchor($this->iCurrentPosition, $this); } /** * @param int $iPosition * * @return void */ public function setPosition($iPosition) { $this->iCurrentPosition = $iPosition; } /** * @param bool $bIgnoreCase * * @return string * * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public function parseIdentifier($bIgnoreCase = true) { if ($this->isEnd()) { throw new UnexpectedEOFException('', '', 'identifier', $this->iLineNo); } $sResult = $this->parseCharacter(true); if ($sResult === null) { throw new UnexpectedTokenException($sResult, $this->peek(5), 'identifier', $this->iLineNo); } $sCharacter = null; while (!$this->isEnd() && ($sCharacter = $this->parseCharacter(true)) !== null) { if (preg_match('/[a-zA-Z0-9\x{00A0}-\x{FFFF}_-]/Sux', $sCharacter)) { $sResult .= $sCharacter; } else { $sResult .= '\\' . $sCharacter; } } if ($bIgnoreCase) { $sResult = $this->strtolower($sResult); } return $sResult; } /** * @param bool $bIsForIdentifier * * @return string|null * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public function parseCharacter($bIsForIdentifier) { if ($this->peek() === '\\') { if ( $bIsForIdentifier && $this->oParserSettings->bLenientParsing && ($this->comes('\0') || $this->comes('\9')) ) { // Non-strings can contain \0 or \9 which is an IE hack supported in lenient parsing. return null; } $this->consume('\\'); if ($this->comes('\n') || $this->comes('\r')) { return ''; } if (preg_match('/[0-9a-fA-F]/Su', $this->peek()) === 0) { return $this->consume(1); } $sUnicode = $this->consumeExpression('/^[0-9a-fA-F]{1,6}/u', 6); if ($this->strlen($sUnicode) < 6) { // Consume whitespace after incomplete unicode escape if (preg_match('/\\s/isSu', $this->peek())) { if ($this->comes('\r\n')) { $this->consume(2); } else { $this->consume(1); } } } $iUnicode = intval($sUnicode, 16); $sUtf32 = ""; for ($i = 0; $i < 4; ++$i) { $sUtf32 .= chr($iUnicode & 0xff); $iUnicode = $iUnicode >> 8; } return iconv('utf-32le', $this->sCharset, $sUtf32); } if ($bIsForIdentifier) { $peek = ord($this->peek()); // Ranges: a-z A-Z 0-9 - _ if ( ($peek >= 97 && $peek <= 122) || ($peek >= 65 && $peek <= 90) || ($peek >= 48 && $peek <= 57) || ($peek === 45) || ($peek === 95) || ($peek > 0xa1) ) { return $this->consume(1); } } else { return $this->consume(1); } return null; } /** * @return array<int, Comment>|void * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ public function consumeWhiteSpace() { $aComments = []; do { while (preg_match('/\\s/isSu', $this->peek()) === 1) { $this->consume(1); } if ($this->oParserSettings->bLenientParsing) { try { $oComment = $this->consumeComment(); } catch (UnexpectedEOFException $e) { $this->iCurrentPosition = $this->iLength; return $aComments; } } else { $oComment = $this->consumeComment(); } if ($oComment !== false) { $aComments[] = $oComment; } } while ($oComment !== false); return $aComments; } /** * @param string $sString * @param bool $bCaseInsensitive * * @return bool */ public function comes($sString, $bCaseInsensitive = false) { $sPeek = $this->peek(strlen($sString)); return ($sPeek == '') ? false : $this->streql($sPeek, $sString, $bCaseInsensitive); } /** * @param int $iLength * @param int $iOffset * * @return string */ public function peek($iLength = 1, $iOffset = 0) { $iOffset += $this->iCurrentPosition; if ($iOffset >= $this->iLength) { return ''; } return $this->substr($iOffset, $iLength); } /** * @param int $mValue * * @return string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ public function consume($mValue = 1) { if (is_string($mValue)) { $iLineCount = substr_count($mValue, "\n"); $iLength = $this->strlen($mValue); if (!$this->streql($this->substr($this->iCurrentPosition, $iLength), $mValue)) { throw new UnexpectedTokenException($mValue, $this->peek(max($iLength, 5)), $this->iLineNo); } $this->iLineNo += $iLineCount; $this->iCurrentPosition += $this->strlen($mValue); return $mValue; } else { if ($this->iCurrentPosition + $mValue > $this->iLength) { throw new UnexpectedEOFException($mValue, $this->peek(5), 'count', $this->iLineNo); } $sResult = $this->substr($this->iCurrentPosition, $mValue); $iLineCount = substr_count($sResult, "\n"); $this->iLineNo += $iLineCount; $this->iCurrentPosition += $mValue; return $sResult; } } /** * @param string $mExpression * @param int|null $iMaxLength * * @return string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ public function consumeExpression($mExpression, $iMaxLength = null) { $aMatches = null; $sInput = $iMaxLength !== null ? $this->peek($iMaxLength) : $this->inputLeft(); if (preg_match($mExpression, $sInput, $aMatches, PREG_OFFSET_CAPTURE) === 1) { return $this->consume($aMatches[0][0]); } throw new UnexpectedTokenException($mExpression, $this->peek(5), 'expression', $this->iLineNo); } /** * @return Comment|false */ public function consumeComment() { $mComment = false; if ($this->comes('/*')) { $iLineNo = $this->iLineNo; $this->consume(1); $mComment = ''; while (($char = $this->consume(1)) !== '') { $mComment .= $char; if ($this->comes('*/')) { $this->consume(2); break; } } } if ($mComment !== false) { // We skip the * which was included in the comment. return new Comment(substr($mComment, 1), $iLineNo); } return $mComment; } /** * @return bool */ public function isEnd() { return $this->iCurrentPosition >= $this->iLength; } /** * @param array<array-key, string>|string $aEnd * @param string $bIncludeEnd * @param string $consumeEnd * @param array<int, Comment> $comments * * @return string * * @throws UnexpectedEOFException * @throws UnexpectedTokenException */ public function consumeUntil($aEnd, $bIncludeEnd = false, $consumeEnd = false, array &$comments = []) { $aEnd = is_array($aEnd) ? $aEnd : [$aEnd]; $out = ''; $start = $this->iCurrentPosition; while (!$this->isEnd()) { $char = $this->consume(1); if (in_array($char, $aEnd)) { if ($bIncludeEnd) { $out .= $char; } elseif (!$consumeEnd) { $this->iCurrentPosition -= $this->strlen($char); } return $out; } $out .= $char; if ($comment = $this->consumeComment()) { $comments[] = $comment; } } if (in_array(self::EOF, $aEnd)) { return $out; } $this->iCurrentPosition = $start; throw new UnexpectedEOFException( 'One of ("' . implode('","', $aEnd) . '")', $this->peek(5), 'search', $this->iLineNo ); } /** * @return string */ private function inputLeft() { return $this->substr($this->iCurrentPosition, -1); } /** * @param string $sString1 * @param string $sString2 * @param bool $bCaseInsensitive * * @return bool */ public function streql($sString1, $sString2, $bCaseInsensitive = true) { if ($bCaseInsensitive) { return $this->strtolower($sString1) === $this->strtolower($sString2); } else { return $sString1 === $sString2; } } /** * @param int $iAmount * * @return void */ public function backtrack($iAmount) { $this->iCurrentPosition -= $iAmount; } /** * @param string $sString * * @return int */ public function strlen($sString) { if ($this->oParserSettings->bMultibyteSupport) { return mb_strlen($sString, $this->sCharset); } else { return strlen($sString); } } /** * @param int $iStart * @param int $iLength * * @return string */ private function substr($iStart, $iLength) { if ($iLength < 0) { $iLength = $this->iLength - $iStart + $iLength; } if ($iStart + $iLength > $this->iLength) { $iLength = $this->iLength - $iStart; } $sResult = ''; while ($iLength > 0) { $sResult .= $this->aText[$iStart]; $iStart++; $iLength--; } return $sResult; } /** * @param string $sString * * @return string */ private function strtolower($sString) { if ($this->oParserSettings->bMultibyteSupport) { return mb_strtolower($sString, $this->sCharset); } else { return strtolower($sString); } } /** * @param string $sString * * @return array<int, string> */ private function strsplit($sString) { if ($this->oParserSettings->bMultibyteSupport) { if ($this->streql($this->sCharset, 'utf-8')) { return preg_split('//u', $sString, -1, PREG_SPLIT_NO_EMPTY); } else { $iLength = mb_strlen($sString, $this->sCharset); $aResult = []; for ($i = 0; $i < $iLength; ++$i) { $aResult[] = mb_substr($sString, $i, 1, $this->sCharset); } return $aResult; } } else { if ($sString === '') { return []; } else { return str_split($sString); } } } /** * @param string $sString * @param string $sNeedle * @param int $iOffset * * @return int|false */ private function strpos($sString, $sNeedle, $iOffset) { if ($this->oParserSettings->bMultibyteSupport) { return mb_strpos($sString, $sNeedle, $iOffset, $this->sCharset); } else { return strpos($sString, $sNeedle, $iOffset); } } } Sabberworm/CSS/Parsing/Anchor.php 0000777 00000001354 15252673315 0012650 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing; /** * @internal since 8.7.0 */ class Anchor { /** * @var int */ private $iPosition; /** * @var \Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState */ private $oParserState; /** * @param int $iPosition * @param \Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState $oParserState */ public function __construct($iPosition, ParserState $oParserState) { $this->iPosition = $iPosition; $this->oParserState = $oParserState; } /** * @return void */ public function backtrack() { $this->oParserState->setPosition($this->iPosition); } } Sabberworm/CSS/Parsing/OutputException.php 0000777 00000000604 15252673315 0014612 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing; /** * Thrown if the CSS parser attempts to print something invalid. */ class OutputException extends SourceException { /** * @param string $sMessage * @param int $iLineNo */ public function __construct($sMessage, $iLineNo = 0) { parent::__construct($sMessage, $iLineNo); } } Sabberworm/CSS/Parsing/SourceException.php 0000777 00000001145 15252673315 0014553 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Positionable; class SourceException extends \Exception implements Positionable { use Position; /** * @param string $sMessage * @param int $iLineNo */ public function __construct($sMessage, $iLineNo = 0) { $this->setPosition($iLineNo); if (!empty($iLineNo)) { $sMessage .= " [line no: $iLineNo]"; } parent::__construct($sMessage); } } Sabberworm/CSS/Property/CSSNamespace.php 0000777 00000005745 15252673315 0014134 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Positionable; /** * `CSSNamespace` represents an `@namespace` rule. */ class CSSNamespace implements AtRule, Positionable { use Position; /** * @var string */ private $mUrl; /** * @var string */ private $sPrefix; /** * @var int */ private $iLineNo; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param string $mUrl * @param string|null $sPrefix * @param int $iLineNo */ public function __construct($mUrl, $sPrefix = null, $iLineNo = 0) { $this->mUrl = $mUrl; $this->sPrefix = $sPrefix; $this->setPosition($iLineNo); $this->aComments = []; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return '@namespace ' . ($this->sPrefix === null ? '' : $this->sPrefix . ' ') . $this->mUrl->render($oOutputFormat) . ';'; } /** * @return string */ public function getUrl() { return $this->mUrl; } /** * @return string|null */ public function getPrefix() { return $this->sPrefix; } /** * @param string $mUrl * * @return void */ public function setUrl($mUrl) { $this->mUrl = $mUrl; } /** * @param string $sPrefix * * @return void */ public function setPrefix($sPrefix) { $this->sPrefix = $sPrefix; } /** * @return string */ public function atRuleName() { return 'namespace'; } /** * @return array<int, string> */ public function atRuleArgs() { $aResult = [$this->mUrl]; if ($this->sPrefix) { array_unshift($aResult, $this->sPrefix); } return $aResult; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } Sabberworm/CSS/Property/Selector.php 0000777 00000007214 15252673315 0013440 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property; /** * Class representing a single CSS selector. Selectors have to be split by the comma prior to being passed into this * class. */ class Selector { /** * regexp for specificity calculations * * @var string * * @internal */ const NON_ID_ATTRIBUTES_AND_PSEUDO_CLASSES_RX = '/ (\.[\w]+) # classes | \[(\w+) # attributes | (\:( # pseudo classes link|visited|active |hover|focus |lang |target |enabled|disabled|checked|indeterminate |root |nth-child|nth-last-child|nth-of-type|nth-last-of-type |first-child|last-child|first-of-type|last-of-type |only-child|only-of-type |empty|contains )) /ix'; /** * regexp for specificity calculations * * @var string * * @internal */ const ELEMENTS_AND_PSEUDO_ELEMENTS_RX = '/ ((^|[\s\+\>\~]+)[\w]+ # elements | \:{1,2}( # pseudo-elements after|before|first-letter|first-line|selection )) /ix'; /** * regexp for specificity calculations * * @var string * * @internal since 8.5.2 */ const SELECTOR_VALIDATION_RX = '/ ^( (?: [a-zA-Z0-9\x{00A0}-\x{FFFF}_^$|*="\'~\[\]()\-\s\.:#+>]* # any sequence of valid unescaped characters (?:\\\\.)? # a single escaped character (?:([\'"]).*?(?<!\\\\)\2)? # a quoted text like [id="example"] )* )$ /ux'; /** * @var string */ private $sSelector; /** * @var int|null */ private $iSpecificity; /** * @param string $sSelector * * @return bool * * @internal since V8.8.0 */ public static function isValid($sSelector) { return preg_match(static::SELECTOR_VALIDATION_RX, $sSelector); } /** * @param string $sSelector * @param bool $bCalculateSpecificity @deprecated since V8.8.0, will be removed in V9.0.0 */ public function __construct($sSelector, $bCalculateSpecificity = false) { $this->setSelector($sSelector); if ($bCalculateSpecificity) { $this->getSpecificity(); } } /** * @return string */ public function getSelector() { return $this->sSelector; } /** * @param string $sSelector * * @return void */ public function setSelector($sSelector) { $this->sSelector = trim($sSelector); $this->iSpecificity = null; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->getSelector(); } /** * @return int */ public function getSpecificity() { if ($this->iSpecificity === null) { $a = 0; /// @todo should exclude \# as well as "#" $aMatches = null; $b = substr_count($this->sSelector, '#'); $c = preg_match_all(self::NON_ID_ATTRIBUTES_AND_PSEUDO_CLASSES_RX, $this->sSelector, $aMatches); $d = preg_match_all(self::ELEMENTS_AND_PSEUDO_ELEMENTS_RX, $this->sSelector, $aMatches); $this->iSpecificity = ($a * 1000) + ($b * 100) + ($c * 10) + $d; } return $this->iSpecificity; } } Sabberworm/CSS/Property/KeyframeSelector.php 0000777 00000001373 15252673315 0015124 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property; class KeyframeSelector extends Selector { /** * regexp for specificity calculations * * @var string * * @internal since 8.5.2 */ const SELECTOR_VALIDATION_RX = '/ ^( (?: [a-zA-Z0-9\x{00A0}-\x{FFFF}_^$|*="\'~\[\]()\-\s\.:#+>]* # any sequence of valid unescaped characters (?:\\\\.)? # a single escaped character (?:([\'"]).*?(?<!\\\\)\2)? # a quoted text like [id="example"] )* )| (\d+%) # keyframe animation progress percentage (e.g. 50%) $ /ux'; } Sabberworm/CSS/Property/Charset.php 0000777 00000005547 15252673315 0013260 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\CSSString; /** * Class representing an `@charset` rule. * * The following restrictions apply: * - May not be found in any CSSList other than the Document. * - May only appear at the very top of a Document’s contents. * - Must not appear more than once. */ class Charset implements AtRule, Positionable { use Position; /** * @var CSSString */ private $oCharset; /** * @var int * * @internal since 8.8.0 */ protected $iLineNo; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param CSSString $oCharset * @param int $iLineNo */ public function __construct(CSSString $oCharset, $iLineNo = 0) { $this->oCharset = $oCharset; $this->setPosition($iLineNo); $this->aComments = []; } /** * @param string|CSSString $oCharset * * @return void */ public function setCharset($sCharset) { $sCharset = $sCharset instanceof CSSString ? $sCharset : new CSSString($sCharset); $this->oCharset = $sCharset; } /** * @return string */ public function getCharset() { return $this->oCharset->getString(); } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return "{$oOutputFormat->comments($this)}@charset {$this->oCharset->render($oOutputFormat)};"; } /** * @return string */ public function atRuleName() { return 'charset'; } /** * @return string */ public function atRuleArgs() { return $this->oCharset; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } Sabberworm/CSS/Property/Import.php 0000777 00000005657 15252673315 0013143 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\URL; /** * Class representing an `@import` rule. */ class Import implements AtRule, Positionable { use Position; /** * @var URL */ private $oLocation; /** * @var string */ private $sMediaQuery; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param URL $oLocation * @param string $sMediaQuery * @param int $iLineNo */ public function __construct(URL $oLocation, $sMediaQuery, $iLineNo = 0) { $this->oLocation = $oLocation; $this->sMediaQuery = $sMediaQuery; $this->setPosition($iLineNo); $this->aComments = []; } /** * @param URL $oLocation * * @return void */ public function setLocation($oLocation) { $this->oLocation = $oLocation; } /** * @return URL */ public function getLocation() { return $this->oLocation; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { return $oOutputFormat->comments($this) . "@import " . $this->oLocation->render($oOutputFormat) . ($this->sMediaQuery === null ? '' : ' ' . $this->sMediaQuery) . ';'; } /** * @return string */ public function atRuleName() { return 'import'; } /** * @return array<int, URL|string> */ public function atRuleArgs() { $aResult = [$this->oLocation]; if ($this->sMediaQuery) { array_push($aResult, $this->sMediaQuery); } return $aResult; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } /** * @return string */ public function getMediaQuery() { return $this->sMediaQuery; } } Sabberworm/CSS/Property/AtRule.php 0000777 00000001703 15252673315 0013051 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Property; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Renderable; interface AtRule extends Renderable, Commentable { /** * Since there are more set rules than block rules, * we’re whitelisting the block rules and have anything else be treated as a set rule. * * @var string * * @internal since 8.5.2 */ const BLOCK_RULES = 'media/document/supports/region-style/font-feature-values'; /** * … and more font-specific ones (to be used inside font-feature-values) * * @var string * * @internal since 8.5.2 */ const SET_RULES = 'font-face/counter-style/page/swash/styleset/annotation'; /** * @return string|null */ public function atRuleName(); /** * @return string|null */ public function atRuleArgs(); } Sabberworm/CSS/Settings.php 0000777 00000005157 15252673315 0011640 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS; /** * Parser settings class. * * Configure parser behaviour here. */ class Settings { /** * Multi-byte string support. * * If `true` (`mbstring` extension must be enabled), will use (slower) `mb_strlen`, `mb_convert_case`, `mb_substr` * and `mb_strpos` functions. Otherwise, the normal (ASCII-Only) functions will be used. * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bMultibyteSupport; /** * The default charset for the CSS if no `@charset` declaration is found. Defaults to utf-8. * * @var string * * @internal since 8.8.0, will be made private in 9.0.0 */ public $sDefaultCharset = 'utf-8'; /** * Whether the parser silently ignore invalid rules instead of choking on them. * * @var bool * * @internal since 8.8.0, will be made private in 9.0.0 */ public $bLenientParsing = true; private function __construct() { $this->bMultibyteSupport = extension_loaded('mbstring'); } /** * @return self new instance */ public static function create() { return new Settings(); } /** * Enables/disables multi-byte string support. * * If `true` (`mbstring` extension must be enabled), will use (slower) `mb_strlen`, `mb_convert_case`, `mb_substr` * and `mb_strpos` functions. Otherwise, the normal (ASCII-Only) functions will be used. * * @param bool $bMultibyteSupport * * @return self fluent interface */ public function withMultibyteSupport($bMultibyteSupport = true) { $this->bMultibyteSupport = $bMultibyteSupport; return $this; } /** * Sets the charset to be used if the CSS does not contain an `@charset` declaration. * * @param string $sDefaultCharset * * @return self fluent interface */ public function withDefaultCharset($sDefaultCharset) { $this->sDefaultCharset = $sDefaultCharset; return $this; } /** * Configures whether the parser should silently ignore invalid rules. * * @param bool $bLenientParsing * * @return self fluent interface */ public function withLenientParsing($bLenientParsing = true) { $this->bLenientParsing = $bLenientParsing; return $this; } /** * Configures the parser to choke on invalid rules. * * @return self fluent interface */ public function beStrict() { return $this->withLenientParsing(false); } } Sabberworm/CSS/Rule/Rule.php 0000777 00000025325 15252673315 0011655 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Sabberworm\CSS\Rule; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Comment; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Comment\Commentable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\CSSElement; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\OutputFormat; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\ParserState; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedEOFException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Parsing\UnexpectedTokenException; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Position; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Position\Positionable; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\RuleValueList; use Automattic\WooCommerce\Vendor\Sabberworm\CSS\Value\Value; /** * `Rule`s just have a string key (the rule) and a 'Value'. * * In CSS, `Rule`s are expressed as follows: “key: value[0][0] value[0][1], value[1][0] value[1][1];” */ class Rule implements Commentable, CSSElement, Positionable { use Position; /** * @var string */ private $sRule; /** * @var RuleValueList|string|null */ private $mValue; /** * @var bool */ private $bIsImportant; /** * @var array<int, int> */ private $aIeHack; /** * @var array<array-key, Comment> * * @internal since 8.8.0 */ protected $aComments; /** * @param string $sRule * @param int $iLineNo * @param int $iColNo */ public function __construct($sRule, $iLineNo = 0, $iColNo = 0) { $this->sRule = $sRule; $this->mValue = null; $this->bIsImportant = false; $this->aIeHack = []; $this->setPosition($iLineNo, $iColNo); $this->aComments = []; } /** * @param array<int, Comment> $commentsBeforeRule * * @return Rule * * @throws UnexpectedEOFException * @throws UnexpectedTokenException * * @internal since V8.8.0 */ public static function parse(ParserState $oParserState, $commentsBeforeRule = []) { $aComments = \array_merge($commentsBeforeRule, $oParserState->consumeWhiteSpace()); $oRule = new Rule( $oParserState->parseIdentifier(!$oParserState->comes("--")), $oParserState->currentLine(), $oParserState->currentColumn() ); $oRule->setComments($aComments); $oRule->addComments($oParserState->consumeWhiteSpace()); $oParserState->consume(':'); $oValue = Value::parseValue($oParserState, self::listDelimiterForRule($oRule->getRule())); $oRule->setValue($oValue); if ($oParserState->getSettings()->bLenientParsing) { while ($oParserState->comes('\\')) { $oParserState->consume('\\'); $oRule->addIeHack($oParserState->consume()); $oParserState->consumeWhiteSpace(); } } $oParserState->consumeWhiteSpace(); if ($oParserState->comes('!')) { $oParserState->consume('!'); $oParserState->consumeWhiteSpace(); $oParserState->consume('important'); $oRule->setIsImportant(true); } $oParserState->consumeWhiteSpace(); while ($oParserState->comes(';')) { $oParserState->consume(';'); } return $oRule; } /** * Returns a list of delimiters (or separators). * The first item is the innermost separator (or, put another way, the highest-precedence operator). * The sequence continues to the outermost separator (or lowest-precedence operator). * * @param string $sRule * * @return list<non-empty-string> */ private static function listDelimiterForRule($sRule) { if (preg_match('/^font($|-)/', $sRule)) { return [',', '/', ' ']; } switch ($sRule) { case 'src': return [' ', ',']; default: return [',', ' ', '/']; } } /** * @param string $sRule * * @return void */ public function setRule($sRule) { $this->sRule = $sRule; } /** * @return string */ public function getRule() { return $this->sRule; } /** * @return RuleValueList|string|null */ public function getValue() { return $this->mValue; } /** * @param RuleValueList|string|null $mValue * * @return void */ public function setValue($mValue) { $this->mValue = $mValue; } /** * @param array<array-key, array<array-key, RuleValueList>> $aSpaceSeparatedValues * * @return RuleValueList * * @deprecated will be removed in version 9.0 * Old-Style 2-dimensional array given. Retained for (some) backwards-compatibility. * Use `setValue()` instead and wrap the value inside a RuleValueList if necessary. */ public function setValues(array $aSpaceSeparatedValues) { $oSpaceSeparatedList = null; if (count($aSpaceSeparatedValues) > 1) { $oSpaceSeparatedList = new RuleValueList(' ', $this->iLineNo); } foreach ($aSpaceSeparatedValues as $aCommaSeparatedValues) { $oCommaSeparatedList = null; if (count($aCommaSeparatedValues) > 1) { $oCommaSeparatedList = new RuleValueList(',', $this->iLineNo); } foreach ($aCommaSeparatedValues as $mValue) { if (!$oSpaceSeparatedList && !$oCommaSeparatedList) { $this->mValue = $mValue; return $mValue; } if ($oCommaSeparatedList) { $oCommaSeparatedList->addListComponent($mValue); } else { $oSpaceSeparatedList->addListComponent($mValue); } } if (!$oSpaceSeparatedList) { $this->mValue = $oCommaSeparatedList; return $oCommaSeparatedList; } else { $oSpaceSeparatedList->addListComponent($oCommaSeparatedList); } } $this->mValue = $oSpaceSeparatedList; return $oSpaceSeparatedList; } /** * @return array<int, array<int, RuleValueList>> * * @deprecated will be removed in version 9.0 * Old-Style 2-dimensional array returned. Retained for (some) backwards-compatibility. * Use `getValue()` instead and check for the existence of a (nested set of) ValueList object(s). */ public function getValues() { if (!$this->mValue instanceof RuleValueList) { return [[$this->mValue]]; } if ($this->mValue->getListSeparator() === ',') { return [$this->mValue->getListComponents()]; } $aResult = []; foreach ($this->mValue->getListComponents() as $mValue) { if (!$mValue instanceof RuleValueList || $mValue->getListSeparator() !== ',') { $aResult[] = [$mValue]; continue; } if ($this->mValue->getListSeparator() === ' ' || count($aResult) === 0) { $aResult[] = []; } foreach ($mValue->getListComponents() as $mValue) { $aResult[count($aResult) - 1][] = $mValue; } } return $aResult; } /** * Adds a value to the existing value. Value will be appended if a `RuleValueList` exists of the given type. * Otherwise, the existing value will be wrapped by one. * * @param RuleValueList|array<int, RuleValueList> $mValue * @param string $sType * * @return void */ public function addValue($mValue, $sType = ' ') { if (!is_array($mValue)) { $mValue = [$mValue]; } if (!$this->mValue instanceof RuleValueList || $this->mValue->getListSeparator() !== $sType) { $mCurrentValue = $this->mValue; $this->mValue = new RuleValueList($sType, $this->getLineNumber()); if ($mCurrentValue) { $this->mValue->addListComponent($mCurrentValue); } } foreach ($mValue as $mValueItem) { $this->mValue->addListComponent($mValueItem); } } /** * @param int $iModifier * * @return void * * @deprecated since V8.8.0, will be removed in V9.0 */ public function addIeHack($iModifier) { $this->aIeHack[] = $iModifier; } /** * @param array<int, int> $aModifiers * * @return void * * @deprecated since V8.8.0, will be removed in V9.0 */ public function setIeHack(array $aModifiers) { $this->aIeHack = $aModifiers; } /** * @return array<int, int> * * @deprecated since V8.8.0, will be removed in V9.0 */ public function getIeHack() { return $this->aIeHack; } /** * @param bool $bIsImportant * * @return void */ public function setIsImportant($bIsImportant) { $this->bIsImportant = $bIsImportant; } /** * @return bool */ public function getIsImportant() { return $this->bIsImportant; } /** * @return string * * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead. */ public function __toString() { return $this->render(new OutputFormat()); } /** * @param OutputFormat|null $oOutputFormat * * @return string */ public function render($oOutputFormat) { $sResult = "{$oOutputFormat->comments($this)}{$this->sRule}:{$oOutputFormat->spaceAfterRuleName()}"; if ($this->mValue instanceof Value) { // Can also be a ValueList $sResult .= $this->mValue->render($oOutputFormat); } else { $sResult .= $this->mValue; } if (!empty($this->aIeHack)) { $sResult .= ' \\' . implode('\\', $this->aIeHack); } if ($this->bIsImportant) { $sResult .= ' !important'; } $sResult .= ';'; return $sResult; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function addComments(array $aComments) { $this->aComments = array_merge($this->aComments, $aComments); } /** * @return array<array-key, Comment> */ public function getComments() { return $this->aComments; } /** * @param array<array-key, Comment> $aComments * * @return void */ public function setComments(array $aComments) { $this->aComments = $aComments; } } Detection/MobileDetect.php 0000777 00000232635 15252673315 0011566 0 ustar 00 <?php /** * Mobile Detect Library * Motto: "Every business should have a mobile detection script to detect mobile readers" * * Mobile_Detect is a lightweight PHP class for detecting mobile devices (including tablets). * It uses the User-Agent string combined with specific HTTP headers to detect the mobile environment. * * Homepage: http://mobiledetect.net * GitHub: https://github.com/serbanghita/Mobile-Detect * README: https://github.com/serbanghita/Mobile-Detect/blob/master/README.md * CONTRIBUTING: https://github.com/serbanghita/Mobile-Detect/blob/master/docs/CONTRIBUTING.md * KNOWN LIMITATIONS: https://github.com/serbanghita/Mobile-Detect/blob/master/docs/KNOWN_LIMITATIONS.md * EXAMPLES: https://github.com/serbanghita/Mobile-Detect/wiki/Code-examples * * @license https://github.com/serbanghita/Mobile-Detect/blob/master/LICENSE * @author Serban Ghita <serbanghita@gmail.com> (since 2012) * @author Nick Ilyin <nick.ilyin@gmail.com> * @author: Victor Stanciu <vic.stanciu@gmail.com> (original author) * * @version 3.74.3 */ namespace Automattic\WooCommerce\Vendor\Detection; use BadMethodCallException; /** * Auto-generated isXXXX() magic methods. * php export/dump_magic_methods.php * * @method bool isiPhone() * @method bool isBlackBerry() * @method bool isPixel() * @method bool isHTC() * @method bool isNexus() * @method bool isDell() * @method bool isMotorola() * @method bool isSamsung() * @method bool isLG() * @method bool isSony() * @method bool isAsus() * @method bool isXiaomi() * @method bool isNokiaLumia() * @method bool isMicromax() * @method bool isPalm() * @method bool isVertu() * @method bool isPantech() * @method bool isFly() * @method bool isWiko() * @method bool isiMobile() * @method bool isSimValley() * @method bool isWolfgang() * @method bool isAlcatel() * @method bool isNintendo() * @method bool isAmoi() * @method bool isINQ() * @method bool isOnePlus() * @method bool isGenericPhone() * @method bool isiPad() * @method bool isNexusTablet() * @method bool isGoogleTablet() * @method bool isSamsungTablet() * @method bool isKindle() * @method bool isSurfaceTablet() * @method bool isHPTablet() * @method bool isAsusTablet() * @method bool isBlackBerryTablet() * @method bool isHTCtablet() * @method bool isMotorolaTablet() * @method bool isNookTablet() * @method bool isAcerTablet() * @method bool isToshibaTablet() * @method bool isLGTablet() * @method bool isFujitsuTablet() * @method bool isPrestigioTablet() * @method bool isLenovoTablet() * @method bool isDellTablet() * @method bool isYarvikTablet() * @method bool isMedionTablet() * @method bool isArnovaTablet() * @method bool isIntensoTablet() * @method bool isIRUTablet() * @method bool isMegafonTablet() * @method bool isEbodaTablet() * @method bool isAllViewTablet() * @method bool isArchosTablet() * @method bool isAinolTablet() * @method bool isNokiaLumiaTablet() * @method bool isSonyTablet() * @method bool isPhilipsTablet() * @method bool isCubeTablet() * @method bool isCobyTablet() * @method bool isMIDTablet() * @method bool isMSITablet() * @method bool isSMiTTablet() * @method bool isRockChipTablet() * @method bool isFlyTablet() * @method bool isbqTablet() * @method bool isHuaweiTablet() * @method bool isNecTablet() * @method bool isPantechTablet() * @method bool isBronchoTablet() * @method bool isVersusTablet() * @method bool isZyncTablet() * @method bool isPositivoTablet() * @method bool isNabiTablet() * @method bool isKoboTablet() * @method bool isDanewTablet() * @method bool isTexetTablet() * @method bool isPlaystationTablet() * @method bool isTrekstorTablet() * @method bool isPyleAudioTablet() * @method bool isAdvanTablet() * @method bool isDanyTechTablet() * @method bool isGalapadTablet() * @method bool isMicromaxTablet() * @method bool isKarbonnTablet() * @method bool isAllFineTablet() * @method bool isPROSCANTablet() * @method bool isYONESTablet() * @method bool isChangJiaTablet() * @method bool isGUTablet() * @method bool isPointOfViewTablet() * @method bool isOvermaxTablet() * @method bool isHCLTablet() * @method bool isDPSTablet() * @method bool isVistureTablet() * @method bool isCrestaTablet() * @method bool isMediatekTablet() * @method bool isConcordeTablet() * @method bool isGoCleverTablet() * @method bool isModecomTablet() * @method bool isVoninoTablet() * @method bool isECSTablet() * @method bool isStorexTablet() * @method bool isVodafoneTablet() * @method bool isEssentielBTablet() * @method bool isRossMoorTablet() * @method bool isiMobileTablet() * @method bool isTolinoTablet() * @method bool isAudioSonicTablet() * @method bool isAMPETablet() * @method bool isSkkTablet() * @method bool isTecnoTablet() * @method bool isJXDTablet() * @method bool isiJoyTablet() * @method bool isFX2Tablet() * @method bool isXoroTablet() * @method bool isViewsonicTablet() * @method bool isVerizonTablet() * @method bool isOdysTablet() * @method bool isCaptivaTablet() * @method bool isIconbitTablet() * @method bool isTeclastTablet() * @method bool isOndaTablet() * @method bool isJaytechTablet() * @method bool isBlaupunktTablet() * @method bool isDigmaTablet() * @method bool isEvolioTablet() * @method bool isLavaTablet() * @method bool isAocTablet() * @method bool isMpmanTablet() * @method bool isCelkonTablet() * @method bool isWolderTablet() * @method bool isMediacomTablet() * @method bool isMiTablet() * @method bool isNibiruTablet() * @method bool isNexoTablet() * @method bool isLeaderTablet() * @method bool isUbislateTablet() * @method bool isPocketBookTablet() * @method bool isKocasoTablet() * @method bool isHisenseTablet() * @method bool isHudl() * @method bool isTelstraTablet() * @method bool isGenericTablet() * @method bool isAndroidOS() * @method bool isBlackBerryOS() * @method bool isPalmOS() * @method bool isSymbianOS() * @method bool isWindowsMobileOS() * @method bool isWindowsPhoneOS() * @method bool isiOS() * @method bool isiPadOS() * @method bool isSailfishOS() * @method bool isMeeGoOS() * @method bool isMaemoOS() * @method bool isJavaOS() * @method bool iswebOS() * @method bool isbadaOS() * @method bool isBREWOS() * @method bool isChrome() * @method bool isDolfin() * @method bool isOpera() * @method bool isSkyfire() * @method bool isEdge() * @method bool isIE() * @method bool isFirefox() * @method bool isBolt() * @method bool isTeaShark() * @method bool isBlazer() * @method bool isSafari() * @method bool isWeChat() * @method bool isUCBrowser() * @method bool isbaiduboxapp() * @method bool isbaidubrowser() * @method bool isDiigoBrowser() * @method bool isMercury() * @method bool isObigoBrowser() * @method bool isNetFront() * @method bool isGenericBrowser() * @method bool isPaleMoon() * @method bool isWebKit() * @method bool isConsole() * @method bool isWatch() */ class MobileDetect { /** * A frequently used regular expression to extract version #s. * * @deprecated since version 2.6.9 */ const VER = '([\w._\+]+)'; /** * Stores the version number of the current release. */ const VERSION = '3.74.3'; /** * A type for the version() method indicating a string return value. */ const VERSION_TYPE_STRING = 'text'; /** * A type for the version() method indicating a float return value. */ const VERSION_TYPE_FLOAT = 'float'; /** * A cache for resolved matches * @var array */ protected array $cache = []; /** * The User-Agent HTTP header is stored in here. * @var string|null */ protected ?string $userAgent = null; /** * HTTP headers in the PHP-flavor. So HTTP_USER_AGENT and SERVER_SOFTWARE. * @var array */ protected array $httpHeaders = []; /** * CloudFront headers. E.g. CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer & CloudFront-Is-Tablet-Viewer. * @var array */ protected array $cloudfrontHeaders = []; /** * The matching Regex. * This is good for debug. * @var string|null */ protected ?string $matchingRegex = null; /** * The matches extracted from the regex expression. * This is good for debug. * * @var array|null */ protected ?array $matchesArray = null; /** * HTTP headers that trigger the 'isMobile' detection * to be true. * * @var array */ protected static array $mobileHeaders = [ 'HTTP_ACCEPT' => [ 'matches' => [ // Opera Mini // @reference: http://dev.opera.com/articles/view/opera-binary-markup-language/ 'application/x-obml2d', // BlackBerry devices. 'application/vnd.rim.html', 'text/vnd.wap.wml', 'application/vnd.wap.xhtml+xml' ]], 'HTTP_X_WAP_PROFILE' => null, 'HTTP_X_WAP_CLIENTID' => null, 'HTTP_WAP_CONNECTION' => null, 'HTTP_PROFILE' => null, // Reported by Opera on Nokia devices (eg. C3). 'HTTP_X_OPERAMINI_PHONE_UA' => null, 'HTTP_X_NOKIA_GATEWAY_ID' => null, 'HTTP_X_ORANGE_ID' => null, 'HTTP_X_VODAFONE_3GPDPCONTEXT' => null, 'HTTP_X_HUAWEI_USERID' => null, // Reported by Windows Smartphones. 'HTTP_UA_OS' => null, // Reported by Verizon, Vodafone proxy system. 'HTTP_X_MOBILE_GATEWAY' => null, // Seen this on HTC Sensation. SensationXE_Beats_Z715e. 'HTTP_X_ATT_DEVICEID' => null, // Seen this on a HTC. 'HTTP_UA_CPU' => ['matches' => ['ARM']], ]; /** * List of mobile devices (phones). * * @var array */ protected static array $phoneDevices = [ 'iPhone' => '\biPhone\b|\biPod\b', // |\biTunes 'BlackBerry' => 'BlackBerry|\bBB10\b|rim[0-9]+|\b(BBA100|BBB100|BBD100|BBE100|BBF100|STH100)\b-[0-9]+', 'Pixel' => '; \bPixel\b', 'HTC' => 'HTC|HTC.*(Sensation|Evo|Vision|Explorer|6800|8100|8900|A7272|S510e|C110e|Legend|Desire|T8282)|APX515CKT|Qtek9090|APA9292KT|HD_mini|Sensation.*Z710e|PG86100|Z715e|Desire.*(A8181|HD)|ADR6200|ADR6400L|ADR6425|001HT|Inspire 4G|Android.*\bEVO\b|T-Mobile G1|Z520m|Android [0-9.]+; Pixel', 'Nexus' => 'Nexus One|Nexus S|Galaxy.*Nexus|Android.*Nexus.*Mobile|Nexus 4|Nexus 5|Nexus 5X|Nexus 6', // @todo: Is 'Dell Streak' a tablet or a phone? ;) 'Dell' => 'Dell[;]? (Streak|Aero|Venue|Venue Pro|Flash|Smoke|Mini 3iX)|XCD28|XCD35|\b001DL\b|\b101DL\b|\bGS01\b', 'Motorola' => 'Motorola|DROIDX|DROID BIONIC|\bDroid\b.*Build|Android.*Xoom|HRI39|MOT-|A1260|A1680|A555|A853|A855|A953|A955|A956|Motorola.*ELECTRIFY|Motorola.*i1|i867|i940|MB200|MB300|MB501|MB502|MB508|MB511|MB520|MB525|MB526|MB611|MB612|MB632|MB810|MB855|MB860|MB861|MB865|MB870|ME501|ME502|ME511|ME525|ME600|ME632|ME722|ME811|ME860|ME863|ME865|MT620|MT710|MT716|MT720|MT810|MT870|MT917|Motorola.*TITANIUM|WX435|WX445|XT300|XT301|XT311|XT316|XT317|XT319|XT320|XT390|XT502|XT530|XT531|XT532|XT535|XT603|XT610|XT611|XT615|XT681|XT701|XT702|XT711|XT720|XT800|XT806|XT860|XT862|XT875|XT882|XT883|XT894|XT901|XT907|XT909|XT910|XT912|XT928|XT926|XT915|XT919|XT925|XT1021|\bMoto E\b|XT1068|XT1092|XT1052', 'Samsung' => '\bSamsung\b|SM-G950F|SM-G955F|SM-G9250|GT-19300|SGH-I337|BGT-S5230|GT-B2100|GT-B2700|GT-B2710|GT-B3210|GT-B3310|GT-B3410|GT-B3730|GT-B3740|GT-B5510|GT-B5512|GT-B5722|GT-B6520|GT-B7300|GT-B7320|GT-B7330|GT-B7350|GT-B7510|GT-B7722|GT-B7800|GT-C3010|GT-C3011|GT-C3060|GT-C3200|GT-C3212|GT-C3212I|GT-C3262|GT-C3222|GT-C3300|GT-C3300K|GT-C3303|GT-C3303K|GT-C3310|GT-C3322|GT-C3330|GT-C3350|GT-C3500|GT-C3510|GT-C3530|GT-C3630|GT-C3780|GT-C5010|GT-C5212|GT-C6620|GT-C6625|GT-C6712|GT-E1050|GT-E1070|GT-E1075|GT-E1080|GT-E1081|GT-E1085|GT-E1087|GT-E1100|GT-E1107|GT-E1110|GT-E1120|GT-E1125|GT-E1130|GT-E1160|GT-E1170|GT-E1175|GT-E1180|GT-E1182|GT-E1200|GT-E1210|GT-E1225|GT-E1230|GT-E1390|GT-E2100|GT-E2120|GT-E2121|GT-E2152|GT-E2220|GT-E2222|GT-E2230|GT-E2232|GT-E2250|GT-E2370|GT-E2550|GT-E2652|GT-E3210|GT-E3213|GT-I5500|GT-I5503|GT-I5700|GT-I5800|GT-I5801|GT-I6410|GT-I6420|GT-I7110|GT-I7410|GT-I7500|GT-I8000|GT-I8150|GT-I8160|GT-I8190|GT-I8320|GT-I8330|GT-I8350|GT-I8530|GT-I8700|GT-I8703|GT-I8910|GT-I9000|GT-I9001|GT-I9003|GT-I9010|GT-I9020|GT-I9023|GT-I9070|GT-I9082|GT-I9100|GT-I9103|GT-I9220|GT-I9250|GT-I9300|GT-I9305|GT-I9500|GT-I9505|GT-M3510|GT-M5650|GT-M7500|GT-M7600|GT-M7603|GT-M8800|GT-M8910|GT-N7000|GT-S3110|GT-S3310|GT-S3350|GT-S3353|GT-S3370|GT-S3650|GT-S3653|GT-S3770|GT-S3850|GT-S5210|GT-S5220|GT-S5229|GT-S5230|GT-S5233|GT-S5250|GT-S5253|GT-S5260|GT-S5263|GT-S5270|GT-S5300|GT-S5330|GT-S5350|GT-S5360|GT-S5363|GT-S5369|GT-S5380|GT-S5380D|GT-S5560|GT-S5570|GT-S5600|GT-S5603|GT-S5610|GT-S5620|GT-S5660|GT-S5670|GT-S5690|GT-S5750|GT-S5780|GT-S5830|GT-S5839|GT-S6102|GT-S6500|GT-S7070|GT-S7200|GT-S7220|GT-S7230|GT-S7233|GT-S7250|GT-S7500|GT-S7530|GT-S7550|GT-S7562|GT-S7710|GT-S8000|GT-S8003|GT-S8500|GT-S8530|GT-S8600|SCH-A310|SCH-A530|SCH-A570|SCH-A610|SCH-A630|SCH-A650|SCH-A790|SCH-A795|SCH-A850|SCH-A870|SCH-A890|SCH-A930|SCH-A950|SCH-A970|SCH-A990|SCH-I100|SCH-I110|SCH-I400|SCH-I405|SCH-I500|SCH-I510|SCH-I515|SCH-I600|SCH-I730|SCH-I760|SCH-I770|SCH-I830|SCH-I910|SCH-I920|SCH-I959|SCH-LC11|SCH-N150|SCH-N300|SCH-R100|SCH-R300|SCH-R351|SCH-R400|SCH-R410|SCH-T300|SCH-U310|SCH-U320|SCH-U350|SCH-U360|SCH-U365|SCH-U370|SCH-U380|SCH-U410|SCH-U430|SCH-U450|SCH-U460|SCH-U470|SCH-U490|SCH-U540|SCH-U550|SCH-U620|SCH-U640|SCH-U650|SCH-U660|SCH-U700|SCH-U740|SCH-U750|SCH-U810|SCH-U820|SCH-U900|SCH-U940|SCH-U960|SCS-26UC|SGH-A107|SGH-A117|SGH-A127|SGH-A137|SGH-A157|SGH-A167|SGH-A177|SGH-A187|SGH-A197|SGH-A227|SGH-A237|SGH-A257|SGH-A437|SGH-A517|SGH-A597|SGH-A637|SGH-A657|SGH-A667|SGH-A687|SGH-A697|SGH-A707|SGH-A717|SGH-A727|SGH-A737|SGH-A747|SGH-A767|SGH-A777|SGH-A797|SGH-A817|SGH-A827|SGH-A837|SGH-A847|SGH-A867|SGH-A877|SGH-A887|SGH-A897|SGH-A927|SGH-B100|SGH-B130|SGH-B200|SGH-B220|SGH-C100|SGH-C110|SGH-C120|SGH-C130|SGH-C140|SGH-C160|SGH-C170|SGH-C180|SGH-C200|SGH-C207|SGH-C210|SGH-C225|SGH-C230|SGH-C417|SGH-C450|SGH-D307|SGH-D347|SGH-D357|SGH-D407|SGH-D415|SGH-D780|SGH-D807|SGH-D980|SGH-E105|SGH-E200|SGH-E315|SGH-E316|SGH-E317|SGH-E335|SGH-E590|SGH-E635|SGH-E715|SGH-E890|SGH-F300|SGH-F480|SGH-I200|SGH-I300|SGH-I320|SGH-I550|SGH-I577|SGH-I600|SGH-I607|SGH-I617|SGH-I627|SGH-I637|SGH-I677|SGH-I700|SGH-I717|SGH-I727|SGH-i747M|SGH-I777|SGH-I780|SGH-I827|SGH-I847|SGH-I857|SGH-I896|SGH-I897|SGH-I900|SGH-I907|SGH-I917|SGH-I927|SGH-I937|SGH-I997|SGH-J150|SGH-J200|SGH-L170|SGH-L700|SGH-M110|SGH-M150|SGH-M200|SGH-N105|SGH-N500|SGH-N600|SGH-N620|SGH-N625|SGH-N700|SGH-N710|SGH-P107|SGH-P207|SGH-P300|SGH-P310|SGH-P520|SGH-P735|SGH-P777|SGH-Q105|SGH-R210|SGH-R220|SGH-R225|SGH-S105|SGH-S307|SGH-T109|SGH-T119|SGH-T139|SGH-T209|SGH-T219|SGH-T229|SGH-T239|SGH-T249|SGH-T259|SGH-T309|SGH-T319|SGH-T329|SGH-T339|SGH-T349|SGH-T359|SGH-T369|SGH-T379|SGH-T409|SGH-T429|SGH-T439|SGH-T459|SGH-T469|SGH-T479|SGH-T499|SGH-T509|SGH-T519|SGH-T539|SGH-T559|SGH-T589|SGH-T609|SGH-T619|SGH-T629|SGH-T639|SGH-T659|SGH-T669|SGH-T679|SGH-T709|SGH-T719|SGH-T729|SGH-T739|SGH-T746|SGH-T749|SGH-T759|SGH-T769|SGH-T809|SGH-T819|SGH-T839|SGH-T919|SGH-T929|SGH-T939|SGH-T959|SGH-T989|SGH-U100|SGH-U200|SGH-U800|SGH-V205|SGH-V206|SGH-X100|SGH-X105|SGH-X120|SGH-X140|SGH-X426|SGH-X427|SGH-X475|SGH-X495|SGH-X497|SGH-X507|SGH-X600|SGH-X610|SGH-X620|SGH-X630|SGH-X700|SGH-X820|SGH-X890|SGH-Z130|SGH-Z150|SGH-Z170|SGH-ZX10|SGH-ZX20|SHW-M110|SPH-A120|SPH-A400|SPH-A420|SPH-A460|SPH-A500|SPH-A560|SPH-A600|SPH-A620|SPH-A660|SPH-A700|SPH-A740|SPH-A760|SPH-A790|SPH-A800|SPH-A820|SPH-A840|SPH-A880|SPH-A900|SPH-A940|SPH-A960|SPH-D600|SPH-D700|SPH-D710|SPH-D720|SPH-I300|SPH-I325|SPH-I330|SPH-I350|SPH-I500|SPH-I600|SPH-I700|SPH-L700|SPH-M100|SPH-M220|SPH-M240|SPH-M300|SPH-M305|SPH-M320|SPH-M330|SPH-M350|SPH-M360|SPH-M370|SPH-M380|SPH-M510|SPH-M540|SPH-M550|SPH-M560|SPH-M570|SPH-M580|SPH-M610|SPH-M620|SPH-M630|SPH-M800|SPH-M810|SPH-M850|SPH-M900|SPH-M910|SPH-M920|SPH-M930|SPH-N100|SPH-N200|SPH-N240|SPH-N300|SPH-N400|SPH-Z400|SWC-E100|SCH-i909|GT-N7100|GT-N7105|SCH-I535|SM-N900A|SGH-I317|SGH-T999L|GT-S5360B|GT-I8262|GT-S6802|GT-S6312|GT-S6310|GT-S5312|GT-S5310|GT-I9105|GT-I8510|GT-S6790N|SM-G7105|SM-N9005|GT-S5301|GT-I9295|GT-I9195|SM-C101|GT-S7392|GT-S7560|GT-B7610|GT-I5510|GT-S7582|GT-S7530E|GT-I8750|SM-G9006V|SM-G9008V|SM-G9009D|SM-G900A|SM-G900D|SM-G900F|SM-G900H|SM-G900I|SM-G900J|SM-G900K|SM-G900L|SM-G900M|SM-G900P|SM-G900R4|SM-G900S|SM-G900T|SM-G900V|SM-G900W8|SHV-E160K|SCH-P709|SCH-P729|SM-T2558|GT-I9205|SM-G9350|SM-J120F|SM-G920F|SM-G920V|SM-G930F|SM-N910C|SM-A310F|GT-I9190|SM-J500FN|SM-G903F|SM-J330F|SM-G610F|SM-G981B|SM-G892A|SM-A530F|SM-G988N|SM-G781B|SM-A805N|SM-G965F', 'LG' => '\bLG\b;|LG[- ]?(C800|C900|E400|E610|E900|E-900|F160|F180K|F180L|F180S|730|855|L160|LS740|LS840|LS970|LU6200|MS690|MS695|MS770|MS840|MS870|MS910|P500|P700|P705|VM696|AS680|AS695|AX840|C729|E970|GS505|272|C395|E739BK|E960|L55C|L75C|LS696|LS860|P769BK|P350|P500|P509|P870|UN272|US730|VS840|VS950|LN272|LN510|LS670|LS855|LW690|MN270|MN510|P509|P769|P930|UN200|UN270|UN510|UN610|US670|US740|US760|UX265|UX840|VN271|VN530|VS660|VS700|VS740|VS750|VS910|VS920|VS930|VX9200|VX11000|AX840A|LW770|P506|P925|P999|E612|D955|D802|MS323|M257)|LM-G710', 'Sony' => 'SonyST|SonyLT|SonyEricsson|SonyEricssonLT15iv|LT18i|E10i|LT28h|LT26w|SonyEricssonMT27i|C5303|C6902|C6903|C6906|C6943|D2533|SOV34|601SO|F8332', 'Asus' => 'Asus.*Galaxy|PadFone.*Mobile|ASUS_Z01QD|ASUS_X00TD', 'Xiaomi' => '^(?!.*\bx11\b).*xiaomi.*$|POCOPHONE F1|\bMI\b 8|\bMi\b 10|Redmi Note 9S|Redmi 5A|Redmi Note 5A Prime|Redmi Note 7 Pro|N2G47H|M2001J2G|M2001J2I|M1805E10A|M2004J11G|M1902F1G|M2002J9G|M2004J19G|M2003J6A1G|M2012K11C|M2007J1SC', 'NokiaLumia' => 'Lumia [0-9]{3,4}', // http://www.micromaxinfo.com/mobiles/smartphones // Added because the codes might conflict with Acer Tablets. 'Micromax' => 'Micromax.*\b(A210|A92|A88|A72|A111|A110Q|A115|A116|A110|A90S|A26|A51|A35|A54|A25|A27|A89|A68|A65|A57|A90)\b', // @todo Complete the regex. 'Palm' => 'PalmSource|Palm', // avantgo|blazer|elaine|hiptop|plucker|xiino ; 'Vertu' => 'Vertu|Vertu.*Ltd|Vertu.*Ascent|Vertu.*Ayxta|Vertu.*Constellation(F|Quest)?|Vertu.*Monika|Vertu.*Signature', // Just for fun ;) // http://www.pantech.co.kr/en/prod/prodList.do?gbrand=VEGA (PANTECH) // Most of the VEGA devices are legacy. PANTECH seem to be newer devices based on Android. 'Pantech' => 'PANTECH|IM-A850S|IM-A840S|IM-A830L|IM-A830K|IM-A830S|IM-A820L|IM-A810K|IM-A810S|IM-A800S|IM-T100K|IM-A725L|IM-A780L|IM-A775C|IM-A770K|IM-A760S|IM-A750K|IM-A740S|IM-A730S|IM-A720L|IM-A710K|IM-A690L|IM-A690S|IM-A650S|IM-A630K|IM-A600S|VEGA PTL21|PT003|P8010|ADR910L|P6030|P6020|P9070|P4100|P9060|P5000|CDM8992|TXT8045|ADR8995|IS11PT|P2030|P6010|P8000|PT002|IS06|CDM8999|P9050|PT001|TXT8040|P2020|P9020|P2000|P7040|P7000|C790', // http://www.fly-phone.com/devices/smartphones/ ; Included only smartphones. 'Fly' => 'IQ230|IQ444|IQ450|IQ440|IQ442|IQ441|IQ245|IQ256|IQ236|IQ255|IQ235|IQ245|IQ275|IQ240|IQ285|IQ280|IQ270|IQ260|IQ250', // http://fr.wikomobile.com 'Wiko' => 'KITE 4G|HIGHWAY|GETAWAY|STAIRWAY|DARKSIDE|DARKFULL|DARKNIGHT|DARKMOON|SLIDE|WAX 4G|RAINBOW|BLOOM|SUNSET|GOA(?!nna)|LENNY|BARRY|IGGY|OZZY|CINK FIVE|CINK PEAX|CINK PEAX 2|CINK SLIM|CINK SLIM 2|CINK +|CINK KING|CINK PEAX|CINK SLIM|SUBLIM', 'iMobile' => 'i-mobile (IQ|i-STYLE|idea|ZAA|Hitz)', // Added simvalley mobile just for fun. They have some interesting devices. // http://www.simvalley.fr/telephonie---gps-_22_telephonie-mobile_telephones_.html 'SimValley' => '\b(SP-80|XT-930|SX-340|XT-930|SX-310|SP-360|SP60|SPT-800|SP-120|SPT-800|SP-140|SPX-5|SPX-8|SP-100|SPX-8|SPX-12)\b', // Wolfgang - a brand that is sold by Aldi supermarkets. // http://www.wolfgangmobile.com/ 'Wolfgang' => 'AT-B24D|AT-AS50HD|AT-AS40W|AT-AS55HD|AT-AS45q2|AT-B26D|AT-AS50Q', 'Alcatel' => 'Alcatel', 'Nintendo' => 'Nintendo (3DS|Switch)', // http://en.wikipedia.org/wiki/Amoi 'Amoi' => 'Amoi', // http://en.wikipedia.org/wiki/INQ 'INQ' => 'INQ', 'OnePlus' => 'ONEPLUS', // @Tapatalk is a mobile app; http://support.tapatalk.com/threads/smf-2-0-2-os-and-browser-detection-plugin-and-tapatalk.15565/#post-79039 'GenericPhone' => 'Tapatalk|PDA;|SAGEM|\bmmp\b|pocket|\bpsp\b|symbian|Smartphone|smartfon|treo|up.browser|up.link|vodafone|\bwap\b|nokia|Series40|Series60|S60|SonyEricsson|N900|MAUI.*WAP.*Browser', ]; /** * List of tablet devices. * * @var array */ protected static array $tabletDevices = [ // @todo: check for mobile friendly emails topic. 'iPad' => 'iPad|iPad.*Mobile', // Removed |^.*Android.*Nexus(?!(?:Mobile).)*$ // @see #442 // @todo Merge NexusTablet into GoogleTablet. 'NexusTablet' => 'Android.*Nexus[\s]+(7|9|10)', // https://en.wikipedia.org/wiki/Pixel_C 'GoogleTablet' => 'Android.*Pixel C', 'SamsungTablet' => 'SAMSUNG.*Tablet|Galaxy.*Tab|SC-01C|GT-P1000|GT-P1003|GT-P1010|GT-P3105|GT-P6210|GT-P6800|GT-P6810|GT-P7100|GT-P7300|GT-P7310|GT-P7500|GT-P7510|SCH-I800|SCH-I815|SCH-I905|SGH-I957|SGH-I987|SGH-T849|SGH-T859|SGH-T869|SPH-P100|GT-P3100|GT-P3108|GT-P3110|GT-P5100|GT-P5110|GT-P6200|GT-P7320|GT-P7511|GT-N8000|GT-P8510|SGH-I497|SPH-P500|SGH-T779|SCH-I705|SCH-I915|GT-N8013|GT-P3113|GT-P5113|GT-P8110|GT-N8010|GT-N8005|GT-N8020|GT-P1013|GT-P6201|GT-P7501|GT-N5100|GT-N5105|GT-N5110|SHV-E140K|SHV-E140L|SHV-E140S|SHV-E150S|SHV-E230K|SHV-E230L|SHV-E230S|SHW-M180K|SHW-M180L|SHW-M180S|SHW-M180W|SHW-M300W|SHW-M305W|SHW-M380K|SHW-M380S|SHW-M380W|SHW-M430W|SHW-M480K|SHW-M480S|SHW-M480W|SHW-M485W|SHW-M486W|SHW-M500W|GT-I9228|SCH-P739|SCH-I925|GT-I9200|GT-P5200|GT-P5210|GT-P5210X|SM-T311|SM-T310|SM-T310X|SM-T210|SM-T210R|SM-T211|SM-P600|SM-P601|SM-P605|SM-P900|SM-P901|SM-T217|SM-T217A|SM-T217S|SM-P6000|SM-T3100|SGH-I467|XE500|SM-T110|GT-P5220|GT-I9200X|GT-N5110X|GT-N5120|SM-P905|SM-T111|SM-T2105|SM-T315|SM-T320|SM-T320X|SM-T321|SM-T520|SM-T525|SM-T530NU|SM-T230NU|SM-T330NU|SM-T900|XE500T1C|SM-P605V|SM-P905V|SM-T337V|SM-T537V|SM-T707V|SM-T807V|SM-P600X|SM-P900X|SM-T210X|SM-T230|SM-T230X|SM-T325|GT-P7503|SM-T531|SM-T330|SM-T530|SM-T705|SM-T705C|SM-T535|SM-T331|SM-T800|SM-T700|SM-T537|SM-T807|SM-P907A|SM-T337A|SM-T537A|SM-T707A|SM-T807A|SM-T237|SM-T807P|SM-P607T|SM-T217T|SM-T337T|SM-T807T|SM-T116NQ|SM-T116BU|SM-P550|SM-T350|SM-T550|SM-T9000|SM-P9000|SM-T705Y|SM-T805|GT-P3113|SM-T710|SM-T810|SM-T815|SM-T360|SM-T533|SM-T113|SM-T335|SM-T715|SM-T560|SM-T670|SM-T677|SM-T377|SM-T567|SM-T357T|SM-T555|SM-T561|SM-T713|SM-T719|SM-T813|SM-T819|SM-T580|SM-T355Y?|SM-T280|SM-T817A|SM-T820|SM-W700|SM-P580|SM-T587|SM-P350|SM-P555M|SM-P355M|SM-T113NU|SM-T815Y|SM-T585|SM-T285|SM-T825|SM-W708|SM-T835|SM-T830|SM-T837V|SM-T720|SM-T510|SM-T387V|SM-P610|SM-T290|SM-T515|SM-T590|SM-T595|SM-T725|SM-T817P|SM-P585N0|SM-T395|SM-T295|SM-T865|SM-P610N|SM-P615|SM-T970|SM-T380|SM-T5950|SM-T905|SM-T231|SM-T500|SM-T860|SM-T536|SM-T837A|SM-X200|SM-T220|SM-T870|SM-X906C|SM-X700|SM-X706|SM-X706B|SM-X706U|SM-X706N|SM-X800|SM-X806|SM-X806B|SM-X806U|SM-X806N|SM-X900|SM-X906|SM-X906B|SM-X906U|SM-X906N|SM-P613', // SCH-P709|SCH-P729|SM-T2558|GT-I9205 - Samsung Mega - treat them like a regular phone. // http://docs.aws.amazon.com/silk/latest/developerguide/user-agent.html 'Kindle' => 'Kindle|Silk.*Accelerated|Android.*\b(KFOT|KFTT|KFJWI|KFJWA|KFOTE|KFSOWI|KFTHWI|KFTHWA|KFAPWI|KFAPWA|WFJWAE|KFSAWA|KFSAWI|KFASWI|KFARWI|KFFOWI|KFGIWI|KFMEWI)\b|Android.*Silk/[0-9.]+ like Chrome/[0-9.]+ (?!Mobile)', // Only the Surface tablets with Windows RT are considered mobile. // http://msdn.microsoft.com/en-us/library/ie/hh920767(v=vs.85).aspx 'SurfaceTablet' => 'Windows NT [0-9.]+; ARM;.*(Tablet|ARMBJS)', // http://shopping1.hp.com/is-bin/INTERSHOP.enfinity/WFS/WW-USSMBPublicStore-Site/en_US/-/USD/ViewStandardCatalog-Browse?CatalogCategoryID=JfIQ7EN5lqMAAAEyDcJUDwMT 'HPTablet' => 'HP Slate (7|8|10)|HP ElitePad 900|hp-tablet|EliteBook.*Touch|HP 8|Slate 21|HP SlateBook 10', // Watch out for PadFone, see #132. // http://www.asus.com/de/Tablets_Mobile/Memo_Pad_Products/ 'AsusTablet' => '^.*PadFone((?!Mobile).)*$|Transformer|TF101|TF101G|TF300T|TF300TG|TF300TL|TF700T|TF700KL|TF701T|TF810C|ME171|ME301T|ME302C|ME371MG|ME370T|ME372MG|ME172V|ME173X|ME400C|Slider SL101|\bK00F\b|\bK00C\b|\bK00E\b|\bK00L\b|TX201LA|ME176C|ME102A|\bM80TA\b|ME372CL|ME560CG|ME372CG|ME302KL| K01A | K010 | K011 | K017 | K01E |ME572C|ME103K|ME170C|ME171C|\bME70C\b|ME581C|ME581CL|ME8510C|ME181C|P01Y|PO1MA|P01Z|\bP027\b|\bP024\b|\bP00C\b', 'BlackBerryTablet' => 'PlayBook|RIM Tablet', 'HTCtablet' => 'HTC_Flyer_P512|HTC Flyer|HTC Jetstream|HTC-P715a|HTC EVO View 4G|PG41200|PG09410', 'MotorolaTablet' => 'xoom|sholest|MZ615|MZ605|MZ505|MZ601|MZ602|MZ603|MZ604|MZ606|MZ607|MZ608|MZ609|MZ615|MZ616|MZ617', 'NookTablet' => 'Android.*Nook|NookColor|nook browser|BNRV200|BNRV200A|BNTV250|BNTV250A|BNTV400|BNTV600|LogicPD Zoom2', // http://www.acer.ro/ac/ro/RO/content/drivers // http://www.packardbell.co.uk/pb/en/GB/content/download (Packard Bell is part of Acer) // http://us.acer.com/ac/en/US/content/group/tablets // http://www.acer.de/ac/de/DE/content/models/tablets/ // Can conflict with Micromax and Motorola phones codes. 'AcerTablet' => 'Android.*; \b(A100|A101|A110|A200|A210|A211|A500|A501|A510|A511|A700|A701|W500|W500P|W501|W501P|W510|W511|W700|G100|G100W|B1-A71|B1-710|B1-711|A1-810|A1-811|A1-830)\b|W3-810|\bA3-A10\b|\bA3-A11\b|\bA3-A20\b|\bA3-A30|A3-A40', // http://eu.computers.toshiba-europe.com/innovation/family/Tablets/1098744/banner_id/tablet_footerlink/ // http://us.toshiba.com/tablets/tablet-finder // http://www.toshiba.co.jp/regza/tablet/ 'ToshibaTablet' => 'Android.*(AT100|AT105|AT200|AT205|AT270|AT275|AT300|AT305|AT1S5|AT500|AT570|AT700|AT830)|TOSHIBA.*FOLIO', // http://www.nttdocomo.co.jp/english/service/developer/smart_phone/technical_info/spec/index.html // http://www.lg.com/us/tablets 'LGTablet' => '\bL-06C|LG-V909|LG-V900|LG-V700|LG-V510|LG-V500|LG-V410|LG-V400|LG-VK810\b', 'FujitsuTablet' => 'Android.*\b(F-01D|F-02F|F-05E|F-10D|M532|Q572)\b', // Prestigio Tablets http://www.prestigio.com/support 'PrestigioTablet' => 'PMP3170B|PMP3270B|PMP3470B|PMP7170B|PMP3370B|PMP3570C|PMP5870C|PMP3670B|PMP5570C|PMP5770D|PMP3970B|PMP3870C|PMP5580C|PMP5880D|PMP5780D|PMP5588C|PMP7280C|PMP7280C3G|PMP7280|PMP7880D|PMP5597D|PMP5597|PMP7100D|PER3464|PER3274|PER3574|PER3884|PER5274|PER5474|PMP5097CPRO|PMP5097|PMP7380D|PMP5297C|PMP5297C_QUAD|PMP812E|PMP812E3G|PMP812F|PMP810E|PMP880TD|PMT3017|PMT3037|PMT3047|PMT3057|PMT7008|PMT5887|PMT5001|PMT5002', // http://support.lenovo.com/en_GB/downloads/default.page?# 'LenovoTablet' => 'Lenovo TAB|Idea(Tab|Pad)( A1|A10| K1|)|ThinkPad([ ]+)?Tablet|YT3-850M|YT3-X90L|YT3-X90F|YT3-X90X|Lenovo.*(S2109|S2110|S5000|S6000|K3011|A3000|A3500|A1000|A2107|A2109|A1107|A5500|A7600|B6000|B8000|B8080)(-|)(FL|F|HV|H|)|TB-X103F|TB-X304X|TB-X304F|TB-X304L|TB-X505F|TB-X505L|TB-X505X|TB-X605F|TB-X605L|TB-8703F|TB-8703X|TB-8703N|TB-8704N|TB-8704F|TB-8704X|TB-8704V|TB-7304F|TB-7304I|TB-7304X|Tab2A7-10F|Tab2A7-20F|TB2-X30L|YT3-X50L|YT3-X50F|YT3-X50M|YT-X705F|YT-X703F|YT-X703L|YT-X705L|YT-X705X|TB2-X30F|TB2-X30L|TB2-X30M|A2107A-F|A2107A-H|TB3-730F|TB3-730M|TB3-730X|TB-7504F|TB-7504X|TB-X704F|TB-X104F|TB3-X70F|TB-X705F|TB-8504F|TB3-X70L|TB3-710F|TB-X704L|TB-J606F|TB-X606F|TB-X306X|YT-J706X|TB128FU', // http://www.dell.com/support/home/us/en/04/Products/tab_mob/tablets 'DellTablet' => 'Venue 11|Venue 8|Venue 7|Dell Streak 10|Dell Streak 7', 'XiaomiTablet' => '21051182G', // http://www.yarvik.com/en/matrix/tablets/ 'YarvikTablet' => 'Android.*\b(TAB210|TAB211|TAB224|TAB250|TAB260|TAB264|TAB310|TAB360|TAB364|TAB410|TAB411|TAB420|TAB424|TAB450|TAB460|TAB461|TAB464|TAB465|TAB467|TAB468|TAB07-100|TAB07-101|TAB07-150|TAB07-151|TAB07-152|TAB07-200|TAB07-201-3G|TAB07-210|TAB07-211|TAB07-212|TAB07-214|TAB07-220|TAB07-400|TAB07-485|TAB08-150|TAB08-200|TAB08-201-3G|TAB08-201-30|TAB09-100|TAB09-211|TAB09-410|TAB10-150|TAB10-201|TAB10-211|TAB10-400|TAB10-410|TAB13-201|TAB274EUK|TAB275EUK|TAB374EUK|TAB462EUK|TAB474EUK|TAB9-200)\b', 'MedionTablet' => 'Android.*\bOYO\b|LIFE.*(P9212|P9514|P9516|S9512)|LIFETAB', 'ArnovaTablet' => '97G4|AN10G2|AN7bG3|AN7fG3|AN8G3|AN8cG3|AN7G3|AN9G3|AN7dG3|AN7dG3ST|AN7dG3ChildPad|AN10bG3|AN10bG3DT|AN9G2', // http://www.intenso.de/kategorie_en.php?kategorie=33 // @todo: http://www.nbhkdz.com/read/b8e64202f92a2df129126bff.html - investigate 'IntensoTablet' => 'INM8002KP|INM1010FP|INM805ND|Intenso Tab|TAB1004', // IRU.ru Tablets http://www.iru.ru/catalog/soho/planetable/ 'IRUTablet' => 'M702pro', 'MegafonTablet' => 'MegaFon V9|\bZTE V9\b|Android.*\bMT7A\b', // http://www.e-boda.ro/tablete-pc.html 'EbodaTablet' => 'E-Boda (Supreme|Impresspeed|Izzycomm|Essential)', // http://www.allview.ro/produse/droseries/lista-tablete-pc/ 'AllViewTablet' => 'Allview.*(Viva|Alldro|City|Speed|All TV|Frenzy|Quasar|Shine|TX1|AX1|AX2)', // http://wiki.archosfans.com/index.php?title=Main_Page // @note Rewrite the regex format after we add more UAs. 'ArchosTablet' => '\b(101G9|80G9|A101IT)\b|Qilive 97R|Archos5|\bARCHOS (70|79|80|90|97|101|FAMILYPAD|)(b|c|)(G10| Cobalt| TITANIUM(HD|)| Xenon| Neon|XSK| 2| XS 2| PLATINUM| CARBON|GAMEPAD)\b', // http://www.ainol.com/plugin.php?identifier=ainol&module=product 'AinolTablet' => 'NOVO7|NOVO8|NOVO10|Novo7Aurora|Novo7Basic|NOVO7PALADIN|novo9-Spark', 'NokiaLumiaTablet' => 'Lumia 2520', // @todo: inspect http://esupport.sony.com/US/p/select-system.pl?DIRECTOR=DRIVER // Readers http://www.atsuhiro-me.net/ebook/sony-reader/sony-reader-web-browser // http://www.sony.jp/support/tablet/ 'SonyTablet' => 'Sony.*Tablet|Xperia Tablet|Sony Tablet S|SO-03E|SGPT12|SGPT13|SGPT114|SGPT121|SGPT122|SGPT123|SGPT111|SGPT112|SGPT113|SGPT131|SGPT132|SGPT133|SGPT211|SGPT212|SGPT213|SGP311|SGP312|SGP321|EBRD1101|EBRD1102|EBRD1201|SGP351|SGP341|SGP511|SGP512|SGP521|SGP541|SGP551|SGP621|SGP641|SGP612|SOT31|SGP771|SGP611|SGP612|SGP712', // http://www.support.philips.com/support/catalog/worldproducts.jsp?userLanguage=en&userCountry=cn&categoryid=3G_LTE_TABLET_SU_CN_CARE&title=3G%20tablets%20/%20LTE%20range&_dyncharset=UTF-8 'PhilipsTablet' => '\b(PI2010|PI3000|PI3100|PI3105|PI3110|PI3205|PI3210|PI3900|PI4010|PI7000|PI7100)\b', // db + http://www.cube-tablet.com/buy-products.html 'CubeTablet' => 'Android.*(K8GT|U9GT|U10GT|U16GT|U17GT|U18GT|U19GT|U20GT|U23GT|U30GT)|CUBE U8GT', // http://www.cobyusa.com/?p=pcat&pcat_id=3001 'CobyTablet' => 'MID1042|MID1045|MID1125|MID1126|MID7012|MID7014|MID7015|MID7034|MID7035|MID7036|MID7042|MID7048|MID7127|MID8042|MID8048|MID8127|MID9042|MID9740|MID9742|MID7022|MID7010', // http://www.match.net.cn/products.asp 'MIDTablet' => 'M9701|M9000|M9100|M806|M1052|M806|T703|MID701|MID713|MID710|MID727|MID760|MID830|MID728|MID933|MID125|MID810|MID732|MID120|MID930|MID800|MID731|MID900|MID100|MID820|MID735|MID980|MID130|MID833|MID737|MID960|MID135|MID860|MID736|MID140|MID930|MID835|MID733|MID4X10', // http://www.msi.com/support // @todo Research the Windows Tablets. 'MSITablet' => 'MSI \b(Primo 73K|Primo 73L|Primo 81L|Primo 77|Primo 93|Primo 75|Primo 76|Primo 73|Primo 81|Primo 91|Primo 90|Enjoy 71|Enjoy 7|Enjoy 10)\b', // @todo http://www.kyoceramobile.com/support/drivers/ // 'KyoceraTablet' => null, // @todo http://intexuae.com/index.php/category/mobile-devices/tablets-products/ // 'IntextTablet' => null, // http://pdadb.net/index.php?m=pdalist&list=SMiT (NoName Chinese Tablets) // http://www.imp3.net/14/show.php?itemid=20454 'SMiTTablet' => 'Android.*(\bMID\b|MID-560|MTV-T1200|MTV-PND531|MTV-P1101|MTV-PND530)', // http://www.rock-chips.com/index.php?do=prod&pid=2 'RockChipTablet' => 'Android.*(RK2818|RK2808A|RK2918|RK3066)|RK2738|RK2808A', // http://www.fly-phone.com/devices/tablets/ ; http://www.fly-phone.com/service/ 'FlyTablet' => 'IQ310|Fly Vision', // http://www.bqreaders.com/gb/tablets-prices-sale.html 'bqTablet' => 'Android.*(bq)?.*\b(Elcano|Curie|Edison|Maxwell|Kepler|Pascal|Tesla|Hypatia|Platon|Newton|Livingstone|Cervantes|Avant|Aquaris ([E|M]10|M8))\b|Maxwell.*Lite|Maxwell.*Plus', // http://www.huaweidevice.com/worldwide/productFamily.do?method=index&directoryId=5011&treeId=3290 // http://www.huaweidevice.com/worldwide/downloadCenter.do?method=index&directoryId=3372&treeId=0&tb=1&type=software (including legacy tablets) 'HuaweiTablet' => 'MediaPad|MediaPad 7 Youth|IDEOS S7|S7-201c|S7-202u|S7-101|S7-103|S7-104|S7-105|S7-106|S7-201|S7-Slim|M2-A01L|BAH-L09|BAH-W09|AGS-L09|CMR-AL19|KOB2-L09|BG2-U01|BG2-W09|BG2-U03', // Nec or Medias Tab 'NecTablet' => '\bN-06D|\bN-08D', // Pantech Tablets: http://www.pantechusa.com/phones/ 'PantechTablet' => 'Pantech.*P4100', // Broncho Tablets: http://www.broncho.cn/ (hard to find) 'BronchoTablet' => 'Broncho.*(N701|N708|N802|a710)', // http://versusuk.com/support.html 'VersusTablet' => 'TOUCHPAD.*[78910]|\bTOUCHTAB\b', // http://www.zync.in/index.php/our-products/tablet-phablets 'ZyncTablet' => 'z1000|Z99 2G|z930|z990|z909|Z919|z900', // Removed "z999" because of https://github.com/serbanghita/Mobile-Detect/issues/717 // http://www.positivoinformatica.com.br/www/pessoal/tablet-ypy/ 'PositivoTablet' => 'TB07STA|TB10STA|TB07FTA|TB10FTA', // https://www.nabitablet.com/ 'NabiTablet' => 'Android.*\bNabi', 'KoboTablet' => 'Kobo Touch|\bK080\b|\bVox\b Build|\bArc\b Build', // French Danew Tablets http://www.danew.com/produits-tablette.php 'DanewTablet' => 'DSlide.*\b(700|701R|702|703R|704|802|970|971|972|973|974|1010|1012)\b', // Texet Tablets and Readers http://www.texet.ru/tablet/ 'TexetTablet' => 'NaviPad|TB-772A|TM-7045|TM-7055|TM-9750|TM-7016|TM-7024|TM-7026|TM-7041|TM-7043|TM-7047|TM-8041|TM-9741|TM-9747|TM-9748|TM-9751|TM-7022|TM-7021|TM-7020|TM-7011|TM-7010|TM-7023|TM-7025|TM-7037W|TM-7038W|TM-7027W|TM-9720|TM-9725|TM-9737W|TM-1020|TM-9738W|TM-9740|TM-9743W|TB-807A|TB-771A|TB-727A|TB-725A|TB-719A|TB-823A|TB-805A|TB-723A|TB-715A|TB-707A|TB-705A|TB-709A|TB-711A|TB-890HD|TB-880HD|TB-790HD|TB-780HD|TB-770HD|TB-721HD|TB-710HD|TB-434HD|TB-860HD|TB-840HD|TB-760HD|TB-750HD|TB-740HD|TB-730HD|TB-722HD|TB-720HD|TB-700HD|TB-500HD|TB-470HD|TB-431HD|TB-430HD|TB-506|TB-504|TB-446|TB-436|TB-416|TB-146SE|TB-126SE', // Avoid detecting 'PLAYSTATION 3' as mobile. 'PlaystationTablet' => 'Playstation.*(Portable|Vita)', // http://www.trekstor.de/surftabs.html 'TrekstorTablet' => 'ST10416-1|VT10416-1|ST70408-1|ST702xx-1|ST702xx-2|ST80208|ST97216|ST70104-2|VT10416-2|ST10216-2A|SurfTab', // http://www.pyleaudio.com/Products.aspx?%2fproducts%2fPersonal-Electronics%2fTablets 'PyleAudioTablet' => '\b(PTBL10CEU|PTBL10C|PTBL72BC|PTBL72BCEU|PTBL7CEU|PTBL7C|PTBL92BC|PTBL92BCEU|PTBL9CEU|PTBL9CUK|PTBL9C)\b', // http://www.advandigital.com/index.php?link=content-product&jns=JP001 // because of the short codenames we have to include whitespaces to reduce the possible conflicts. 'AdvanTablet' => 'Android.* \b(E3A|T3X|T5C|T5B|T3E|T3C|T3B|T1J|T1F|T2A|T1H|T1i|E1C|T1-E|T5-A|T4|E1-B|T2Ci|T1-B|T1-D|O1-A|E1-A|T1-A|T3A|T4i)\b ', // http://www.danytech.com/category/tablet-pc 'DanyTechTablet' => 'Genius Tab G3|Genius Tab S2|Genius Tab Q3|Genius Tab G4|Genius Tab Q4|Genius Tab G-II|Genius TAB GII|Genius TAB GIII|Genius Tab S1', // http://www.galapad.net/product.html ; https://github.com/serbanghita/Mobile-Detect/issues/761 'GalapadTablet' => 'Android [0-9.]+; [a-z-]+; \bG1\b', // http://www.micromaxinfo.com/tablet/funbook 'MicromaxTablet' => 'Funbook|Micromax.*\b(P250|P560|P360|P362|P600|P300|P350|P500|P275)\b', // http://www.karbonnmobiles.com/products_tablet.php 'KarbonnTablet' => 'Android.*\b(A39|A37|A34|ST8|ST10|ST7|Smart Tab3|Smart Tab2)\b', // http://www.myallfine.com/Products.asp 'AllFineTablet' => 'Fine7 Genius|Fine7 Shine|Fine7 Air|Fine8 Style|Fine9 More|Fine10 Joy|Fine11 Wide', // http://www.proscanvideo.com/products-search.asp?itemClass=TABLET&itemnmbr= 'PROSCANTablet' => '\b(PEM63|PLT1023G|PLT1041|PLT1044|PLT1044G|PLT1091|PLT4311|PLT4311PL|PLT4315|PLT7030|PLT7033|PLT7033D|PLT7035|PLT7035D|PLT7044K|PLT7045K|PLT7045KB|PLT7071KG|PLT7072|PLT7223G|PLT7225G|PLT7777G|PLT7810K|PLT7849G|PLT7851G|PLT7852G|PLT8015|PLT8031|PLT8034|PLT8036|PLT8080K|PLT8082|PLT8088|PLT8223G|PLT8234G|PLT8235G|PLT8816K|PLT9011|PLT9045K|PLT9233G|PLT9735|PLT9760G|PLT9770G)\b', // http://www.yonesnav.com/products/products.php 'YONESTablet' => 'BQ1078|BC1003|BC1077|RK9702|BC9730|BC9001|IT9001|BC7008|BC7010|BC708|BC728|BC7012|BC7030|BC7027|BC7026', // http://www.cjshowroom.com/eproducts.aspx?classcode=004001001 // China manufacturer makes tablets for different small brands (eg. http://www.zeepad.net/index.html) 'ChangJiaTablet' => 'TPC7102|TPC7103|TPC7105|TPC7106|TPC7107|TPC7201|TPC7203|TPC7205|TPC7210|TPC7708|TPC7709|TPC7712|TPC7110|TPC8101|TPC8103|TPC8105|TPC8106|TPC8203|TPC8205|TPC8503|TPC9106|TPC9701|TPC97101|TPC97103|TPC97105|TPC97106|TPC97111|TPC97113|TPC97203|TPC97603|TPC97809|TPC97205|TPC10101|TPC10103|TPC10106|TPC10111|TPC10203|TPC10205|TPC10503', // http://www.gloryunion.cn/products.asp // http://www.allwinnertech.com/en/apply/mobile.html // http://www.ptcl.com.pk/pd_content.php?pd_id=284 (EVOTAB) // @todo: Softwiner tablets? // aka. Cute or Cool tablets. Not sure yet, must research to avoid collisions. 'GUTablet' => 'TX-A1301|TX-M9002|Q702|kf026', // A12R|D75A|D77|D79|R83|A95|A106C|R15|A75|A76|D71|D72|R71|R73|R77|D82|R85|D92|A97|D92|R91|A10F|A77F|W71F|A78F|W78F|W81F|A97F|W91F|W97F|R16G|C72|C73E|K72|K73|R96G // http://www.pointofview-online.com/showroom.php?shop_mode=product_listing&category_id=118 'PointOfViewTablet' => 'TAB-P506|TAB-navi-7-3G-M|TAB-P517|TAB-P-527|TAB-P701|TAB-P703|TAB-P721|TAB-P731N|TAB-P741|TAB-P825|TAB-P905|TAB-P925|TAB-PR945|TAB-PL1015|TAB-P1025|TAB-PI1045|TAB-P1325|TAB-PROTAB[0-9]+|TAB-PROTAB25|TAB-PROTAB26|TAB-PROTAB27|TAB-PROTAB26XL|TAB-PROTAB2-IPS9|TAB-PROTAB30-IPS9|TAB-PROTAB25XXL|TAB-PROTAB26-IPS10|TAB-PROTAB30-IPS10', // http://www.overmax.pl/pl/katalog-produktow,p8/tablety,c14/ // @todo: add more tests. 'OvermaxTablet' => 'OV-(SteelCore|NewBase|Basecore|Baseone|Exellen|Quattor|EduTab|Solution|ACTION|BasicTab|TeddyTab|MagicTab|Stream|TB-08|TB-09)|Qualcore 1027', // http://hclmetablet.com/India/index.php 'HCLTablet' => 'HCL.*Tablet|Connect-3G-2.0|Connect-2G-2.0|ME Tablet U1|ME Tablet U2|ME Tablet G1|ME Tablet X1|ME Tablet Y2|ME Tablet Sync', // http://www.edigital.hu/Tablet_es_e-book_olvaso/Tablet-c18385.html 'DPSTablet' => 'DPS Dream 9|DPS Dual 7', // http://www.visture.com/index.asp 'VistureTablet' => 'V97 HD|i75 3G|Visture V4( HD)?|Visture V5( HD)?|Visture V10', // http://www.mijncresta.nl/tablet 'CrestaTablet' => 'CTP(-)?810|CTP(-)?818|CTP(-)?828|CTP(-)?838|CTP(-)?888|CTP(-)?978|CTP(-)?980|CTP(-)?987|CTP(-)?988|CTP(-)?989', // MediaTek - http://www.mediatek.com/_en/01_products/02_proSys.php?cata_sn=1&cata1_sn=1&cata2_sn=309 'MediatekTablet' => '\bMT8125|MT8389|MT8135|MT8377\b', // Concorde tab 'ConcordeTablet' => 'Concorde([ ]+)?Tab|ConCorde ReadMan', // GoClever Tablets - http://www.goclever.com/uk/products,c1/tablet,c5/ 'GoCleverTablet' => 'GOCLEVER TAB|A7GOCLEVER|M1042|M7841|M742|R1042BK|R1041|TAB A975|TAB A7842|TAB A741|TAB A741L|TAB M723G|TAB M721|TAB A1021|TAB I921|TAB R721|TAB I720|TAB T76|TAB R70|TAB R76.2|TAB R106|TAB R83.2|TAB M813G|TAB I721|GCTA722|TAB I70|TAB I71|TAB S73|TAB R73|TAB R74|TAB R93|TAB R75|TAB R76.1|TAB A73|TAB A93|TAB A93.2|TAB T72|TAB R83|TAB R974|TAB R973|TAB A101|TAB A103|TAB A104|TAB A104.2|R105BK|M713G|A972BK|TAB A971|TAB R974.2|TAB R104|TAB R83.3|TAB A1042', // Modecom Tablets - http://www.modecom.eu/tablets/portal/ 'ModecomTablet' => 'FreeTAB 9000|FreeTAB 7.4|FreeTAB 7004|FreeTAB 7800|FreeTAB 2096|FreeTAB 7.5|FreeTAB 1014|FreeTAB 1001 |FreeTAB 8001|FreeTAB 9706|FreeTAB 9702|FreeTAB 7003|FreeTAB 7002|FreeTAB 1002|FreeTAB 7801|FreeTAB 1331|FreeTAB 1004|FreeTAB 8002|FreeTAB 8014|FreeTAB 9704|FreeTAB 1003', // Vonino Tablets 'VoninoTablet' => '\b(Argus[ _]?S|Diamond[ _]?79HD|Emerald[ _]?78E|Luna[ _]?70C|Onyx[ _]?S|Onyx[ _]?Z|Orin[ _]?HD|Orin[ _]?S|Otis[ _]?S|SpeedStar[ _]?S|Magnet[ _]?M9|Primus[ _]?94[ _]?3G|Primus[ _]?94HD|Primus[ _]?QS|Android.*\bQ8\b|Sirius[ _]?EVO[ _]?QS|Sirius[ _]?QS|Spirit[ _]?S)\b', // ECS Tablets - http://www.ecs.com.tw/ECSWebSite/Product/Product_Tablet_List.aspx?CategoryID=14&MenuID=107&childid=M_107&LanID=0 'ECSTablet' => 'V07OT2|TM105A|S10OT1|TR10CS1', // Storex Tablets - http://storex.fr/espace_client/support.html // @note: no need to add all the tablet codes since they are guided by the first regex. 'StorexTablet' => 'eZee[_\']?(Tab|Go)[0-9]+|TabLC7|Looney Tunes Tab', // Generic Vodafone tablets. 'VodafoneTablet' => 'SmartTab([ ]+)?[0-9]+|SmartTabII10|SmartTabII7|VF-1497|VFD 1400', // French tablets - Essentiel B http://www.boulanger.fr/tablette_tactile_e-book/tablette_tactile_essentiel_b/cl_68908.htm?multiChoiceToDelete=brand&mc_brand=essentielb // Aka: http://www.essentielb.fr/ 'EssentielBTablet' => 'Smart[ \']?TAB[ ]+?[0-9]+|Family[ \']?TAB2', // Ross & Moor - http://ross-moor.ru/ 'RossMoorTablet' => 'RM-790|RM-997|RMD-878G|RMD-974R|RMT-705A|RMT-701|RME-601|RMT-501|RMT-711', // i-mobile http://product.i-mobilephone.com/Mobile_Device 'iMobileTablet' => 'i-mobile i-note', // http://www.tolino.de/de/vergleichen/ 'TolinoTablet' => 'tolino tab [0-9.]+|tolino shine', // AudioSonic - a Kmart brand // http://www.kmart.com.au/webapp/wcs/stores/servlet/Search?langId=-1&storeId=10701&catalogId=10001&categoryId=193001&pageSize=72¤tPage=1&searchCategory=193001%2b4294965664&sortBy=p_MaxPrice%7c1 'AudioSonicTablet' => '\bC-22Q|T7-QC|T-17B|T-17P\b', // AMPE Tablets - http://www.ampe.com.my/product-category/tablets/ // @todo: add them gradually to avoid conflicts. 'AMPETablet' => 'Android.* A78 ', // Skk Mobile - http://skkmobile.com.ph/product_tablets.php 'SkkTablet' => 'Android.* (SKYPAD|PHOENIX|CYCLOPS)', // Tecno Mobile (only tablet) - http://www.tecno-mobile.com/index.php/product?filterby=smart&list_order=all&page=1 'TecnoTablet' => 'TECNO P9|TECNO DP8D', // JXD (consoles & tablets) - http://jxd.hk/products.asp?selectclassid=009008&clsid=3 'JXDTablet' => 'Android.* \b(F3000|A3300|JXD5000|JXD3000|JXD2000|JXD300B|JXD300|S5800|S7800|S602b|S5110b|S7300|S5300|S602|S603|S5100|S5110|S601|S7100a|P3000F|P3000s|P101|P200s|P1000m|P200m|P9100|P1000s|S6600b|S908|P1000|P300|S18|S6600|S9100)\b', // i-Joy tablets - http://www.i-joy.es/en/cat/products/tablets/ 'iJoyTablet' => 'Tablet (Spirit 7|Essentia|Galatea|Fusion|Onix 7|Landa|Titan|Scooby|Deox|Stella|Themis|Argon|Unique 7|Sygnus|Hexen|Finity 7|Cream|Cream X2|Jade|Neon 7|Neron 7|Kandy|Scape|Saphyr 7|Rebel|Biox|Rebel|Rebel 8GB|Myst|Draco 7|Myst|Tab7-004|Myst|Tadeo Jones|Tablet Boing|Arrow|Draco Dual Cam|Aurix|Mint|Amity|Revolution|Finity 9|Neon 9|T9w|Amity 4GB Dual Cam|Stone 4GB|Stone 8GB|Andromeda|Silken|X2|Andromeda II|Halley|Flame|Saphyr 9,7|Touch 8|Planet|Triton|Unique 10|Hexen 10|Memphis 4GB|Memphis 8GB|Onix 10)', // http://www.intracon.eu/tablet 'FX2Tablet' => 'FX2 PAD7|FX2 PAD10', // http://www.xoro.de/produkte/ // @note: Might be the same brand with 'Simply tablets' 'XoroTablet' => 'KidsPAD 701|PAD[ ]?712|PAD[ ]?714|PAD[ ]?716|PAD[ ]?717|PAD[ ]?718|PAD[ ]?720|PAD[ ]?721|PAD[ ]?722|PAD[ ]?790|PAD[ ]?792|PAD[ ]?900|PAD[ ]?9715D|PAD[ ]?9716DR|PAD[ ]?9718DR|PAD[ ]?9719QR|PAD[ ]?9720QR|TelePAD1030|Telepad1032|TelePAD730|TelePAD731|TelePAD732|TelePAD735Q|TelePAD830|TelePAD9730|TelePAD795|MegaPAD 1331|MegaPAD 1851|MegaPAD 2151', // http://www1.viewsonic.com/products/computing/tablets/ 'ViewsonicTablet' => 'ViewPad 10pi|ViewPad 10e|ViewPad 10s|ViewPad E72|ViewPad7|ViewPad E100|ViewPad 7e|ViewSonic VB733|VB100a', // https://www.verizonwireless.com/tablets/verizon/ 'VerizonTablet' => 'QTAQZ3|QTAIR7|QTAQTZ3|QTASUN1|QTASUN2|QTAXIA1', // http://www.odys.de/web/internet-tablet_en.html 'OdysTablet' => 'LOOX|XENO10|ODYS[ -](Space|EVO|Xpress|NOON)|\bXELIO\b|Xelio10Pro|XELIO7PHONETAB|XELIO10EXTREME|XELIOPT2|NEO_QUAD10', // http://www.captiva-power.de/products.html#tablets-en 'CaptivaTablet' => 'CAPTIVA PAD', // IconBIT - http://www.iconbit.com/products/tablets/ 'IconbitTablet' => 'NetTAB|NT-3702|NT-3702S|NT-3702S|NT-3603P|NT-3603P|NT-0704S|NT-0704S|NT-3805C|NT-3805C|NT-0806C|NT-0806C|NT-0909T|NT-0909T|NT-0907S|NT-0907S|NT-0902S|NT-0902S', // http://www.teclast.com/topic.php?channelID=70&topicID=140&pid=63 'TeclastTablet' => 'T98 4G|\bP80\b|\bX90HD\b|X98 Air|X98 Air 3G|\bX89\b|P80 3G|\bX80h\b|P98 Air|\bX89HD\b|P98 3G|\bP90HD\b|P89 3G|X98 3G|\bP70h\b|P79HD 3G|G18d 3G|\bP79HD\b|\bP89s\b|\bA88\b|\bP10HD\b|\bP19HD\b|G18 3G|\bP78HD\b|\bA78\b|\bP75\b|G17s 3G|G17h 3G|\bP85t\b|\bP90\b|\bP11\b|\bP98t\b|\bP98HD\b|\bG18d\b|\bP85s\b|\bP11HD\b|\bP88s\b|\bA80HD\b|\bA80se\b|\bA10h\b|\bP89\b|\bP78s\b|\bG18\b|\bP85\b|\bA70h\b|\bA70\b|\bG17\b|\bP18\b|\bA80s\b|\bA11s\b|\bP88HD\b|\bA80h\b|\bP76s\b|\bP76h\b|\bP98\b|\bA10HD\b|\bP78\b|\bP88\b|\bA11\b|\bA10t\b|\bP76a\b|\bP76t\b|\bP76e\b|\bP85HD\b|\bP85a\b|\bP86\b|\bP75HD\b|\bP76v\b|\bA12\b|\bP75a\b|\bA15\b|\bP76Ti\b|\bP81HD\b|\bA10\b|\bT760VE\b|\bT720HD\b|\bP76\b|\bP73\b|\bP71\b|\bP72\b|\bT720SE\b|\bC520Ti\b|\bT760\b|\bT720VE\b|T720-3GE|T720-WiFi', // Onda - http://www.onda-tablet.com/buy-android-onda.html?dir=desc&limit=all&order=price 'OndaTablet' => '\b(V975i|Vi30|VX530|V701|Vi60|V701s|Vi50|V801s|V719|Vx610w|VX610W|V819i|Vi10|VX580W|Vi10|V711s|V813|V811|V820w|V820|Vi20|V711|VI30W|V712|V891w|V972|V819w|V820w|Vi60|V820w|V711|V813s|V801|V819|V975s|V801|V819|V819|V818|V811|V712|V975m|V101w|V961w|V812|V818|V971|V971s|V919|V989|V116w|V102w|V973|Vi40)\b[\s]+|V10 \b4G\b', 'JaytechTablet' => 'TPC-PA762', 'BlaupunktTablet' => 'Endeavour 800NG|Endeavour 1010', // http://www.digma.ru/support/download/ // @todo: Ebooks also (if requested) 'DigmaTablet' => '\b(iDx10|iDx9|iDx8|iDx7|iDxD7|iDxD8|iDsQ8|iDsQ7|iDsQ8|iDsD10|iDnD7|3TS804H|iDsQ11|iDj7|iDs10)\b', // http://www.evolioshop.com/ro/tablete-pc.html // http://www.evolio.ro/support/downloads_static.html?cat=2 // @todo: Research some more 'EvolioTablet' => 'ARIA_Mini_wifi|Aria[ _]Mini|Evolio X10|Evolio X7|Evolio X8|\bEvotab\b|\bNeura\b', // @todo http://www.lavamobiles.com/tablets-data-cards 'LavaTablet' => 'QPAD E704|\bIvoryS\b|E-TAB IVORY|\bE-TAB\b', // http://www.breezetablet.com/ 'AocTablet' => 'MW0811|MW0812|MW0922|MTK8382|MW1031|MW0831|MW0821|MW0931|MW0712', // http://www.mpmaneurope.com/en/products/internet-tablets-14/android-tablets-14/ 'MpmanTablet' => 'MP11 OCTA|MP10 OCTA|MPQC1114|MPQC1004|MPQC994|MPQC974|MPQC973|MPQC804|MPQC784|MPQC780|\bMPG7\b|MPDCG75|MPDCG71|MPDC1006|MP101DC|MPDC9000|MPDC905|MPDC706HD|MPDC706|MPDC705|MPDC110|MPDC100|MPDC99|MPDC97|MPDC88|MPDC8|MPDC77|MP709|MID701|MID711|MID170|MPDC703|MPQC1010', // https://www.celkonmobiles.com/?_a=categoryphones&sid=2 'CelkonTablet' => 'CT695|CT888|CT[\s]?910|CT7 Tab|CT9 Tab|CT3 Tab|CT2 Tab|CT1 Tab|C820|C720|\bCT-1\b', // http://www.wolderelectronics.com/productos/manuales-y-guias-rapidas/categoria-2-miTab 'WolderTablet' => 'miTab \b(DIAMOND|SPACE|BROOKLYN|NEO|FLY|MANHATTAN|FUNK|EVOLUTION|SKY|GOCAR|IRON|GENIUS|POP|MINT|EPSILON|BROADWAY|JUMP|HOP|LEGEND|NEW AGE|LINE|ADVANCE|FEEL|FOLLOW|LIKE|LINK|LIVE|THINK|FREEDOM|CHICAGO|CLEVELAND|BALTIMORE-GH|IOWA|BOSTON|SEATTLE|PHOENIX|DALLAS|IN 101|MasterChef)\b', 'MediacomTablet' => 'M-MPI10C3G|M-SP10EG|M-SP10EGP|M-SP10HXAH|M-SP7HXAH|M-SP10HXBH|M-SP8HXAH|M-SP8MXA', // http://www.mi.com/en 'MiTablet' => '\bMI PAD\b|\bHM NOTE 1W\b', // http://www.nbru.cn/index.html 'NibiruTablet' => 'Nibiru M1|Nibiru Jupiter One', // http://navroad.com/products/produkty/tablety/ // http://navroad.com/products/produkty/tablety/ 'NexoTablet' => 'NEXO NOVA|NEXO 10|NEXO AVIO|NEXO FREE|NEXO GO|NEXO EVO|NEXO 3G|NEXO SMART|NEXO KIDDO|NEXO MOBI', // http://leader-online.com/new_site/product-category/tablets/ // http://www.leader-online.net.au/List/Tablet 'LeaderTablet' => 'TBLT10Q|TBLT10I|TBL-10WDKB|TBL-10WDKBO2013|TBL-W230V2|TBL-W450|TBL-W500|SV572|TBLT7I|TBA-AC7-8G|TBLT79|TBL-8W16|TBL-10W32|TBL-10WKB|TBL-W100', // http://www.datawind.com/ubislate/ 'UbislateTablet' => 'UbiSlate[\s]?7C', // http://www.pocketbook-int.com/ru/support 'PocketBookTablet' => 'Pocketbook', // http://www.kocaso.com/product_tablet.html 'KocasoTablet' => '\b(TB-1207)\b', // http://global.hisense.com/product/asia/tablet/Sero7/201412/t20141215_91832.htm 'HisenseTablet' => '\b(F5281|E2371)\b', // http://www.tesco.com/direct/hudl/ 'Hudl' => 'Hudl HT7S3|Hudl 2', // http://www.telstra.com.au/home-phone/thub-2/ 'TelstraTablet' => 'T-Hub2', 'GenericTablet' => 'Android.*\b97D\b|Tablet(?!.*PC)|BNTV250A|MID-WCDMA|LogicPD Zoom2|\bA7EB\b|CatNova8|A1_07|CT704|CT1002|\bM721\b|rk30sdk|\bEVOTAB\b|M758A|ET904|ALUMIUM10|Smartfren Tab|Endeavour 1010|Tablet-PC-4|Tagi Tab|\bM6pro\b|CT1020W|arc 10HD|\bTP750\b|\bQTAQZ3\b|WVT101|TM1088|KT107' ]; /** * List of mobile Operating Systems. * * @var array */ protected static array $operatingSystems = [ 'AndroidOS' => 'Android', 'BlackBerryOS' => 'blackberry|\bBB10\b|rim tablet os', 'PalmOS' => 'PalmOS|avantgo|blazer|elaine|hiptop|palm|plucker|xiino', 'SymbianOS' => 'Symbian|SymbOS|Series60|Series40|SYB-[0-9]+|\bS60\b', // @reference: http://en.wikipedia.org/wiki/Windows_Mobile 'WindowsMobileOS' => 'Windows CE.*(PPC|Smartphone|Mobile|[0-9]{3}x[0-9]{3})|Windows Mobile|Windows Phone [0-9.]+|WCE;', // @reference: http://en.wikipedia.org/wiki/Windows_Phone // http://wifeng.cn/?r=blog&a=view&id=106 // http://nicksnettravels.builttoroam.com/post/2011/01/10/Bogus-Windows-Phone-7-User-Agent-String.aspx // http://msdn.microsoft.com/library/ms537503.aspx // https://msdn.microsoft.com/en-us/library/hh869301(v=vs.85).aspx 'WindowsPhoneOS' => 'Windows Phone 10.0|Windows Phone 8.1|Windows Phone 8.0|Windows Phone OS|XBLWP7|ZuneWP7|Windows NT 6.[23]; ARM;', 'iOS' => '\biPhone.*Mobile|\biPod|\biPad|AppleCoreMedia', // https://en.wikipedia.org/wiki/IPadOS 'iPadOS' => 'CPU OS 13', // @reference https://en.m.wikipedia.org/wiki/Sailfish_OS // https://sailfishos.org/ 'SailfishOS' => 'Sailfish', // http://en.wikipedia.org/wiki/MeeGo // @todo: research MeeGo in UAs 'MeeGoOS' => 'MeeGo', // http://en.wikipedia.org/wiki/Maemo // @todo: research Maemo in UAs 'MaemoOS' => 'Maemo', 'JavaOS' => 'J2ME/|\bMIDP\b|\bCLDC\b', // '|Java/' produces bug #135 'webOS' => 'webOS|hpwOS', 'badaOS' => '\bBada\b', 'BREWOS' => 'BREW', ]; /** * List of mobile User Agents. * * IMPORTANT: This is a list of only mobile browsers. * Mobile Detect 2.x supports only mobile browsers, * it was never designed to detect all browsers. * The change will come in 2017 in the 3.x release for PHP7. * * @var array */ protected static array $browsers = [ //'Vivaldi' => 'Vivaldi', // @reference: https://developers.google.com/chrome/mobile/docs/user-agent 'Chrome' => '\bCrMo\b|CriOS.*Mobile|Android.*Chrome/[.0-9]* Mobile', 'Dolfin' => '\bDolfin\b', 'Opera' => 'Opera.*Mini|Opera.*Mobi|Android.*Opera|Mobile.*OPR/[0-9.]+$|Coast/[0-9.]+', 'Skyfire' => 'Skyfire', // Added "Edge on iOS" https://github.com/serbanghita/Mobile-Detect/issues/764 'Edge' => 'EdgiOS.*Mobile|Mobile Safari/[.0-9]* Edge', 'IE' => 'IEMobile|MSIEMobile', // |Trident/[.0-9]+ 'Firefox' => 'fennec|firefox.*maemo|(Mobile|Tablet).*Firefox|Firefox.*Mobile|FxiOS.*Mobile', 'Bolt' => 'bolt', 'TeaShark' => 'teashark', 'Blazer' => 'Blazer', // @reference: http://developer.apple.com/library/safari/#documentation/AppleApplications/Reference/SafariWebContent/OptimizingforSafarioniPhone/OptimizingforSafarioniPhone.html#//apple_ref/doc/uid/TP40006517-SW3 // Excluded "Edge on iOS" https://github.com/serbanghita/Mobile-Detect/issues/764 'Safari' => 'Version((?!\bEdgiOS\b).)*Mobile.*Safari|Safari.*Mobile|MobileSafari', // http://en.wikipedia.org/wiki/Midori_(web_browser) //'Midori' => 'midori', //'Tizen' => 'Tizen', 'WeChat' => '\bMicroMessenger\b', 'UCBrowser' => 'UC.*Browser|UCWEB', 'baiduboxapp' => 'baiduboxapp', 'baidubrowser' => 'baidubrowser', // https://github.com/serbanghita/Mobile-Detect/issues/7 'DiigoBrowser' => 'DiigoBrowser', // http://www.puffinbrowser.com/index.php // https://github.com/serbanghita/Mobile-Detect/issues/752 // 'Puffin' => 'Puffin', // http://mercury-browser.com/index.html 'Mercury' => '\bMercury\b', // http://en.wikipedia.org/wiki/Obigo_Browser 'ObigoBrowser' => 'Obigo', // http://en.wikipedia.org/wiki/NetFront 'NetFront' => 'NF-Browser', // @reference: http://en.wikipedia.org/wiki/Minimo // http://en.wikipedia.org/wiki/Vision_Mobile_Browser 'GenericBrowser' => 'NokiaBrowser|OviBrowser|OneBrowser|TwonkyBeamBrowser|SEMC.*Browser|FlyFlow|Minimo|NetFront|Novarra-Vision|MQQBrowser|MicroMessenger', // @reference: https://en.wikipedia.org/wiki/Pale_Moon_(web_browser) 'PaleMoon' => 'Android.*PaleMoon|Mobile.*PaleMoon', ]; /** * All possible HTTP headers that represent the * User-Agent string. * * @var array */ protected static array $uaHttpHeaders = [ // The default User-Agent string. 'HTTP_USER_AGENT', // Header can occur on devices using Opera Mini. 'HTTP_X_OPERAMINI_PHONE_UA', // Vodafone specific header: http://www.seoprinciple.com/mobile-web-community-still-angry-at-vodafone/24/ 'HTTP_X_DEVICE_USER_AGENT', 'HTTP_X_ORIGINAL_USER_AGENT', 'HTTP_X_SKYFIRE_PHONE', 'HTTP_X_BOLT_PHONE_UA', 'HTTP_DEVICE_STOCK_UA', 'HTTP_X_UCBROWSER_DEVICE_UA' ]; /** * The individual segments that could exist in a User-Agent string. VER refers to the regular * expression defined in the constant self::VER. * * @var array */ protected static array $properties = [ // Build 'Mobile' => 'Mobile/[VER]', 'Build' => 'Build/[VER]', 'Version' => 'Version/[VER]', 'VendorID' => 'VendorID/[VER]', // Devices 'iPad' => 'iPad.*CPU[a-z ]+[VER]', 'iPhone' => 'iPhone.*CPU[a-z ]+[VER]', 'iPod' => 'iPod.*CPU[a-z ]+[VER]', //'BlackBerry' => array('BlackBerry[VER]', 'BlackBerry [VER];'), 'Kindle' => 'Kindle/[VER]', // Browser 'Chrome' => ['Chrome/[VER]', 'CriOS/[VER]', 'CrMo/[VER]'], 'Coast' => ['Coast/[VER]'], 'Dolfin' => 'Dolfin/[VER]', // @reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent/Firefox 'Firefox' => ['Firefox/[VER]', 'FxiOS/[VER]'], 'Fennec' => 'Fennec/[VER]', // http://msdn.microsoft.com/en-us/library/ms537503(v=vs.85).aspx // https://msdn.microsoft.com/en-us/library/ie/hh869301(v=vs.85).aspx 'Edge' => 'Edge/[VER]', 'IE' => ['IEMobile/[VER];', 'IEMobile [VER]', 'MSIE [VER];', 'Trident/[0-9.]+;.*rv:[VER]'], // http://en.wikipedia.org/wiki/NetFront 'NetFront' => 'NetFront/[VER]', 'NokiaBrowser' => 'NokiaBrowser/[VER]', 'Opera' => [' OPR/[VER]', 'Opera Mini/[VER]', 'Version/[VER]'], 'Opera Mini' => 'Opera Mini/[VER]', 'Opera Mobi' => 'Version/[VER]', 'UCBrowser' => ['UCWEB[VER]', 'UC.*Browser/[VER]'], 'MQQBrowser' => 'MQQBrowser/[VER]', 'MicroMessenger' => 'MicroMessenger/[VER]', 'baiduboxapp' => 'baiduboxapp/[VER]', 'baidubrowser' => 'baidubrowser/[VER]', 'SamsungBrowser' => 'SamsungBrowser/[VER]', 'Iron' => 'Iron/[VER]', // @note: Safari 7534.48.3 is actually Version 5.1. // @note: On BlackBerry the Version is overwriten by the OS. 'Safari' => ['Version/[VER]', 'Safari/[VER]'], 'Skyfire' => 'Skyfire/[VER]', 'Tizen' => 'Tizen/[VER]', 'Webkit' => 'webkit[ /][VER]', 'PaleMoon' => 'PaleMoon/[VER]', 'SailfishBrowser' => 'SailfishBrowser/[VER]', // Engine 'Gecko' => 'Gecko/[VER]', 'Trident' => 'Trident/[VER]', 'Presto' => 'Presto/[VER]', 'Goanna' => 'Goanna/[VER]', // OS 'iOS' => ' \bi?OS\b [VER][ ;]{1}', 'Android' => 'Android [VER]', 'Sailfish' => 'Sailfish [VER]', 'BlackBerry' => ['BlackBerry[\w]+/[VER]', 'BlackBerry.*Version/[VER]', 'Version/[VER]'], 'BREW' => 'BREW [VER]', 'Java' => 'Java/[VER]', // @reference: http://windowsteamblog.com/windows_phone/b/wpdev/archive/2011/08/29/introducing-the-ie9-on-windows-phone-mango-user-agent-string.aspx // @reference: http://en.wikipedia.org/wiki/Windows_NT#Releases 'Windows Phone OS' => ['Windows Phone OS [VER]', 'Windows Phone [VER]'], 'Windows Phone' => 'Windows Phone [VER]', 'Windows CE' => 'Windows CE/[VER]', // http://social.msdn.microsoft.com/Forums/en-US/windowsdeveloperpreviewgeneral/thread/6be392da-4d2f-41b4-8354-8dcee20c85cd 'Windows NT' => 'Windows NT [VER]', 'Symbian' => ['SymbianOS/[VER]', 'Symbian/[VER]'], 'webOS' => ['webOS/[VER]', 'hpwOS/[VER];'], ]; /** * Construct an instance of this class. * * @param array|null $headers Specify the headers as injection. Should be PHP _SERVER flavored. * If left empty, will use the global _SERVER['HTTP_*'] vars instead. * @param string|null $userAgent Inject the User-Agent header. If null, will use HTTP_USER_AGENT * from the $headers array instead. */ public function __construct(?array $headers = null, ?string $userAgent = null) { $this->setHttpHeaders($headers); $this->setUserAgent($userAgent); } /** * Get the current script version. * This is useful for the demo.php file, * so people can check on what version they are testing * for mobile devices. * * @return string The version number in semantic version format. */ public static function getScriptVersion(): string { return self::VERSION; } /** * Set the HTTP Headers. Must be PHP-flavored. This method will reset existing headers. * * @param array|null $httpHeaders The headers to set. If null, then using PHP's _SERVER to extract * the headers. The default null is left for backwards compatibility. */ public function setHttpHeaders(?array $httpHeaders = null) { // use global _SERVER if $httpHeaders aren't defined if (!is_array($httpHeaders) || !count($httpHeaders)) { $httpHeaders = $_SERVER; } // clear existing headers $this->httpHeaders = array(); // Only save HTTP headers. In PHP land, that means only _SERVER vars that // start with HTTP_. foreach ($httpHeaders as $key => $value) { if (substr($key, 0, 5) === 'HTTP_') { $this->httpHeaders[$key] = $value; } } // In case we're dealing with CloudFront, we need to know. $this->setCfHeaders($httpHeaders); } /** * Retrieves the HTTP headers. * * @return array */ public function getHttpHeaders(): array { return $this->httpHeaders; } /** * Retrieves a particular header. If it doesn't exist, no exception/error is caused. * Simply null is returned. * * @param string $header The name of the header to retrieve. Can be HTTP compliant such as * "User-Agent" or "X-Device-User-Agent" or can be php-esque with the * all-caps, HTTP_ prefixed, underscore separated awesomeness. * * @return string|null The value of the header. */ public function getHttpHeader(string $header): ?string { // are we using PHP-flavored headers? if (strpos($header, '_') === false) { $header = str_replace('-', '_', $header); $header = strtoupper($header); } // test the alternate, too $altHeader = 'HTTP_' . $header; //Test both the regular and the HTTP_ prefix if (isset($this->httpHeaders[$header])) { return $this->httpHeaders[$header]; } elseif (isset($this->httpHeaders[$altHeader])) { return $this->httpHeaders[$altHeader]; } return null; } public function getMobileHeaders(): array { return static::$mobileHeaders; } /** * Get all possible HTTP headers that * can contain the User-Agent string. * * @return array List of HTTP headers. */ public function getUaHttpHeaders(): array { return static::$uaHttpHeaders; } /** * Set CloudFront headers * http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html#header-caching-web-device * * @param array|null $cfHeaders List of HTTP headers * * @return bool If there were CloudFront headers to be set */ public function setCfHeaders(?array $cfHeaders = null): bool { // use global _SERVER if $cfHeaders aren't defined if (!is_array($cfHeaders) || !count($cfHeaders)) { $cfHeaders = $_SERVER; } // clear existing headers $this->cloudfrontHeaders = array(); // Only save CLOUDFRONT headers. In PHP land, that means only _SERVER vars that // start with cloudfront-. $response = false; foreach ($cfHeaders as $key => $value) { if (substr(strtolower($key), 0, 16) === 'http_cloudfront_') { $this->cloudfrontHeaders[strtoupper($key)] = $value; $response = true; } } return $response; } /** * Retrieves the cloudfront headers. * * @return array */ public function getCfHeaders(): array { return $this->cloudfrontHeaders; } /** * @param string $userAgent * @return string */ private function prepareUserAgent(string $userAgent): string { $userAgent = trim($userAgent); return substr($userAgent, 0, 500); } /** * Set the User-Agent to be used. * * @param string|null $userAgent The user agent string to set. * * @return string|null */ public function setUserAgent(?string $userAgent = null): ?string { // Invalidate cache due to #375 $this->cache = array(); if (false === empty($userAgent)) { return $this->userAgent = $this->prepareUserAgent($userAgent); } else { $this->userAgent = null; foreach ($this->getUaHttpHeaders() as $altHeader) { // @todo: should use getHttpHeader(), but it would be slow. (Serban) if (false === empty($this->httpHeaders[$altHeader])) { $this->userAgent .= $this->httpHeaders[$altHeader] . " "; } } if (!empty($this->userAgent)) { return $this->userAgent = $this->prepareUserAgent($this->userAgent); } } if (count($this->getCfHeaders()) > 0) { return $this->userAgent = 'Amazon CloudFront'; } return $this->userAgent = null; } /** * Retrieve the User-Agent. * * @return string|null The user agent if it's set. */ public function getUserAgent(): ?string { return $this->userAgent; } public function getMatchingRegex(): ?string { return $this->matchingRegex; } public function getMatchesArray(): ?array { return $this->matchesArray; } /** * Retrieve the list of known phone devices. * * @return array List of phone devices. */ public static function getPhoneDevices(): array { return static::$phoneDevices; } /** * Retrieve the list of known tablet devices. * * @return array List of tablet devices. */ public static function getTabletDevices(): array { return static::$tabletDevices; } /** * Alias for getBrowsers() method. * * @return array List of user agents. */ public static function getUserAgents(): array { return static::getBrowsers(); } /** * Retrieve the list of known browsers. Specifically, the user agents. * * @return array List of browsers / user agents. */ public static function getBrowsers(): array { return static::$browsers; } /** * Method gets the mobile detection rules. This method is used for the magic methods $detect->is*(). * Retrieve the current set of rules. * * @return array */ public function getRules(): array { static $rules; if (!$rules) { $rules = array_merge( static::$phoneDevices, static::$tabletDevices, static::$operatingSystems, static::$browsers ); } return $rules; } /** * Retrieve the list of mobile operating systems. * * @return array The list of mobile operating systems. */ public static function getOperatingSystems(): array { return static::$operatingSystems; } /** * Check the HTTP headers for signs of mobile. * This is the fastest mobile check possible; it's used * inside isMobile() method. * * @return bool */ public function checkHttpHeadersForMobile(): bool { foreach ($this->getMobileHeaders() as $mobileHeader => $matchType) { if (isset($this->httpHeaders[$mobileHeader])) { if (isset($matchType['matches']) && is_array($matchType['matches'])) { foreach ($matchType['matches'] as $_match) { if (strpos($this->httpHeaders[$mobileHeader], $_match) !== false) { return true; } } return false; } else { return true; } } } return false; } /** * Magic overloading method. * * @method boolean is[...]() * @param string $name * @param array $arguments * @return bool * @throws BadMethodCallException when the method doesn't exist and doesn't start with 'is' */ public function __call(string $name, array $arguments) { // make sure the name starts with 'is', otherwise if (substr($name, 0, 2) !== 'is') { throw new BadMethodCallException("No such method exists: $name"); } $key = substr($name, 2); return $this->matchUAAgainstKey($key); } /** * Find a detection rule that matches the current User-agent. * * @param string|null $userAgent deprecated * @return bool */ protected function matchDetectionRulesAgainstUA(?string $userAgent = null): bool { // Begin general search. foreach ($this->getRules() as $_regex) { if (empty($_regex)) { continue; } if ($this->match($_regex, $userAgent)) { return true; } } return false; } /** * Search for a certain key in the rules array. * If the key is found then try to match the corresponding * regex against the User-Agent. * * @param string $key * * @return bool */ protected function matchUAAgainstKey(string $key): bool { // Make the keys lowercase, so we can match: isIphone(), isiPhone(), isiphone(), etc. $key = strtolower($key); if (false === isset($this->cache[$key])) { // change the keys to lower case $_rules = array_change_key_case($this->getRules()); if (false === empty($_rules[$key])) { $this->cache[$key] = $this->match($_rules[$key]); } if (false === isset($this->cache[$key])) { $this->cache[$key] = false; } } return $this->cache[$key]; } /** * Check if the device is mobile. * Returns true if any type of mobile device detected, including special ones * @param string|null $userAgent deprecated * @param array|null $httpHeaders deprecated * @return bool */ public function isMobile(?string $userAgent = null, ?array $httpHeaders = null): bool { if ($httpHeaders) { $this->setHttpHeaders($httpHeaders); } if ($userAgent) { $this->setUserAgent($userAgent); } // Check specifically for cloudfront headers if the useragent === 'Amazon CloudFront' if ($this->getUserAgent() === 'Amazon CloudFront') { $cfHeaders = $this->getCfHeaders(); if (array_key_exists('HTTP_CLOUDFRONT_IS_MOBILE_VIEWER', $cfHeaders) && $cfHeaders['HTTP_CLOUDFRONT_IS_MOBILE_VIEWER'] === 'true' ) { return true; } } if ($this->checkHttpHeadersForMobile()) { return true; } else { return $this->matchDetectionRulesAgainstUA(); } } /** * Check if the device is a tablet. * Return true if any type of tablet device is detected. * * @param string|null $userAgent deprecated * @param array|null $httpHeaders deprecated * @return bool */ public function isTablet(?string $userAgent = null, ?array $httpHeaders = null): bool { // Check specifically for cloudfront headers if the useragent === 'Amazon CloudFront' if ($this->getUserAgent() === 'Amazon CloudFront') { $cfHeaders = $this->getCfHeaders(); if (array_key_exists('HTTP_CLOUDFRONT_IS_TABLET_VIEWER', $cfHeaders) && $cfHeaders['HTTP_CLOUDFRONT_IS_TABLET_VIEWER'] === 'true' ) { return true; } } foreach (static::$tabletDevices as $_regex) { if ($this->match($_regex, $userAgent)) { return true; } } return false; } /** * This method checks for a certain property in the * userAgent. * @param string $key * @param string|null $userAgent deprecated * @param array|null $httpHeaders deprecated * @return bool * * @todo: The httpHeaders part is not yet used. */ public function is(string $key, ?string $userAgent = null, ?array $httpHeaders = null): bool { // Set the UA and HTTP headers only if needed (eg. batch mode). if ($httpHeaders) { $this->setHttpHeaders($httpHeaders); } if ($userAgent) { $this->setUserAgent($userAgent); } return $this->matchUAAgainstKey($key); } /** * Some detection rules are relative (not standard), * because of the diversity of devices, vendors and * their conventions in representing the User-Agent or * the HTTP headers. * * This method will be used to check custom regexes against * the User-Agent string. * * @param string $regex * @param string|null $userAgent * @return bool * * @todo: search in the HTTP headers too. */ public function match(string $regex, ?string $userAgent = null): bool { if (!\is_string($userAgent) && !\is_string($this->userAgent)) { return false; } $match = (bool) preg_match( sprintf('#%s#is', $regex), (false === empty($userAgent) ? $userAgent : $this->userAgent), $matches ); // If positive match is found, store the results for debug. if ($match) { $this->matchingRegex = $regex; $this->matchesArray = $matches; } return $match; } /** * Get the properties array. * * @return array */ public static function getProperties(): array { return static::$properties; } /** * Prepare the version number. * * @param string $ver The string version, like "2.6.21.2152"; * * @return float * * @todo Remove the error suppression from str_replace() call. */ public function prepareVersionNo(string $ver): float { $ver = str_replace(array('_', ' ', '/'), '.', $ver); $arrVer = explode('.', $ver, 2); if (isset($arrVer[1])) { $arrVer[1] = @str_replace('.', '', $arrVer[1]); // @todo: treat strings versions. } return (float) implode('.', $arrVer); } /** * Check the version of the given property in the User-Agent. * Will return a float number. (e.g. 2_0 will return 2.0, 4.3.1 will return 4.31) * * @param string $propertyName The name of the property. See self::getProperties() array * keys for all possible properties. * @param string $type Either self::VERSION_TYPE_STRING to get a string value or * self::VERSION_TYPE_FLOAT indicating a float value. This parameter * is optional and defaults to self::VERSION_TYPE_STRING. Passing an * invalid parameter will default to the type as well. * * @return string|float|false The version of the property we are trying to extract. */ public function version(string $propertyName, string $type = self::VERSION_TYPE_STRING) { if (empty($propertyName)) { return false; } if (!\is_string($this->userAgent)) { return false; } // set the $type to the default if we don't recognize the type if ($type !== self::VERSION_TYPE_STRING && $type !== self::VERSION_TYPE_FLOAT) { $type = self::VERSION_TYPE_STRING; } $properties = self::getProperties(); // Check if the property exists in the properties array. if (true === isset($properties[$propertyName])) { // Prepare the pattern to be matched. // Make sure we always deal with an array (string is converted). $properties[$propertyName] = (array) $properties[$propertyName]; foreach ($properties[$propertyName] as $propertyMatchString) { $propertyPattern = str_replace('[VER]', self::VER, $propertyMatchString); // Identify and extract the version. preg_match(sprintf('#%s#is', $propertyPattern), $this->userAgent, $match); if (false === empty($match[1])) { return ($type == self::VERSION_TYPE_FLOAT ? $this->prepareVersionNo($match[1]) : $match[1]); } } } return false; } } Psr/Container/ContainerExceptionInterface.php 0000777 00000000326 15252673315 0015406 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Psr\Container; use Throwable; /** * Base interface representing a generic exception in a container. */ interface ContainerExceptionInterface extends Throwable { } Psr/Container/NotFoundExceptionInterface.php 0000777 00000000274 15252673315 0015222 0 ustar 00 <?php namespace Automattic\WooCommerce\Vendor\Psr\Container; /** * No entry was found in the container. */ interface NotFoundExceptionInterface extends ContainerExceptionInterface { } Psr/Container/ContainerInterface.php 0000777 00000002056 15252673315 0013531 0 ustar 00 <?php declare(strict_types=1); namespace Automattic\WooCommerce\Vendor\Psr\Container; /** * Describes the interface of a container that exposes methods to read its entries. */ interface ContainerInterface { /** * Finds an entry of the container by its identifier and returns it. * * @param string $id Identifier of the entry to look for. * * @throws NotFoundExceptionInterface No entry was found for **this** identifier. * @throws ContainerExceptionInterface Error while retrieving the entry. * * @return mixed Entry. */ public function get(string $id); /** * Returns true if the container can return an entry for the given identifier. * Returns false otherwise. * * `has($id)` returning true does not mean that `get($id)` will not throw an exception. * It does however mean that `get($id)` will not throw a `NotFoundExceptionInterface`. * * @param string $id Identifier of the entry to look for. * * @return bool */ public function has(string $id); }
| ver. 1.6 |
Github
|
.
| PHP 8.1.34 | Генерация страницы: 0.07 |
proxy
|
phpinfo
|
Настройка