Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow XML validation to be disabled but keep it enabled by default. #11165

Merged
merged 4 commits into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,11 @@ explicitly forbidden to point out mistakes.

You should use `DEFERRED_EXPLICIT` instead.

## BC BREAK: `Mapping\Driver\XmlDriver::__construct()` third argument is now a no-op
## BC BREAK: `Mapping\Driver\XmlDriver::__construct()` third argument is now enabled by default

The third argument to
`Doctrine\ORM\Mapping\Driver\XmlDriver::__construct()` was introduced to
let users opt-in to XML validation, that is now always enabled, regardless of
the value of that argument.
let users opt-in to XML validation, that is now always enabled by default.

As a consequence, the same goes for
`Doctrine\ORM\Mapping\Driver\SimplifiedXmlDriver`, and for
Expand Down
12 changes: 1 addition & 11 deletions src/Mapping/Driver/SimplifiedXmlDriver.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
namespace Doctrine\ORM\Mapping\Driver;

use Doctrine\Persistence\Mapping\Driver\SymfonyFileLocator;
use InvalidArgumentException;

use function sprintf;

/**
* XmlDriver that additionally looks for mapping information in a global file.
Expand All @@ -21,15 +18,8 @@ class SimplifiedXmlDriver extends XmlDriver
*/
public function __construct($prefixes, $fileExtension = self::DEFAULT_FILE_EXTENSION, bool $isXsdValidationEnabled = true)
{
if (! $isXsdValidationEnabled) {
throw new InvalidArgumentException(sprintf(
'The $isXsdValidationEnabled argument is no longer supported, make sure to omit it when calling %s.',
__METHOD__,
));
}

$locator = new SymfonyFileLocator((array) $prefixes, $fileExtension);

parent::__construct($locator, $fileExtension);
parent::__construct($locator, $fileExtension, $isXsdValidationEnabled);
}
}
17 changes: 6 additions & 11 deletions src/Mapping/Driver/XmlDriver.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,11 @@ class XmlDriver extends FileDriver

