UpgradeCommand::configure() - Code Metrics - Inspection of "update vendors" - zikula/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8a455a...42a228 )

by Craig

created 2019-12-14 23:31 UTC

UpgradeCommand::configure() A

↳ Parent: UpgradeCommand

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	12
nc	3
nop	0
dl	0
loc	17
rs	9.8666
c	0
b	0
f	0

<?php

declare(strict_types=1);

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula Foundation - https://ziku.la/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\Bundle\CoreInstallerBundle\Command;

use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Zikula\Bundle\CoreBundle\HttpKernel\ZikulaHttpKernelInterface;
use Zikula\Bundle\CoreBundle\HttpKernel\ZikulaKernel;
use Zikula\Bundle\CoreBundle\YamlDumper;
use Zikula\Bundle\CoreInstallerBundle\Controller\UpgraderController;
use Zikula\Bundle\CoreInstallerBundle\Form\Type\LocaleType;
use Zikula\Bundle\CoreInstallerBundle\Form\Type\LoginType;
use Zikula\Bundle\CoreInstallerBundle\Form\Type\RequestContextType;
use Zikula\Bundle\CoreInstallerBundle\Helper\ControllerHelper;
use Zikula\Bundle\CoreInstallerBundle\Helper\MigrationHelper;
use Zikula\Bundle\CoreInstallerBundle\Helper\StageHelper;
use Zikula\Bundle\CoreInstallerBundle\Stage\Upgrade\AjaxUpgraderStage;
use Zikula\Common\Translator\TranslatorInterface;
use Zikula\SettingsModule\Api\ApiInterface\LocaleApiInterface;

class UpgradeCommand extends AbstractCoreInstallerCommand
{
    /**
     * @var string
     */
    private $currentInstalledVersion;

    /**
     * @var ZikulaHttpKernelInterface
     */
    private $kernel;

    /**
     * @var ControllerHelper
     */
    private $controllerHelper;

    /**
     * @var MigrationHelper
     */
    private $migrationHelper;

    /**
     * @var LocaleApiInterface
     */
    private $localeApi;

    /**
     * @var StageHelper
     */
    private $stageHelper;

    /**
     * @var array
     */
    private $selectedSettings = [
        'username',
        'password',
        'router:request_context:host',
        'router:request_context:scheme',
        'router:request_context:base_url'
    ];

    public function __construct(
        string $currentInstalledVersion,
        ZikulaHttpKernelInterface $kernel,
        ControllerHelper $controllerHelper,
        MigrationHelper $migrationHelper,
        LocaleApiInterface $localeApi,
        StageHelper $stageHelper,
        TranslatorInterface $translator
    ) {
        $this->currentInstalledVersion = $currentInstalledVersion;
        $this->kernel = $kernel;
        $this->controllerHelper = $controllerHelper;
        $this->migrationHelper = $migrationHelper;
        $this->localeApi = $localeApi;
        $this->stageHelper = $stageHelper;
        parent::__construct($translator);
    }

