WeavingTransformer::transform() - Code Metrics - Inspection of "Reflection getFileName fix" - goaop/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#398)

by Andy

created 2018-07-12 21:30 UTC

WeavingTransformer::transform() B

↳ Parent: WeavingTransformer

Complexity

Conditions	7
Paths	16

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	7

Importance

Changes

Metric	Value
dl	0
loc	32
ccs	19
cts	19
cp	1
rs	8.4746
c	0
b	0
f	0
cc	7
nc	16
nop	1
crap	7

<?php
declare(strict_types = 1);
/*
 * Go! AOP framework
 *
 * @copyright Copyright 2011, Lisachenko Alexander <[email protected]>
 *
 * This source file is subject to the license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Go\Instrument\Transformer;

use Go\Aop\Advisor;
use Go\Aop\Aspect;
use Go\Aop\Features;
use Go\Aop\Framework\AbstractJoinpoint;
use Go\Core\AdviceMatcher;
use Go\Core\AspectContainer;
use Go\Core\AspectKernel;
use Go\Core\AspectLoader;
use Go\Instrument\ClassLoading\CachePathManager;
use Go\ParserReflection\ReflectionClass;
use Go\ParserReflection\ReflectionFile;
use Go\ParserReflection\ReflectionFileNamespace;
use Go\ParserReflection\ReflectionMethod;
use Go\Proxy\ClassProxyGenerator;
use Go\Proxy\FunctionProxyGenerator;
use Go\Proxy\TraitProxyGenerator;

/**
 * Main transformer that performs weaving of aspects into the source code
 */
class WeavingTransformer extends BaseSourceTransformer
{

    /**
     * Advice matcher for class
     */
    protected $adviceMatcher;

    /**
     * Should we use parameter widening for our decorators
     */
    protected $useParameterWidening = false;

    /**
     * Cache manager
     */
    private $cachePathManager;

    /**
     * Loader for aspects
     */
    protected $aspectLoader;

    /**
     * Constructs a weaving transformer
     */
    public function __construct(
        AspectKernel $kernel,
        AdviceMatcher $adviceMatcher,
        CachePathManager $cachePathManager,
        AspectLoader $loader
    ) {
        parent::__construct($kernel);
        $this->adviceMatcher    = $adviceMatcher;
        $this->cachePathManager = $cachePathManager;
        $this->aspectLoader     = $loader;

        $this->useParameterWidening = $kernel->hasFeature(Features::PARAMETER_WIDENING);
    }

    /**
     * This method may transform the supplied source and return a new replacement for it
     *
     * @return string See RESULT_XXX constants in the interface
     */
    public function transform(StreamMetaData $metadata): string
    {
        $totalTransformations = 0;
        $parsedSource         = new ReflectionFile($metadata->uri, $metadata->syntaxTree);

        // Check if we have some new aspects that weren't loaded yet
        $unloadedAspects = $this->aspectLoader->getUnloadedAspects();
        if (!empty($unloadedAspects)) {
            $this->loadAndRegisterAspects($unloadedAspects);
        }
        $advisors = $this->container->getByTag('advisor');

        $namespaces = $parsedSource->getFileNamespaces();

        foreach ($namespaces as $namespace) {
            $classes = $namespace->getClasses();
            foreach ($classes as $class) {
                // Skip interfaces and aspects
                if ($class->isInterface() || in_array(Aspect::class, $class->getInterfaceNames())) {
                    continue;
                }
                $wasClassProcessed = $this->processSingleClass($advisors, $metadata, $class);
                $totalTransformations += (integer) $wasClassProcessed;
            }
            $wasFunctionsProcessed = $this->processFunctions($advisors, $metadata, $namespace);
            $totalTransformations += (integer) $wasFunctionsProcessed;
        }

        $result = ($totalTransformations > 0) ? self::RESULT_TRANSFORMED : self::RESULT_ABSTAIN;

        return $result;
    }

