Autoloader.php
9 months ago
DefaultProxyClassNameResolver.php
9 months ago
InternalProxy.php
9 months ago
Proxy.php
9 months ago
ProxyFactory.php
9 months ago
index.php
9 months ago
ProxyFactory.php
378 lines
| 1 | <?php |
| 2 | declare (strict_types=1); |
| 3 | namespace MailPoetVendor\Doctrine\ORM\Proxy; |
| 4 | if (!defined('ABSPATH')) exit; |
| 5 | use Closure; |
| 6 | use MailPoetVendor\Doctrine\Common\Proxy\AbstractProxyFactory; |
| 7 | use MailPoetVendor\Doctrine\Common\Proxy\Proxy as CommonProxy; |
| 8 | use MailPoetVendor\Doctrine\Common\Proxy\ProxyDefinition; |
| 9 | use MailPoetVendor\Doctrine\Common\Proxy\ProxyGenerator; |
| 10 | use MailPoetVendor\Doctrine\Deprecations\Deprecation; |
| 11 | use MailPoetVendor\Doctrine\ORM\EntityManagerInterface; |
| 12 | use MailPoetVendor\Doctrine\ORM\EntityNotFoundException; |
| 13 | use MailPoetVendor\Doctrine\ORM\ORMInvalidArgumentException; |
| 14 | use MailPoetVendor\Doctrine\ORM\Persisters\Entity\EntityPersister; |
| 15 | use MailPoetVendor\Doctrine\ORM\Proxy\Proxy as LegacyProxy; |
| 16 | use MailPoetVendor\Doctrine\ORM\UnitOfWork; |
| 17 | use MailPoetVendor\Doctrine\ORM\Utility\IdentifierFlattener; |
| 18 | use MailPoetVendor\Doctrine\Persistence\Mapping\ClassMetadata; |
| 19 | use MailPoetVendor\Doctrine\Persistence\Proxy; |
| 20 | use ReflectionProperty; |
| 21 | use MailPoetVendor\Symfony\Component\VarExporter\ProxyHelper; |
| 22 | use Throwable; |
| 23 | use function array_combine; |
| 24 | use function array_flip; |
| 25 | use function array_intersect_key; |
| 26 | use function bin2hex; |
| 27 | use function chmod; |
| 28 | use function class_exists; |
| 29 | use function dirname; |
| 30 | use function file_exists; |
| 31 | use function file_put_contents; |
| 32 | use function filemtime; |
| 33 | use function is_bool; |
| 34 | use function is_dir; |
| 35 | use function is_int; |
| 36 | use function is_writable; |
| 37 | use function ltrim; |
| 38 | use function mkdir; |
| 39 | use function preg_match_all; |
| 40 | use function random_bytes; |
| 41 | use function rename; |
| 42 | use function rtrim; |
| 43 | use function str_replace; |
| 44 | use function strpos; |
| 45 | use function strrpos; |
| 46 | use function strtr; |
| 47 | use function substr; |
| 48 | use function ucfirst; |
| 49 | use const DIRECTORY_SEPARATOR; |
| 50 | use const PHP_VERSION_ID; |
| 51 | class ProxyFactory extends AbstractProxyFactory |
| 52 | { |
| 53 | public const AUTOGENERATE_NEVER = 0; |
| 54 | public const AUTOGENERATE_ALWAYS = 1; |
| 55 | public const AUTOGENERATE_FILE_NOT_EXISTS = 2; |
| 56 | public const AUTOGENERATE_EVAL = 3; |
| 57 | public const AUTOGENERATE_FILE_NOT_EXISTS_OR_CHANGED = 4; |
| 58 | private const PROXY_CLASS_TEMPLATE = <<<'EOPHP' |
| 59 | <?php |
| 60 | namespace <namespace>; |
| 61 | class <proxyShortClassName> extends \<className> implements \<baseProxyInterface> |
| 62 | { |
| 63 | <useLazyGhostTrait> |
| 64 | public function __isInitialized(): bool |
| 65 | { |
| 66 | return isset($this->lazyObjectState) && $this->isLazyObjectInitialized(); |
| 67 | } |
| 68 | public function __serialize(): array |
| 69 | { |
| 70 | <serializeImpl> |
| 71 | } |
| 72 | } |
| 73 | EOPHP; |
| 74 | private $em; |
| 75 | private $uow; |
| 76 | private $proxyDir; |
| 77 | private $proxyNs; |
| 78 | private $autoGenerate; |
| 79 | private $identifierFlattener; |
| 80 | private $proxyFactories = []; |
| 81 | private $isLazyGhostObjectEnabled = \true; |
| 82 | public function __construct(EntityManagerInterface $em, $proxyDir, $proxyNs, $autoGenerate = self::AUTOGENERATE_NEVER) |
| 83 | { |
| 84 | if (!$em->getConfiguration()->isLazyGhostObjectEnabled()) { |
| 85 | if (PHP_VERSION_ID >= 80100) { |
| 86 | Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/pull/10837/', 'Not enabling lazy ghost objects is deprecated and will not be supported in Doctrine ORM 3.0. Ensure Doctrine\\ORM\\Configuration::setLazyGhostObjectEnabled(true) is called to enable them.'); |
| 87 | } |
| 88 | $this->isLazyGhostObjectEnabled = \false; |
| 89 | // @phpstan-ignore new.deprecatedClass, method.deprecatedClass |
| 90 | $proxyGenerator = new ProxyGenerator($proxyDir, $proxyNs); |
| 91 | // @phpstan-ignore classConstant.deprecatedInterface, method.deprecatedClass |
| 92 | $proxyGenerator->setPlaceholder('baseProxyInterface', LegacyProxy::class); |
| 93 | // @phpstan-ignore method.deprecatedClass |
| 94 | parent::__construct($proxyGenerator, $em->getMetadataFactory(), $autoGenerate); |
| 95 | } |
| 96 | if (!$proxyDir) { |
| 97 | throw ORMInvalidArgumentException::proxyDirectoryRequired(); |
| 98 | } |
| 99 | if (!$proxyNs) { |
| 100 | throw ORMInvalidArgumentException::proxyNamespaceRequired(); |
| 101 | } |
| 102 | if (is_int($autoGenerate) ? $autoGenerate < 0 || $autoGenerate > 4 : !is_bool($autoGenerate)) { |
| 103 | throw ORMInvalidArgumentException::invalidAutoGenerateMode($autoGenerate); |
| 104 | } |
| 105 | $this->em = $em; |
| 106 | $this->uow = $em->getUnitOfWork(); |
| 107 | $this->proxyDir = $proxyDir; |
| 108 | $this->proxyNs = $proxyNs; |
| 109 | $this->autoGenerate = (int) $autoGenerate; |
| 110 | $this->identifierFlattener = new IdentifierFlattener($this->uow, $em->getMetadataFactory()); |
| 111 | } |
| 112 | public function getProxy($className, array $identifier) |
| 113 | { |
| 114 | if (!$this->isLazyGhostObjectEnabled) { |
| 115 | // @phpstan-ignore method.deprecatedClass |
| 116 | return parent::getProxy($className, $identifier); |
| 117 | } |
| 118 | $proxyFactory = $this->proxyFactories[$className] ?? $this->getProxyFactory($className); |
| 119 | return $proxyFactory($identifier); |
| 120 | } |
| 121 | public function generateProxyClasses(array $classes, $proxyDir = null) |
| 122 | { |
| 123 | if (!$this->isLazyGhostObjectEnabled) { |
| 124 | // @phpstan-ignore method.deprecatedClass |
| 125 | return parent::generateProxyClasses($classes, $proxyDir); |
| 126 | } |
| 127 | $generated = 0; |
| 128 | foreach ($classes as $class) { |
| 129 | if ($this->skipClass($class)) { |
| 130 | continue; |
| 131 | } |
| 132 | $proxyFileName = $this->getProxyFileName($class->getName(), $proxyDir ?: $this->proxyDir); |
| 133 | $proxyClassName = self::generateProxyClassName($class->getName(), $this->proxyNs); |
| 134 | $this->generateProxyClass($class, $proxyFileName, $proxyClassName); |
| 135 | ++$generated; |
| 136 | } |
| 137 | return $generated; |
| 138 | } |
| 139 | public function resetUninitializedProxy(CommonProxy $proxy) |
| 140 | { |
| 141 | return parent::resetUninitializedProxy($proxy); |
| 142 | } |
| 143 | protected function skipClass(ClassMetadata $metadata) |
| 144 | { |
| 145 | return $metadata->isMappedSuperclass || $metadata->isEmbeddedClass || $metadata->getReflectionClass()->isAbstract(); |
| 146 | } |
| 147 | protected function createProxyDefinition($className) |
| 148 | { |
| 149 | $classMetadata = $this->em->getClassMetadata($className); |
| 150 | $entityPersister = $this->uow->getEntityPersister($className); |
| 151 | $initializer = $this->createInitializer($classMetadata, $entityPersister); |
| 152 | $cloner = $this->createCloner($classMetadata, $entityPersister); |
| 153 | return new ProxyDefinition(self::generateProxyClassName($className, $this->proxyNs), $classMetadata->getIdentifierFieldNames(), $classMetadata->getReflectionProperties(), $initializer, $cloner); |
| 154 | } |
| 155 | private function createInitializer(ClassMetadata $classMetadata, EntityPersister $entityPersister) : Closure |
| 156 | { |
| 157 | $wakeupProxy = $classMetadata->getReflectionClass()->hasMethod('__wakeup'); |
| 158 | return function (CommonProxy $proxy) use($entityPersister, $classMetadata, $wakeupProxy) : void { |
| 159 | $initializer = $proxy->__getInitializer(); |
| 160 | $cloner = $proxy->__getCloner(); |
| 161 | $proxy->__setInitializer(null); |
| 162 | $proxy->__setCloner(null); |
| 163 | if ($proxy->__isInitialized()) { |
| 164 | return; |
| 165 | } |
| 166 | $properties = $proxy->__getLazyProperties(); |
| 167 | foreach ($properties as $propertyName => $property) { |
| 168 | if (!isset($proxy->{$propertyName})) { |
| 169 | $proxy->{$propertyName} = $properties[$propertyName]; |
| 170 | } |
| 171 | } |
| 172 | $proxy->__setInitialized(\true); |
| 173 | if ($wakeupProxy) { |
| 174 | $proxy->__wakeup(); |
| 175 | } |
| 176 | $identifier = $classMetadata->getIdentifierValues($proxy); |
| 177 | try { |
| 178 | $entity = $entityPersister->loadById($identifier, $proxy); |
| 179 | } catch (Throwable $exception) { |
| 180 | $proxy->__setInitializer($initializer); |
| 181 | $proxy->__setCloner($cloner); |
| 182 | $proxy->__setInitialized(\false); |
| 183 | throw $exception; |
| 184 | } |
| 185 | if ($entity === null) { |
| 186 | $proxy->__setInitializer($initializer); |
| 187 | $proxy->__setCloner($cloner); |
| 188 | $proxy->__setInitialized(\false); |
| 189 | throw EntityNotFoundException::fromClassNameAndIdentifier($classMetadata->getName(), $this->identifierFlattener->flattenIdentifier($classMetadata, $identifier)); |
| 190 | } |
| 191 | }; |
| 192 | } |
| 193 | private function createLazyInitializer(ClassMetadata $classMetadata, EntityPersister $entityPersister, IdentifierFlattener $identifierFlattener) : Closure |
| 194 | { |
| 195 | return static function (InternalProxy $proxy, array $identifier) use($entityPersister, $classMetadata, $identifierFlattener) : void { |
| 196 | $original = $entityPersister->loadById($identifier); |
| 197 | if ($original === null) { |
| 198 | throw EntityNotFoundException::fromClassNameAndIdentifier($classMetadata->getName(), $identifierFlattener->flattenIdentifier($classMetadata, $identifier)); |
| 199 | } |
| 200 | if ($proxy === $original) { |
| 201 | return; |
| 202 | } |
| 203 | $class = $entityPersister->getClassMetadata(); |
| 204 | foreach ($class->getReflectionProperties() as $property) { |
| 205 | if (isset($identifier[$property->name])) { |
| 206 | continue; |
| 207 | } |
| 208 | $property->setValue($proxy, $property->getValue($original)); |
| 209 | } |
| 210 | }; |
| 211 | } |
| 212 | private function createCloner(ClassMetadata $classMetadata, EntityPersister $entityPersister) : Closure |
| 213 | { |
| 214 | return function (CommonProxy $proxy) use($entityPersister, $classMetadata) : void { |
| 215 | if ($proxy->__isInitialized()) { |
| 216 | return; |
| 217 | } |
| 218 | $proxy->__setInitialized(\true); |
| 219 | $proxy->__setInitializer(null); |
| 220 | $class = $entityPersister->getClassMetadata(); |
| 221 | $identifier = $classMetadata->getIdentifierValues($proxy); |
| 222 | $original = $entityPersister->loadById($identifier); |
| 223 | if ($original === null) { |
| 224 | throw EntityNotFoundException::fromClassNameAndIdentifier($classMetadata->getName(), $this->identifierFlattener->flattenIdentifier($classMetadata, $identifier)); |
| 225 | } |
| 226 | foreach ($class->getReflectionProperties() as $property) { |
| 227 | if (!$class->hasField($property->name) && !$class->hasAssociation($property->name)) { |
| 228 | continue; |
| 229 | } |
| 230 | if (PHP_VERSION_ID < 80100) { |
| 231 | $property->setAccessible(\true); |
| 232 | } |
| 233 | $property->setValue($proxy, $property->getValue($original)); |
| 234 | } |
| 235 | }; |
| 236 | } |
| 237 | private function getProxyFileName(string $className, string $baseDirectory) : string |
| 238 | { |
| 239 | $baseDirectory = $baseDirectory ?: $this->proxyDir; |
| 240 | return rtrim($baseDirectory, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . InternalProxy::MARKER . str_replace('\\', '', $className) . '.php'; |
| 241 | } |
| 242 | private function getProxyFactory(string $className) : Closure |
| 243 | { |
| 244 | $skippedProperties = []; |
| 245 | $class = $this->em->getClassMetadata($className); |
| 246 | $identifiers = array_flip($class->getIdentifierFieldNames()); |
| 247 | $filter = ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED | ReflectionProperty::IS_PRIVATE; |
| 248 | $reflector = $class->getReflectionClass(); |
| 249 | while ($reflector) { |
| 250 | foreach ($reflector->getProperties($filter) as $property) { |
| 251 | $name = $property->name; |
| 252 | if ($property->isStatic() || !isset($identifiers[$name])) { |
| 253 | continue; |
| 254 | } |
| 255 | $prefix = $property->isPrivate() ? "\x00" . $property->class . "\x00" : ($property->isProtected() ? "\x00*\x00" : ''); |
| 256 | $skippedProperties[$prefix . $name] = \true; |
| 257 | } |
| 258 | $filter = ReflectionProperty::IS_PRIVATE; |
| 259 | $reflector = $reflector->getParentClass(); |
| 260 | } |
| 261 | $className = $class->getName(); |
| 262 | // aliases and case sensitivity |
| 263 | $entityPersister = $this->uow->getEntityPersister($className); |
| 264 | $initializer = $this->createLazyInitializer($class, $entityPersister, $this->identifierFlattener); |
| 265 | $proxyClassName = $this->loadProxyClass($class); |
| 266 | $identifierFields = array_intersect_key($class->getReflectionProperties(), $identifiers); |
| 267 | $proxyFactory = Closure::bind(static function (array $identifier) use($initializer, $skippedProperties, $identifierFields, $className) : InternalProxy { |
| 268 | $proxy = self::createLazyGhost(static function (InternalProxy $object) use($initializer, $identifier) : void { |
| 269 | $initializer($object, $identifier); |
| 270 | }, $skippedProperties); |
| 271 | foreach ($identifierFields as $idField => $reflector) { |
| 272 | if (!isset($identifier[$idField])) { |
| 273 | throw ORMInvalidArgumentException::missingPrimaryKeyValue($className, $idField); |
| 274 | } |
| 275 | $reflector->setValue($proxy, $identifier[$idField]); |
| 276 | } |
| 277 | return $proxy; |
| 278 | }, null, $proxyClassName); |
| 279 | return $this->proxyFactories[$className] = $proxyFactory; |
| 280 | } |
| 281 | private function loadProxyClass(ClassMetadata $class) : string |
| 282 | { |
| 283 | $proxyClassName = self::generateProxyClassName($class->getName(), $this->proxyNs); |
| 284 | if (class_exists($proxyClassName, \false)) { |
| 285 | return $proxyClassName; |
| 286 | } |
| 287 | if ($this->autoGenerate === self::AUTOGENERATE_EVAL) { |
| 288 | $this->generateProxyClass($class, null, $proxyClassName); |
| 289 | return $proxyClassName; |
| 290 | } |
| 291 | $fileName = $this->getProxyFileName($class->getName(), $this->proxyDir); |
| 292 | switch ($this->autoGenerate) { |
| 293 | case self::AUTOGENERATE_FILE_NOT_EXISTS_OR_CHANGED: |
| 294 | if (file_exists($fileName) && filemtime($fileName) >= filemtime($class->getReflectionClass()->getFileName())) { |
| 295 | break; |
| 296 | } |
| 297 | // no break |
| 298 | case self::AUTOGENERATE_FILE_NOT_EXISTS: |
| 299 | if (file_exists($fileName)) { |
| 300 | break; |
| 301 | } |
| 302 | // no break |
| 303 | case self::AUTOGENERATE_ALWAYS: |
| 304 | $this->generateProxyClass($class, $fileName, $proxyClassName); |
| 305 | break; |
| 306 | } |
| 307 | require $fileName; |
| 308 | return $proxyClassName; |
| 309 | } |
| 310 | private function generateProxyClass(ClassMetadata $class, ?string $fileName, string $proxyClassName) : void |
| 311 | { |
| 312 | $i = strrpos($proxyClassName, '\\'); |
| 313 | $placeholders = ['<className>' => $class->getName(), '<namespace>' => substr($proxyClassName, 0, $i), '<proxyShortClassName>' => substr($proxyClassName, 1 + $i), '<baseProxyInterface>' => InternalProxy::class]; |
| 314 | preg_match_all('(<([a-zA-Z]+)>)', self::PROXY_CLASS_TEMPLATE, $placeholderMatches); |
| 315 | foreach (array_combine($placeholderMatches[0], $placeholderMatches[1]) as $placeholder => $name) { |
| 316 | $placeholders[$placeholder] ?? ($placeholders[$placeholder] = $this->{'generate' . ucfirst($name)}($class)); |
| 317 | } |
| 318 | $proxyCode = strtr(self::PROXY_CLASS_TEMPLATE, $placeholders); |
| 319 | if (!$fileName) { |
| 320 | if (!class_exists($proxyClassName)) { |
| 321 | eval(substr($proxyCode, 5)); |
| 322 | } |
| 323 | return; |
| 324 | } |
| 325 | $parentDirectory = dirname($fileName); |
| 326 | if (!is_dir($parentDirectory) && !@mkdir($parentDirectory, 0775, \true)) { |
| 327 | throw ORMInvalidArgumentException::proxyDirectoryNotWritable($this->proxyDir); |
| 328 | } |
| 329 | if (!is_writable($parentDirectory)) { |
| 330 | throw ORMInvalidArgumentException::proxyDirectoryNotWritable($this->proxyDir); |
| 331 | } |
| 332 | $tmpFileName = $fileName . '.' . bin2hex(random_bytes(12)); |
| 333 | file_put_contents($tmpFileName, $proxyCode); |
| 334 | @chmod($tmpFileName, 0664); |
| 335 | rename($tmpFileName, $fileName); |
| 336 | } |
| 337 | private function generateUseLazyGhostTrait(ClassMetadata $class) : string |
| 338 | { |
| 339 | // @phpstan-ignore staticMethod.deprecated (Because we support Symfony < 7.3) |
| 340 | $code = ProxyHelper::generateLazyGhost($class->getReflectionClass()); |
| 341 | $code = substr($code, 7 + (int) strpos($code, "\n{")); |
| 342 | $code = substr($code, 0, (int) strpos($code, "\n}")); |
| 343 | $code = str_replace('LazyGhostTrait;', str_replace("\n ", "\n", 'LazyGhostTrait { |
| 344 | initializeLazyObject as __load; |
| 345 | setLazyObjectAsInitialized as public __setInitialized; |
| 346 | isLazyObjectInitialized as private; |
| 347 | createLazyGhost as private; |
| 348 | resetLazyObject as private; |
| 349 | }'), $code); |
| 350 | return $code; |
| 351 | } |
| 352 | private function generateSerializeImpl(ClassMetadata $class) : string |
| 353 | { |
| 354 | $reflector = $class->getReflectionClass(); |
| 355 | $properties = $reflector->hasMethod('__serialize') ? 'parent::__serialize()' : '(array) $this'; |
| 356 | $code = '$properties = ' . $properties . '; |
| 357 | unset($properties["\\0" . self::class . "\\0lazyObjectState"]); |
| 358 | '; |
| 359 | if ($reflector->hasMethod('__serialize') || !$reflector->hasMethod('__sleep')) { |
| 360 | return $code . 'return $properties;'; |
| 361 | } |
| 362 | return $code . '$data = []; |
| 363 | foreach (parent::__sleep() as $name) { |
| 364 | $value = $properties[$k = $name] ?? $properties[$k = "\\0*\\0$name"] ?? $properties[$k = "\\0' . $reflector->name . '\\0$name"] ?? $k = null; |
| 365 | if (null === $k) { |
| 366 | trigger_error(sprintf(\'serialize(): "%s" returned as member variable from __sleep() but does not exist\', $name), \\E_USER_NOTICE); |
| 367 | } else { |
| 368 | $data[$k] = $value; |
| 369 | } |
| 370 | } |
| 371 | return $data;'; |
| 372 | } |
| 373 | private static function generateProxyClassName(string $className, string $proxyNamespace) : string |
| 374 | { |
| 375 | return rtrim($proxyNamespace, '\\') . '\\' . Proxy::MARKER . '\\' . ltrim($className, '\\'); |
| 376 | } |
| 377 | } |
| 378 |