AuditTrait::extraFields() - Code Metrics - Inspection of "Add extra fields and indices to audit tables, base..." - DamienHarper/auditor - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#187)

unknown

created 2023-11-30 08:42 UTC

AuditTrait::extraFields() A

↳ Parent: AuditTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	9
c	0
b	0
f	0
dl	0
loc	17
rs	9.9666
cc	3
nc	3
nop	1

<?php

declare(strict_types=1);

namespace DH\Auditor\Provider\Doctrine\Auditing\Transaction;

use DH\Auditor\Exception\MappingException;
use DH\Auditor\Provider\Doctrine\Persistence\Helper\DoctrineHelper;
use DH\Auditor\User\UserInterface;
use Doctrine\DBAL\Types\Type;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping\MappingException as ORMMappingException;
use Symfony\Component\PropertyAccess\PropertyAccess;
filter:
    dependency_paths: ["lib/*"]
use Throwable;
use UnitEnum;
filter:
    dependency_paths: ["lib/*"]

trait AuditTrait
{
    /**
     * Returns the primary key value of an entity.
     *
     * @throws \DH\Auditor\Exception\MappingException
     * @throws \Doctrine\DBAL\Exception
     * @throws \Doctrine\ORM\Mapping\MappingException
     */
    private function id(EntityManagerInterface $entityManager, object $entity): mixed
    {
        $meta = $entityManager->getClassMetadata(DoctrineHelper::getRealClassName($entity));

        try {
            $pk = $meta->getSingleIdentifierFieldName();
        } catch (ORMMappingException) {
            throw new MappingException(sprintf('Composite primary keys are not supported (%s).', $entity::class));
        }

        if (isset($meta->fieldMappings[$pk])) {
            $type = Type::getType($meta->fieldMappings[$pk]['type']);

            return $this->value($entityManager, $type, $meta->getReflectionProperty($pk)->getValue($entity));
        }

        /**
         * Primary key is not part of fieldMapping.
         *
         * @see https://github.com/DamienHarper/auditor-bundle/issues/40
         * @see https://www.doctrine-project.org/projects/doctrine-orm/en/latest/tutorials/composite-primary-keys.html#identity-through-foreign-entities
         * We try to get it from associationMapping (will throw a MappingException if not available)
         */
        $targetEntity = $meta->getReflectionProperty($pk)->getValue($entity);

        $mapping = $meta->getAssociationMapping($pk);

        $meta = $entityManager->getClassMetadata($mapping['targetEntity']);
        $pk = $meta->getSingleIdentifierFieldName();
        $type = Type::getType($meta->fieldMappings[$pk]['type']);

        \assert(\is_object($targetEntity));

        return $this->value($entityManager, $type, $meta->getReflectionProperty($pk)->getValue($targetEntity));
    }

    /**
     * Type converts the input value and returns it.
     *
     * @throws \Doctrine\DBAL\Exception
     * @throws \Doctrine\DBAL\Types\ConversionException
     */
    private function value(EntityManagerInterface $entityManager, Type $type, mixed $value): mixed
    {
        if (null === $value) {
            return null;
        }

        if (interface_exists(UnitEnum::class) && $value instanceof UnitEnum && property_exists($value, 'value')) { /** @phpstan-ignore-line */
            $value = $value->value;
        }

        $platform = $entityManager->getConnection()->getDatabasePlatform();

        switch (array_search($type::class, Type::getTypesMap(), true)) {
            case DoctrineHelper::getDoctrineType('BIGINT'):
                $convertedValue = (string) $value;  // @phpstan-ignore-line

                break;

            case DoctrineHelper::getDoctrineType('INTEGER'):
            case DoctrineHelper::getDoctrineType('SMALLINT'):
                $convertedValue = (int) $value; // @phpstan-ignore-line

                break;

            case DoctrineHelper::getDoctrineType('DECIMAL'):
            case DoctrineHelper::getDoctrineType('FLOAT'):
            case DoctrineHelper::getDoctrineType('BOOLEAN'):
                $convertedValue = $type->convertToPHPValue($value, $platform);

                break;

            case 'uuid_binary':
            case 'uuid_binary_ordered_time':
            case 'uuid':
            case 'ulid':
                // Ramsey UUID / Symfony UID (UUID/ULID)
                $convertedValue = (string) $value;  // @phpstan-ignore-line

                break;

            case DoctrineHelper::getDoctrineType('BLOB'):
            case DoctrineHelper::getDoctrineType('BINARY'):
                if (\is_resource($value)) {
                    // let's replace resources with a "simple" representation: resourceType#resourceId
                    $convertedValue = get_resource_type($value).'#'.get_resource_id($value);
                } else {
                    $convertedValue = $type->convertToDatabaseValue($value, $platform);
                }

                break;

            case DoctrineHelper::getDoctrineType('JSON'):
                return $value;

            default:
                $convertedValue = $type->convertToDatabaseValue($value, $platform);
        }

        return $convertedValue;
    }