    /**
     * Performs weaving of single class if needed, returns true if the class was processed
     *
     * @param Advisor[] $advisors List of advisors
     */
    private function processSingleClass(array $advisors, StreamMetaData $metadata, ReflectionClass $class): bool
    {
        $advices = $this->adviceMatcher->getAdvicesForClass($class, $advisors);

        if (empty($advices)) {
            // Fast return if there aren't any advices for that class
            return false;
        }

        // Sort advices in advance to keep the correct order in cache, and leave only keys for the cache
        $advices = AbstractJoinpoint::flatAndSortAdvices($advices);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        // Prepare new class name
        $newClassName = $class->getShortName() . AspectContainer::AOP_PROXIED_SUFFIX;

        // Replace original class name with new
        $this->adjustOriginalClass($class, $advices, $metadata, $newClassName);
        $newParentName = $class->getNamespaceName() . '\\' . $newClassName;

        // Prepare child Aop proxy
        $childProxyGenerator = $class->isTrait()
            ? new TraitProxyGenerator($class, $newParentName, $advices, $this->useParameterWidening)
            : new ClassProxyGenerator($class, $newParentName, $advices, $this->useParameterWidening);

        $refNamespace = new ReflectionFileNamespace($class->getFileName(), $class->getNamespaceName());
        foreach ($refNamespace->getNamespaceAliases() as $fqdn => $alias) {
            $childProxyGenerator->addUse($fqdn, $alias);
        }

        $contentToInclude = $this->saveProxyToCache($class, $childProxyGenerator->generate());

        // Get last token for this class
        $lastClassToken = $class->getNode()->getAttribute('endTokenPos');

        $metadata->tokenStream[$lastClassToken][1] .= PHP_EOL . $contentToInclude;

        return true;
    }

    /**
     * Adjust definition of original class source to enable extending
     *
     * @param array $advices List of class advices (used to check for final methods and make them non-final)
     */
    private function adjustOriginalClass(
        ReflectionClass $class,
        array $advices,
        StreamMetaData $streamMetaData,
        string $newClassName
    ): void {
        $classNode = $class->getNode();
        $position  = $classNode->getAttribute('startTokenPos');
        do {
            if (isset($streamMetaData->tokenStream[$position])) {
                $token = $streamMetaData->tokenStream[$position];
                // Remove final and following whitespace from the class, child will be final instead
                if ($token[0] === T_FINAL) {
                    unset($streamMetaData->tokenStream[$position], $streamMetaData->tokenStream[$position+1]);
                }
                // First string is class/trait name
                if ($token[0] === T_STRING) {
                    $streamMetaData->tokenStream[$position][1] = $newClassName;
                    // We have finished our job, can break this loop
                    break;
                }
            }
            ++$position;
        } while (true);

        foreach ($class->getMethods(ReflectionMethod::IS_FINAL) as $finalMethod) {
            if (!$finalMethod instanceof ReflectionMethod || $finalMethod->getDeclaringClass()->name !== $class->name) {
                continue;
            }
            $hasDynamicAdvice = isset($advices[AspectContainer::METHOD_PREFIX][$finalMethod->name]);
            $hasStaticAdvice  = isset($advices[AspectContainer::STATIC_METHOD_PREFIX][$finalMethod->name]);
            if (!$hasDynamicAdvice && !$hasStaticAdvice) {
                continue;
            }
            $methodNode = $finalMethod->getNode();
            $position   = $methodNode->getAttribute('startTokenPos');
            do {
                if (isset($streamMetaData->tokenStream[$position])) {
                    $token = $streamMetaData->tokenStream[$position];
                    // Remove final and following whitespace from the method, child will be final instead
                    if ($token[0] === T_FINAL) {
                        unset($streamMetaData->tokenStream[$position], $streamMetaData->tokenStream[$position+1]);
                        break;
                    }
                }
                ++$position;
            } while (true);
        }
    }

