AbstractNode - Code Metrics - Inspection of "fixes" - gyselroth/balloon - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Branch — dev (bc6e47)

by Raffael
created 2017-12-08 16:01 UTC
AbstractNode F

↳ Parent: Project
Complexity

Total Complexity
150
Size/Duplication

Total Lines	1159
Duplicated Lines	0 %
Coupling/Cohesion

Components	1
Dependencies	13
Importance

Changes
Metric	Value
wmc	150
cbo	13
dl	0
loc	1159
rs	2.8148
c	0
b	0
f	0
lcom	1
45 Methods

Rating	Name	Size	Complexity
A	__toString()	4	1
A	getOwner()	4	1
A	setFilesystem()	7	1
A	getFilesystem()	4	1
B	isSubNode()	18	5
C	setParent()	78	22
B	getShareId()	20	9
A	getShareNode()	8	2
A	isReadonly()	4	1
A	isOwnerRequest()	4	2
A	isSpecial()	14	4
A	isShareMember()	4	2
A	isShare()	4	2
A	isShared()	8	2
A	setName()	20	3
A	checkName()	15	4
A	getName()	4	1
C	undelete()	89	10
A	isDeleted()	4	1
A	getLastModified()	8	2
A	getId()	8	2
C	getParent()	30	7
A	getParents()	14	3
A	getZip()	12	2
C	zip()	42	12
A	getContentType()	4	1
A	isReference()	4	1
A	setAppAttributes()	7	1
A	setAppAttribute()	11	2
A	unsetAppAttributes()	9	2
A	unsetAppAttribute()	9	2
A	getAppAttribute()	8	2
A	getAppAttributes()	8	2
A	setMetaAttribute()	7	1
B	validateMetaAttribute()	23	6
B	getMetaAttribute()	12	5
A	setReadonly()	6	1
A	setDestroyable()	10	2
A	getRawAttributes()	4	1
A	isInRoot()	4	1
A	isRoot()	4	2
A	getPath()	11	2
C	save()	64	10
A	getDuplicateName()	18	4
	_forceDelete()	1	?
How to fix Complexity

<?php

declare(strict_types=1);

/**
 * Balloon
 *
 * @author      Raffael Sahli <[email protected]>
 * @copyright   Copryright (c) 2012-2017 gyselroth GmbH (https://gyselroth.com)
 * @license     GPL-3.0 https://opensource.org/licenses/GPL-3.0
 */

namespace Balloon\Filesystem\Node;

use Balloon\App\AppInterface;
use Balloon\Exception;
use Balloon\Filesystem;
use Balloon\Filesystem\Acl;
use Balloon\Filesystem\Acl\Exception\Forbidden as ForbiddenException;
use Balloon\Filesystem\Storage;
use Balloon\Hook;
use Balloon\Server;
use Balloon\Server\User;
use MongoDB\BSON\ObjectId;
use MongoDB\BSON\UTCDateTime;
use MongoDB\Database;
use Normalizer;
use PHPZip\Zip\Stream\ZipStream;
use Psr\Log\LoggerInterface;

abstract class AbstractNode implements NodeInterface
{
    /**
     * name max lenght.
     */
    const MAX_NAME_LENGTH = 255;

    /**
     * Unique id.
     *
     * @var ObjectId
     */
    protected $_id;

    /**
     * Node name.
     *
     * @var string
     */
    protected $name = '';

    /**
     * Owner.
     *
     * @var ObjectId
     */
    protected $owner;

    /**
     * Mime.
     *
     * @var string
     */
    protected $mime;

    /**
     * Meta attributes.
     *
     * @var array
     */
    protected $meta = [];

    /**
     * Parent collection.
     *
     * @var ObjectId
     */
    protected $parent;

    /**
     * Is file deleted.
     *
     * @var bool|UTCDateTime
     */
    protected $deleted = false;

    /**
     * Is shared?
     *
     * @var bool
     */
    protected $shared = false;

    /**
     * Destory at a certain time.
     *
     * @var UTCDateTime
     */
    protected $destroy;

    /**
     * Changed timestamp.
     *
     * @var UTCDateTime
     */
    protected $changed;

