Issues in CleanCommand.php (master) - Issues in master - spatie/laravel-medialibrary - Measure and Improve Code Quality continuously with Scrutinizer

Issues (74)

Security Analysis not enabled

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/Commands/CleanCommand.php (7 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\MediaLibrary\Commands;

use Illuminate\Console\Command;
use Illuminate\Console\ConfirmableTrait;
use Illuminate\Contracts\Filesystem\Factory;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Support\Str;
use Spatie\MediaLibrary\Conversion\Conversion;
use Spatie\MediaLibrary\Conversion\ConversionCollection;
use Spatie\MediaLibrary\Exceptions\FileCannotBeAdded;
use Spatie\MediaLibrary\FileManipulator;
use Spatie\MediaLibrary\MediaRepository;
use Spatie\MediaLibrary\Models\Media;
use Spatie\MediaLibrary\PathGenerator\BasePathGenerator;
use Spatie\MediaLibrary\ResponsiveImages\RegisteredResponsiveImages;

class CleanCommand extends Command
{
    use ConfirmableTrait;

    protected $signature = 'medialibrary:clean {modelType?} {collectionName?} {disk?}
    {--dry-run : List files that will be removed without removing them},
    {--force : Force the operation to run when in production},
    {--rate-limit= : Limit the number of request per second }';

    protected $description = 'Clean deprecated conversions and files without related model.';

    /** @var \Spatie\MediaLibrary\MediaRepository */
    protected $mediaRepository;

    /** @var \Spatie\MediaLibrary\FileManipulator */
    protected $fileManipulator;

    /** @var \Illuminate\Contracts\Filesystem\Factory */
    protected $fileSystem;

    /** @var \Spatie\MediaLibrary\PathGenerator\BasePathGenerator */
    protected $basePathGenerator;

    /** @var bool */
    protected $isDryRun = false;

    /** @var int */
    protected $rateLimit = 0;

    /**
     * @param \Spatie\MediaLibrary\MediaRepository                 $mediaRepository
     * @param \Spatie\MediaLibrary\FileManipulator                 $fileManipulator
     * @param \Illuminate\Contracts\Filesystem\Factory             $fileSystem
     * @param \Spatie\MediaLibrary\PathGenerator\BasePathGenerator $basePathGenerator
     */
    public function __construct(
        MediaRepository $mediaRepository,
        FileManipulator $fileManipulator,
        Factory $fileSystem,
        BasePathGenerator $basePathGenerator
    ) {
        parent::__construct();

        $this->mediaRepository = $mediaRepository;
        $this->fileManipulator = $fileManipulator;
        $this->fileSystem = $fileSystem;
        $this->basePathGenerator = $basePathGenerator;
    }

    public function handle()
    {
        if (! $this->confirmToProceed()) {
            return;
        }

        $this->isDryRun = $this->option('dry-run');
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->rateLimit = (int) $this->option('rate-limit');

        $this->deleteFilesGeneratedForDeprecatedConversions();

        $this->deleteOrphanedDirectories();

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

    public function getMediaItems(): Collection
    {
        $modelType = $this->argument('modelType');
        $collectionName = $this->argument('collectionName');

        if (! is_null($modelType) && ! is_null($collectionName)) {
            return $this->mediaRepository->getByModelTypeAndCollectionName(
                $modelType,
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $collectionName
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        if (! is_null($modelType)) {
            return $this->mediaRepository->getByModelType($modelType);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        if (! is_null($collectionName)) {
            return $this->mediaRepository->getByCollectionName($collectionName);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        return $this->mediaRepository->all();
    }

    protected function deleteFilesGeneratedForDeprecatedConversions()
    {
        $this->getMediaItems()->each(function (Media $media) {
            $this->deleteConversionFilesForDeprecatedConversions($media);

            if ($media->responsive_images) {
                $this->deleteResponsiveImagesForDeprecatedConversions($media);
            }

            if ($this->rateLimit) {
                usleep((1 / $this->rateLimit) * 1000000 * 2);
            }
        });
    }

    protected function deleteConversionFilesForDeprecatedConversions(Media $media)
    {
        $conversionFilePaths = ConversionCollection::createForMedia($media)->getConversionsFiles($media->collection_name);

        $conversionPath = $this->basePathGenerator->getPathForConversions($media);
        $currentFilePaths = $this->fileSystem->disk($media->disk)->files($conversionPath);

        collect($currentFilePaths)
            ->reject(function (string $currentFilePath) use ($conversionFilePaths) {
                return $conversionFilePaths->contains(basename($currentFilePath));
            })
            ->each(function (string $currentFilePath) use ($media) {
                if (! $this->isDryRun) {
                    $this->fileSystem->disk($media->disk)->delete($currentFilePath);

                    $this->markConversionAsRemoved($media, $currentFilePath);
                }

                $this->info("Deprecated conversion file `{$currentFilePath}` ".($this->isDryRun ? 'found' : 'has been removed'));
            });
    }

    protected function deleteResponsiveImagesForDeprecatedConversions(Media $media)
    {
        $conversionNames = ConversionCollection::createForMedia($media)
            ->map(function (Conversion $conversion) {
                return $conversion->getName();
            })
            ->push('medialibrary_original');

        $responsiveImagesGeneratedFor = array_keys($media->responsive_images);

        collect($responsiveImagesGeneratedFor)
            ->map(function (string $generatedFor) use ($media) {
                return $media->responsiveImages($generatedFor);
            })
            ->reject(function (RegisteredResponsiveImages $responsiveImages) use ($conversionNames) {
                return $conversionNames->contains($responsiveImages->generatedFor);
            })
            ->each(function (RegisteredResponsiveImages $responsiveImages) {
                if (! $this->isDryRun) {
                    $responsiveImages->delete();
                }
            });
    }

    protected function deleteOrphanedDirectories()
    {
        $diskName = $this->argument('disk') ?: config('medialibrary.disk_name');

        if (is_null(config("filesystems.disks.{$diskName}"))) {
            throw FileCannotBeAdded::diskDoesNotExist($diskName);

        }
        $mediaClass = config('medialibrary.media_model');
        $mediaInstance = new $mediaClass();
        $keyName = $mediaInstance->getKeyName();

        $mediaIds = collect($this->mediaRepository->all()->pluck($keyName)->toArray());

        collect($this->fileSystem->disk($diskName)->directories())
            ->filter(function (string $directory) {
                return is_numeric($directory);
            })
            ->reject(function (string $directory) use ($mediaIds) {
                return $mediaIds->contains((int) $directory);
            })->each(function (string $directory) use ($diskName) {
                if (! $this->isDryRun) {
                    $this->fileSystem->disk($diskName)->deleteDirectory($directory);
                }

                if ($this->rateLimit) {
                    usleep((1 / $this->rateLimit) * 1000000);
                }

                $this->info("Orphaned media directory `{$directory}` ".($this->isDryRun ? 'found' : 'has been removed'));
            });
    }

    protected function markConversionAsRemoved(Media $media, string $conversionPath)
    {
        $conversionFile = pathinfo($conversionPath, PATHINFO_FILENAME);

        $generatedConversionName = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        $media->getGeneratedConversions()
            ->filter(function (bool $isGenerated, string $generatedConversionName) use ($conversionFile) {
                return Str::contains($conversionFile, $generatedConversionName);
            })
            ->each(function (bool $isGenerated, string $generatedConversionName) use ($media) {
                $media->markAsConversionGenerated($generatedConversionName, false);
            });

        $media->save();
    }
}


1			<?php
2
3			namespace Spatie\MediaLibrary\Commands;
4
5			use Illuminate\Console\Command;
6			use Illuminate\Console\ConfirmableTrait;
7			use Illuminate\Contracts\Filesystem\Factory;
8			use Illuminate\Database\Eloquent\Collection;
9			use Illuminate\Support\Str;
10			use Spatie\MediaLibrary\Conversion\Conversion;
11			use Spatie\MediaLibrary\Conversion\ConversionCollection;
12			use Spatie\MediaLibrary\Exceptions\FileCannotBeAdded;
13			use Spatie\MediaLibrary\FileManipulator;
14			use Spatie\MediaLibrary\MediaRepository;
15			use Spatie\MediaLibrary\Models\Media;
16			use Spatie\MediaLibrary\PathGenerator\BasePathGenerator;
17			use Spatie\MediaLibrary\ResponsiveImages\RegisteredResponsiveImages;
18
19			class CleanCommand extends Command
20			{
21			use ConfirmableTrait;
22
23			protected $signature = 'medialibrary:clean {modelType?} {collectionName?} {disk?}
24			{--dry-run : List files that will be removed without removing them},
25			{--force : Force the operation to run when in production},
26			{--rate-limit= : Limit the number of request per second }';
27
28			protected $description = 'Clean deprecated conversions and files without related model.';
29
30			/** @var \Spatie\MediaLibrary\MediaRepository */
31			protected $mediaRepository;
32
33			/** @var \Spatie\MediaLibrary\FileManipulator */
34			protected $fileManipulator;
35
36			/** @var \Illuminate\Contracts\Filesystem\Factory */
37			protected $fileSystem;
38
39			/** @var \Spatie\MediaLibrary\PathGenerator\BasePathGenerator */
40			protected $basePathGenerator;
41
42			/** @var bool */
43			protected $isDryRun = false;
44
45			/** @var int */
46			protected $rateLimit = 0;
47
48			/**
49			* @param \Spatie\MediaLibrary\MediaRepository $mediaRepository
50			* @param \Spatie\MediaLibrary\FileManipulator $fileManipulator
51			* @param \Illuminate\Contracts\Filesystem\Factory $fileSystem
52			* @param \Spatie\MediaLibrary\PathGenerator\BasePathGenerator $basePathGenerator
53			*/
54			public function __construct(
55			MediaRepository $mediaRepository,
56			FileManipulator $fileManipulator,
57			Factory $fileSystem,
58			BasePathGenerator $basePathGenerator
59			) {
60			parent::__construct();
61
62			$this->mediaRepository = $mediaRepository;
63			$this->fileManipulator = $fileManipulator;
64			$this->fileSystem = $fileSystem;
65			$this->basePathGenerator = $basePathGenerator;
66			}
67
68			public function handle()
69			{
70			if (! $this->confirmToProceed()) {
71			return;
72			}
73
74			$this->isDryRun = $this->option('dry-run');
			0 ignored issues – show Documentation Bug introduced 2018-11-12 18:02 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$this->option('dry-run')` can also be of type `array` or `string`. However, the property `$isDryRun` is declared as type `boolean`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
75			$this->rateLimit = (int) $this->option('rate-limit');
76
77			$this->deleteFilesGeneratedForDeprecatedConversions();
78
79			$this->deleteOrphanedDirectories();
80
81			$this->info('All done!');
82			}
83
84			public function getMediaItems(): Collection
85			{
86			$modelType = $this->argument('modelType');
87			$collectionName = $this->argument('collectionName');
88
89			if (! is_null($modelType) && ! is_null($collectionName)) {
90			return $this->mediaRepository->getByModelTypeAndCollectionName(
91			$modelType,
			0 ignored issues – show Bug introduced 2016-02-17 08:52 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$modelType` defined by `$this->argument('modelType')` on line `86` can also be of type `array`; however, `Spatie\MediaLibrary\Medi...TypeAndCollectionName()` does only seem to accept `string`, 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...
92			$collectionName
			0 ignored issues – show Bug introduced 2016-02-17 08:52 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$collectionName` defined by `$this->argument('collectionName')` on line `87` can also be of type `array`; however, `Spatie\MediaLibrary\Medi...TypeAndCollectionName()` does only seem to accept `string`, 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...
93			);
94			}
95
96			if (! is_null($modelType)) {
97			return $this->mediaRepository->getByModelType($modelType);
			0 ignored issues – show Bug introduced 2017-04-18 16:25 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$modelType` defined by `$this->argument('modelType')` on line `86` can also be of type `array`; however, `Spatie\MediaLibrary\Medi...itory::getByModelType()` does only seem to accept `string`, 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...
98			}
99
100			if (! is_null($collectionName)) {
101			return $this->mediaRepository->getByCollectionName($collectionName);
			0 ignored issues – show Bug introduced 2016-02-17 08:52 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$collectionName` defined by `$this->argument('collectionName')` on line `87` can also be of type `array`; however, `Spatie\MediaLibrary\Medi...::getByCollectionName()` does only seem to accept `string`, 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...
102			}
103
104			return $this->mediaRepository->all();
105			}
106
107			protected function deleteFilesGeneratedForDeprecatedConversions()
108			{
109			$this->getMediaItems()->each(function (Media $media) {
110			$this->deleteConversionFilesForDeprecatedConversions($media);
111
112			if ($media->responsive_images) {
113			$this->deleteResponsiveImagesForDeprecatedConversions($media);
114			}
115
116			if ($this->rateLimit) {
117			usleep((1 / $this->rateLimit) * 1000000 * 2);
118			}
119			});
120			}
121
122			protected function deleteConversionFilesForDeprecatedConversions(Media $media)
123			{
124			$conversionFilePaths = ConversionCollection::createForMedia($media)->getConversionsFiles($media->collection_name);
125
126			$conversionPath = $this->basePathGenerator->getPathForConversions($media);
127			$currentFilePaths = $this->fileSystem->disk($media->disk)->files($conversionPath);
128
129			collect($currentFilePaths)
130			->reject(function (string $currentFilePath) use ($conversionFilePaths) {
131			return $conversionFilePaths->contains(basename($currentFilePath));
132			})
133			->each(function (string $currentFilePath) use ($media) {
134			if (! $this->isDryRun) {
135			$this->fileSystem->disk($media->disk)->delete($currentFilePath);
136
137			$this->markConversionAsRemoved($media, $currentFilePath);
138			}
139
140			$this->info("Deprecated conversion file `{$currentFilePath}` ".($this->isDryRun ? 'found' : 'has been removed'));
141			});
142			}
143
144			protected function deleteResponsiveImagesForDeprecatedConversions(Media $media)
145			{
146			$conversionNames = ConversionCollection::createForMedia($media)
147			->map(function (Conversion $conversion) {
148			return $conversion->getName();
149			})
150			->push('medialibrary_original');
151
152			$responsiveImagesGeneratedFor = array_keys($media->responsive_images);
153
154			collect($responsiveImagesGeneratedFor)
155			->map(function (string $generatedFor) use ($media) {
156			return $media->responsiveImages($generatedFor);
157			})
158			->reject(function (RegisteredResponsiveImages $responsiveImages) use ($conversionNames) {
159			return $conversionNames->contains($responsiveImages->generatedFor);
160			})
161			->each(function (RegisteredResponsiveImages $responsiveImages) {
162			if (! $this->isDryRun) {
163			$responsiveImages->delete();
164			}
165			});
166			}
167
168			protected function deleteOrphanedDirectories()
169			{
170			$diskName = $this->argument('disk') ?: config('medialibrary.disk_name');
171
172			if (is_null(config("filesystems.disks.{$diskName}"))) {
173			throw FileCannotBeAdded::diskDoesNotExist($diskName);
			0 ignored issues – show Bug introduced 2017-01-30 11:16 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `diskDoesNotExist()` does not seem to exist on `object<Spatie\MediaLibra...ions\FileCannotBeAdded>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
174			}
175			$mediaClass = config('medialibrary.media_model');
176			$mediaInstance = new $mediaClass();
177			$keyName = $mediaInstance->getKeyName();
178
179			$mediaIds = collect($this->mediaRepository->all()->pluck($keyName)->toArray());
180
181			collect($this->fileSystem->disk($diskName)->directories())
182			->filter(function (string $directory) {
183			return is_numeric($directory);
184			})
185			->reject(function (string $directory) use ($mediaIds) {
186			return $mediaIds->contains((int) $directory);
187			})->each(function (string $directory) use ($diskName) {
188			if (! $this->isDryRun) {
189			$this->fileSystem->disk($diskName)->deleteDirectory($directory);
190			}
191
192			if ($this->rateLimit) {
193			usleep((1 / $this->rateLimit) * 1000000);
194			}
195
196			$this->info("Orphaned media directory `{$directory}` ".($this->isDryRun ? 'found' : 'has been removed'));
197			});
198			}
199
200			protected function markConversionAsRemoved(Media $media, string $conversionPath)
201			{
202			$conversionFile = pathinfo($conversionPath, PATHINFO_FILENAME);
203
204			$generatedConversionName = null;
			0 ignored issues – show Unused Code introduced 2018-04-30 09:51 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$generatedConversionName` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
205
206			$media->getGeneratedConversions()
207			->filter(function (bool $isGenerated, string $generatedConversionName) use ($conversionFile) {
208			return Str::contains($conversionFile, $generatedConversionName);
209			})
210			->each(function (bool $isGenerated, string $generatedConversionName) use ($media) {
211			$media->markAsConversionGenerated($generatedConversionName, false);
212			});
213
214			$media->save();
215			}
216			}
217

spatie / laravel-medialibrary

Issues (74)

Security Analysis not enabled

src/Commands/CleanCommand.php (7 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like