    /**
     * Returns the extra fields if set.
     */
    private function extraFields(object $entity): array
    {
        $configuration = $this->provider->getConfiguration();
        $extraFieldProperties = array_keys($configuration->getExtraFields());
        $propertyAccessor = PropertyAccess::createPropertyAccessor();

        $extraFields = [];

        foreach ($extraFieldProperties as $extraField) {
            if (!$propertyAccessor->isReadable($entity, $extraField)) {
                continue;
            }

            $extraFields[$extraField] = $propertyAccessor->getValue($entity, $extraField);
        }

        return $extraFields;
    }

    /**
     * Computes a usable diff.
     *
     * @throws \DH\Auditor\Exception\MappingException
     * @throws \Doctrine\DBAL\Exception
     * @throws \Doctrine\DBAL\Types\ConversionException
     * @throws \Doctrine\ORM\Mapping\MappingException
     */
    private function diff(EntityManagerInterface $entityManager, object $entity, array $changeset): array
    {
        $meta = $entityManager->getClassMetadata(DoctrineHelper::getRealClassName($entity));
        $diff = [
            '@source' => $this->summarize($entityManager, $entity),
        ];

        foreach ($changeset as $fieldName => [$old, $new]) {
            $o = null;
            $n = null;

            // skip if $old and $new are null
            if (null === $old && null === $new) {
                continue;
            }

            if (
                !isset($meta->embeddedClasses[$fieldName])
                && $meta->hasField($fieldName)
                && $this->provider->isAuditedField($entity, $fieldName)
            ) {
                $mapping = $meta->fieldMappings[$fieldName];
                $type = Type::getType($mapping['type']);
                $o = $this->value($entityManager, $type, $old);
                $n = $this->value($entityManager, $type, $new);
            } elseif (
                $meta->hasAssociation($fieldName)
                && $meta->isSingleValuedAssociation($fieldName)
                && $this->provider->isAuditedField($entity, $fieldName)
            ) {
                $o = $this->summarize($entityManager, $old);
                $n = $this->summarize($entityManager, $new);
            }

            if ($o !== $n) {
                $diff[$fieldName] = [
                    'new' => $n,
                    'old' => $o,
                ];
            }
        }

        return $diff;
    }

    /**
     * Returns an array describing an entity.
     *
     * @throws \DH\Auditor\Exception\MappingException
     * @throws \Doctrine\DBAL\Exception
     * @throws \Doctrine\ORM\Mapping\MappingException
     */
    private function summarize(EntityManagerInterface $entityManager, ?object $entity = null, array $extra = []): ?array
    {
        if (null === $entity) {
            return null;
        }

        $entityManager->getUnitOfWork()->initializeObject($entity); // ensure that proxies are initialized
        $meta = $entityManager->getClassMetadata(DoctrineHelper::getRealClassName($entity));

        $pkValue = $extra['id'] ?? $this->id($entityManager, $entity);
        $pkName = $meta->getSingleIdentifierFieldName();

        if (method_exists($entity, '__toString')) {
            try {
                $label = (string) $entity;
            } catch (Throwable) {
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
                $label = DoctrineHelper::getRealClassName($entity).(null === $pkValue ? '' : '#'.$pkValue);
            }
        } else {
            $label = DoctrineHelper::getRealClassName($entity).(null === $pkValue ? '' : '#'.$pkValue);
        }

        if ('id' !== $pkName) {
            $extra['pkName'] = $pkName;
        }

        return [
            $pkName => $pkValue,
            'class' => $meta->name,
            'label' => $label,
            'table' => $meta->getTableName(),
        ] + $extra;
    }

