DatabasebackupLog - Code Metrics - sunnysideup/silverstripe-databasebackup - Measure and Improve Code Quality continuously with Scrutinizer

DatabasebackupLog F
last analyzed 2019-04-24 10:32 UTC

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	402
Duplicated Lines	10.95 %
Coupling/Cohesion

Components	2
Dependencies	12
Importance

Changes
Metric	Value
wmc	65
lcom	2
cbo	12
dl	44
loc	402
rs	3.2
c	0
b	0
f	0
16 Methods

Rating	Name	Duplication	Size	Complexity
A	canCreate()	0	4	1
A	canDelete()	0	4	1
A	canEdit()	0	4	1
A	getCMSFields()	0	11	1
A	getSizeInMegabytes()	0	8	2
B	getCMSActions()	0	35	10
B	onBeforeWrite()	5	30	8
A	onAfterWrite()	0	8	2
A	onBeforeDelete()	0	8	2
A	restoreDatabaseBackup()	5	23	5
A	saveToSession()	0	12	2
A	retrieveFromSession()	0	13	3
F	cycleDatabaseBackupFiles()	34	68	17
A	getFullLocationWithExtension()	0	12	3
A	olderBackupFileName()	0	4	1
B	requireDefaultRecords()	0	29	6
How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class
Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.
Complex classes like DatabasebackupLog often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use DatabasebackupLog, and based on these observations, apply Extract Interface, too.
<?php

/**
 * keeps a record for every database backup made...
 *
 *
 *
 *
 */


class DatabasebackupLog extends DataObject
{
    private static $singular_name = "Database Backup";


    private static $plural_name = "Database Backups";


    private static $db = array(

        "Title" => "Varchar(255)",
        "Notes" => "Text",
        "FullLocation" => "Varchar(255)",
        "SizeInBytes" => "Int",
        "DebugMessage" => "Text"
    );

    private static $indexes = array(

        "FullLocation" => true
    );

    private static $default_sort = "Created DESC";


    private static $casting = array(

        "SizeInMegabytes" => "Int"
    );

    private static $summary_fields = array(

        "Title" => "Title",
        "Created" => "Created",
        "SizeInMegabytes" => "Size (in Mb.)",
    );

    /**
     * location for backup file e.g. /var/backups/db.sql
     * @var String
     */
    private static $full_location_for_db_backup_file = "";

    /**
     * number of cycles before the database backups get deleted forgood...
     * @var Int
     */
    private static $max_db_copies = 3;

    /**
     * at the moment only the gzip compression is supported!
     * @var String
     */
    private static $compression = "";

    /**
     * for security reasons we set this to false ...
     * @var Boolean
     */
    private static $allow_restores_in_live_environment = false;

    public function canCreate($member = null)
    {
        return Permission::check("ADMIN");
    }

    public function canDelete($member = null)
    {
        return Permission::check("ADMIN");
    }

    public function canEdit($member = null)
    {
        return Permission::check("ADMIN");
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->addFieldToTab("Root.Main", new ReadonlyField("Created"));
        $fields->addFieldToTab("Root.Main", new ReadonlyField("FullLocation"));
        $fields->addFieldToTab("Root.Main", new ReadonlyField("SizeInBytes"));
        $fields->addFieldToTab("Root.Main", new ReadonlyField("SizeInMegabytes"));
        $fields->removeFieldFromTab("Root.Main", "DebugMessage");
        $fields->addFieldToTab("Root.Main", new LiteralField("DownloadLink", "<h2><a href=\"/backupsystem/download/".$this->ID."/\">download now</a></h2>"));
        return $fields;
    }

