CORE_V5 // MediaCollections

PATH: home / cardxfeb / public_html / vendor / spatie / laravel-medialibrary / src / MediaCollections /

Editing: FileAdder.php

<?php

namespace Spatie\MediaLibrary\MediaCollections;

use Closure;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Traits\Macroable;
use Spatie\MediaLibrary\Conversions\ImageGenerators\Image as ImageGenerator;
use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\MediaCollections\Exceptions\DiskCannotBeAccessed;
use Spatie\MediaLibrary\MediaCollections\Exceptions\DiskDoesNotExist;
use Spatie\MediaLibrary\MediaCollections\Exceptions\FileDoesNotExist;
use Spatie\MediaLibrary\MediaCollections\Exceptions\FileIsTooBig;
use Spatie\MediaLibrary\MediaCollections\Exceptions\FileUnacceptableForCollection;
use Spatie\MediaLibrary\MediaCollections\Exceptions\UnknownType;
use Spatie\MediaLibrary\MediaCollections\File as PendingFile;
use Spatie\MediaLibrary\MediaCollections\Models\Media;
use Spatie\MediaLibrary\ResponsiveImages\Jobs\GenerateResponsiveImagesJob;
use Spatie\MediaLibrary\Support\File;
use Spatie\MediaLibrary\Support\RemoteFile;
use Spatie\MediaLibraryPro\Models\TemporaryUpload;
use Symfony\Component\HttpFoundation\File\File as SymfonyFile;
use Symfony\Component\HttpFoundation\File\UploadedFile;

/**
 * @template TModel of \Spatie\MediaLibrary\MediaCollections\Models\Media
 */