    /**
     * Created timestamp.
     *
     * @var UTCDateTime
     */
    protected $created;

    /**
     * Point to antother node (Means this node is reference to $reference).
     *
     * @var ObjectId
     */
    protected $reference;

    /**
     * Raw attributes before any processing or modifications.
     *
     * @var array
     */
    protected $raw_attributes;

    /**
     * Readonly flag.
     *
     * @var bool
     */
    protected $readonly = false;

    /**
     * App attributes.
     *
     * @var array
     */
    protected $app = [];

    /**
     * Filesystem.
     *
     * @var Filesystem
     */
    protected $_fs;

    /**
     * Database.
     *
     * @var Database
     */
    protected $_db;

    /**
     * User.
     *
     * @var User
     */
    protected $_user;

    /**
     * Logger.
     *
     * @var LoggerInterface
     */
    protected $_logger;

    /**
     * Server.
     *
     * @var Server
     */
    protected $_server;

    /**
     * Hook.
     *
     * @var Hook
     */
    protected $_hook;

    /**
     * Acl.
     *
     * @var Acl
     */
    protected $_acl;

    /**
     * Storage adapter.
     *
     * @var string
     */
    protected $storage_adapter;

    /**
     * Acl.
     *
     * @var Acl
     */
    protected $acl;

    /**
     * Convert to filename.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->name;
    }

    /**
     * Get owner.
     *
     * @return ObjectId
     */
    public function getOwner(): ObjectId
    {
        return $this->owner;
    }

    /**
     * Set filesystem.
     *
     * @param Filesystem $fs
     *
     * @return NodeInterface
     */
    public function setFilesystem(Filesystem $fs): NodeInterface
    {
        $this->_fs = $fs;
        $this->_user = $fs->getUser();

        return $this;
    }

    /**
     * Get filesystem.
     *
     * @return Filesystem
     */
    public function getFilesystem(): Filesystem
    {
        return $this->_fs;
    }

    /**
     * Check if $node is a sub node of any parent nodes of this node.
     *
     * @param NodeInterface $node
     *
     * @return bool
     */
    public function isSubNode(NodeInterface $node): bool
    {
        if ($node->getId() === $this->_id) {
            return true;
        }

        foreach ($node->getParents() as $node) {
            if ($node->getId() === $this->_id) {
                return true;
            }
        }

        if ($this->isRoot()) {
            return true;
        }

        return false;
    }

    /**
     * Move node.
     *
     * @param Collection $parent
     * @param int        $conflict
     *
     * @return NodeInterface
     */
    public function setParent(Collection $parent, int $conflict = NodeInterface::CONFLICT_NOACTION): NodeInterface
    {
        if ($this->parent === $parent->getId()) {
            throw new Exception\Conflict(
                'source node '.$this->name.' is already in the requested parent folder',
                Exception\Conflict::ALREADY_THERE
            );
        }
        if ($this->isSubNode($parent)) {
            throw new Exception\Conflict(
                'node called '.$this->name.' can not be moved into itself',
                Exception\Conflict::CANT_BE_CHILD_OF_ITSELF
            );
        }
        if (!$this->_acl->isAllowed($this, 'w') && !$this->isReference()) {
            throw new ForbiddenException(
                'not allowed to move node '.$this->name,
                ForbiddenException::NOT_ALLOWED_TO_MOVE
            );
        }

        $exists = $parent->childExists($this->name);
        if (true === $exists && NodeInterface::CONFLICT_NOACTION === $conflict) {
            throw new Exception\Conflict(
                'a node called '.$this->name.' does already exists in this collection',
                Exception\Conflict::NODE_WITH_SAME_NAME_ALREADY_EXISTS
            );
        }
        if ($this->isShared() && $this instanceof Collection && $parent->isShared()) {
            throw new Exception\Conflict(
                'a shared folder can not be a child of a shared folder too',
                Exception\Conflict::SHARED_NODE_CANT_BE_CHILD_OF_SHARE
            );
        }
        if ($parent->isDeleted()) {
            throw new Exception\Conflict(
                'cannot move node into a deleted collction',
                Exception\Conflict::DELETED_PARENT
            );
        }

        if (true === $exists && NodeInterface::CONFLICT_RENAME === $conflict) {
            $this->setName($this->getDuplicateName());
            $this->raw_attributes['name'] = $this->name;
        }

        if ($this instanceof Collection) {
            $this->getChildrenRecursive($this->getRealId(), $shares);


            if (!empty($shares) && $parent->isShared()) {
                throw new Exception\Conflict(
                    'folder contains a shared folder',
                    Exception\Conflict::NODE_CONTAINS_SHARED_NODE
                );
            }
        }

        if ($parent->isSpecial() && $this->shared !== $parent->getShareId() || !$parent->isSpecial() && $this->isShareMember()) {
            $new = $this->copyTo($parent, $conflict);
            $this->delete();

            return $new;
        }

        if (true === $exists && NodeInterface::CONFLICT_MERGE === $conflict) {
            $new = $this->copyTo($parent, $conflict);
            $this->delete(true/*, false, false*/);


            return $new;
        }

        $this->parent = $parent->getRealId();
        $this->owner = $this->_user->getId();

        $this->save(['parent', 'shared', 'owner']);

        return $this;
    }

