UpgradeConfigService::upgradeOldConfigFile() - Code Metrics - Inspection of "* [MOD] Use config cache file instead of storing i..." - nuxsmin/sysPass - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 3.0 ( 5e1ed3...5a5495 )

by Rubén

created 2018-11-11 23:12 UTC

UpgradeConfigService::upgradeOldConfigFile() B

↳ Parent: UpgradeConfigService

Complexity

Conditions	10
Paths	14

Size

Total Lines	60
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	33
nc	14
nop	1
dl	0
loc	60
rs	7.6666
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * sysPass
 *
 * @author    nuxsmin
 * @link      https://syspass.org
 * @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
 *
 * This file is part of sysPass.
 *
 * sysPass is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * sysPass is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 *  along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace SP\Services\Upgrade;

use SP\Config\ConfigData;
use SP\Core\Events\Event;
use SP\Core\Events\EventMessage;
use SP\Core\MimeTypes;
use SP\Providers\Log\FileLogHandler;
use SP\Services\Service;
use SP\Util\VersionUtil;

/**
 * Class UpgradeService
 *
 * @package SP\Services\Upgrade
 */
final class UpgradeConfigService extends Service implements UpgradeInterface
{
    /**
     * @var array Versiones actualizables
     */
    const UPGRADES = ['112.4', '130.16020501', '200.17011202', '300.18111001'];
    /**
     * @var ConfigData
     */
    protected $configData;

    /**
     * @param $version
     *
     * @return bool
     */
    public static function needsUpgrade($version)
    {
        return VersionUtil::checkVersion($version, self::UPGRADES);
    }

    /**
     * Actualizar el archivo de configuración a formato XML
     *
     * @param $version
     *
     * @throws UpgradeException
     */
    public function upgradeOldConfigFile($version)
    {
        $configData = $this->config->getConfigData();

        $message = EventMessage::factory()->addDescription(__u('Update Configuration'));

        $this->eventDispatcher->notifyEvent('upgrade.config.old.start', new Event($this, $message));

        // Include the file, save the data from $CONFIG
        include OLD_CONFIG_FILE;

        $message = EventMessage::factory();

        if (isset($CONFIG) && is_array($CONFIG)) {

            $paramMapper = function ($mapFrom, $mapTo) use ($CONFIG, $message, $configData) {
                if (isset($CONFIG[$mapFrom])) {
                    $message->addDetail(__u('Parameter'), $mapFrom);
                    $configData->{$mapTo}($CONFIG[$mapFrom]);
                }
            };

            foreach (self::getConfigParams() as $mapTo => $mapFrom) {
                if (method_exists($configData, $mapTo)) {
                    if (is_array($mapFrom)) {
                        /** @var array $mapFrom */
                        foreach ($mapFrom as $param) {
                            $paramMapper($mapFrom, $param);
                        }
                    } else {
                        if (isset($CONFIG[$mapFrom])) {
                            $paramMapper($mapFrom, $mapTo);
                        }
                    }
                }
            }
        }

        $oldFile = OLD_CONFIG_FILE . '.old.' . time();

        try {
            $configData->setSiteTheme('material-blue');
            $configData->setConfigVersion($version);

            $this->config->saveConfig($configData, false);

            rename(OLD_CONFIG_FILE, $oldFile);

            $message->addDetail(__u('Version'), $version);

            $this->eventDispatcher->notifyEvent('upgrade.config.old.end', new Event($this, $message));
        } catch (\Exception $e) {
            processException($e);

            $this->eventDispatcher->notifyEvent('exception',
                new Event($this, EventMessage::factory()
                    ->addDescription(__u('Error while updating the configuration'))
                    ->addDetail(__u('File'), $oldFile))
            );

            throw new UpgradeException(__u('Error while updating the configuration'));
        }
    }

