WidgetXMLSniff.php

<?php
/**
 * Copyright 2021 Adobe
 * All Rights Reserved.
 */
declare(strict_types=1);

namespace Magento2\Sniffs\Legacy;

use DOMDocument;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

/**
 * Test for obsolete nodes/attributes in the widget.xml
 */
class WidgetXMLSniff implements Sniff
{
    private const ERROR_CODE_OBSOLETE_SUPPORTED_BLOCKS = 'FoundObsoleteNodeSupportedBlocks';
    private const ERROR_CODE_OBSOLETE_BLOCK_NAME = 'FoundObsoleteNodeBlockName';
    private const ERROR_CODE_FACTORY = 'FoundFactory';
    private const ERROR_CODE_XML = 'WrongXML';

    /**
     * @inheritdoc
     */
    public function register(): array
    {
        return [
            T_INLINE_HTML
        ];
    }

    /**
     * @inheritDoc
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        if ($stackPtr > 0) {
            return;
        }

        $xml = simplexml_load_string($this->getFormattedXML($phpcsFile));

        if ($xml === false) {
            $this->invalidXML($phpcsFile, $stackPtr);
            return;
        }

        $foundElements = $xml->xpath('/widgets/*[@type]');

        foreach ($foundElements as $element) {
            if (!property_exists($element->attributes(), 'type')) {
                continue;
            }
            $type = (string) $element['type'];
            if (preg_match('/\//', $type)) {
                $phpcsFile->addError(
                    "Factory name detected: {$type}.",
                    dom_import_simplexml($element)->getLineNo() - 1,
                    self::ERROR_CODE_FACTORY
                );
            }
        }

        $foundElements = $xml->xpath('/widgets/*/supported_blocks');
        foreach ($foundElements as $element) {
            $phpcsFile->addError(
                "Obsolete node: <supported_blocks>. To be replaced with <supported_containers>",
                dom_import_simplexml($element)->getLineNo() - 1,
                self::ERROR_CODE_OBSOLETE_SUPPORTED_BLOCKS
            );
        }

        $foundElements = $xml->xpath('/widgets/*/*/*/block_name');
        foreach ($foundElements as $element) {
            $phpcsFile->addError(
                "Obsolete node: <block_name>. To be replaced with <container_name>",
                dom_import_simplexml($element)->getLineNo() - 1,
                self::ERROR_CODE_OBSOLETE_BLOCK_NAME
            );
        }
    }

    /**
     * Adds an invalid XML error
     *
     * @param File $phpcsFile
     * @param int $stackPtr
     */
    protected function invalidXML(File $phpcsFile, int $stackPtr): void
    {
        $phpcsFile->addError(
            sprintf(
                "Couldn't parse contents of '%s', check that they are in valid XML format",
                $phpcsFile->getFilename(),
            ),
            $stackPtr,
            self::ERROR_CODE_XML
        );
    }

    /**
     * Format the incoming XML to avoid tags split into several lines.
     *
     * @param File $phpcsFile
     * @return false|string
     */
    private function getFormattedXML(File $phpcsFile)
    {
        $doc = new DomDocument('1.0');
        $doc->formatOutput = true;
        $doc->loadXML($phpcsFile->getTokensAsString(0, 999999));
        return $doc->saveXML();
    }
}