    protected function configure()
    {
        $this
            ->setDescription('Upgrade Zikula from the command line.')
            ->setName('zikula:upgrade')
        ;
        foreach ($this->settings as $name => $setting) {
            if (!in_array($name, $this->selectedSettings, true)) {
                // only use selected settings for upgrade
                continue;
            }
            $this->addOption(
                $name,
                null,
                InputOption::VALUE_REQUIRED,
                $setting['description'],
                $setting['default']
            );
        }
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        if (version_compare($this->currentInstalledVersion, UpgraderController::ZIKULACORE_MINIMUM_UPGRADE_VERSION, '<')) {
            $output->writeln($this->translator->__f('The current installed version of Zikula is reporting (%1$s). You must upgrade to version (%2$s) before you can use this upgrade.', ['%1$s' => $this->currentInstalledVersion, '%2$s' => UpgraderController::ZIKULACORE_MINIMUM_UPGRADE_VERSION]));

            return false;
        }

        $io = new SymfonyStyle($input, $output);
        $io->title($this->translator->__('Zikula Upgrader Script'));
        $io->section($this->translator->__f('*** UPGRADING TO ZIKULA CORE %version% ***', ['%version%' => ZikulaKernel::VERSION]));
        $io->text($this->translator->__f('Upgrading Zikula in %env% environment.', ['%env%' => $this->kernel->getEnvironment()]));

        $warnings = $this->controllerHelper->initPhp();
        if (!empty($warnings)) {
            $this->printWarnings($output, $warnings);

            return false;
        }
        $checks = $this->controllerHelper->requirementsMet();
        if (true !== $checks) {

            $this->printRequirementsWarnings($output, $checks);

            return false;
        }

        $count = $this->migrationHelper->countUnMigratedUsers();
        if ($count > 0) {
            $io->text($this->translator->__('Beginning user migration...'));
            $userMigrationMaxuid = (int)$this->migrationHelper->getMaxUnMigratedUid();
            $progressBar = new ProgressBar($output, (int)ceil($count / MigrationHelper::BATCH_LIMIT));
            $progressBar->start();
            $lastUid = 0;
            do {
                $result = $this->migrationHelper->migrateUsers($lastUid);
                $lastUid = $result['lastUid'];
                $progressBar->advance();
            } while ($lastUid < $userMigrationMaxuid);
            $progressBar->finish();
            $io->success($this->translator->__('User migration complete!'));
        } else {
            $io->text($this->translator->__('There was no need to migrate any users.'));
        }

        // avoid warning in PHP 7.2 based on ini_set() usage which is caused by any access to the
        // session before regeneration happens (e.g. by an event listener executed before a login)
        // see issue #3898 for the details
        $reportingLevel = error_reporting();
        error_reporting($reportingLevel & ~E_WARNING);

        // get the settings from user input
        $settings = $this->getHelper('form')->interactUsingForm(LocaleType::class, $input, $output, [
            'choices' => $this->localeApi->getSupportedLocaleNames()
        ]);

        $data = $this->getHelper('form')->interactUsingForm(LoginType::class, $input, $output);
        foreach ($data as $k => $v) {
            $data[$k] = base64_encode($v); // encode so values are 'safe' for json
        }
        $settings = array_merge($settings, $data);

        $data = $this->getHelper('form')->interactUsingForm(RequestContextType::class, $input, $output);
        foreach ($data as $k => $v) {

            $newKey = str_replace(':', '.', $k);
            $data[$newKey] = $v;
            unset($data[$k]);
        }
        $settings = array_merge($settings, $data);

        $this->printSettings($settings, $io);
        $io->newLine();

        // write the parameters to custom_parameters.yml
        $yamlManager = new YamlDumper($this->kernel->getProjectDir() . '/app/config', 'custom_parameters.yml');
        $params = array_merge($yamlManager->getParameters(), $settings);
        unset($params['upgrading']);
        $yamlManager->setParameters($params);

        // upgrade!
        $ajaxStage = new AjaxUpgraderStage($this->translator, $this->currentInstalledVersion);
        $this->stageHelper->handleAjaxStage($ajaxStage, $io);

        error_reporting($reportingLevel);

        $io->success($this->translator->__('UPGRADE COMPLETE!'));

        return true;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Zikula package.
7			*
8			* Copyright Zikula Foundation - https://ziku.la/
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Zikula\Bundle\CoreInstallerBundle\Command;
15
16			use Symfony\Component\Console\Helper\ProgressBar;
17			use Symfony\Component\Console\Input\InputInterface;
18			use Symfony\Component\Console\Input\InputOption;
19			use Symfony\Component\Console\Output\OutputInterface;
20			use Symfony\Component\Console\Style\SymfonyStyle;
21			use Zikula\Bundle\CoreBundle\HttpKernel\ZikulaHttpKernelInterface;
22			use Zikula\Bundle\CoreBundle\HttpKernel\ZikulaKernel;
23			use Zikula\Bundle\CoreBundle\YamlDumper;
24			use Zikula\Bundle\CoreInstallerBundle\Controller\UpgraderController;
25			use Zikula\Bundle\CoreInstallerBundle\Form\Type\LocaleType;
26			use Zikula\Bundle\CoreInstallerBundle\Form\Type\LoginType;
27			use Zikula\Bundle\CoreInstallerBundle\Form\Type\RequestContextType;
28			use Zikula\Bundle\CoreInstallerBundle\Helper\ControllerHelper;
29			use Zikula\Bundle\CoreInstallerBundle\Helper\MigrationHelper;
30			use Zikula\Bundle\CoreInstallerBundle\Helper\StageHelper;
31			use Zikula\Bundle\CoreInstallerBundle\Stage\Upgrade\AjaxUpgraderStage;
32			use Zikula\Common\Translator\TranslatorInterface;
33			use Zikula\SettingsModule\Api\ApiInterface\LocaleApiInterface;
34
35			class UpgradeCommand extends AbstractCoreInstallerCommand
36			{
37			/**
38			* @var string
39			*/
40			private $currentInstalledVersion;
41
42			/**
43			* @var ZikulaHttpKernelInterface
44			*/
45			private $kernel;
46
47			/**
48			* @var ControllerHelper
49			*/
50			private $controllerHelper;
51
52			/**
53			* @var MigrationHelper
54			*/
55			private $migrationHelper;
56
57			/**
58			* @var LocaleApiInterface
59			*/
60			private $localeApi;
61
62			/**
63			* @var StageHelper
64			*/
65			private $stageHelper;
66
67			/**
68			* @var array
69			*/
70			private $selectedSettings = [
71			'username',
72			'password',
73			'router:request_context:host',
74			'router:request_context:scheme',
75			'router:request_context:base_url'
76			];
77
78			public function __construct(
79			string $currentInstalledVersion,
80			ZikulaHttpKernelInterface $kernel,
81			ControllerHelper $controllerHelper,
82			MigrationHelper $migrationHelper,
83			LocaleApiInterface $localeApi,
84			StageHelper $stageHelper,
85			TranslatorInterface $translator
86			) {
87			$this->currentInstalledVersion = $currentInstalledVersion;
88			$this->kernel = $kernel;
89			$this->controllerHelper = $controllerHelper;
90			$this->migrationHelper = $migrationHelper;
91			$this->localeApi = $localeApi;
92			$this->stageHelper = $stageHelper;
93			parent::__construct($translator);
94			}
95
96			protected function configure()
97			{
98			$this
99			->setDescription('Upgrade Zikula from the command line.')
100			->setName('zikula:upgrade')
101			;
102			foreach ($this->settings as $name => $setting) {
103			if (!in_array($name, $this->selectedSettings, true)) {
104			// only use selected settings for upgrade
105			continue;
106			}
107			$this->addOption(
108			$name,
109			null,
110			InputOption::VALUE_REQUIRED,
111			$setting['description'],
112			$setting['default']
113			);
114			}
115			}
116
117			protected function execute(InputInterface $input, OutputInterface $output)
118			{
119			if (version_compare($this->currentInstalledVersion, UpgraderController::ZIKULACORE_MINIMUM_UPGRADE_VERSION, '<')) {
120			$output->writeln($this->translator->__f('The current installed version of Zikula is reporting (%1$s). You must upgrade to version (%2$s) before you can use this upgrade.', ['%1$s' => $this->currentInstalledVersion, '%2$s' => UpgraderController::ZIKULACORE_MINIMUM_UPGRADE_VERSION]));
121
122			return false;
123			}
124
125			$io = new SymfonyStyle($input, $output);
126			$io->title($this->translator->__('Zikula Upgrader Script'));
127			$io->section($this->translator->__f('* UPGRADING TO ZIKULA CORE %version% *', ['%version%' => ZikulaKernel::VERSION]));
128			$io->text($this->translator->__f('Upgrading Zikula in %env% environment.', ['%env%' => $this->kernel->getEnvironment()]));
129
130			$warnings = $this->controllerHelper->initPhp();
131			if (!empty($warnings)) {
132			$this->printWarnings($output, $warnings);
133
134			return false;
135			}
136			$checks = $this->controllerHelper->requirementsMet();
137			if (true !== $checks) {
			0 ignored issues – show introduced 2019-12-14 23:38 UTC by Report Bug Copy Issue Report The condition `true !== $checks` is always `true`. Loading history...
138			$this->printRequirementsWarnings($output, $checks);
139
140			return false;
141			}
142
143			$count = $this->migrationHelper->countUnMigratedUsers();
144			if ($count > 0) {
145			$io->text($this->translator->__('Beginning user migration...'));
146			$userMigrationMaxuid = (int)$this->migrationHelper->getMaxUnMigratedUid();
147			$progressBar = new ProgressBar($output, (int)ceil($count / MigrationHelper::BATCH_LIMIT));
148			$progressBar->start();
149			$lastUid = 0;
150			do {
151			$result = $this->migrationHelper->migrateUsers($lastUid);
152			$lastUid = $result['lastUid'];
153			$progressBar->advance();
154			} while ($lastUid < $userMigrationMaxuid);
155			$progressBar->finish();
156			$io->success($this->translator->__('User migration complete!'));
157			} else {
158			$io->text($this->translator->__('There was no need to migrate any users.'));
159			}
160
161			// avoid warning in PHP 7.2 based on ini_set() usage which is caused by any access to the
162			// session before regeneration happens (e.g. by an event listener executed before a login)
163			// see issue #3898 for the details
164			$reportingLevel = error_reporting();
165			error_reporting($reportingLevel & ~E_WARNING);
166
167			// get the settings from user input
168			$settings = $this->getHelper('form')->interactUsingForm(LocaleType::class, $input, $output, [
169			'choices' => $this->localeApi->getSupportedLocaleNames()
170			]);
171
172			$data = $this->getHelper('form')->interactUsingForm(LoginType::class, $input, $output);
173			foreach ($data as $k => $v) {
174			$data[$k] = base64_encode($v); // encode so values are 'safe' for json
175			}
176			$settings = array_merge($settings, $data);
177
178			$data = $this->getHelper('form')->interactUsingForm(RequestContextType::class, $input, $output);
179			foreach ($data as $k => $v) {
			0 ignored issues – show Comprehensibility Bug introduced 2019-12-14 23:38 UTC by Report Bug Copy Issue Report `$k` is overwriting a variable from outer foreach loop. Loading history... Comprehensibility Bug introduced 2019-12-14 23:38 UTC by Report Bug Copy Issue Report `$v` is overwriting a variable from outer foreach loop. Loading history...
180			$newKey = str_replace(':', '.', $k);
181			$data[$newKey] = $v;
182			unset($data[$k]);
183			}
184			$settings = array_merge($settings, $data);
185
186			$this->printSettings($settings, $io);
187			$io->newLine();
188
189			// write the parameters to custom_parameters.yml
190			$yamlManager = new YamlDumper($this->kernel->getProjectDir() . '/app/config', 'custom_parameters.yml');
191			$params = array_merge($yamlManager->getParameters(), $settings);
192			unset($params['upgrading']);
193			$yamlManager->setParameters($params);
194
195			// upgrade!
196			$ajaxStage = new AjaxUpgraderStage($this->translator, $this->currentInstalledVersion);
197			$this->stageHelper->handleAjaxStage($ajaxStage, $io);
198
199			error_reporting($reportingLevel);
200
201			$io->success($this->translator->__('UPGRADE COMPLETE!'));
202
203			return true;
204			}
205			}
206

zikula / core

Push — master ( 8a455a...42a228 )

UpgradeCommand::configure() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like