    /**
     * Devuelve array de métodos y parámetros de configuración
     *
     * @return array
     */
    private static function getConfigParams()
    {
        return [
            'setAccountCount' => 'account_count',
            'setAccountLink' => 'account_link',
            'setCheckUpdates' => 'checkupdates',
            'setCheckNotices' => 'checknotices',
            'setDbHost' => 'dbhost',
            'setDbName' => 'dbname',
            'setDbPass' => 'dbpass',
            'setDbUser' => 'dbuser',
            'setDebug' => 'debug',
            'setDemoEnabled' => 'demo_enabled',
            'setGlobalSearch' => 'globalsearch',
            'setInstalled' => 'installed',
            'setMaintenance' => 'maintenance',
            'setPasswordSalt' => 'passwordsalt',
            'setSessionTimeout' => 'session_timeout',
            'setSiteLang' => 'sitelang',
            'setConfigVersion' => 'version',
            'setConfigHash' => 'config_hash',
            'setProxyEnabled' => 'proxy_enabled',
            'setProxyPass' => 'proxy_pass',
            'setProxyPort' => 'proxy_port',
            'setProxyServer' => 'proxy_server',
            'setProxyUser' => 'proxy_user',
            'setResultsAsCards' => 'resultsascards',
            'setSiteTheme' => 'sitetheme',
            'setAccountPassToImage' => 'account_passtoimage',
            'setFilesAllowedExts' => ['allowed_exts', 'files_allowed_exts'],
            'setFilesAllowedSize' => ['allowed_size', 'files_allowed_size'],
            'setFilesEnabled' => ['filesenabled', 'files_enabled'],
            'setLdapBase' => ['ldapbase', 'ldap_base'],
            'setLdapBindPass' => ['ldapbindpass', 'ldap_bindpass'],
            'setLdapBindUser' => ['ldapbinduser', 'ldap_binduser'],
            'setLdapEnabled' => ['ldapenabled', 'ldap_enabled'],
            'setLdapGroup' => ['ldapgroup', 'ldap_group'],
            'setLdapServer' => ['ldapserver', 'ldap_server'],
            'setLdapAds' => 'ldap_ads',
            'setLdapDefaultGroup' => 'ldap_defaultgroup',
            'setLdapDefaultProfile' => 'ldap_defaultprofile',
            'setLogEnabled' => ['logenabled', 'log_enabled'],
            'setMailEnabled' => ['mailenabled', 'mail_enabled'],
            'setMailFrom' => ['mailfrom', 'mail_from'],
            'setMailPass' => ['mailpass', 'mail_pass'],
            'setMailPort' => ['mailport', 'mail_port'],
            'setMailRequestsEnabled' => ['mailrequestsenabled', 'mail_requestsenabled'],
            'setMailAuthenabled' => 'mail_authenabled',
            'setMailSecurity' => ['mailsecurity', 'mail_security'],
            'setMailServer' => ['mailserver', 'mail_server'],
            'setMailUser' => ['mailuser', 'mail_user'],
            'setWikiEnabled' => ['wikienabled', 'wiki_enabled'],
            'setWikiFilter' => ['wikifilter', 'wiki_filter'],
            'setWikiPageUrl' => ['wikipageurl' . 'wiki_pageurl'],
            'setWikiSearchUrl' => ['wikisearchurl', 'wiki_searchurl']
        ];
    }

    /**
     * Migrar valores de configuración.
     *
     * @param            $version
     * @param ConfigData $configData
     *
     * @throws \DI\DependencyException
     * @throws \DI\NotFoundException
     * @throws \SP\Storage\File\FileException
     */
    public function upgrade($version, ConfigData $configData)
    {
        $this->configData = $configData;

        $message = EventMessage::factory()->addDescription(__u('Update Configuration'));
        $this->eventDispatcher->notifyEvent('upgrade.config.start', new Event($this, $message));

        foreach (self::UPGRADES as $upgradeVersion) {
            if (VersionUtil::checkVersion($version, $upgradeVersion)) {
                $this->applyUpgrade($upgradeVersion);
            }
        }

        $this->eventDispatcher->notifyEvent('upgrade.config.end', new Event($this, $message));
    }

    /**
     * @param $version
     *
     * @throws \DI\DependencyException
     * @throws \DI\NotFoundException
     * @throws \SP\Storage\File\FileException
     */
    private function applyUpgrade($version)
    {
        switch ($version) {
            case '200.17011202':
                $this->upgrade_200_17011202($version);
                break;
            case '300.18111001':
                $this->upgrade_300_18111001($version);
                break;
        }
    }

    /**
     * @param $version
     *
     * @throws \DI\DependencyException
     * @throws \DI\NotFoundException
     * @throws \SP\Storage\File\FileException
     */
    private function upgrade_200_17011202($version)
    {
        $this->configData->setSiteTheme('material-blue');
        $this->configData->setConfigVersion($version);

        $this->config->saveConfig($this->configData, false);

        $this->eventDispatcher->notifyEvent('upgrade.config.process',
            new Event($this, EventMessage::factory()
                ->addDescription(__u('Update Configuration'))
                ->addDetail(__u('Version'), $version))
        );
    }

