CloudFileExtension - Code Metrics - markguinn/silverstripe-cloudassets - Measure and Improve Code Quality continuously with Scrutinizer

CloudFileExtension F
last analyzed 2018-09-25 15:47 UTC

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	362
Duplicated Lines	0 %
Coupling/Cohesion

Components	1
Dependencies	8
Importance

Changes
Metric	Value
wmc	67
lcom	1
cbo	8
dl	0
loc	362
rs	3.04
c	0
b	0
f	0
15 Methods

Rating	Name	Size	Complexity
B	onBeforeWrite()	28	6
A	onAfterWrite()	4	1
B	onAfterDelete()	20	6
C	updateCloudStatus()	75	16
A	canBeInCloud()	10	3
A	containsPlaceholder()	8	3
A	convertToPlaceholder()	13	3
A	getCloudBucket()	4	1
A	getCloudURL()	5	2
A	getCloudMeta()	13	5
A	setCloudMeta()	12	2
A	downloadFromCloud()	17	4
B	createLocalIfNeeded()	22	8
A	isCloudPutNeeded()	27	5
A	isLocalMissing()	4	2
How to fix Complexity

<?php
/**
 * This is added to all File objects for shared functionality.
 *
 * @author Mark Guinn <[email protected]>
 * @date 01.10.2014
 * @package cloudassets
 */
class CloudFileExtension extends DataExtension

{
    private static $db = array(
        'CloudStatus'   => "Enum('Local,Live,Error','Local')",
        'CloudSize'     => 'Int',
        'CloudMetaJson' => 'Text',      // saves any bucket or file-type specific information
    );

    /** @var File|CloudFileExtension */
    protected $owner;

    private $inUpdate = false;


    /**
     * Handle renames
     */
    public function onBeforeWrite()
    {
        $bucket = CloudAssets::inst()->map($this->owner->getFilename());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        if ($bucket) {
            if (!$this->owner->isChanged('Filename')) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                return;
            }

            $changedFields = $this->owner->getChangedFields();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            $pathBefore = $changedFields['Filename']['before'];
            $pathAfter = $changedFields['Filename']['after'];

            // If the file or folder didn't exist before, don't rename - its created
            if (!$pathBefore) {
                return;
            }

            // Tell the remote to rename the file (or delete and recreate or whatever)
            if ($this->owner->hasMethod('onBeforeCloudRename')) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                $this->owner->onBeforeCloudRename($pathBefore, $pathAfter);
            }
            CloudAssets::inst()->getLogger()->info("CloudAssets: Renaming $pathBefore to $pathAfter");
            $bucket->rename($this->owner, $pathBefore, $pathAfter);
/**
 * @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->owner->hasMethod('onAfterCloudRename')) {
                $this->owner->onAfterCloudRename($pathBefore, $pathAfter);
            }
        }
    }


    /**
     * Update cloud status any time the file is written
     */
    public function onAfterWrite()
    {
        $this->updateCloudStatus();
    }


