init

vendor/sebastian/global-state/src/Blacklist.php

@@ -0,0 +1,123 @@
+<?php
+/*
+ * This file is part of sebastian/global-state.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace SebastianBergmann\GlobalState;
+
+use ReflectionClass;
+
+/**
+ * A blacklist for global state elements that should not be snapshotted.
+ */
+class Blacklist
+{
+    /**
+     * @var array
+     */
+    private $globalVariables = [];
+
+    /**
+     * @var string[]
+     */
+    private $classes = [];
+
+    /**
+     * @var string[]
+     */
+    private $classNamePrefixes = [];
+
+    /**
+     * @var string[]
+     */
+    private $parentClasses = [];
+
+    /**
+     * @var string[]
+     */
+    private $interfaces = [];
+
+    /**
+     * @var array
+     */
+    private $staticAttributes = [];
+
+    public function addGlobalVariable(string $variableName)
+    {
+        $this->globalVariables[$variableName] = true;
+    }
+
+    public function addClass(string $className)
+    {
+        $this->classes[] = $className;
+    }
+
+    public function addSubclassesOf(string $className)
+    {
+        $this->parentClasses[] = $className;
+    }
+
+    public function addImplementorsOf(string $interfaceName)
+    {
+        $this->interfaces[] = $interfaceName;
+    }
+
+    public function addClassNamePrefix(string $classNamePrefix)
+    {
+        $this->classNamePrefixes[] = $classNamePrefix;
+    }
+
+    public function addStaticAttribute(string $className, string $attributeName)
+    {
+        if (!isset($this->staticAttributes[$className])) {
+            $this->staticAttributes[$className] = [];
+        }
+
+        $this->staticAttributes[$className][$attributeName] = true;
+    }
+
+    public function isGlobalVariableBlacklisted(string $variableName): bool
+    {
+        return isset($this->globalVariables[$variableName]);
+    }
+
+    public function isStaticAttributeBlacklisted(string $className, string $attributeName): bool
+    {
+        if (\in_array($className, $this->classes)) {
+            return true;
+        }
+
+        foreach ($this->classNamePrefixes as $prefix) {
+            if (\strpos($className, $prefix) === 0) {
+                return true;
+            }
+        }
+
+        $class = new ReflectionClass($className);
+
+        foreach ($this->parentClasses as $type) {
+            if ($class->isSubclassOf($type)) {
+                return true;
+            }
+        }
+
+        foreach ($this->interfaces as $type) {
+            if ($class->implementsInterface($type)) {
+                return true;
+            }
+        }
+
+        if (isset($this->staticAttributes[$className][$attributeName])) {
+            return true;
+        }
+
+        return false;
+    }
+}

vendor/sebastian/global-state/src/CodeExporter.php

@@ -0,0 +1,94 @@
+<?php
+/*
+ * This file is part of sebastian/global-state.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace SebastianBergmann\GlobalState;
+
+/**
+ * Exports parts of a Snapshot as PHP code.
+ */
+class CodeExporter
+{
+    public function constants(Snapshot $snapshot): string
+    {
+        $result = '';
+
+        foreach ($snapshot->constants() as $name => $value) {
+            $result .= \sprintf(
+                'if (!defined(\'%s\')) define(\'%s\', %s);' . "\n",
+                $name,
+                $name,
+                $this->exportVariable($value)
+            );
+        }
+
+        return $result;
+    }
+
+    public function globalVariables(Snapshot $snapshot): string
+    {
+        $result = '$GLOBALS = [];' . PHP_EOL;
+
+        foreach ($snapshot->globalVariables() as $name => $value) {
+            $result .= \sprintf(
+                '$GLOBALS[%s] = %s;' . PHP_EOL,
+                $this->exportVariable($name),
+                $this->exportVariable($value)
+            );
+        }
+
+        return $result;
+    }
+
+    public function iniSettings(Snapshot $snapshot): string
+    {
+        $result = '';
+
+        foreach ($snapshot->iniSettings() as $key => $value) {
+            $result .= \sprintf(
+                '@ini_set(%s, %s);' . "\n",
+                $this->exportVariable($key),
+                $this->exportVariable($value)
+            );
+        }
+
+        return $result;
+    }
+
+    private function exportVariable($variable): string
+    {
+        if (\is_scalar($variable) || \is_null($variable) ||
+            (\is_array($variable) && $this->arrayOnlyContainsScalars($variable))) {
+            return \var_export($variable, true);
+        }
+
+        return 'unserialize(' . \var_export(\serialize($variable), true) . ')';
+    }
+
+    private function arrayOnlyContainsScalars(array $array): bool
+    {
+        $result = true;
+
+        foreach ($array as $element) {
+            if (\is_array($element)) {
+                $result = self::arrayOnlyContainsScalars($element);
+            } elseif (!\is_scalar($element) && !\is_null($element)) {
+                $result = false;
+            }
+
+            if ($result === false) {
+                break;
+            }
+        }
+
+        return $result;
+    }
+}