    /**
     * @param $version
     *
     * @throws \DI\DependencyException
     * @throws \DI\NotFoundException
     * @throws \SP\Storage\File\FileException
     */
    private function upgrade_300_18111001($version)
    {
        $extensions = array_map('strtolower', $this->configData->getFilesAllowedExts());
        $mimeTypes = $this->dic->get(MimeTypes::class)->getMimeTypes();
        $configMimeTypes = [];

        foreach ($extensions as $extension) {
            $exists = false;

            foreach ($mimeTypes as $mimeType) {
                if (strtolower($mimeType['extension']) === $extension) {
                    $configMimeTypes[] = $mimeType['type'];
                    $exists = true;

                    $this->eventDispatcher->notifyEvent('upgrade.config.process',
                        new Event($this, EventMessage::factory()
                            ->addDescription(__u('MIME type set for this extension'))
                            ->addDetail(__u('MIME type'), $mimeType['type'])
                            ->addDetail(__u('Extension'), $extension))
                    );
                }
            }

            if (!$exists) {
                $this->eventDispatcher->notifyEvent('upgrade.config.process',
                    new Event($this, EventMessage::factory()
                        ->addDescription(__u('MIME type not found for this extension'))
                        ->addDetail(__u('Extension'), $extension))
                );
            }
        }

        $this->configData->setFilesAllowedMime($configMimeTypes);
        $this->configData->setConfigVersion($version);

        $this->config->saveConfig($this->configData, false);

        $this->eventDispatcher->notifyEvent('upgrade.config.process',
            new Event($this, EventMessage::factory()
                ->addDescription(__u('Update Configuration'))
                ->addDetail(__u('Version'), $version))
        );
    }

    /**
     * initialize
     */
    protected function initialize()
    {
        $this->eventDispatcher->attach($this->dic->get(FileLogHandler::class));
    }
}