class FileAdder
{
    use Macroable;

protected ?Model $subject = null;

protected bool $preserveOriginal = false;

/** @var \Symfony\Component\HttpFoundation\File\UploadedFile|string */
    protected $file;

protected array $properties = [];

protected array $customProperties = [];

protected array $manipulations = [];

protected string $pathToFile = '';

protected string $fileName = '';

protected string $mediaName = '';

protected string $diskName = '';

protected string $conversionsDiskName = '';

protected ?Closure $fileNameSanitizer;

protected bool $generateResponsiveImages = false;

protected array $customHeaders = [];

public ?int $order = null;

public function __construct(
        protected ?Filesystem $filesystem
    ) {
        $this->fileNameSanitizer = fn ($fileName) => $this->defaultSanitizer($fileName);
    }

public function setSubject(Model $subject): self
    {
        $this->subject = $subject;

return $this;
    }

/*
     * Set the file that needs to be imported.
     *
     * @param string|\Symfony\Component\HttpFoundation\File\UploadedFile $file
     *
     * @return $this
     */
    public function setFile($file): self
    {
        $this->file = $file;

if (is_string($file)) {
            $this->pathToFile = $file;
            $this->setFileName(pathinfo($file, PATHINFO_BASENAME));
            $this->mediaName = pathinfo($file, PATHINFO_FILENAME);

return $this;
        }

if ($file instanceof RemoteFile) {
            $this->pathToFile = $file->getKey();
            $this->setFileName($file->getFilename());
            $this->mediaName = $file->getName();

return $this;
        }

if ($file instanceof UploadedFile) {
            $this->pathToFile = $file->getPath().'/'.$file->getFilename();
            $this->setFileName($file->getClientOriginalName());
            $this->mediaName = pathinfo($file->getClientOriginalName(), PATHINFO_FILENAME);

return $this;
        }

if ($file instanceof SymfonyFile) {
            $this->pathToFile = $file->getPath().'/'.$file->getFilename();
            $this->setFileName(pathinfo($file->getFilename(), PATHINFO_BASENAME));
            $this->mediaName = pathinfo($file->getFilename(), PATHINFO_FILENAME);

return $this;
        }

if ($file instanceof TemporaryUpload) {
            return $this;
        }

throw UnknownType::create();
    }

public function preservingOriginal(bool $preserveOriginal = true): self
    {
        $this->preserveOriginal = $preserveOriginal;

return $this;
    }

public function usingName(string $name): self
    {
        return $this->setName($name);
    }

public function setName(string $name): self
    {
        $this->mediaName = $name;

return $this;
    }

public function setOrder(?int $order): self
    {
        $this->order = $order;

return $this;
    }

public function usingFileName(string $fileName): self
    {
        return $this->setFileName($fileName);
    }

public function setFileName(string $fileName): self
    {
        $this->fileName = $fileName;

return $this;
    }

public function withCustomProperties(array $customProperties): self
    {
        $this->customProperties = $customProperties;

return $this;
    }

public function storingConversionsOnDisk(string $diskName): self
    {
        $this->conversionsDiskName = $diskName;

return $this;
    }

public function withManipulations(array $manipulations): self
    {
        $this->manipulations = $manipulations;

return $this;
    }

public function withProperties(array $properties): self
    {
        $this->properties = $properties;

return $this;
    }

public function withAttributes(array $properties): self
    {
        return $this->withProperties($properties);
    }

public function withResponsiveImages(): self
    {
        $this->generateResponsiveImages = true;

return $this;
    }

public function withResponsiveImagesIf($condition): self
    {
        $this->generateResponsiveImages = (bool) (is_callable($condition) ? $condition() : $condition);

return $this;
    }

public function addCustomHeaders(array $customRemoteHeaders): self
    {
        $this->customHeaders = $customRemoteHeaders;

$this->filesystem->addCustomRemoteHeaders($customRemoteHeaders);

return $this;
    }

/**
     * @return TModel
     */
    public function toMediaCollectionOnCloudDisk(string $collectionName = 'default'): Media
    {
        return $this->toMediaCollection($collectionName, config('filesystems.cloud'));
    }

/**
     * @return TModel
     */
    public function toMediaCollectionFromRemote(string $collectionName = 'default', string $diskName = ''): Media
    {
        $storage = Storage::disk($this->file->getDisk());

if (! $storage->exists($this->pathToFile)) {
            throw FileDoesNotExist::create($this->pathToFile);
        }

if ($storage->size($this->pathToFile) > config('media-library.max_file_size')) {
            throw FileIsTooBig::create($this->pathToFile, $storage->size($this->pathToFile));
        }

$mediaClass = config('media-library.media_model');
        /** @var \Spatie\MediaLibrary\MediaCollections\Models\Media $media */
        $media = new $mediaClass();

$media->name = $this->mediaName;

$sanitizedFileName = ($this->fileNameSanitizer)($this->fileName);
        $fileName = app(config('media-library.file_namer'))->originalFileName($sanitizedFileName);
        $this->fileName = $this->appendExtension($fileName, pathinfo($sanitizedFileName, PATHINFO_EXTENSION));

$media->file_name = $this->fileName;

$media->disk = $this->determineDiskName($diskName, $collectionName);
        $this->ensureDiskExists($media->disk);
        $media->conversions_disk = $this->determineConversionsDiskName($media->disk, $collectionName);
        $this->ensureDiskExists($media->conversions_disk);

$media->collection_name = $collectionName;

$media->mime_type = $storage->mimeType($this->pathToFile);
        $media->size = $storage->size($this->pathToFile);
        $media->custom_properties = $this->customProperties;

$media->generated_conversions = [];
        $media->responsive_images = [];

$media->manipulations = $this->manipulations;

if (filled($this->customHeaders)) {
            $media->setCustomHeaders($this->customHeaders);
        }

$media->fill($this->properties);

$this->attachMedia($media);

return $media;
    }

/**
     * @return TModel
     */
    public function toMediaCollection(string $collectionName = 'default', string $diskName = ''): Media
    {
        $sanitizedFileName = ($this->fileNameSanitizer)($this->fileName);
        $fileName = app(config('media-library.file_namer'))->originalFileName($sanitizedFileName);
        $this->fileName = $this->appendExtension($fileName, pathinfo($sanitizedFileName, PATHINFO_EXTENSION));

if ($this->file instanceof RemoteFile) {
            return $this->toMediaCollectionFromRemote($collectionName, $diskName);
        }

if ($this->file instanceof TemporaryUpload) {
            return $this->toMediaCollectionFromTemporaryUpload($collectionName, $diskName, $this->fileName);
        }

if (! is_file($this->pathToFile)) {
            throw FileDoesNotExist::create($this->pathToFile);
        }

if (filesize($this->pathToFile) > config('media-library.max_file_size')) {
            throw FileIsTooBig::create($this->pathToFile);
        }

$mediaClass = config('media-library.media_model');
        /** @var \Spatie\MediaLibrary\MediaCollections\Models\Media $media */
        $media = new $mediaClass();

$media->name = $this->mediaName;

$media->file_name = $this->fileName;

$media->disk = $this->determineDiskName($diskName, $collectionName);
        $this->ensureDiskExists($media->disk);

$media->conversions_disk = $this->determineConversionsDiskName($media->disk, $collectionName);
        $this->ensureDiskExists($media->conversions_disk);

$media->collection_name = $collectionName;

$media->mime_type = File::getMimeType($this->pathToFile);
        $media->size = filesize($this->pathToFile);

if (! is_null($this->order)) {
            $media->order_column = $this->order;
        }

$media->custom_properties = $this->customProperties;

$media->generated_conversions = [];
        $media->responsive_images = [];

$media->manipulations = $this->manipulations;

if (filled($this->customHeaders)) {
            $media->setCustomHeaders($this->customHeaders);
        }

$media->fill($this->properties);

$this->attachMedia($media);

return $media;
    }

/**
     * @return TModel
     */
    public function toMediaLibrary(string $collectionName = 'default', string $diskName = ''): Media
    {
        return $this->toMediaCollection($collectionName, $diskName);
    }

protected function determineDiskName(string $diskName, string $collectionName): string
    {
        if ($diskName !== '') {
            return $diskName;
        }

if ($collection = $this->getMediaCollection($collectionName)) {
            $collectionDiskName = $collection->diskName;

if ($collectionDiskName !== '') {
                return $collectionDiskName;
            }
        }

return config('media-library.disk_name');
    }

protected function determineConversionsDiskName(string $originalsDiskName, string $collectionName): string
    {
        if ($this->conversionsDiskName !== '') {
            return $this->conversionsDiskName;
        }

if ($collection = $this->getMediaCollection($collectionName)) {
            $collectionConversionsDiskName = $collection->conversionsDiskName;

if ($collectionConversionsDiskName !== '') {
                return $collectionConversionsDiskName;
            }
        }

return $originalsDiskName;
    }

protected function ensureDiskExists(string $diskName)
    {
        if (is_null(config("filesystems.disks.{$diskName}"))) {
            throw DiskDoesNotExist::create($diskName);
        }
    }

public function defaultSanitizer(string $fileName): string
    {
        $fileName = preg_replace('#\p{C}+#u', '', $fileName);

return str_replace(['#', '/', '\\', ' '], '-', $fileName);
    }

public function sanitizingFileName(callable $fileNameSanitizer): self
    {
        $this->fileNameSanitizer = $fileNameSanitizer;

return $this;
    }

protected function attachMedia(Media $media)
    {
        if (! $this->subject->exists) {
            $this->subject->prepareToAttachMedia($media, $this);

$class = $this->subject::class;

$class::created(function ($model) {
                $model->processUnattachedMedia(function (Media $media, self $fileAdder) use ($model) {
                    $this->processMediaItem($model, $media, $fileAdder);
                });
            });

return;
        }

$this->processMediaItem($this->subject, $media, $this);
    }

protected function processMediaItem(HasMedia $model, Media $media, self $fileAdder)
    {
        $this->guardAgainstDisallowedFileAdditions($media);

$this->checkGenerateResponsiveImages($media);

if (! $media->getConnectionName()) {
            $media->setConnection($model->getConnectionName());
        }

$model->media()->save($media);

if ($fileAdder->file instanceof RemoteFile) {
            $addedMediaSuccessfully = $this->filesystem->addRemote($fileAdder->file, $media, $fileAdder->fileName);
        } else {
            $addedMediaSuccessfully = $this->filesystem->add($fileAdder->pathToFile, $media, $fileAdder->fileName);
        }

if (! $addedMediaSuccessfully) {
            $media->forceDelete();

throw DiskCannotBeAccessed::create($media->disk);
        }

if (! $fileAdder->preserveOriginal) {
            if ($fileAdder->file instanceof RemoteFile) {
                Storage::disk($fileAdder->file->getDisk())->delete($fileAdder->file->getKey());
            } else {
                unlink($fileAdder->pathToFile);
            }
        }

if ($this->generateResponsiveImages && (new ImageGenerator())->canConvert($media)) {
            $generateResponsiveImagesJobClass = config('media-library.jobs.generate_responsive_images', GenerateResponsiveImagesJob::class);

$job = new $generateResponsiveImagesJobClass($media);

if ($customConnection = config('media-library.queue_connection_name')) {
                $job->onConnection($customConnection);
            }

if ($customQueue = config('media-library.queue_name')) {
                $job->onQueue($customQueue);
            }

dispatch($job);
        }

if ($collectionSizeLimit = optional($this->getMediaCollection($media->collection_name))->collectionSizeLimit) {
            $collectionMedia = $this->subject->fresh()->getMedia($media->collection_name);

if ($collectionMedia->count() > $collectionSizeLimit) {
                $model->clearMediaCollectionExcept($media->collection_name, $collectionMedia->slice(-$collectionSizeLimit, $collectionSizeLimit));
            }
        }
    }

protected function getMediaCollection(string $collectionName): ?MediaCollection
    {
        $this->subject->registerMediaCollections();

return collect($this->subject->mediaCollections)
            ->first(fn (MediaCollection $collection) => $collection->name === $collectionName);
    }

protected function guardAgainstDisallowedFileAdditions(Media $media)
    {
        $file = PendingFile::createFromMedia($media);

if (! $collection = $this->getMediaCollection($media->collection_name)) {
            return;
        }

if (! ($collection->acceptsFile)($file, $this->subject)) {
            throw FileUnacceptableForCollection::create($file, $collection, $this->subject);
        }

if (! empty($collection->acceptsMimeTypes) && ! in_array($file->mimeType, $collection->acceptsMimeTypes)) {
            throw FileUnacceptableForCollection::create($file, $collection, $this->subject);
        }
    }

protected function checkGenerateResponsiveImages(Media $media)
    {
        $collection = optional($this->getMediaCollection($media->collection_name))->generateResponsiveImages;

if ($collection) {
            $this->withResponsiveImages();
        }
    }

protected function toMediaCollectionFromTemporaryUpload(string $collectionName, string $diskName, string $fileName = ''): Media
    {
        /** @var TemporaryUpload $temporaryUpload */
        $temporaryUpload = $this->file;

$media = $temporaryUpload->getFirstMedia();

$media->name = $this->mediaName;
        $media->custom_properties = $this->customProperties;

if (! is_null($this->order)) {
            $media->order_column = $this->order;
        }

$media->setCustomHeaders($this->customHeaders);

$media->save();

return $temporaryUpload->moveMedia($this->subject, $collectionName, $diskName, $fileName);
    }

protected function appendExtension(string $file, ?string $extension): string
    {
        return $extension
            ? $file . '.' . $extension
            : $file;
    }
}

CANCEL