Issues in CleanUpModelsCommand.php (master) - Issues in master - spatie/laravel-model-cleanup - Measure and Improve Code Quality continuously with Scrutinizer

Issues (4)

Security Analysis no request data

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/CleanUpModelsCommand.php (4 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Spatie\ModelCleanup;

use Illuminate\Console\Command;
use Illuminate\Support\Collection;
use Illuminate\Filesystem\Filesystem;
use PhpParser\Node\Stmt\Class_;
use PhpParser\NodeTraverser;
use PhpParser\ParserFactory;
use PhpParser\NodeVisitor\NameResolver;

class CleanUpModelsCommand extends Command
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $signature = 'clean:models';
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Clean up models.';

    protected $filesystem;

    public function __construct(Filesystem $filesystem)
    {
        parent::__construct();

        $this->filesystem = $filesystem;
    }

    public function handle()
    {
        $this->comment('Cleaning models...');

        // Cleaning Normal models
        $cleanableModels = $this->getModelsThatShouldBeCleanedUp();
        $this->cleanUp($cleanableModels);

        // Cleaning softdeletes models
        $cleanableModels = $this->getModelsThatShouldBeForcedCleanedUp();
        $this->forceCleanUp($cleanableModels);

        $this->comment('All done!');
    }

    protected function getModelsThatShouldBeCleanedUp() : Collection

    {
        $directories = config('model-cleanup.directories');

        $modelsFromDirectories = $this->getAllModelsFromEachDirectory($directories);

        return $modelsFromDirectories
            ->merge(collect(config('model-cleanup.models')))
            ->filter(function ($modelClass) {
                return in_array(GetsCleanedUp::class, class_implements($modelClass));
            });
    }

    protected function getModelsThatShouldBeForcedCleanedUp() : Collection

    {
        $directories = config('model-cleanup.directories');

        $modelsFromDirectories = $this->getAllModelsFromEachDirectory($directories);

        return $modelsFromDirectories
            ->merge(collect(config('model-cleanup.models')))
            ->filter(function ($modelClass) {
                return in_array(GetsForcedCleanedUp::class, class_implements($modelClass));
            });
    }

    protected function cleanUp(Collection $cleanableModels)
    {
        $cleanableModels->each(function (string $modelClass) {

            $numberOfDeletedRecords = $modelClass::cleanUp($modelClass::query())->delete();

            event(new ModelWasCleanedUp($modelClass, $numberOfDeletedRecords));

            $this->info("Deleted {$numberOfDeletedRecords} record(s) from {$modelClass}.");

        });
    }

    protected function forceCleanUp(Collection $cleanableModels)
    {
        $cleanableModels->each(function (string $modelClass) {

            $numberOfDeletedRecords = $modelClass::forceCleanUp($modelClass::query())->forceDelete();

            event(new ModelWasCleanedUp($modelClass, $numberOfDeletedRecords));

            $this->info("Deleted {$numberOfDeletedRecords} record(s) from {$modelClass}.");

        });
    }

    protected function getAllModelsFromEachDirectory(array $directories) : Collection
    {
        return collect($directories)
            ->map(function ($directory) {
                return $this->getClassNamesInDirectory($directory)->all();
            })
            ->flatten();
    }

    protected function getClassNamesInDirectory(string $directory) : Collection
    {
        $files = config('model-cleanup.recursive', true)
            ? $this->filesystem->allFiles($directory)
            : $this->filesystem->files($directory);

        return collect($files)->map(function (string $path) {

            return $this->getFullyQualifiedClassNameFromFile($path);

        })->filter(function (string $className) {

            return !empty($className);

        });
    }

    protected function getFullyQualifiedClassNameFromFile(string $path) : string
    {
        $parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);

        $traverser = new NodeTraverser();

        $traverser->addVisitor(new NameResolver());

        $code = file_get_contents($path);

        $statements = $parser->parse($code);

        $statements = $traverser->traverse($statements);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return collect($statements[0]->stmts)
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->filter(function ($statement) {
                return $statement instanceof Class_;
            })
            ->map(function (Class_ $statement) {
                return $statement->namespacedName->toString();
            })
            ->first() ?? '';
    }
}