    /**
     * Performs weaving of functions in the current namespace, returns true if functions were processed, false otherwise
     *
     * @param Advisor[] $advisors List of advisors
     */
    private function processFunctions(
        array $advisors,
        StreamMetaData $metadata,
        ReflectionFileNamespace $namespace
    ): bool {
        static $cacheDirSuffix = '/_functions/';

        $wasProcessedFunctions = false;
        $functionAdvices = $this->adviceMatcher->getAdvicesForFunctions($namespace, $advisors);
        $cacheDir        = $this->cachePathManager->getCacheDir();
        if (!empty($functionAdvices)) {
            $cacheDir .= $cacheDirSuffix;
            $fileName = str_replace('\\', '/', $namespace->getName()) . '.php';

            $functionFileName = $cacheDir . $fileName;
            if (!file_exists($functionFileName) || !$this->container->isFresh(filemtime($functionFileName))) {
                $functionAdvices = AbstractJoinpoint::flatAndSortAdvices($functionAdvices);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $dirname         = dirname($functionFileName);
                if (!file_exists($dirname)) {
                    mkdir($dirname, $this->options['cacheFileMode'], true);
                }
                $generator = new FunctionProxyGenerator($namespace, $functionAdvices, $this->useParameterWidening);
                file_put_contents($functionFileName, $generator->generate(), LOCK_EX);
                // For cache files we don't want executable bits by default
                chmod($functionFileName, $this->options['cacheFileMode'] & (~0111));
            }
            $content = 'include_once AOP_CACHE_DIR . ' . var_export($cacheDirSuffix . $fileName, true) . ';';

            $lastTokenPosition = $namespace->getLastTokenPosition();
            $metadata->tokenStream[$lastTokenPosition][1] .= PHP_EOL . $content;
            $wasProcessedFunctions = true;
        }

        return $wasProcessedFunctions;
    }

    /**
     * Save AOP proxy to the separate file anr returns the php source code for inclusion
     */
    private function saveProxyToCache(ReflectionClass $class, string $childCode): string
    {
        static $cacheDirSuffix = '/_proxies/';

        $cacheDir          = $this->cachePathManager->getCacheDir() . $cacheDirSuffix;
        $relativePath      = str_replace($this->options['appDir'] . DIRECTORY_SEPARATOR, '', $class->getFileName());
        $proxyRelativePath = str_replace('\\', '/', $relativePath . '/' . $class->getName() . '.php');
        $proxyFileName     = $cacheDir . $proxyRelativePath;
        $dirname           = dirname($proxyFileName);
        if (!file_exists($dirname)) {
            mkdir($dirname, $this->options['cacheFileMode'], true);
        }

        $body = '<?php' . PHP_EOL . $childCode;

        $isVirtualSystem = strpos($proxyFileName, 'vfs') === 0;
        file_put_contents($proxyFileName, $body, $isVirtualSystem ? 0 : LOCK_EX);
        // For cache files we don't want executable bits by default
        chmod($proxyFileName, $this->options['cacheFileMode'] & (~0111));

        return 'include_once AOP_CACHE_DIR . ' . var_export($cacheDirSuffix . $proxyRelativePath, true) . ';';
    }

    /**
     * Utility method to load and register unloaded aspects
     *
     * @param array $unloadedAspects List of unloaded aspects
     */
    private function loadAndRegisterAspects(array $unloadedAspects): void
    {
        foreach ($unloadedAspects as $unloadedAspect) {
            $this->aspectLoader->loadAndRegister($unloadedAspect);
        }
    }
}