    /**
     * Delete the file from the cloud (if it was ever there)
     */
    public function onAfterDelete()
    {
        $bucket = CloudAssets::inst()->map($this->owner->getFilename());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        if ($bucket && !Config::inst()->get('CloudAssets', 'uploads_disabled')) {
            if ($this->owner->hasMethod('onBeforeCloudDelete')) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                $this->owner->onBeforeCloudDelete();
            }

            try {
                CloudAssets::inst()->getLogger()->info("CloudAssets: deleting {$this->owner->getFilename()}");
                $bucket->delete($this->owner);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            } catch (Exception $e) {
                CloudAssets::inst()->getLogger()->error("CloudAssets: Failed bucket delete: " . $e->getMessage() . " for " . $this->owner->getFullPath());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            }

            if ($this->owner->hasMethod('onAfterCloudDelete')) {
                $this->owner->onAfterCloudDelete();
            }
        }
    }


    /**
     * Performs two functions:
     * 1. Wraps this object in CloudFile (etc) by changing the classname if it should be and is not
     * 2. Uploads the file to the cloud storage if it doesn't contain the placeholder
     *
     * @return File
     */
    public function updateCloudStatus()
    {
        if ($this->inUpdate) {
            return;
        }
        $this->inUpdate = true;
        $cloud  = CloudAssets::inst();

        // does this file fall under a cloud bucket?
        $bucket = $cloud->map($this->owner->getFilename());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        if ($bucket) {
            // does this file need to be wrapped?
            $wrapClass = $cloud->getWrapperClass($this->owner->ClassName);
            if (!empty($wrapClass)) {
                if ($wrapClass != $this->owner->ClassName) {
                    $cloud->getLogger()->debug("CloudAssets: wrapping {$this->owner->ClassName} to $wrapClass. ID={$this->owner->ID}");
                    $this->owner->ClassName = $wrapClass;
                    $this->owner->write();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                    $wrapped = DataObject::get($wrapClass)->byID($this->owner->ID);
                    if ($wrapped->hasMethod('onAfterCloudWrap')) {
                        $wrapped->onAfterCloudWrap();
                    }
                } else {
                    $wrapped = $this->owner;

                }

                // does this file need to be uploaded to storage?
                if ($wrapped->canBeInCloud() && $wrapped->isCloudPutNeeded() && !Config::inst()->get('CloudAssets', 'uploads_disabled')) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                    try {
                        if ($wrapped->hasMethod('onBeforeCloudPut')) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                            $wrapped->onBeforeCloudPut();
                        }
                        $cloud->getLogger()->debug("CloudAssets: uploading file ".$wrapped->getFilename());
                        $bucket->put($wrapped);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

                        $wrapped->setCloudMeta('LastPut', time());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                        $wrapped->CloudStatus = 'Live';
                        $wrapped->CloudSize   = filesize($this->owner->getFullPath());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                        $wrapped->write();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

                        $wrapped->convertToPlaceholder();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                        if ($wrapped->hasMethod('onAfterCloudPut')) {
                            $wrapped->onAfterCloudPut();
                        }
                    } catch (Exception $e) {
                        $wrapped->CloudStatus = 'Error';
                        $wrapped->write();
                        $cloud->getLogger()->error("CloudAssets: Failed bucket upload: " . $e->getMessage() . " for " . $wrapped->getFullPath());
                        // Fail silently for now. This will cause the local copy to be served.
                    }
                } elseif ($wrapped->CloudStatus !== 'Live' && $wrapped->containsPlaceholder()) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                    // If this is a duplicate file, update the status
                    // This shouldn't happen ever and won't happen often but when it does this will be helpful
                    $dup = File::get()->filter(array(
                        'Filename'      => $wrapped->Filename,
                        'CloudStatus'   => 'Live',
                    ))->first();

                    if ($dup && $dup->exists()) {
                        $cloud->getLogger()->warn("CloudAssets: fixing status for duplicate file: {$wrapped->ID} and {$dup->ID}");
                        $wrapped->CloudStatus   = $dup->CloudStatus;
                        $wrapped->CloudSize     = $dup->CloudSize;
                        $wrapped->CloudMetaJson = $dup->CloudMetaJson;
                        $wrapped->write();
                    }
                }

                $this->inUpdate = false;
                return $wrapped;
            }
        }

        $this->inUpdate = false;
        return $this->owner;

    }


    /**
     * @return bool
     */
    public function canBeInCloud()
    {
        if ($this->owner instanceof Folder) {
            return false;
        }
        if (!file_exists($this->owner->getFullPath())) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            return false;
        }
        return true;
    }


    /**
     * @return bool
     */
    public function containsPlaceholder()
    {
        $placeholder = Config::inst()->get('CloudAssets', 'file_placeholder');
        $path = $this->owner->getFullPath();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        // check the size first to avoid reading crazy huge files into memory
        return (file_exists($path) && filesize($path) == strlen($placeholder) && file_get_contents($path) == $placeholder);
    }


    /**
     * Wipes out the contents of this file and replaces with placeholder text
     */
    public function convertToPlaceholder()
    {
        $bucket = $this->getCloudBucket();
        if ($bucket && !$bucket->isLocalCopyEnabled()) {
            $path = $this->owner->getFullPath();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            CloudAssets::inst()->getLogger()->debug("CloudAssets: converting $path to placeholder");
            Filesystem::makeFolder(dirname($path));
            file_put_contents($path, Config::inst()->get('CloudAssets', 'file_placeholder'));
            clearstatcache();
        }

        return $this->owner;
    }


    /**
     * @return CloudBucket
     */
    public function getCloudBucket()
    {
        return CloudAssets::inst()->map($this->owner);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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


    /**
     * @param int $linkType [optional] - see CloudBucket::LINK_XXX constants
     * @return string
     */
    public function getCloudURL($linkType = CloudBucket::LINK_SMART)
    {
        $bucket = $this->getCloudBucket();
        return $bucket ? $bucket->getLinkFor($this->owner, $linkType) : '';
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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


    /**
     * @param string $key [optional] - if not present returns the whole array
     * @return array
     */
    public function getCloudMeta($key = null)
    {
        $data = json_decode($this->owner->CloudMetaJson, true);
        if (empty($data) || !is_array($data)) {
            $data = array();
        }

        if (!empty($key)) {
            return isset($data[$key]) ? $data[$key] : null;
        } else {
            return $data;
        }
    }


    /**
     * @param string|array $key - passing an array as the first argument replaces the meta data entirely
     * @param mixed        $val
     * @return File - chainable
     */
    public function setCloudMeta($key, $val = null)
    {
        if (is_array($key)) {
            $data = $key;
        } else {
            $data = $this->getCloudMeta();
            $data[$key] = $val;
        }

        $this->owner->CloudMetaJson = json_encode($data);
        return $this->owner;

    }


    /**
     * If this file is stored in the cloud, downloads the cloud
     * copy and replaces whatever is local.
     */
    public function downloadFromCloud()
    {
        if ($this->owner->CloudStatus === 'Live') {
            $bucket   = $this->owner->getCloudBucket();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            if ($bucket) {
                $contents = $bucket->getContents($this->owner);
                $path     = $this->owner->getFullPath();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                Filesystem::makeFolder(dirname($path));
                CloudAssets::inst()->getLogger()->debug("CloudAssets: downloading $path from cloud (size=".strlen($contents).")");
                // if there was an error and we overwrote the local file with empty or null, it could delete the remote
                // file as well. Better to err on the side of not writing locally when we should than that.
                if (!empty($contents)) {
                    file_put_contents($path, $contents);
                }
            }
        }
    }


    /**
     * If the file is present in the database and the cloud but not
     * locally, create a placeholder for it. This can happen in a lot
     * of cases such as load balanced servers and local development.
     */
    public function createLocalIfNeeded()
    {
        if ($this->owner->CloudStatus === 'Live') {
            $bucket = $this->getCloudBucket();
            if ($bucket && $bucket->isLocalCopyEnabled()) {
                if (!file_exists($this->owner->getFullPath()) || $this->containsPlaceholder()) {
                    try {
                        $this->downloadFromCloud();
                    } catch (Exception $e) {
                        // I'm not sure what the correct behaviour is here
                        // Pretty sure it'd be better to have a broken image
                        // link than a 500 error though.
                        CloudAssets::inst()->getLogger()->error("CloudAssets: Failed bucket download: " . $e->getMessage() . " for " . $this->owner->getFullPath());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                    }
                }
            } else {
                if (!file_exists($this->owner->getFullPath())) {
                    $this->convertToPlaceholder();
                }
            }
        }
    }


    /**
     * @return bool
     */
    public function isCloudPutNeeded()
    {
        // we never want to upload the placeholder
        if ($this->containsPlaceholder()) {
            return false;
        }

        // we never want to upload an empty file
        $path = $this->owner->getFullPath();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        if (!file_exists($path)) {
            return false;
        }

        // we always want to upload if it's the first time
        $lastPut = $this->getCloudMeta('LastPut');
        if (!$lastPut) {

            return true;
        }

        // additionally, we want to upload if the file has been changed or replaced
        $mtime = filemtime($path);
        if ($mtime > $lastPut) {
            return true;
        }

        return false;
    }


    /**
     * Returns true if the local file is not available
     * @return bool
     */
    public function isLocalMissing()
    {
        return !file_exists($this->owner->getFullPath()) || $this->containsPlaceholder();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }
}

CloudFileExtension F
last analyzed 2018-09-25 15:47 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Complexity

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

markguinn / silverstripe-cloudassets

CloudFileExtension F last analyzed 2018-09-25 15:47 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Complexity

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

CloudFileExtension F
last analyzed 2018-09-25 15:47 UTC