vendor/sebastian/global-state/src/Restorer.php

@@ -0,0 +1,137 @@
+<?php
+/*
+ * This file is part of sebastian/global-state.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace SebastianBergmann\GlobalState;
+
+use ReflectionProperty;
+
+/**
+ * Restorer of snapshots of global state.
+ */
+class Restorer
+{
+    /**
+     * Deletes function definitions that are not defined in a snapshot.
+     *
+     * @throws RuntimeException when the uopz_delete() function is not available
+     *
+     * @see    https://github.com/krakjoe/uopz
+     */
+    public function restoreFunctions(Snapshot $snapshot)
+    {
+        if (!\function_exists('uopz_delete')) {
+            throw new RuntimeException('The uopz_delete() function is required for this operation');
+        }
+
+        $functions = \get_defined_functions();
+
+        foreach (\array_diff($functions['user'], $snapshot->functions()) as $function) {
+            uopz_delete($function);
+        }
+    }
+
+    /**
+     * Restores all global and super-global variables from a snapshot.
+     */
+    public function restoreGlobalVariables(Snapshot $snapshot)
+    {
+        $superGlobalArrays = $snapshot->superGlobalArrays();
+
+        foreach ($superGlobalArrays as $superGlobalArray) {
+            $this->restoreSuperGlobalArray($snapshot, $superGlobalArray);
+        }
+
+        $globalVariables = $snapshot->globalVariables();
+
+        foreach (\array_keys($GLOBALS) as $key) {
+            if ($key != 'GLOBALS' &&
+                !\in_array($key, $superGlobalArrays) &&
+                !$snapshot->blacklist()->isGlobalVariableBlacklisted($key)) {
+                if (\array_key_exists($key, $globalVariables)) {
+                    $GLOBALS[$key] = $globalVariables[$key];
+                } else {
+                    unset($GLOBALS[$key]);
+                }
+            }
+        }
+    }
+
+    /**
+     * Restores all static attributes in user-defined classes from this snapshot.
+     */
+    public function restoreStaticAttributes(Snapshot $snapshot)
+    {
+        $current    = new Snapshot($snapshot->blacklist(), false, false, false, false, true, false, false, false, false);
+        $newClasses = \array_diff($current->classes(), $snapshot->classes());
+
+        unset($current);
+
+        foreach ($snapshot->staticAttributes() as $className => $staticAttributes) {
+            foreach ($staticAttributes as $name => $value) {
+                $reflector = new ReflectionProperty($className, $name);
+                $reflector->setAccessible(true);
+                $reflector->setValue($value);
+            }
+        }
+
+        foreach ($newClasses as $className) {
+            $class    = new \ReflectionClass($className);
+            $defaults = $class->getDefaultProperties();
+
+            foreach ($class->getProperties() as $attribute) {
+                if (!$attribute->isStatic()) {
+                    continue;
+                }
+
+                $name = $attribute->getName();
+
+                if ($snapshot->blacklist()->isStaticAttributeBlacklisted($className, $name)) {
+                    continue;
+                }
+
+                if (!isset($defaults[$name])) {
+                    continue;
+                }
+
+                $attribute->setAccessible(true);
+                $attribute->setValue($defaults[$name]);
+            }
+        }
+    }
+
+    /**
+     * Restores a super-global variable array from this snapshot.
+     */
+    private function restoreSuperGlobalArray(Snapshot $snapshot, string $superGlobalArray)
+    {
+        $superGlobalVariables = $snapshot->superGlobalVariables();
+
+        if (isset($GLOBALS[$superGlobalArray]) &&
+            \is_array($GLOBALS[$superGlobalArray]) &&
+            isset($superGlobalVariables[$superGlobalArray])) {
+            $keys = \array_keys(
+                \array_merge(
+                    $GLOBALS[$superGlobalArray],
+                    $superGlobalVariables[$superGlobalArray]
+                )
+            );
+
+            foreach ($keys as $key) {
+                if (isset($superGlobalVariables[$superGlobalArray][$key])) {
+                    $GLOBALS[$superGlobalArray][$key] = $superGlobalVariables[$superGlobalArray][$key];
+                } else {
+                    unset($GLOBALS[$superGlobalArray][$key]);
+                }
+            }
+        }
+    }
+}

vendor/sebastian/global-state/src/Snapshot.php