    /**
     * @casting
     * @return Int

     */
    public function getSizeInMegabytes()
    {
        if($this->SizeInBytes) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            return round($this->SizeInBytes / 1024 / 1024, 2);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        } else {
            return 'n/a';
        }
    }

    /**
     * Adds a button the Site Config page of the CMS to rebuild the Lucene search index.
     */
    public function getCMSActions()
    {
        $actions = parent::getCMSActions();
        if (Permission::check("ADMIN")) {
            if ($fileLocation = $this->getFullLocationWithExtension()) {
                clearstatcache();
                if ($this->FullLocation && file_exists($this->FullLocation)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    //do nothing
                } else {
                    $lastChanged = _t('Databasebackup.NO_BACKUP_IS_AVAILABLE', 'This Backup is NOT Available ... Once created, you can access it here: '.$fileLocation);
                }
                if (!$this->exists()) {
                    $actions->push(
                        new FormAction(
                            'doMakeDatabaseBackup',
                            _t('Databasebackup.MAKE_DATABASE_BACKUP', 'Make Database Backup')."; ".$lastChanged
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                        )
                    );
                } else {
                    if ($this->FullLocation && file_exists($this->FullLocation)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                        if (!Director::IsLive() || $this->Config()->get("allow_restores_in_live_environment")) {
                            $actions->push(
                                new FormAction(
                                    'doRestoreDatabaseBackup',
                                    _t('Databasebackup.RESTORE_DB_BACKUP_NOW', 'Restore This Database (override current one)')
                                )
                            );
                        }
                    }
                }
            }
            $this->extend('updateCMSActions', $actions);
        }
        return $actions;
    }

    /**
     * if backup does not exist then make it ...
     * set size
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        clearstatcache();
        if (!$this->exists()) {
            if (!$this->FullLocation) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                if ($fileLocation = $this->getFullLocationWithExtension()) {
                    $fileLocation = $this->cycleDatabaseBackupFiles($fileLocation);
                    global $databaseConfig;
                    $compression = $this->Config()->get("compression");
                    if ($compression == "gzip") {

                        $command = "mysqldump -u ".$databaseConfig["username"]." -p".$databaseConfig["password"]." -h ".$databaseConfig["server"]." ".$databaseConfig["database"]."  | gzip >  ".$fileLocation;
                    } else {
                        $command = "mysqldump -u ".$databaseConfig["username"]." -p".$databaseConfig["password"]." -h ".$databaseConfig["server"]." ".$databaseConfig["database"]." >  ".$fileLocation;
                    }
                    $this->DebugMessage = exec($command);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $this->FullLocation = $fileLocation;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    clearstatcache();
                    $this->SizeInBytes = filesize($this->FullLocation);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                }
            }
        }
        //just in case, we do this everytime...
        if (!$this->SizeInBytes && file_exists($this->FullLocation)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->SizeInBytes = filesize($this->FullLocation);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        if (!$this->Title) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->Title = $this->FullLocation." (" .$this->getSizeInMegabytes()."mb.)";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
    }

    /**
     * delete me if file does not exist
     */
    public function onAfterWrite()
    {
        parent::onAfterWrite();
        clearstatcache();
        if (!file_exists($this->FullLocation)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->delete();
        }
    }


    /**
     * delete file if I get deleted
     */
    public function onBeforeDelete()
    {
        parent::onBeforeDelete();
        clearstatcache();
        if (file_exists($this->FullLocation)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            unlink($this->FullLocation);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
    }

    /**
     *
     * @return Boolean
     */
    public function restoreDatabaseBackup()
    {
        if (!Director::IsLive() || $this->Config()->get("allow_restores_in_live_environment")) {
            $fileLocation = $this->FullLocation;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            if (file_exists($fileLocation)) {
                $this->saveToSession();
                global $databaseConfig;
                $compression = $this->Config()->get("compression");
                if ($compression == "gzip") {

                    $command = "gunzip <  ".$fileLocation. " | mysql -u ".$databaseConfig["username"]." -p".$databaseConfig["password"]." -h ".$databaseConfig["server"]."  ".$databaseConfig["database"]." ";
                } else {
                    $command = "mysql -u ".$databaseConfig["username"]." -p".$databaseConfig["password"]." -h ".$databaseConfig["server"]."  ".$databaseConfig["database"]." <  ".$fileLocation;
                }
                exec($command);
                //reset list of backups ...
                $this->requireDefaultRecords();
                $this->retrieveFromSession();
                Controller::curr()->redirect("/admin/databasebackuplog/");
                return true;
            }
        }
        return false;
    }

    /**
     * we have this so that when we restore a database
     * we dont loose the backup information...
     * saves all the logs to session
     */
    protected function saveToSession()
    {
        foreach (DatabasebackupLog::get() as $object) {
            $array[$object->ID] = array(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                "FullLocation" => $object->FullLocation,
                "Title" => $object->Title,
                "Notes" => $object->Notes,
                "Created" => $object->Created
            );
            Session::set("DatabasebackupLogs", serialize($array));
        }
    }

    /**
     *
     * retrieves and updates all the logs from session
     */
    protected function retrieveFromSession()
    {
        $array = unserialize(Session::get("DatabasebackupLogs"));
        foreach ($array as $id => $values) {
            $obj = DatabasebackupLog::get()->filter(array("FullLocation" => $values["FullLocation"]))->first();
            if ($obj) {
                $obj->Title = convert::raw2sql($values["Title"]);
                $obj->Notes = convert::raw2sql($values["Notes"]);
                $obj->Created = convert::raw2sql($values["Created"]);
                $obj->write();
            }
        }
    }

    /**
     * move all of the database copies up one,
     * deleting the upper one.
     *
     * Returns the name of the file name freed up ... (by moving all of them one up...)
     *
     * @param string $fileLocation
     *
     * @return string File Location
     *
     */
    protected function cycleDatabaseBackupFiles($fileLocation)
    {
        $copyFileLocation = $fileLocation;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $max = $this->Config()->get("max_db_copies");
        for ($i = $max; $i > -1; $i--) {
            $lowerFileLocation = $this->olderBackupFileName($fileLocation, $i);
            if ($i == $max) {
                //delete the top one ...
                clearstatcache();
                if (file_exists($lowerFileLocation)) {

                    clearstatcache();
                    $obj = DatabasebackupLog::get()->filter(array("FullLocation" => $lowerFileLocation))->First();
                    if ($obj) {
                        $obj->delete();
                    }
                }
            } else {
                $j = $i + 1;
                $higherFileLocation = $fileLocation.".".$j.".bak";
                clearstatcache();
                if (file_exists($lowerFileLocation)) {
                    //double-check the top one ...
                    if (file_exists($higherFileLocation)) {

                        clearstatcache();
                        $obj = DatabasebackupLog::get()->filter(array("FullLocation" => $higherFileLocation))->First();
                        if ($obj) {
                            $obj->delete();
                        }
                    }
                    clearstatcache();
                    if (rename($lowerFileLocation, $higherFileLocation)) {

                        $obj = DatabasebackupLog::get()->filter(array("FullLocation" => $lowerFileLocation))->First();
                        if ($obj) {
                            $obj->FullLocation = $higherFileLocation;
                            $obj->write();
                        }
                    }
                }
            }
        }
        //just in case there were NO DBes to cycle....
        if (!isset($lowerFileLocation)) {
            $lowerFileLocation = $this->olderBackupFileName($fileLocation, ".0.bak");
        }

        clearstatcache();
        if (file_exists($fileLocation)) {
            if (file_exists($lowerFileLocation)) {
                unlink($lowerFileLocation);
                clearstatcache();
                if (!file_exists($lowerFileLocation)) {

                    $obj = DatabasebackupLog::get()->filter(array("FullLocation" => $lowerFileLocation))->First();
                    if ($obj) {
                        $obj->delete();
                    }
                }
            }
            clearstatcache();
            if (rename($fileLocation, $lowerFileLocation)) {

                $obj = DatabasebackupLog::get()->filter(array("FullLocation" => $fileLocation))->First();
                if ($obj) {
                    $obj->FullLocation = $lowerFileLocation;
                    $obj->write();
                }
            }
        }
        return $fileLocation;
    }

    /**
     * returns best file location with compression extension...
     *
     * @return String | Null
     */
    protected function getFullLocationWithExtension()
    {
        $fileLocation = $this->Config()->get("full_location_for_db_backup_file");
        if ($fileLocation) {
            $compression = $this->Config()->get("compression");
            if ($compression == "gzip") {
                $fileLocation .= ".gz";
            }
            return $fileLocation;
        }
        return null;
    }

    /**
     * returns file name for older back up file (cycled one)
     *
     * @param String $fileLocation
     * @param Int $position
     *
     * @return String
     */
    protected function olderBackupFileName($fileLocation, $position)
    {
        return $fileLocation.".".$position.".bak";
    }

    /**
     * check for existing backups
     *
     */
    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        $array = array($this->getFullLocationWithExtension());
        $arrayOfIDs = DatabasebackupLog::get()->map("ID", "ID")->toArray();
        for ($i = 0; $i < 100; $i++) {
            $array[] = $this->olderBackupFileName($array[0], $i);
        }
        foreach ($array as $fileLocation) {
            clearstatcache();
            if (file_exists($fileLocation)) {
                $obj = DatabasebackupLog::get()->filter(array("FullLocation" => $fileLocation))->First();
                if ($obj) {
                    //do nothing
                } else {
                    $className = $this->class;
                    $obj = new $className;
                    //make sure it has a full file location!
                    $obj->FullLocation = $fileLocation;
                    $obj->write();
                }
                unset($arrayOfIDs[$obj->ID]);
            }
        }
        $objects = DatabasebackupLog::get()->filter(array("ID" => $arrayOfIDs));
        foreach ($objects as $obj) {
            $obj->delete();
        }
    }
}

sunnysideup / silverstripe-databasebackup

DatabasebackupLog F last analyzed 2019-04-24 10:32 UTC