    /**
     * Blames an audit operation.
     *
     * @return array{client_ip: null|string, user_firewall: null|string, user_fqdn: null|string, user_id: null|string, username: null|string}
     */
    private function blame(): array
    {
        $user_id = null;
        $username = null;
        $client_ip = null;
        $user_fqdn = null;
        $user_firewall = null;

        $securityProvider = $this->provider->getAuditor()->getConfiguration()->getSecurityProvider();
        if (null !== $securityProvider) {
            [$client_ip, $user_firewall] = $securityProvider();
        }

        $userProvider = $this->provider->getAuditor()->getConfiguration()->getUserProvider();
        $user = null === $userProvider ? null : $userProvider();
        if ($user instanceof UserInterface) {
            $user_id = $user->getIdentifier();
            $username = $user->getUsername();
            $user_fqdn = DoctrineHelper::getRealClassName($user);
        }

        return [
            'client_ip' => $client_ip,
            'user_firewall' => $user_firewall,
            'user_fqdn' => $user_fqdn,
            'user_id' => $user_id,
            'username' => $username,
        ];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace DH\Auditor\Provider\Doctrine\Auditing\Transaction;
6
7			use DH\Auditor\Exception\MappingException;
8			use DH\Auditor\Provider\Doctrine\Persistence\Helper\DoctrineHelper;
9			use DH\Auditor\User\UserInterface;
10			use Doctrine\DBAL\Types\Type;
11			use Doctrine\ORM\EntityManagerInterface;
12			use Doctrine\ORM\Mapping\MappingException as ORMMappingException;
13			use Symfony\Component\PropertyAccess\PropertyAccess;
			0 ignored issues – show Bug introduced 2023-11-28 15:23 UTC by Report Bug Copy Issue Report The type `Symfony\Component\PropertyAccess\PropertyAccess` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
14			use Throwable;
15			use UnitEnum;
			0 ignored issues – show Bug introduced 2022-10-26 12:51 UTC by Report Bug Copy Issue Report The type `UnitEnum` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16
17			trait AuditTrait
18			{
19			/**
20			* Returns the primary key value of an entity.
21			*
22			* @throws \DH\Auditor\Exception\MappingException
23			* @throws \Doctrine\DBAL\Exception
24			* @throws \Doctrine\ORM\Mapping\MappingException
25			*/
26			private function id(EntityManagerInterface $entityManager, object $entity): mixed
27			{
28			$meta = $entityManager->getClassMetadata(DoctrineHelper::getRealClassName($entity));
29
30			try {
31			$pk = $meta->getSingleIdentifierFieldName();
32			} catch (ORMMappingException) {
33			throw new MappingException(sprintf('Composite primary keys are not supported (%s).', $entity::class));
34			}
35
36			if (isset($meta->fieldMappings[$pk])) {
37			$type = Type::getType($meta->fieldMappings[$pk]['type']);
38
39			return $this->value($entityManager, $type, $meta->getReflectionProperty($pk)->getValue($entity));
40			}
41
42			/**
43			* Primary key is not part of fieldMapping.
44			*
45			* @see https://github.com/DamienHarper/auditor-bundle/issues/40
46			* @see https://www.doctrine-project.org/projects/doctrine-orm/en/latest/tutorials/composite-primary-keys.html#identity-through-foreign-entities
47			* We try to get it from associationMapping (will throw a MappingException if not available)
48			*/
49			$targetEntity = $meta->getReflectionProperty($pk)->getValue($entity);
50
51			$mapping = $meta->getAssociationMapping($pk);
52
53			$meta = $entityManager->getClassMetadata($mapping['targetEntity']);
54			$pk = $meta->getSingleIdentifierFieldName();
55			$type = Type::getType($meta->fieldMappings[$pk]['type']);
56
57			\assert(\is_object($targetEntity));
58
59			return $this->value($entityManager, $type, $meta->getReflectionProperty($pk)->getValue($targetEntity));
60			}
61
62			/**
63			* Type converts the input value and returns it.
64			*
65			* @throws \Doctrine\DBAL\Exception
66			* @throws \Doctrine\DBAL\Types\ConversionException
67			*/
68			private function value(EntityManagerInterface $entityManager, Type $type, mixed $value): mixed
69			{
70			if (null === $value) {
71			return null;
72			}
73
74			if (interface_exists(UnitEnum::class) && $value instanceof UnitEnum && property_exists($value, 'value')) { /** @phpstan-ignore-line */
75			$value = $value->value;
76			}
77
78			$platform = $entityManager->getConnection()->getDatabasePlatform();
79
80			switch (array_search($type::class, Type::getTypesMap(), true)) {
81			case DoctrineHelper::getDoctrineType('BIGINT'):
82			$convertedValue = (string) $value; // @phpstan-ignore-line
83
84			break;
85
86			case DoctrineHelper::getDoctrineType('INTEGER'):
87			case DoctrineHelper::getDoctrineType('SMALLINT'):
88			$convertedValue = (int) $value; // @phpstan-ignore-line
89
90			break;
91
92			case DoctrineHelper::getDoctrineType('DECIMAL'):
93			case DoctrineHelper::getDoctrineType('FLOAT'):
94			case DoctrineHelper::getDoctrineType('BOOLEAN'):
95			$convertedValue = $type->convertToPHPValue($value, $platform);
96
97			break;
98
99			case 'uuid_binary':
100			case 'uuid_binary_ordered_time':
101			case 'uuid':
102			case 'ulid':
103			// Ramsey UUID / Symfony UID (UUID/ULID)
104			$convertedValue = (string) $value; // @phpstan-ignore-line
105
106			break;
107
108			case DoctrineHelper::getDoctrineType('BLOB'):
109			case DoctrineHelper::getDoctrineType('BINARY'):
110			if (\is_resource($value)) {
111			// let's replace resources with a "simple" representation: resourceType#resourceId
112			$convertedValue = get_resource_type($value).'#'.get_resource_id($value);
113			} else {
114			$convertedValue = $type->convertToDatabaseValue($value, $platform);
115			}
116
117			break;
118
119			case DoctrineHelper::getDoctrineType('JSON'):
120			return $value;
121
122			default:
123			$convertedValue = $type->convertToDatabaseValue($value, $platform);
124			}
125
126			return $convertedValue;
127			}
128
129			/**
130			* Returns the extra fields if set.
131			*/
132			private function extraFields(object $entity): array
133			{
134			$configuration = $this->provider->getConfiguration();
135			$extraFieldProperties = array_keys($configuration->getExtraFields());
136			$propertyAccessor = PropertyAccess::createPropertyAccessor();
137
138			$extraFields = [];
139
140			foreach ($extraFieldProperties as $extraField) {
141			if (!$propertyAccessor->isReadable($entity, $extraField)) {
142			continue;
143			}
144
145			$extraFields[$extraField] = $propertyAccessor->getValue($entity, $extraField);
146			}
147
148			return $extraFields;
149			}
150
151			/**
152			* Computes a usable diff.
153			*
154			* @throws \DH\Auditor\Exception\MappingException
155			* @throws \Doctrine\DBAL\Exception
156			* @throws \Doctrine\DBAL\Types\ConversionException
157			* @throws \Doctrine\ORM\Mapping\MappingException
158			*/
159			private function diff(EntityManagerInterface $entityManager, object $entity, array $changeset): array
160			{
161			$meta = $entityManager->getClassMetadata(DoctrineHelper::getRealClassName($entity));
162			$diff = [
163			'@source' => $this->summarize($entityManager, $entity),
164			];
165
166			foreach ($changeset as $fieldName => [$old, $new]) {
167			$o = null;
168			$n = null;
169
170			// skip if $old and $new are null
171			if (null === $old && null === $new) {
172			continue;
173			}
174
175			if (
176			!isset($meta->embeddedClasses[$fieldName])
177			&& $meta->hasField($fieldName)
178			&& $this->provider->isAuditedField($entity, $fieldName)
179			) {
180			$mapping = $meta->fieldMappings[$fieldName];
181			$type = Type::getType($mapping['type']);
182			$o = $this->value($entityManager, $type, $old);
183			$n = $this->value($entityManager, $type, $new);
184			} elseif (
185			$meta->hasAssociation($fieldName)
186			&& $meta->isSingleValuedAssociation($fieldName)
187			&& $this->provider->isAuditedField($entity, $fieldName)
188			) {
189			$o = $this->summarize($entityManager, $old);
190			$n = $this->summarize($entityManager, $new);
191			}
192
193			if ($o !== $n) {
194			$diff[$fieldName] = [
195			'new' => $n,
196			'old' => $o,
197			];
198			}
199			}
200
201			return $diff;
202			}
203
204			/**
205			* Returns an array describing an entity.
206			*
207			* @throws \DH\Auditor\Exception\MappingException
208			* @throws \Doctrine\DBAL\Exception
209			* @throws \Doctrine\ORM\Mapping\MappingException
210			*/
211			private function summarize(EntityManagerInterface $entityManager, ?object $entity = null, array $extra = []): ?array
212			{
213			if (null === $entity) {
214			return null;
215			}
216
217			$entityManager->getUnitOfWork()->initializeObject($entity); // ensure that proxies are initialized
218			$meta = $entityManager->getClassMetadata(DoctrineHelper::getRealClassName($entity));
219
220			$pkValue = $extra['id'] ?? $this->id($entityManager, $entity);
221			$pkName = $meta->getSingleIdentifierFieldName();
222
223			if (method_exists($entity, '__toString')) {
224			try {
225			$label = (string) $entity;
226			} catch (Throwable) {
			0 ignored issues – show Unused Code introduced 2022-11-29 23:03 UTC by Report Bug Copy Issue Report `catch (\Throwable)` is not reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
227			$label = DoctrineHelper::getRealClassName($entity).(null === $pkValue ? '' : '#'.$pkValue);
228			}
229			} else {
230			$label = DoctrineHelper::getRealClassName($entity).(null === $pkValue ? '' : '#'.$pkValue);
231			}
232
233			if ('id' !== $pkName) {
234			$extra['pkName'] = $pkName;
235			}
236
237			return [
238			$pkName => $pkValue,
239			'class' => $meta->name,
240			'label' => $label,
241			'table' => $meta->getTableName(),
242			] + $extra;
243			}
244
245			/**
246			* Blames an audit operation.
247			*
248			* @return array{client_ip: null\|string, user_firewall: null\|string, user_fqdn: null\|string, user_id: null\|string, username: null\|string}
249			*/
250			private function blame(): array
251			{
252			$user_id = null;
253			$username = null;
254			$client_ip = null;
255			$user_fqdn = null;
256			$user_firewall = null;
257
258			$securityProvider = $this->provider->getAuditor()->getConfiguration()->getSecurityProvider();
259			if (null !== $securityProvider) {
260			[$client_ip, $user_firewall] = $securityProvider();
261			}
262
263			$userProvider = $this->provider->getAuditor()->getConfiguration()->getUserProvider();
264			$user = null === $userProvider ? null : $userProvider();
265			if ($user instanceof UserInterface) {
266			$user_id = $user->getIdentifier();
267			$username = $user->getUsername();
268			$user_fqdn = DoctrineHelper::getRealClassName($user);
269			}
270
271			return [
272			'client_ip' => $client_ip,
273			'user_firewall' => $user_firewall,
274			'user_fqdn' => $user_fqdn,
275			'user_id' => $user_id,
276			'username' => $username,
277			];
278			}
279			}
280

DamienHarper / auditor

Pull Request — master (#187)

AuditTrait::extraFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like