@@ -0,0 +1,368 @@
+<?php
+/*
+ * This file is part of sebastian/global-state.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace SebastianBergmann\GlobalState;
+
+use ReflectionClass;
+use Serializable;
+
+/**
+ * A snapshot of global state.
+ */
+class Snapshot
+{
+    /**
+     * @var Blacklist
+     */
+    private $blacklist;
+
+    /**
+     * @var array
+     */
+    private $globalVariables = [];
+
+    /**
+     * @var array
+     */
+    private $superGlobalArrays = [];
+
+    /**
+     * @var array
+     */
+    private $superGlobalVariables = [];
+
+    /**
+     * @var array
+     */
+    private $staticAttributes = [];
+
+    /**
+     * @var array
+     */
+    private $iniSettings = [];
+
+    /**
+     * @var array
+     */
+    private $includedFiles = [];
+
+    /**
+     * @var array
+     */
+    private $constants = [];
+
+    /**
+     * @var array
+     */
+    private $functions = [];
+
+    /**
+     * @var array
+     */
+    private $interfaces = [];
+
+    /**
+     * @var array
+     */
+    private $classes = [];
+
+    /**
+     * @var array
+     */
+    private $traits = [];
+
+    /**
+     * Creates a snapshot of the current global state.
+     */
+    public function __construct(Blacklist $blacklist = null, bool $includeGlobalVariables = true, bool $includeStaticAttributes = true, bool $includeConstants = true, bool $includeFunctions = true, bool $includeClasses = true, bool $includeInterfaces = true, bool $includeTraits = true, bool $includeIniSettings = true, bool $includeIncludedFiles = true)
+    {
+        if ($blacklist === null) {
+            $blacklist = new Blacklist;
+        }
+
+        $this->blacklist = $blacklist;
+
+        if ($includeConstants) {
+            $this->snapshotConstants();
+        }
+
+        if ($includeFunctions) {
+            $this->snapshotFunctions();
+        }
+
+        if ($includeClasses || $includeStaticAttributes) {
+            $this->snapshotClasses();
+        }
+
+        if ($includeInterfaces) {
+            $this->snapshotInterfaces();
+        }
+
+        if ($includeGlobalVariables) {
+            $this->setupSuperGlobalArrays();
+            $this->snapshotGlobals();
+        }
+
+        if ($includeStaticAttributes) {
+            $this->snapshotStaticAttributes();
+        }
+
+        if ($includeIniSettings) {
+            $this->iniSettings = \ini_get_all(null, false);
+        }
+
+        if ($includeIncludedFiles) {
+            $this->includedFiles = \get_included_files();
+        }
+
+        $this->traits = \get_declared_traits();
+    }
+
+    public function blacklist(): Blacklist
+    {
+        return $this->blacklist;
+    }
+
+    public function globalVariables(): array
+    {
+        return $this->globalVariables;
+    }
+
+    public function superGlobalVariables(): array
+    {
+        return $this->superGlobalVariables;
+    }
+
+    public function superGlobalArrays(): array
+    {
+        return $this->superGlobalArrays;
+    }
+
+    public function staticAttributes(): array
+    {
+        return $this->staticAttributes;
+    }
+
+    public function iniSettings(): array
+    {
+        return $this->iniSettings;
+    }
+
+    public function includedFiles(): array
+    {
+        return $this->includedFiles;
+    }
+
+    public function constants(): array
+    {
+        return $this->constants;
+    }
+
+    public function functions(): array
+    {
+        return $this->functions;
+    }
+
+    public function interfaces(): array
+    {
+        return $this->interfaces;
+    }
+
+    public function classes(): array
+    {
+        return $this->classes;
+    }
+
+    public function traits(): array
+    {
+        return $this->traits;
+    }
+
+    /**
+     * Creates a snapshot user-defined constants.
+     */
+    private function snapshotConstants()
+    {
+        $constants = \get_defined_constants(true);
+
+        if (isset($constants['user'])) {
+            $this->constants = $constants['user'];
+        }
+    }
+
+    /**
+     * Creates a snapshot user-defined functions.
+     */
+    private function snapshotFunctions()
+    {
+        $functions = \get_defined_functions();
+
+        $this->functions = $functions['user'];
+    }
+
+    /**
+     * Creates a snapshot user-defined classes.
+     */
+    private function snapshotClasses()
+    {
+        foreach (\array_reverse(\get_declared_classes()) as $className) {
+            $class = new ReflectionClass($className);
+
+            if (!$class->isUserDefined()) {
+                break;
+            }
+
+            $this->classes[] = $className;
+        }
+
+        $this->classes = \array_reverse($this->classes);
+    }
+
+    /**
+     * Creates a snapshot user-defined interfaces.
+     */
+    private function snapshotInterfaces()
+    {
+        foreach (\array_reverse(\get_declared_interfaces()) as $interfaceName) {
+            $class = new ReflectionClass($interfaceName);
+
+            if (!$class->isUserDefined()) {
+                break;
+            }
+
+            $this->interfaces[] = $interfaceName;
+        }
+
+        $this->interfaces = \array_reverse($this->interfaces);
+    }
+
+    /**
+     * Creates a snapshot of all global and super-global variables.
+     */
+    private function snapshotGlobals()
+    {
+        $superGlobalArrays = $this->superGlobalArrays();
+
+        foreach ($superGlobalArrays as $superGlobalArray) {
+            $this->snapshotSuperGlobalArray($superGlobalArray);
+        }
+
+        foreach (\array_keys($GLOBALS) as $key) {
+            if ($key != 'GLOBALS' &&
+                !\in_array($key, $superGlobalArrays) &&
+                $this->canBeSerialized($GLOBALS[$key]) &&
+                !$this->blacklist->isGlobalVariableBlacklisted($key)) {
+                $this->globalVariables[$key] = \unserialize(\serialize($GLOBALS[$key]));
+            }
+        }
+    }
+
+    /**
+     * Creates a snapshot a super-global variable array.
+     */
+    private function snapshotSuperGlobalArray(string $superGlobalArray)
+    {
+        $this->superGlobalVariables[$superGlobalArray] = [];
+
+        if (isset($GLOBALS[$superGlobalArray]) && \is_array($GLOBALS[$superGlobalArray])) {
+            foreach ($GLOBALS[$superGlobalArray] as $key => $value) {
+                $this->superGlobalVariables[$superGlobalArray][$key] = \unserialize(\serialize($value));
+            }
+        }
+    }
+
+    /**
+     * Creates a snapshot of all static attributes in user-defined classes.
+     */
+    private function snapshotStaticAttributes()
+    {
+        foreach ($this->classes as $className) {
+            $class    = new ReflectionClass($className);
+            $snapshot = [];
+
+            foreach ($class->getProperties() as $attribute) {
+                if ($attribute->isStatic()) {
+                    $name = $attribute->getName();
+
+                    if ($this->blacklist->isStaticAttributeBlacklisted($className, $name)) {
+                        continue;
+                    }
+
+                    $attribute->setAccessible(true);
+                    $value = $attribute->getValue();
+
+                    if ($this->canBeSerialized($value)) {
+                        $snapshot[$name] = \unserialize(\serialize($value));
+                    }
+                }
+            }
+
+            if (!empty($snapshot)) {
+                $this->staticAttributes[$className] = $snapshot;
+            }
+        }
+    }
+
+    /**
+     * Returns a list of all super-global variable arrays.
+     */
+    private function setupSuperGlobalArrays()
+    {
+        $this->superGlobalArrays = [
+            '_ENV',
+            '_POST',
+            '_GET',
+            '_COOKIE',
+            '_SERVER',
+            '_FILES',
+            '_REQUEST'
+        ];
+
+        if (\ini_get('register_long_arrays') == '1') {
+            $this->superGlobalArrays = \array_merge(
+                $this->superGlobalArrays,
+                [
+                    'HTTP_ENV_VARS',
+                    'HTTP_POST_VARS',
+                    'HTTP_GET_VARS',
+                    'HTTP_COOKIE_VARS',
+                    'HTTP_SERVER_VARS',
+                    'HTTP_POST_FILES'
+                ]
+            );
+        }
+    }
+
+    /**
+     * @todo Implement this properly
+     */
+    private function canBeSerialized($variable): bool
+    {
+        if (!\is_object($variable)) {
+            return !\is_resource($variable);
+        }
+
+        if ($variable instanceof \stdClass) {
+            return true;
+        }
+
+        $class = new ReflectionClass($variable);
+
+        do {
+            if ($class->isInternal()) {
+                return $variable instanceof Serializable;
+            }
+        } while ($class = $class->getParentClass());
+
+        return true;
+    }
+}

vendor/sebastian/global-state/src/exceptions/Exception.php

@@ -0,0 +1,17 @@
+<?php
+/*
+ * This file is part of sebastian/global-state.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace SebastianBergmann\GlobalState;
+
+interface Exception
+{
+}

vendor/sebastian/global-state/src/exceptions/RuntimeException.php

@@ -0,0 +1,17 @@
+<?php
+/*
+ * This file is part of sebastian/global-state.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace SebastianBergmann\GlobalState;
+
+class RuntimeException extends \RuntimeException implements Exception
+{
+}