    /**
     * Get share id.
     *
     * @param bool $reference
     *
     * @return ObjectId
     */
    public function getShareId(bool $reference = false): ?ObjectId
    {
        if ($this->isReference() && true === $reference) {
            return $this->_id;
        }
        if ($this->isShareMember() && true === $reference) {
            return $this->shared;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
        if ($this->isShared() && $this->isReference()) {
            return $this->reference;
        }
        if ($this->isShared()) {
            return $this->_id;
        }
        if ($this->isShareMember()) {
            return $this->shared;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return null;
    }

    /**
     * Get share node.
     *
     * @param bool $reference
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return Collection
     */
    public function getShareNode(): ?Collection
    {
        if ($this->isSpecial()) {
            return $this->_fs->findNodeById($this->getShareId(true));
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        return null;
    }

    /**
     * Is node marked as readonly?
     *
     * @return bool
     */
    public function isReadonly(): bool
    {
        return $this->readonly;
    }

    /**
     * Request is from node owner?
     *
     * @return bool
     */
    public function isOwnerRequest(): bool
    {
        return null !== $this->_user && $this->owner == $this->_user->getId();
    }

    /**
     * Check if node is kind of special.
     *
     * @return bool
     */
    public function isSpecial(): bool
    {
        if ($this->isShared()) {
            return true;
        }
        if ($this->isReference()) {
            return true;
        }
        if ($this->isShareMember()) {
            return true;
        }

        return false;
    }

    /**
     * Check if node is a sub node of a share.
     *
     * @return bool
     */
    public function isShareMember(): bool
    {
        return $this->shared instanceof ObjectId && !$this->isReference();
if ($x instanceof DoesNotExist) {
    // Do something.
}
    }

    /**
     * Is share.
     *
     * @return bool
     */
    public function isShare(): bool
    {
        return true === $this->shared && !$this->isReference();
    }

    /**
     * Is share (Reference or master share).
     *
     * @return bool
     */
    public function isShared(): bool
    {
        if (true === $this->shared) {
            return true;
        }

        return false;
    }

    /**
     * Set the name.
     *
     * @param string $name
     *
     * @return bool
     */
    public function setName($name): bool
    {
        $name = $this->checkName($name);

        try {
            $child = $this->getParent()->getChild($name);
            if ($child->getId() != $this->_id) {
                throw new Exception\Conflict(
                    'a node called '.$name.' does already exists in this collection',
                    Exception\Conflict::NODE_WITH_SAME_NAME_ALREADY_EXISTS
                );
            }
        } catch (Exception\NotFound $e) {
            //child does not exists, we can safely rename
        }

        $this->name = $name;

        return $this->save('name');
    }

    /**
     * Check name.
     *
     * @param string $name
     *
     * @return string
     */
    public function checkName(string $name): string
    {
        if (preg_match('/([\\\<\>\:\"\/\|\*\?])|(^$)|(^\.$)|(^\..$)/', $name)) {
            throw new Exception\InvalidArgument('name contains invalid characters');
        }
        if (strlen($name) > self::MAX_NAME_LENGTH) {
            throw new Exception\InvalidArgument('name is longer than '.self::MAX_NAME_LENGTH.' characters');
        }

        if (!Normalizer::isNormalized($name)) {
            $name = Normalizer::normalize($name);
        }

        return $name;
    }

    /**
     * Get the name.
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Undelete.
     *
     * @param int    $conflict
     * @param string $recursion
     * @param bool   $recursion_first
     *
     * @return bool
     */
    public function undelete(int $conflict = NodeInterface::CONFLICT_NOACTION, ?string $recursion = null, bool $recursion_first = true): bool
    {
        if (!$this->_acl->isAllowed($this, 'w')) {
            throw new ForbiddenException(
                'not allowed to restore node '.$this->name,
                ForbiddenException::NOT_ALLOWED_TO_UNDELETE
            );
        }
        if (!$this->isDeleted()) {
            throw new Exception\Conflict(
                'node is not deleted, skip restore',
                Exception\Conflict::NOT_DELETED
            );
        }

        $parent = $this->getParent();
        if ($parent->isDeleted()) {
            throw new Exception\Conflict(
                'could not restore node '.$this->name.' into a deleted parent',
                Exception\Conflict::DELETED_PARENT
            );
        }

        if ($parent->childExists($this->name)) {
            if (NodeInterface::CONFLICT_MERGE === $conflict) {
                $this->copyTo($parent, $conflict);
                $this->delete(true);
            } elseif (NodeInterface::CONFLICT_RENAME === $conflict) {
                $this->setName($this->getDuplicateName());
                $this->raw_attributes['name'] = $this->name;
            } else {
                throw new Exception\Conflict(
                    'a node called '.$this->name.' does already exists in this collection',
                    Exception\Conflict::NODE_WITH_SAME_NAME_ALREADY_EXISTS
                );
            }
        }

        if (null === $recursion) {
            $recursion_first = true;
            $recursion = uniqid();
        } else {
            $recursion_first = false;
        }

        $this->deleted = false;

        if ($this instanceof File) {
            $current = $this->version;
$myVar = 'Value';
$higher = false;

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

            $this->history[] = [
                'version' => $new,
                'changed' => $this->changed,
                'user' => $this->owner,
                'type' => File::HISTORY_UNDELETE,
                'storage' => $this->storage,
                'storage_adapter' => $this->storage_adapter,
                'size' => $this->size,
                'mime' => $this->mime,
            ];

            return $this->save([
                'name',
                'deleted',
                'history',
                'version',
            ], [], $recursion, $recursion_first);
        }

        $this->save([
                'name',
                'deleted',
            ], [], $recursion, $recursion_first);

        if ($this->isReference()) {
            return true;
        }

        return $this->doRecursiveAction(
                'undelete',
                [
                    'conflict' => $conflict,
                    'recursion' => $recursion,
                    'recursion_first' => false,
                ],
                NodeInterface::DELETED_ONLY
            );
    }

    /**
     * Is node deleted?
     *
     * @return bool
     */
    public function isDeleted(): bool
    {
        return $this->deleted instanceof UTCDateTime;
if ($x instanceof DoesNotExist) {
    // Do something.
}
    }

    /**
     * Get last modified timestamp.
     *
     * @return int
     */
    public function getLastModified(): int
    {
        if ($this->changed instanceof UTCDateTime) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return (int) $this->changed->toDateTime()->format('U');
        }

        return 0;
    }

    /**
     * Get unique id.
     *
     * @return ObjectId|string
     */
    public function getId(bool $string = false)
    {
        if (true === $string) {
            return (string) $this->_id;
        }

        return $this->_id;
    }

    /**
     * Get parent.
     *
     * @return Collection
     */
    public function getParent(): ?Collection
    {
        try {
            if ($this->isRoot()) {
                return null;
            }
            if ($this->isInRoot()) {
                return $this->_fs->getRoot();
            }

            $parent = $this->_fs->findNodeById($this->parent);

            if ($parent->isShare() && !$parent->isOwnerRequest() && null !== $this->_user) {
                $node = $this->_db->storage->findOne([
                        'owner' => $this->_user->getId(),
                        'shared' => true,
                        'reference' => $this->parent,
                    ]);

                return $this->_fs->initNode($node);
            }

            return $parent;
        } catch (Exception\NotFound $e) {
            throw new Exception\NotFound(
                'parent node '.$this->parent.' could not be found',
                Exception\NotFound::PARENT_NOT_FOUND
            );
        }
    }

    /**
     * Get parents.
     *
     * @param array $parents
     *
     * @return array
     */
    public function getParents(?NodeInterface $node = null, array $parents = []): array
    {
        if (null === $node) {
            $node = $this;
        }

        if ($node->isInRoot()) {
            return $parents;
        }
        $parent = $node->getParent();
        $parents[] = $parent;

        return $node->getParents($parent, $parents);
    }

    /**
     * Get as zip.
     */
    public function getZip(): void
    {
        $temp = $this->_server->getTempDir().DIRECTORY_SEPARATOR.'zip';
        if (!file_exists($temp)) {
            mkdir($temp, 0700, true);
        }

        ZipStream::$temp = $temp;
        $archive = new ZipStream($this->name.'.zip', 'application/zip', $this->name.'.zip');
        $this->zip($archive, false);
        $archive->finalize();
    }

    /**
     * Create zip.
     *
     * @param ZipStream     $archive
     * @param bool          $self    true means that the zip represents the collection itself instead a child of the zip
     * @param NodeInterface $parent
     * @param string        $path
     * @param int           $depth
     *
     * @return bool
     */
    public function zip(ZipStream $archive, bool $self = true, ?NodeInterface $parent = null, string $path = '', int $depth = 0): bool
    {
        if (null === $parent) {
            $parent = $this;
        }

        if ($parent instanceof Collection) {
            $children = $parent->getChildNodes();

            if (true === $self && 0 === $depth) {
                $path = $parent->getName();
                $archive->addDirectory($path);
                $path .= DIRECTORY_SEPARATOR;
            } elseif (0 === $depth) {
                $path = '';
            } elseif (0 !== $depth) {
                $path .= DIRECTORY_SEPARATOR.$parent->getName().DIRECTORY_SEPARATOR;
            }

            foreach ($children as $child) {
                $name = $path.$child->getName();

                if ($child instanceof Collection) {
                    $archive->addDirectory($name);
                    $this->zip($archive, $self, $child, $name, ++$depth);
                } elseif ($child instanceof File) {
                    try {
                        $archive->addFile($child->get(), $name);
                    } catch (\Exception $e) {
                        $this->_logger->error('failed add file ['.$child->getId().'] to zip stream', [
                            'category' => get_class($this),
                            'exception' => $e,
                        ]);
                    }
                }
            }
        } elseif ($parent instanceof File) {
            $archive->addFile($parent->get(), $parent->getName());
        }

        return true;
    }

    /**
     * Get mime type.
     *
     * @return string
     */
    public function getContentType(): string
    {
        return $this->mime;
    }

    /**
     * Is reference.
     *
     *  @return bool
     */
    public function isReference(): bool
    {
        return $this->reference instanceof ObjectId;
if ($x instanceof DoesNotExist) {
    // Do something.
}
    }

    /**
     * Set app attributes.
     *
     * @param AppInterface $app
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param array        $attributes
     *
     * @return NodeInterface
     */
    public function setAppAttributes(string $namespace, array $attributes): NodeInterface
    {
        $this->app[$namespace] = $attributes;
        $this->save('app');

        return $this;
    }

    /**
     * Set app attribute.
     *
     * @param AppInterface $app
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string       $attribute
     * @param mixed        $value
     *
     * @return NodeInterface
     */
    public function setAppAttribute(string $namespace, string $attribute, $value): NodeInterface
    {
        if (!isset($this->app[$namespace])) {
            $this->app[$namespace] = [];
        }

        $this->app[$namespace][$attribute] = $value;
        $this->save('app');

        return $this;
    }

    /**
     * Remove app attribute.
     *
     * @param AppInterface $app
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return NodeInterface
     */
    public function unsetAppAttributes(string $namespace): NodeInterface
    {
        if (isset($this->app[$namespace])) {
            unset($this->app[$namespace]);
            $this->save('app');
        }

        return $this;
    }

    /**
     * Remove app attribute.
     *
     * @param AppInterface $app
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string       $attribute
     *
     * @return NodeInterface
     */
    public function unsetAppAttribute(string $namespace, string $attribute): NodeInterface
    {
        if (isset($this->app[$namespace][$attribute])) {
            unset($this->app[$namespace][$attribute]);
            $this->save('app');
        }

        return $this;
    }

    /**
     * Get app attribute.
     *
     * @param AppInterface $app
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string       $attribute
     *
     * @return mixed
     */
    public function getAppAttribute(string $namespace, string $attribute)
    {
        if (isset($this->app[$namespace][$attribute])) {
            return $this->app[$namespace][$attribute];
        }

        return null;
    }

    /**
     * Get app attributes.
     *
     * @param AppInterface $app
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return array
     */
    public function getAppAttributes(string $namespace): array
    {
        if (isset($this->app[$namespace])) {
            return $this->app[$namespace];
        }

        return [];
    }

    /**
     * Set meta attribute.
     *
     * @param   array|string
     * @param mixed $value
     * @param mixed $attributes
     *
     * @return NodeInterface
     */
    public function setMetaAttribute($attributes, $value = null): NodeInterface
    {
        $this->meta = self::validateMetaAttribute($attributes, $value, $this->meta);
        $this->save('meta');

        return $this;
    }

    /**
     * validate meta attribut.
     *
     * @param array|string $attributes
     * @param mixed        $value
     * @param array        $set
     *
     * @return array
     */
    public static function validateMetaAttribute($attributes, $value = null, array $set = []): array
    {
        if (is_string($attributes)) {
            $attributes = [
                $attributes => $value,
            ];
        }

        foreach ($attributes as $attribute => $value) {
            $const = __CLASS__.'::META_'.strtoupper($attribute);
            if (!defined($const)) {
                throw new Exception('meta attribute '.$attribute.' is not valid');
            }

            if (empty($value) && array_key_exists($attribute, $set)) {
                unset($set[$attribute]);
            } else {
                $set[$attribute] = $value;
            }
        }

        return $set;
    }

    /**
     * Get meta attributes as array.
     *
     * @param array|string $attribute Specify attributes to return
     *
     * @return array|string
     */
    public function getMetaAttribute($attribute = [])
    {
        if (is_string($attribute)) {
            if (isset($this->meta[$attribute])) {
                return $this->meta[$attribute];
            }
        } elseif (empty($attribute)) {
            return $this->meta;
        } elseif (is_array($attribute)) {
            return array_intersect_key($this->meta, array_flip($attribute));
        }
    }

    /**
     * Mark node as readonly.
     *
     * @param bool $readonly
     *
     * @return bool
     */
    public function setReadonly(bool $readonly = true): bool
    {
        $this->readonly = $readonly;

        return $this->save('readonly');
    }

    /**
     * Mark node as self-destroyable.
     *
     * @param UTCDateTime $ts
     *
     * @return bool
     */
    public function setDestroyable(?UTCDateTime $ts): bool
    {
        $this->destroy = $ts;

        if (null === $ts) {
            return $this->save([], 'destroy');
        }

        return $this->save('destroy');
    }

    /**
     * Get original raw attributes before any processing.
     *
     * @return array
     */
    public function getRawAttributes(): array
    {
        return $this->raw_attributes;
    }

    /**
     * Check if node is in root.
     *
     * @return bool
     */
    public function isInRoot(): bool
    {
        return null === $this->parent;
    }

    /**
     * Check if node is an instance of the actual root collection.
     *
     * @return bool
     */
    public function isRoot(): bool
    {
        return null === $this->_id && ($this instanceof Collection);
    }

    /**
     * Resolve node path.
     *
     * @return string
     */
    public function getPath(): string
    {
        $path = '';
        foreach (array_reverse($this->getParents()) as $parent) {
            $path .= DIRECTORY_SEPARATOR.$parent->getName();
        }

        $path .= DIRECTORY_SEPARATOR.$this->getName();


        return $path;
    }

    /**
     * Save node attributes.
     *
     * @param array|string $attributes
     * @param array|string $remove
     * @param string       $recursion
     * @param bool         $recursion_first
     *
     * @return bool
     */
    public function save($attributes = [], $remove = [], ?string $recursion = null, bool $recursion_first = true): bool
    {
        if (!$this->_acl->isAllowed($this, 'w') && !$this->isReference()) {
            throw new ForbiddenException(
                'not allowed to modify node '.$this->name,
                ForbiddenException::NOT_ALLOWED_TO_MODIFY
            );
        }

        if ($this instanceof Collection && $this->isRoot()) {
            return false;
        }

        $remove = (array) $remove;
        $attributes = (array) $attributes;
        $this->_hook->run(
            'preSaveNodeAttributes',
            [$this, &$attributes, &$remove, &$recursion, &$recursion_first]
        );

        try {
            $set = [];

            foreach ($attributes as $attr) {
                $set[$attr] = $this->{$attr};
            }

            $update = [];
            if (!empty($set)) {
                $update['$set'] = $set;
            }

            if (!empty($remove)) {
                $remove = array_fill_keys($remove, 1);
                $update['$unset'] = $remove;
            }

            if (empty($update)) {
                return false;
            }
            $result = $this->_db->storage->updateOne([
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                    '_id' => $this->_id,
                ], $update);

            $this->_hook->run(
                'postSaveNodeAttributes',
                [$this, $attributes, $remove, $recursion, $recursion_first]
            );

            $this->_logger->info('modified node attributes of ['.$this->_id.']', [
                'category' => get_class($this),
                'params' => $update,
            ]);

            return true;
        } catch (\Exception $e) {
            $this->_logger->error('failed modify node attributes of ['.$this->_id.']', [
                'category' => get_class($this),
                'exception' => $e,
            ]);

            throw $e;
        }
    }

    /**
     * Duplicate name with a uniqid within name.
     *
     * @param string $name
     *
     * @return string
     */
    protected function getDuplicateName(?string $name = null): string
    {
        if (null === $name) {
            $name = $this->name;
        }

        if ($this instanceof Collection) {
            return $name.' ('.substr(uniqid('', true), -4).')';
        }
        $ext = substr(strrchr($name, '.'), 1);

        if (false === $ext) {
            return $name.' ('.substr(uniqid('', true), -4).')';
        }
        $name = substr($name, 0, -(strlen($ext) + 1));

        return $name.' ('.substr(uniqid('', true), -4).')'.'.'.$ext;
    }

    /**
     * Completly remove node.
     *
     * @return bool
     */
    abstract protected function _forceDelete(): bool;
}

Branch — dev (bc6e47)

AbstractNode F

Complexity

Size/Duplication

Coupling/Cohesion

Importance

45 Methods

How to fix Complexity

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* Balloon
7			*
8			* @author Raffael Sahli <[email protected]>
9			* @copyright Copryright (c) 2012-2017 gyselroth GmbH (https://gyselroth.com)
10			* @license GPL-3.0 https://opensource.org/licenses/GPL-3.0
11			*/
12
13			namespace Balloon\Filesystem\Node;
14
15			use Balloon\App\AppInterface;
16			use Balloon\Exception;
17			use Balloon\Filesystem;
18			use Balloon\Filesystem\Acl;
19			use Balloon\Filesystem\Acl\Exception\Forbidden as ForbiddenException;
20			use Balloon\Filesystem\Storage;
21			use Balloon\Hook;
22			use Balloon\Server;
23			use Balloon\Server\User;
24			use MongoDB\BSON\ObjectId;
25			use MongoDB\BSON\UTCDateTime;
26			use MongoDB\Database;
27			use Normalizer;
28			use PHPZip\Zip\Stream\ZipStream;
29			use Psr\Log\LoggerInterface;
30
31			abstract class AbstractNode implements NodeInterface
32			{
33			/**
34			* name max lenght.
35			*/
36			const MAX_NAME_LENGTH = 255;
37
38			/**
39			* Unique id.
40			*
gyselroth / balloon

Branch — dev (bc6e47)

AbstractNode F

Complexity

Size/Duplication

Coupling/Cohesion

Importance

45 Methods

How to fix Complexity

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like