1		<?php
2		declare(strict_types = 1);
3		/*
4		* Go! AOP framework
5		*
6		* @copyright Copyright 2011, Lisachenko Alexander <[email protected]>
7		*
8		* This source file is subject to the license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Go\Instrument\Transformer;
13
14		use Go\Aop\Advisor;
15		use Go\Aop\Aspect;
16		use Go\Aop\Features;
17		use Go\Aop\Framework\AbstractJoinpoint;
18		use Go\Core\AdviceMatcher;
19		use Go\Core\AspectContainer;
20		use Go\Core\AspectKernel;
21		use Go\Core\AspectLoader;
22		use Go\Instrument\ClassLoading\CachePathManager;
23		use Go\ParserReflection\ReflectionClass;
24		use Go\ParserReflection\ReflectionFile;
25		use Go\ParserReflection\ReflectionFileNamespace;
26		use Go\ParserReflection\ReflectionMethod;
27		use Go\Proxy\ClassProxyGenerator;
28		use Go\Proxy\FunctionProxyGenerator;
29		use Go\Proxy\TraitProxyGenerator;
30
31		/**
32		* Main transformer that performs weaving of aspects into the source code
33		*/
34		class WeavingTransformer extends BaseSourceTransformer
35		{
36
37		/**
38		* Advice matcher for class
39		*/
40		protected $adviceMatcher;
41
42		/**
43		* Should we use parameter widening for our decorators
44		*/
45		protected $useParameterWidening = false;
46
47		/**
48		* Cache manager
49		*/
50		private $cachePathManager;
51
52		/**
53		* Loader for aspects
54		*/
55		protected $aspectLoader;
56
57		/**
58		* Constructs a weaving transformer
59		*/
60	8	public function __construct(
61		AspectKernel $kernel,
62		AdviceMatcher $adviceMatcher,
63		CachePathManager $cachePathManager,
64		AspectLoader $loader
65		) {
66	8	parent::__construct($kernel);
67	8	$this->adviceMatcher = $adviceMatcher;
68	8	$this->cachePathManager = $cachePathManager;
69	8	$this->aspectLoader = $loader;
70
71	8	$this->useParameterWidening = $kernel->hasFeature(Features::PARAMETER_WIDENING);
72	8	}
73
74		/**
75		* This method may transform the supplied source and return a new replacement for it
76		*
77		* @return string See RESULT_XXX constants in the interface
78		*/
79	8	public function transform(StreamMetaData $metadata): string
80		{
81	8	$totalTransformations = 0;
82	8	$parsedSource = new ReflectionFile($metadata->uri, $metadata->syntaxTree);
83
84		// Check if we have some new aspects that weren't loaded yet
85	8	$unloadedAspects = $this->aspectLoader->getUnloadedAspects();
86	8	if (!empty($unloadedAspects)) {
87	1	$this->loadAndRegisterAspects($unloadedAspects);
88		}
89	8	$advisors = $this->container->getByTag('advisor');
90
91	8	$namespaces = $parsedSource->getFileNamespaces();
92
93	8	foreach ($namespaces as $namespace) {
94	8	$classes = $namespace->getClasses();
95	8	foreach ($classes as $class) {
96		// Skip interfaces and aspects
97	7	if ($class->isInterface() \|\| in_array(Aspect::class, $class->getInterfaceNames())) {
98	2	continue;
99		}
100	6	$wasClassProcessed = $this->processSingleClass($advisors, $metadata, $class);
101	6	$totalTransformations += (integer) $wasClassProcessed;
102		}
103	8	$wasFunctionsProcessed = $this->processFunctions($advisors, $metadata, $namespace);
104	8	$totalTransformations += (integer) $wasFunctionsProcessed;
105		}
106
107	8	$result = ($totalTransformations > 0) ? self::RESULT_TRANSFORMED : self::RESULT_ABSTAIN;
108
109	8	return $result;
110		}
111
112		/**
113		* Performs weaving of single class if needed, returns true if the class was processed
114		*
115		* @param Advisor[] $advisors List of advisors
116		*/
117	6	private function processSingleClass(array $advisors, StreamMetaData $metadata, ReflectionClass $class): bool
118		{
119	6	$advices = $this->adviceMatcher->getAdvicesForClass($class, $advisors);
120
121	6	if (empty($advices)) {
122		// Fast return if there aren't any advices for that class
123	1	return false;
124		}
125
126		// Sort advices in advance to keep the correct order in cache, and leave only keys for the cache
127	6	$advices = AbstractJoinpoint::flatAndSortAdvices($advices);
		0 ignored issues – show Documentation introduced 2018-05-11 16:32 UTC by Report Bug Copy Issue Report `$advices` is of type `array<integer,object<Go\Aop\Advice>>`, but the function expects a `array<integer,array<inte...bject<Go\Aop\Advice>>>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
128
129		// Prepare new class name
130	6	$newClassName = $class->getShortName() . AspectContainer::AOP_PROXIED_SUFFIX;
131
132		// Replace original class name with new
133	6	$this->adjustOriginalClass($class, $advices, $metadata, $newClassName);
134	6	$newParentName = $class->getNamespaceName() . '\\' . $newClassName;
135
136		// Prepare child Aop proxy
137	6	$childProxyGenerator = $class->isTrait()
138		? new TraitProxyGenerator($class, $newParentName, $advices, $this->useParameterWidening)
139	6	: new ClassProxyGenerator($class, $newParentName, $advices, $this->useParameterWidening);
140
141	6	$refNamespace = new ReflectionFileNamespace($class->getFileName(), $class->getNamespaceName());
142	6	foreach ($refNamespace->getNamespaceAliases() as $fqdn => $alias) {
143	1	$childProxyGenerator->addUse($fqdn, $alias);
144		}
145
146	6	$contentToInclude = $this->saveProxyToCache($class, $childProxyGenerator->generate());
147
148		// Get last token for this class
149	6	$lastClassToken = $class->getNode()->getAttribute('endTokenPos');
150
151	6	$metadata->tokenStream[$lastClassToken][1] .= PHP_EOL . $contentToInclude;
152
153	6	return true;
154		}
155
156		/**
157		* Adjust definition of original class source to enable extending
158		*
159		* @param array $advices List of class advices (used to check for final methods and make them non-final)
160		*/
161	6	private function adjustOriginalClass(
162		ReflectionClass $class,
163		array $advices,
164		StreamMetaData $streamMetaData,
165		string $newClassName
166		): void {
167	6	$classNode = $class->getNode();
168	6	$position = $classNode->getAttribute('startTokenPos');
169		do {
170	6	if (isset($streamMetaData->tokenStream[$position])) {
171	6	$token = $streamMetaData->tokenStream[$position];
172		// Remove final and following whitespace from the class, child will be final instead
173	6	if ($token[0] === T_FINAL) {
174		unset($streamMetaData->tokenStream[$position], $streamMetaData->tokenStream[$position+1]);
175		}
176		// First string is class/trait name
177	6	if ($token[0] === T_STRING) {
178	6	$streamMetaData->tokenStream[$position][1] = $newClassName;
179		// We have finished our job, can break this loop
180	6	break;
181		}
182		}
183	6	++$position;
184	6	} while (true);
185
186	6	foreach ($class->getMethods(ReflectionMethod::IS_FINAL) as $finalMethod) {
187		if (!$finalMethod instanceof ReflectionMethod \|\| $finalMethod->getDeclaringClass()->name !== $class->name) {
188		continue;
189		}
190		$hasDynamicAdvice = isset($advices[AspectContainer::METHOD_PREFIX][$finalMethod->name]);
191		$hasStaticAdvice = isset($advices[AspectContainer::STATIC_METHOD_PREFIX][$finalMethod->name]);
192		if (!$hasDynamicAdvice && !$hasStaticAdvice) {
193		continue;
194		}
195		$methodNode = $finalMethod->getNode();
196		$position = $methodNode->getAttribute('startTokenPos');
197		do {
198		if (isset($streamMetaData->tokenStream[$position])) {
199		$token = $streamMetaData->tokenStream[$position];
200		// Remove final and following whitespace from the method, child will be final instead
201		if ($token[0] === T_FINAL) {
202		unset($streamMetaData->tokenStream[$position], $streamMetaData->tokenStream[$position+1]);
203		break;
204		}
205		}
206		++$position;
207		} while (true);
208		}
209	6	}
210
211		/**
212		* Performs weaving of functions in the current namespace, returns true if functions were processed, false otherwise
213		*
214		* @param Advisor[] $advisors List of advisors
215		*/
216	8	private function processFunctions(
217		array $advisors,
218		StreamMetaData $metadata,
219		ReflectionFileNamespace $namespace
220		): bool {
221	8	static $cacheDirSuffix = '/_functions/';
222
223	8	$wasProcessedFunctions = false;
224	8	$functionAdvices = $this->adviceMatcher->getAdvicesForFunctions($namespace, $advisors);
225	8	$cacheDir = $this->cachePathManager->getCacheDir();
226	8	if (!empty($functionAdvices)) {
227		$cacheDir .= $cacheDirSuffix;
228		$fileName = str_replace('\\', '/', $namespace->getName()) . '.php';
229
230		$functionFileName = $cacheDir . $fileName;
231		if (!file_exists($functionFileName) \|\| !$this->container->isFresh(filemtime($functionFileName))) {
232		$functionAdvices = AbstractJoinpoint::flatAndSortAdvices($functionAdvices);
		0 ignored issues – show Documentation introduced 2018-05-11 16:32 UTC by Report Bug Copy Issue Report `$functionAdvices` is of type `array<integer,object<Go\Aop\Advice>>`, but the function expects a `array<integer,array<inte...bject<Go\Aop\Advice>>>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
233		$dirname = dirname($functionFileName);
234		if (!file_exists($dirname)) {
235		mkdir($dirname, $this->options['cacheFileMode'], true);
236		}
237		$generator = new FunctionProxyGenerator($namespace, $functionAdvices, $this->useParameterWidening);
238		file_put_contents($functionFileName, $generator->generate(), LOCK_EX);
239		// For cache files we don't want executable bits by default
240		chmod($functionFileName, $this->options['cacheFileMode'] & (~0111));
241		}
242		$content = 'include_once AOP_CACHE_DIR . ' . var_export($cacheDirSuffix . $fileName, true) . ';';
243
244		$lastTokenPosition = $namespace->getLastTokenPosition();
245		$metadata->tokenStream[$lastTokenPosition][1] .= PHP_EOL . $content;
246		$wasProcessedFunctions = true;
247		}
248
249	8	return $wasProcessedFunctions;
250		}
251
252		/**
253		* Save AOP proxy to the separate file anr returns the php source code for inclusion
254		*/
255	6	private function saveProxyToCache(ReflectionClass $class, string $childCode): string
256		{
257	6	static $cacheDirSuffix = '/_proxies/';
258
259	6	$cacheDir = $this->cachePathManager->getCacheDir() . $cacheDirSuffix;
260	6	$relativePath = str_replace($this->options['appDir'] . DIRECTORY_SEPARATOR, '', $class->getFileName());
261	6	$proxyRelativePath = str_replace('\\', '/', $relativePath . '/' . $class->getName() . '.php');
262	6	$proxyFileName = $cacheDir . $proxyRelativePath;
263	6	$dirname = dirname($proxyFileName);
264	6	if (!file_exists($dirname)) {
265	6	mkdir($dirname, $this->options['cacheFileMode'], true);
266		}
267
268	6	$body = '<?php' . PHP_EOL . $childCode;
269
270	6	$isVirtualSystem = strpos($proxyFileName, 'vfs') === 0;
271	6	file_put_contents($proxyFileName, $body, $isVirtualSystem ? 0 : LOCK_EX);
272		// For cache files we don't want executable bits by default
273	6	chmod($proxyFileName, $this->options['cacheFileMode'] & (~0111));
274
275	6	return 'include_once AOP_CACHE_DIR . ' . var_export($cacheDirSuffix . $proxyRelativePath, true) . ';';
276		}
277
278		/**
279		* Utility method to load and register unloaded aspects
280		*
281		* @param array $unloadedAspects List of unloaded aspects
282		*/
283	1	private function loadAndRegisterAspects(array $unloadedAspects): void
284		{
285	1	foreach ($unloadedAspects as $unloadedAspect) {
286	1	$this->aspectLoader->loadAndRegister($unloadedAspect);
287		}
288	1	}
289		}
290

goaop / framework

Pull Request — master (#398)

WeavingTransformer::transform() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like