Sugarcrm\UpgradeSpec\Data\Provider\LocalUpgradePackage

Complexity

Total Complexity

20

Size/Duplication

Total Lines	198
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getListOfCustomizations()	0	20	2
A	getListOfDeletedFiles()	0	4	1
A	getListOfModifiedFiles()	0	4	1
A	getListOfScripts()	0	4	1
A	getListOfSQLScripts()	0	4	1
A	getDirectoryFileList()	0	9	2
A	getNewOrChangedFiles()	0	11	3
A	extractUpgradePackage()	0	13	2
A	getExtractedPackagePath()	0	4	1
A	setExtractedPackagePath()	0	4	1
A	clearUpgradePackageDirectory()	0	5	1
A	initPackageDirectory()	0	19	3

<?php

namespace Sugarcrm\UpgradeSpec\Data\Provider;

use Symfony\Component\Finder\Finder;

use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Filesystem\Exception\IOExceptionInterface;
use ZipArchive;


class LocalUpgradePackage implements PackageDataProviderInterface
{
    private $upgradePackagePath;

The property $upgradePackagePath is not used and could be removed.

    private $zipExtractor;

The property $zipExtractor is not used and could be removed.

    private $data;

The property $data is not used and could be removed.

    private $etractedPackagePath;


    /**
     * LocalUpgradePackage constructor.
     *
     * @param Cache         $cache

There is no parameter named $cache. Was it maybe removed?

     * @param $zipExtractor
     * @param String $pathToBuild

There is no parameter named $pathToBuild. Was it maybe removed?

     */
    public function __construct()
    {

    }

    /*
     * calculates all modified files in new directory
     */
    public function getListOfCustomizations(Context $context)
    {

        if ($context->pathToUpgradePackage) {
            $this->setExtractedPackagePath($context->version);
            $this->initPackageDirectory($this->getExtractedPackagePath());
            $this->extractUpgradePackage($context->pathToUpgradePackage);
            $customizations = array();
            $finder = new Finder();
            $customizations['deleted_files'] =
                $this->getDirectoryFileList($finder, $this->etractedPackagePath . '/scripts/files_to_remove/');

            $customizations['sql_scripts'] =
                $this->getDirectoryFileList($finder, $this->etractedPackagePath . '/scripts/');

            $customizations['sql_scripts'] =
                $this->getDirectoryFileList($finder, $this->etractedPackagePath . '/scripts/');
        }
        return $customizations;

The variable $customizations does not seem to be defined for all execution paths leading up to this point.

    }
    /**
     * Get list of files needs to be deleted
     *
     * @param String $pathToUpgradePackage
     *
     * @return mixed
     */
    public function getListOfDeletedFiles($pathToUpgradePackage)

The parameter $pathToUpgradePackage is not used and could be removed.

    {
        return '';
    }
    /**
     * Get list of files needs to be Modified
     *
     * @param String $pathToUpgradePackage
     *
     * @return mixed
     */
    public function getListOfModifiedFiles($pathToUpgradePackage)

The parameter $pathToUpgradePackage is not used and could be removed.

    {
        return '';
    }
    /**
     * Get list of scripts needs to be run for upgrade
     *
     * @param String $pathToUpgradePackage
     *
     * @return mixed
     */
    public function getListOfScripts($pathToUpgradePackage)

The parameter $pathToUpgradePackage is not used and could be removed.

    {
        return '';
    }
    /**
     * Get list of sql migration scripts needs to be run for upgrade
     *
     * @param String $pathToUpgradePackage
     *
     * @return mixed
     */
    public function getListOfSQLScripts($pathToUpgradePackage)

The parameter $pathToUpgradePackage is not used and could be removed.

    {
        return '';
    }


    /*
     * @param Finder $finder
     * @param String $path
     * return mixed
     */
    private function getDirectoryFileList($finder, $path)

The parameter $path is not used and could be removed.

    {
        $filesLIst = [];
        $finder->files()->in($this->pathToUpgradePackage . '/scripts/files_to_remove/');

The property pathToUpgradePackage does not exist. Did you maybe forget to declare it?

        foreach ($finder as $file) {
            $filesLIst[] = $file->getRelativePathname();
        }
        return $filesLIst;
    }

    /*
     * @param Finder $finder
     * @param String $installedBuildPath
     * @param String $upgradePackagePath

There is no parameter named $upgradePackagePath. Was it maybe removed?

     * return mixed
     */
    private function getNewOrChangedFiles($finder, $installedBuildPath, $needstoBeUpgradedPath)

This method is not used, and could be removed.

    {
        $filesLIst = [];
        $finder->files()->in($needstoBeUpgradedPath);
        foreach ($finder as $file) {
            $fileName = $file->getRelativePathname();
            if (!file_exists($installedBuildPath . $fileName))
                $filesLIst[] = $fileName;
        }
        return $filesLIst;
    }

    /*
     * Extracts zipped upgrade package
     * @param String $pathToZipPackage

There is no parameter named $pathToZipPackage. Was it maybe removed?

     *
     */
    private function extractUpgradePackage($pathToUpgradePackage)
    {
        $unzip = new ZipArchive;
        $out = $unzip->open($pathToUpgradePackage);

        if ($out === TRUE) {
            $unzip->extractTo($this->getExtractedPackagePath());
            $unzip->close();
            echo 'Upgrade Package unzipped successfully' . "\n";
        } else {
            echo 'Something went wrong?';
        }
    }



    /**
     * @return string
     */
    protected function getExtractedPackagePath()
    {
        return $this->etractedPackagePath;
    }

    /**
     * @param string $upgradePackagePath

There is no parameter named $upgradePackagePath. Was it maybe removed?

     * @param string version
     */
    public function setExtractedPackagePath($version)
    {
        $this->etractedPackagePath = '/tmp/' . $version . '/';
    }


    /**
     * clear packege for unzipped package
     */
    private function clearUpgradePackageDirectory($extractedPackagePath)
    {
        $fs = new Filesystem();
        $fs->remove($extractedPackagePath);
    }

    /**
     * Creates directory for extracting zip package
     * @return bool
     */
    private function initPackageDirectory($extractedPackagePath)
    {

        $fs = new Filesystem();

        if ($fs->exists($extractedPackagePath))
        {
            $this->clearUpgradePackageDirectory($extractedPackagePath);
            return true;
        }

        try {
            $fs->mkdir($extractedPackagePath);
            return true;
        } catch (IOExceptionInterface $e) {
            echo "An error occurred while creating upgrade package directory ".$e->getPath();
        }

    }

}