/**
* {@inheritDoc}
*
* @param true $isXsdValidationEnabled no-op, will be removed in 4.0
*/
public function __construct(
string|array|FileLocator $locator,
string $fileExtension = self::DEFAULT_FILE_EXTENSION,
bool $isXsdValidationEnabled = true,
private readonly bool $isXsdValidationEnabled = true,
) {
if (! extension_loaded('simplexml')) {
throw new LogicException(
Expand All @@ -58,14 +56,7 @@ public function __construct(
);
}

if (! $isXsdValidationEnabled) {
throw new InvalidArgumentException(sprintf(
'The $isXsdValidationEnabled argument is no longer supported, make sure to omit it when calling %s.',
__METHOD__,
));
}

if (! extension_loaded('dom')) {
if ($isXsdValidationEnabled && ! extension_loaded('dom')) {
throw new LogicException(
'XSD validation cannot be enabled because the DOM extension is missing.',
);
Expand Down Expand Up @@ -914,6 +905,10 @@ protected function loadMappingFile($file)

private function validateMapping(string $file): void
{
if (! $this->isXsdValidationEnabled) {
return;
}
jwage marked this conversation as resolved.
Show resolved Hide resolved

$backedUpErrorSetting = libxml_use_internal_errors(true);

try {
Expand Down
9 changes: 0 additions & 9 deletions src/ORMSetup.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

use Doctrine\ORM\Mapping\Driver\AttributeDriver;
use Doctrine\ORM\Mapping\Driver\XmlDriver;
use InvalidArgumentException;
use Psr\Cache\CacheItemPoolInterface;
use Redis;
use RuntimeException;
Expand All @@ -19,7 +18,6 @@
use function class_exists;
use function extension_loaded;
use function md5;
use function sprintf;
use function sys_get_temp_dir;

final class ORMSetup
Expand Down Expand Up @@ -54,13 +52,6 @@ public static function createXMLMetadataConfiguration(
CacheItemPoolInterface|null $cache = null,
bool $isXsdValidationEnabled = true,
): Configuration {
if (! $isXsdValidationEnabled) {
throw new InvalidArgumentException(sprintf(
'The $isXsdValidationEnabled argument is no longer supported, make sure to omit it when calling %s.',
__METHOD__,
));
}

$config = self::createConfiguration($isDevMode, $proxyDir, $cache);
$config->setMetadataDriverImpl(new XmlDriver($paths, XmlDriver::DEFAULT_FILE_EXTENSION, $isXsdValidationEnabled));

Expand Down
9 changes: 9 additions & 0 deletions tests/Tests/Models/InvalidXml.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

declare(strict_types=1);

namespace Doctrine\Tests\Models;

class InvalidXml
{
}
39 changes: 36 additions & 3 deletions tests/Tests/ORM/Mapping/XmlMappingDriverTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@
use Doctrine\Tests\Models\Generic\BooleanModel;
use Doctrine\Tests\Models\GH7141\GH7141Article;
use Doctrine\Tests\Models\GH7316\GH7316Article;
use Doctrine\Tests\Models\InvalidXml;
use Doctrine\Tests\Models\Project\Project;
use Doctrine\Tests\Models\Project\ProjectId;
use Doctrine\Tests\Models\Project\ProjectInvalidMapping;
use Doctrine\Tests\Models\Project\ProjectName;
use Doctrine\Tests\Models\ValueObjects\Name;
use Doctrine\Tests\Models\ValueObjects\Person;
use InvalidArgumentException;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;

Expand Down Expand Up @@ -301,16 +301,49 @@ public function testClassNameInFieldOrId(): void
self::assertEquals(ProjectName::class, $name['type']);
}

public function testDisablingXmlValidationIsNotPossible(): void
public function testDisablingXmlValidationIsPossible(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectNotToPerformAssertions();

new XmlDriver(
__DIR__ . DIRECTORY_SEPARATOR . 'xml',
XmlDriver::DEFAULT_FILE_EXTENSION,
false,
);
}

public function testXmlValidationEnabled(): void
{
$driver = new XmlDriver(
__DIR__ . DIRECTORY_SEPARATOR . 'invalid_xml',
XmlDriver::DEFAULT_FILE_EXTENSION,
true,
);

$class = new ClassMetadata(InvalidXml::class);
$class->initializeReflection(new RuntimeReflectionService());

self::expectException(MappingException::class);
self::expectExceptionMessage("libxml error: Element '{http://doctrine-project.org/schemas/orm/doctrine-mapping}field', attribute 'invalid': The attribute 'invalid' is not allowed.");

$driver->loadMetadataForClass(InvalidXml::class, $class);
}

public function testXmlValidationDisabled(): void
{
$driver = new XmlDriver(
__DIR__ . DIRECTORY_SEPARATOR . 'invalid_xml',
XmlDriver::DEFAULT_FILE_EXTENSION,
false,
);

$class = new ClassMetadata(InvalidXml::class);
$class->initializeReflection(new RuntimeReflectionService());

$driver->loadMetadataForClass(InvalidXml::class, $class);

self::assertCount(1, $class->fieldMappings);
}
}

class CTI
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
https://www.doctrine-project.org/schemas/orm/doctrine-mapping.xsd">

<entity name="Doctrine\Tests\Models\InvalidXml" table="invalid_xml">
<field name="email" type="string" invalid="true" />
</entity>
</doctrine-mapping>
5 changes: 2 additions & 3 deletions tests/Tests/ORM/ORMSetupTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
use Doctrine\ORM\Mapping\Driver\AttributeDriver;
use Doctrine\ORM\Mapping\Driver\XmlDriver;
use Doctrine\ORM\ORMSetup;
use InvalidArgumentException;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\RequiresPhpExtension;
use PHPUnit\Framework\Attributes\RequiresSetting;
Expand Down Expand Up @@ -41,9 +40,9 @@ public function testXMLConfiguration(): void
self::assertInstanceOf(XmlDriver::class, $config->getMetadataDriverImpl());
}

public function testDisablingXmlValidationIsNotPossible(): void
public function testDisablingXmlValidationIsPossible(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectNotToPerformAssertions();

ORMSetup::createXMLMetadataConfiguration(paths: [], isXsdValidationEnabled: false);
}
Expand Down
Loading