UploadableBehavior::copyFiles() - Code Metrics - Inspection of "Merge pull request #2007 from bedita/feat/v4/clone..." - bedita/bedita - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 4-cactus ( f0b320...c9f1dc )

by Alberto

created 2023-04-28 07:52 UTC

UploadableBehavior::copyFiles() A

↳ Parent: UploadableBehavior

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	5
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	2

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2017-2021 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */

namespace BEdita\Core\Model\Behavior;

use BEdita\Core\Filesystem\FilesystemRegistry;
use Cake\Event\Event;
use Cake\ORM\Behavior;
use Cake\ORM\Entity;
use League\Flysystem\MountManager;
use Psr\Http\Message\StreamInterface;

/**
 * Upload files.
 *
 * @since 4.0.0
 */
class UploadableBehavior extends Behavior
{
    /**
     * @inheritDoc
     */
    protected $_defaultConfig = [
        'files' => [
            [
                'path' => 'path',
                'contents' => 'contents',
            ],
        ],
        'implementedMethods' => [
            'copyFiles' => 'copyFiles',
        ],
    ];

    /**
     * Write file contents.
     *
     * @param \League\Flysystem\MountManager $manager Mount manager.
     * @param string $path File path.
     * @param mixed $contents File contents.
     * @return bool
     */
    protected function write(MountManager $manager, $path, $contents)
    {
        if ($contents instanceof StreamInterface) {
            $contents = $contents->detach();
        }

        if (is_resource($contents)) {
            return $manager->putStream($path, $contents);
        }

        return $manager->put($path, $contents);
    }

    /**
     * Process upload of a single file.
     *
     * @param \Cake\ORM\Entity $entity Entity.
     * @param string $pathField Name of field in which path is stored.
     * @param string $contentsField Name of field in which contents are stored.
     * @return bool
     */
    protected function processUpload(Entity $entity, $pathField, $contentsField)
    {
        $manager = FilesystemRegistry::getMountManager();
        if (
            (!$entity->isDirty($pathField) || !$manager->has($entity->getOriginal($pathField)))
            && !$entity->isDirty($contentsField)
        ) {
            // Nothing to do.
            return true;
        }

        $path = $entity->get($pathField);
        $originalPath = $entity->getOriginal($pathField);
        if ($entity->isDirty($pathField) && $originalPath !== $path) {
            if ($entity->isDirty($contentsField)) {
                // Delete and re-upload.
                return $manager->delete($originalPath) && $this->write($manager, $path, $entity->get($contentsField));
            }

            // Move to new location.
            return $manager->move($originalPath, $path);
        }

        // Updated contents.
        return $this->write($manager, $path, $entity->get($contentsField));
    }

    /**
     * Set `private` file visibility on `private_url`
     *
     * @param \Cake\ORM\Entity $entity Entity.
     * @param string $pathField Name of field in which path is stored.
     * @return void
     */
    protected function setVisibility(Entity $entity, $pathField): void
    {
        if (!$entity->get('private_url')) {
            return;
        }
        $path = $entity->get($pathField);
        $manager = FilesystemRegistry::getMountManager();
        $manager->setVisibility($path, 'private');
    }

    /**
     * Process delete of a single file.
     *
     * @param \Cake\ORM\Entity $entity Entity.
     * @param string $pathField Name of field in which path is stored.
     * @return bool
     */
    protected function processDelete(Entity $entity, $pathField)
    {
        $manager = FilesystemRegistry::getMountManager();
        $path = $entity->get($pathField);

        return !$manager->has($path) || $manager->delete($path);
    }

    /**
     * Process upload.
     *
     * @param \Cake\Event\Event $event Dispatched event.
     * @param \Cake\ORM\Entity $entity Entity.
     * @return void
     */
    public function afterSave(Event $event, Entity $entity)
    public function afterSave(/** @scrutinizer ignore-unused */ Event $event, Entity $entity)
    {
        foreach ($this->getConfig('files') as $file) {
            $this->processUpload($entity, $file['path'], $file['contents']);
            $this->setVisibility($entity, $file['path']);
        }
    }

    /**
     * Process delete.
     *
     * @param \Cake\Event\Event $event Dispatched event.
     * @param \Cake\ORM\Entity $entity Entity.
     * @return void
     */
    public function afterDelete(Event $event, Entity $entity)
    public function afterDelete(/** @scrutinizer ignore-unused */ Event $event, Entity $entity)
    {
        foreach ($this->getConfig('files') as $file) {
            $this->processDelete($entity, $file['path']);
        }
    }

    /**
     * Copy files from an entity to another.
     *
     * @param \Cake\ORM\Entity $src Source entity. It must have path fields set and referenced files must exist.
     * @param \Cake\ORM\Entity $dest Destination entity. It must have path fields set.
     * @return void
     * @throws \League\Flysystem\FilesystemException
     */
    public function copyFiles(Entity $src, Entity $dest): void
    {
        $manager = FilesystemRegistry::getMountManager();
        foreach ($this->getConfig('files') as $file) {
            $srcPath = $src->get($file['path']);
            $destPath = $dest->get($file['path']);

            $manager->copy($srcPath, $destPath);
        }
    }
}


bedita / bedita

Push — 4-cactus ( f0b320...c9f1dc )

UploadableBehavior::copyFiles() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like