1			<?php
2			/**
3			* sysPass
4			*
5			* @author nuxsmin
6			* @link https://syspass.org
7			* @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
8			*
9			* This file is part of sysPass.
10			*
11			* sysPass is free software: you can redistribute it and/or modify
12			* it under the terms of the GNU General Public License as published by
13			* the Free Software Foundation, either version 3 of the License, or
14			* (at your option) any later version.
15			*
16			* sysPass is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU General Public License for more details.
20			*
21			* You should have received a copy of the GNU General Public License
22			* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
23			*/
24
25			namespace SP\Services\Upgrade;
26
27			use SP\Config\ConfigData;
28			use SP\Core\Events\Event;
29			use SP\Core\Events\EventMessage;
30			use SP\Core\MimeTypes;
31			use SP\Providers\Log\FileLogHandler;
32			use SP\Services\Service;
33			use SP\Util\VersionUtil;
34
35			/**
36			* Class UpgradeService
37			*
38			* @package SP\Services\Upgrade
39			*/
40			final class UpgradeConfigService extends Service implements UpgradeInterface
41			{
42			/**
43			* @var array Versiones actualizables
44			*/
45			const UPGRADES = ['112.4', '130.16020501', '200.17011202', '300.18111001'];
46			/**
47			* @var ConfigData
48			*/
49			protected $configData;
50
51			/**
52			* @param $version
53			*
54			* @return bool
55			*/
56			public static function needsUpgrade($version)
57			{
58			return VersionUtil::checkVersion($version, self::UPGRADES);
59			}
60
61			/**
62			* Actualizar el archivo de configuración a formato XML
63			*
64			* @param $version
65			*
66			* @throws UpgradeException
67			*/
68			public function upgradeOldConfigFile($version)
69			{
70			$configData = $this->config->getConfigData();
71
72			$message = EventMessage::factory()->addDescription(__u('Update Configuration'));
73
74			$this->eventDispatcher->notifyEvent('upgrade.config.old.start', new Event($this, $message));
75
76			// Include the file, save the data from $CONFIG
77			include OLD_CONFIG_FILE;
78
79			$message = EventMessage::factory();
80
81			if (isset($CONFIG) && is_array($CONFIG)) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-07-31 20:46 UTC by Report Bug Copy Issue Report The variable `$CONFIG` seems to never exist and therefore `isset` should always be `false`. Loading history...
82			$paramMapper = function ($mapFrom, $mapTo) use ($CONFIG, $message, $configData) {
83			if (isset($CONFIG[$mapFrom])) {
84			$message->addDetail(__u('Parameter'), $mapFrom);
85			$configData->{$mapTo}($CONFIG[$mapFrom]);
86			}
87			};
88
89			foreach (self::getConfigParams() as $mapTo => $mapFrom) {
90			if (method_exists($configData, $mapTo)) {
91			if (is_array($mapFrom)) {
92			/** @var array $mapFrom */
93			foreach ($mapFrom as $param) {
94			$paramMapper($mapFrom, $param);
95			}
96			} else {
97			if (isset($CONFIG[$mapFrom])) {
98			$paramMapper($mapFrom, $mapTo);
99			}
100			}
101			}
102			}
103			}
104
105			$oldFile = OLD_CONFIG_FILE . '.old.' . time();
106
107			try {
108			$configData->setSiteTheme('material-blue');
109			$configData->setConfigVersion($version);
110
111			$this->config->saveConfig($configData, false);
112
113			rename(OLD_CONFIG_FILE, $oldFile);
114
115			$message->addDetail(__u('Version'), $version);
116
117			$this->eventDispatcher->notifyEvent('upgrade.config.old.end', new Event($this, $message));
118			} catch (\Exception $e) {
119			processException($e);
120
121			$this->eventDispatcher->notifyEvent('exception',
122			new Event($this, EventMessage::factory()
123			->addDescription(__u('Error while updating the configuration'))
124			->addDetail(__u('File'), $oldFile))
125			);
126
127			throw new UpgradeException(__u('Error while updating the configuration'));
128			}
129			}
130
131			/**
132			* Devuelve array de métodos y parámetros de configuración
133			*
134			* @return array
135			*/
136			private static function getConfigParams()
137			{
138			return [
139			'setAccountCount' => 'account_count',
140			'setAccountLink' => 'account_link',
141			'setCheckUpdates' => 'checkupdates',
142			'setCheckNotices' => 'checknotices',
143			'setDbHost' => 'dbhost',
144			'setDbName' => 'dbname',
145			'setDbPass' => 'dbpass',
146			'setDbUser' => 'dbuser',
147			'setDebug' => 'debug',
148			'setDemoEnabled' => 'demo_enabled',
149			'setGlobalSearch' => 'globalsearch',
150			'setInstalled' => 'installed',
151			'setMaintenance' => 'maintenance',
152			'setPasswordSalt' => 'passwordsalt',
153			'setSessionTimeout' => 'session_timeout',
154			'setSiteLang' => 'sitelang',
155			'setConfigVersion' => 'version',
156			'setConfigHash' => 'config_hash',
157			'setProxyEnabled' => 'proxy_enabled',
158			'setProxyPass' => 'proxy_pass',
159			'setProxyPort' => 'proxy_port',
160			'setProxyServer' => 'proxy_server',
161			'setProxyUser' => 'proxy_user',
162			'setResultsAsCards' => 'resultsascards',
163			'setSiteTheme' => 'sitetheme',
164			'setAccountPassToImage' => 'account_passtoimage',
165			'setFilesAllowedExts' => ['allowed_exts', 'files_allowed_exts'],
166			'setFilesAllowedSize' => ['allowed_size', 'files_allowed_size'],
167			'setFilesEnabled' => ['filesenabled', 'files_enabled'],
168			'setLdapBase' => ['ldapbase', 'ldap_base'],
169			'setLdapBindPass' => ['ldapbindpass', 'ldap_bindpass'],
170			'setLdapBindUser' => ['ldapbinduser', 'ldap_binduser'],
171			'setLdapEnabled' => ['ldapenabled', 'ldap_enabled'],
172			'setLdapGroup' => ['ldapgroup', 'ldap_group'],
173			'setLdapServer' => ['ldapserver', 'ldap_server'],
174			'setLdapAds' => 'ldap_ads',
175			'setLdapDefaultGroup' => 'ldap_defaultgroup',
176			'setLdapDefaultProfile' => 'ldap_defaultprofile',
177			'setLogEnabled' => ['logenabled', 'log_enabled'],
178			'setMailEnabled' => ['mailenabled', 'mail_enabled'],
179			'setMailFrom' => ['mailfrom', 'mail_from'],
180			'setMailPass' => ['mailpass', 'mail_pass'],
181			'setMailPort' => ['mailport', 'mail_port'],
182			'setMailRequestsEnabled' => ['mailrequestsenabled', 'mail_requestsenabled'],
183			'setMailAuthenabled' => 'mail_authenabled',
184			'setMailSecurity' => ['mailsecurity', 'mail_security'],
185			'setMailServer' => ['mailserver', 'mail_server'],
186			'setMailUser' => ['mailuser', 'mail_user'],
187			'setWikiEnabled' => ['wikienabled', 'wiki_enabled'],
188			'setWikiFilter' => ['wikifilter', 'wiki_filter'],
189			'setWikiPageUrl' => ['wikipageurl' . 'wiki_pageurl'],
190			'setWikiSearchUrl' => ['wikisearchurl', 'wiki_searchurl']
191			];
192			}
193
194			/**
195			* Migrar valores de configuración.
196			*
197			* @param $version
198			* @param ConfigData $configData
199			*
200			* @throws \DI\DependencyException
201			* @throws \DI\NotFoundException
202			* @throws \SP\Storage\File\FileException
203			*/
204			public function upgrade($version, ConfigData $configData)
205			{
206			$this->configData = $configData;
207
208			$message = EventMessage::factory()->addDescription(__u('Update Configuration'));
209			$this->eventDispatcher->notifyEvent('upgrade.config.start', new Event($this, $message));
210
211			foreach (self::UPGRADES as $upgradeVersion) {
212			if (VersionUtil::checkVersion($version, $upgradeVersion)) {
213			$this->applyUpgrade($upgradeVersion);
214			}
215			}
216
217			$this->eventDispatcher->notifyEvent('upgrade.config.end', new Event($this, $message));
218			}
219
220			/**
221			* @param $version
222			*
223			* @throws \DI\DependencyException
224			* @throws \DI\NotFoundException
225			* @throws \SP\Storage\File\FileException
226			*/
227			private function applyUpgrade($version)
228			{
229			switch ($version) {
230			case '200.17011202':
231			$this->upgrade_200_17011202($version);
232			break;
233			case '300.18111001':
234			$this->upgrade_300_18111001($version);
235			break;
236			}
237			}
238
239			/**
240			* @param $version
241			*
242			* @throws \DI\DependencyException
243			* @throws \DI\NotFoundException
244			* @throws \SP\Storage\File\FileException
245			*/
246			private function upgrade_200_17011202($version)
247			{
248			$this->configData->setSiteTheme('material-blue');
249			$this->configData->setConfigVersion($version);
250
251			$this->config->saveConfig($this->configData, false);
252
253			$this->eventDispatcher->notifyEvent('upgrade.config.process',
254			new Event($this, EventMessage::factory()
255			->addDescription(__u('Update Configuration'))
256			->addDetail(__u('Version'), $version))
257			);
258			}
259
260			/**
261			* @param $version
262			*
263			* @throws \DI\DependencyException
264			* @throws \DI\NotFoundException
265			* @throws \SP\Storage\File\FileException
266			*/
267			private function upgrade_300_18111001($version)
268			{
269			$extensions = array_map('strtolower', $this->configData->getFilesAllowedExts());
270			$mimeTypes = $this->dic->get(MimeTypes::class)->getMimeTypes();
271			$configMimeTypes = [];
272
273			foreach ($extensions as $extension) {
274			$exists = false;
275
276			foreach ($mimeTypes as $mimeType) {
277			if (strtolower($mimeType['extension']) === $extension) {
278			$configMimeTypes[] = $mimeType['type'];
279			$exists = true;
280
281			$this->eventDispatcher->notifyEvent('upgrade.config.process',
282			new Event($this, EventMessage::factory()
283			->addDescription(__u('MIME type set for this extension'))
284			->addDetail(__u('MIME type'), $mimeType['type'])
285			->addDetail(__u('Extension'), $extension))
286			);
287			}
288			}
289
290			if (!$exists) {
291			$this->eventDispatcher->notifyEvent('upgrade.config.process',
292			new Event($this, EventMessage::factory()
293			->addDescription(__u('MIME type not found for this extension'))
294			->addDetail(__u('Extension'), $extension))
295			);
296			}
297			}
298
299			$this->configData->setFilesAllowedMime($configMimeTypes);
300			$this->configData->setConfigVersion($version);
301
302			$this->config->saveConfig($this->configData, false);
303
304			$this->eventDispatcher->notifyEvent('upgrade.config.process',
305			new Event($this, EventMessage::factory()
306			->addDescription(__u('Update Configuration'))
307			->addDetail(__u('Version'), $version))
308			);
309			}
310
311			/**
312			* initialize
313			*/
314			protected function initialize()
315			{
316			$this->eventDispatcher->attach($this->dic->get(FileLogHandler::class));
317			}
318			}

nuxsmin / sysPass

Push — 3.0 ( 5e1ed3...5a5495 )

UpgradeConfigService::upgradeOldConfigFile() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like