1		<?php
2
3		namespace Spatie\ModelCleanup;
4
5		use Illuminate\Console\Command;
6		use Illuminate\Support\Collection;
7		use Illuminate\Filesystem\Filesystem;
8		use PhpParser\Node\Stmt\Class_;
9		use PhpParser\NodeTraverser;
10		use PhpParser\ParserFactory;
11		use PhpParser\NodeVisitor\NameResolver;
12
13		class CleanUpModelsCommand extends Command
14		{
15		/**
16		* The console command name.
17		*
18		* @var string
19		*/
20		protected $signature = 'clean:models';
21		/**
22		* The console command description.
23		*
24		* @var string
25		*/
26		protected $description = 'Clean up models.';
27
28		protected $filesystem;
29
30		public function __construct(Filesystem $filesystem)
31		{
32		parent::__construct();
33
34		$this->filesystem = $filesystem;
35		}
36
37		public function handle()
38		{
39		$this->comment('Cleaning models...');
40
41		// Cleaning Normal models
42		$cleanableModels = $this->getModelsThatShouldBeCleanedUp();
43		$this->cleanUp($cleanableModels);
44
45		// Cleaning softdeletes models
46		$cleanableModels = $this->getModelsThatShouldBeForcedCleanedUp();
47		$this->forceCleanUp($cleanableModels);
48
49		$this->comment('All done!');
50		}
51
52	View Code Duplication	protected function getModelsThatShouldBeCleanedUp() : Collection
		0 ignored issues – show Duplication introduced 2018-12-12 02:49 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
53		{
54		$directories = config('model-cleanup.directories');
55
56		$modelsFromDirectories = $this->getAllModelsFromEachDirectory($directories);
57
58		return $modelsFromDirectories
59		->merge(collect(config('model-cleanup.models')))
60		->filter(function ($modelClass) {
61		return in_array(GetsCleanedUp::class, class_implements($modelClass));
62		});
63		}
64
65	View Code Duplication	protected function getModelsThatShouldBeForcedCleanedUp() : Collection
		0 ignored issues – show Duplication introduced 2018-12-12 02:49 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
66		{
67		$directories = config('model-cleanup.directories');
68
69		$modelsFromDirectories = $this->getAllModelsFromEachDirectory($directories);
70
71		return $modelsFromDirectories
72		->merge(collect(config('model-cleanup.models')))
73		->filter(function ($modelClass) {
74		return in_array(GetsForcedCleanedUp::class, class_implements($modelClass));
75		});
76		}
77
78		protected function cleanUp(Collection $cleanableModels)
79		{
80		$cleanableModels->each(function (string $modelClass) {
81
82		$numberOfDeletedRecords = $modelClass::cleanUp($modelClass::query())->delete();
83
84		event(new ModelWasCleanedUp($modelClass, $numberOfDeletedRecords));
85
86		$this->info("Deleted {$numberOfDeletedRecords} record(s) from {$modelClass}.");
87
88		});
89		}
90
91		protected function forceCleanUp(Collection $cleanableModels)
92		{
93		$cleanableModels->each(function (string $modelClass) {
94
95		$numberOfDeletedRecords = $modelClass::forceCleanUp($modelClass::query())->forceDelete();
96
97		event(new ModelWasCleanedUp($modelClass, $numberOfDeletedRecords));
98
99		$this->info("Deleted {$numberOfDeletedRecords} record(s) from {$modelClass}.");
100
101		});
102		}
103
104		protected function getAllModelsFromEachDirectory(array $directories) : Collection
105		{
106		return collect($directories)
107		->map(function ($directory) {
108		return $this->getClassNamesInDirectory($directory)->all();
109		})
110		->flatten();
111		}
112
113		protected function getClassNamesInDirectory(string $directory) : Collection
114		{
115		$files = config('model-cleanup.recursive', true)
116		? $this->filesystem->allFiles($directory)
117		: $this->filesystem->files($directory);
118
119		return collect($files)->map(function (string $path) {
120
121		return $this->getFullyQualifiedClassNameFromFile($path);
122
123		})->filter(function (string $className) {
124
125		return !empty($className);
126
127		});
128		}
129
130		protected function getFullyQualifiedClassNameFromFile(string $path) : string
131		{
132		$parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
133
134		$traverser = new NodeTraverser();
135
136		$traverser->addVisitor(new NameResolver());
137
138		$code = file_get_contents($path);
139
140		$statements = $parser->parse($code);
141
142		$statements = $traverser->traverse($statements);
		0 ignored issues – show Bug introduced 2016-07-29 15:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$statements` can also be of type `null`; however, `PhpParser\NodeTraverser::traverse()` does only seem to accept `array<integer,object<PhpParser\Node>>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
143
144		return collect($statements[0]->stmts)
		0 ignored issues – show Bug introduced 2016-03-18 09:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this Accessing `stmts` on the interface `PhpParser\Node` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
145		->filter(function ($statement) {
146		return $statement instanceof Class_;
147		})
148		->map(function (Class_ $statement) {
149		return $statement->namespacedName->toString();
150		})
151		->first() ?? '';
152		}
153		}
154

spatie / laravel-model-cleanup

Issues (4)

Security Analysis no request data

src/CleanUpModelsCommand.php (4 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like