[ticket/13740] CLI installer and fixes

[ci skip]

PHPBB3-13740
This commit is contained in:
Tristan Darricau 2015-05-31 17:19:42 +02:00 committed by Mate Bartus
parent 524b98e7bd
commit 06f4ebce1b
18 changed files with 1165 additions and 7 deletions

View file

@ -0,0 +1,44 @@
services:
console.installer.command_collection:
class: phpbb\di\service_collection
arguments:
- @service_container
tags:
- { name: service_collection, tag: console.installer.command }
console.installer.command.install:
class: phpbb\install\console\command\install\install
arguments:
- @language
- @installer.helper.iohandler_factory
- @installer.installer.install
tags:
- { name: console.installer.command }
console.installer.command.config.default:
class: phpbb\install\console\command\install\config\default_config
arguments:
- @language
- @installer.helper.iohandler_factory
- @installer.installer.install
tags:
- { name: console.installer.command }
console.installer.command.config.show:
class: phpbb\install\console\command\install\config\show
arguments:
- @language
- @installer.helper.iohandler_factory
- @installer.installer.install
tags:
- { name: console.installer.command }
console.installer.command.config.validate:
class: phpbb\install\console\command\install\config\validate
arguments:
- @language
- @installer.helper.iohandler_factory
- @installer.installer.install
tags:
- { name: console.installer.command }

View file

@ -1,4 +1,5 @@
imports: imports:
- { resource: services_install_console.yml }
- { resource: services_install_controller.yml } - { resource: services_install_controller.yml }
- { resource: services_install_data.yml } - { resource: services_install_data.yml }
- { resource: services_install_database.yml } - { resource: services_install_database.yml }
@ -40,6 +41,10 @@ services:
- @request - @request
- @template - @template
installer.helper.iohandler_cli:
class: phpbb\install\helper\iohandler\cli_iohandler
parent: installer.helper.iohandler_abstract
installer.helper.iohandler: installer.helper.iohandler:
class: phpbb\install\helper\iohandler\iohandler_interface class: phpbb\install\helper\iohandler\iohandler_interface
factory: ["@installer.helper.iohandler_factory", get] factory: ["@installer.helper.iohandler_factory", get]

35
phpBB/install-config.yml Normal file
View file

@ -0,0 +1,35 @@
installer:
admin:
name: admin
password: adminadmin
email: admin@example.org
board:
lang: en
name: My Board
description: My amazing new phpBB board
database:
dbms: sqlite3
dbhost: /tmp/phpbb.sqlite3
dbport: ~
dbuser: ~
dbpasswd: ~
dbname: ~
table_prefix: phpbb_
email:
enabled: false
smtp_delivery : ~
smtp_host: ~
smtp_auth: ~
smtp_user: ~
smtp_pass: ~
server:
cookie_secure: false
server_protocol: http://
force_server_vars: false
server_name: localhost
server_port: 80
script_path: /

68
phpBB/install/phpbbcli.php Executable file
View file

@ -0,0 +1,68 @@
#!/usr/bin/env php
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
use Symfony\Component\Console\Input\ArgvInput;
if (php_sapi_name() !== 'cli')
{
echo 'This program must be run from the command line.' . PHP_EOL;
exit(1);
}
define('IN_PHPBB', true);
define('IN_INSTALL', true);
define('PHPBB_ENVIRONMENT', 'production');
$phpbb_root_path = __DIR__ . '/../';
$phpEx = substr(strrchr(__FILE__, '.'), 1);
//
// Let's do the common.php logic
//
require($phpbb_root_path . 'includes/startup.' . $phpEx);
require($phpbb_root_path . 'phpbb/class_loader.' . $phpEx);
$phpbb_class_loader = new \phpbb\class_loader('phpbb\\', "{$phpbb_root_path}phpbb/", $phpEx);
$phpbb_class_loader->register();
// In case $phpbb_adm_relative_path is not set (in case of an update), use the default.
$phpbb_adm_relative_path = (isset($phpbb_adm_relative_path)) ? $phpbb_adm_relative_path : 'adm/';
$phpbb_admin_path = (defined('PHPBB_ADMIN_PATH')) ? PHPBB_ADMIN_PATH : $phpbb_root_path . $phpbb_adm_relative_path;
// Include files
require($phpbb_root_path . 'includes/functions.' . $phpEx);
require($phpbb_root_path . 'includes/functions_content.' . $phpEx);
include($phpbb_root_path . 'includes/functions_compatibility.' . $phpEx);
require($phpbb_root_path . 'includes/functions_user.' . $phpEx);
require($phpbb_root_path . 'includes/utf/utf_tools.' . $phpEx);
// Set PHP error handler to ours
set_error_handler(defined('PHPBB_MSG_HANDLER') ? PHPBB_MSG_HANDLER : 'msg_handler');
$phpbb_installer_container_builder = new \phpbb\di\container_builder($phpbb_root_path, $phpEx);
$phpbb_installer_container = $phpbb_installer_container_builder
->with_environment('installer')
->without_extensions()
->without_cache()
->get_container();
/** @var \phpbb\filesystem\filesystem $phpbb_filesystem */
$phpbb_filesystem = $phpbb_installer_container->get('filesystem');
/** @var \phpbb\language\language $language */
$language = $phpbb_installer_container->get('language');
$language->add_lang(array('common', 'acp/common', 'acp/board', 'install', 'posting', 'cli'));
$application = new \phpbb\console\application('phpBB Installer', PHPBB_VERSION, $language);
$application->register_container_commands($phpbb_installer_container->get('console.installer.command_collection'));
$application->run($input);

View file

@ -35,7 +35,7 @@ class application extends \Symfony\Component\Console\Application
* @param string $version The version of the application * @param string $version The version of the application
* @param \phpbb\user $user The user which runs the application (used for translation) * @param \phpbb\user $user The user which runs the application (used for translation)
*/ */
public function __construct($name, $version, \phpbb\user $user) public function __construct($name, $version, $user)
{ {
$this->user = $user; $this->user = $user;

View file

@ -0,0 +1,103 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\install\console\command\install\config;
use phpbb\language\language;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Yaml\Yaml;
class default_config extends \phpbb\console\command\command
{
/**
* @var language
*/
protected $language;
/**
* Constructor
*
* @param language $language
*/
public function __construct(language $language)
{
$this->language = $language;
parent::__construct(new \phpbb\user($language, 'datetime'));
}
/**
*
* {@inheritdoc}
*/
protected function configure()
{
$this
->setName('install:config:default')
;
}
/**
* Display the default configuration
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$default_config = <<<EOL
installer:
admin:
name: admin
password: adminadmin
email: admin@example.org
board:
lang: en
name: My Board
description: My amazing new phpBB board
database:
dbms: sqlite3
dbhost: ~
dbport: ~
dbuser: ~
dbpasswd: ~
dbname: ~
table_prefix: phpbb_
email:
enabled: false
smtp_delivery : ~
smtp_host: ~
smtp_auth: ~
smtp_user: ~
smtp_pass: ~
server:
cookie_secure: false
server_protocol: http://
force_server_vars: false
server_name: localhost
server_port: 80
script_path: /
EOL;
$default_config = Yaml::parse($default_config);
$default_config = Yaml::dump($default_config, 10);
$output->writeln($default_config);
}
}

View file

@ -0,0 +1,131 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\install\console\command\install\config;
use phpbb\install\helper\iohandler\factory;
use phpbb\install\installer;
use phpbb\install\installer_configuration;
use phpbb\language\language;
use Symfony\Component\Config\Definition\Exception\Exception;
use Symfony\Component\Config\Definition\Processor;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;
class show extends \phpbb\console\command\command
{
/**
* @var factory
*/
protected $iohandler_factory;
/**
* @var installer
*/
protected $installer;
/**
* @var language
*/
protected $language;
/**
* Constructor
*
* @param language $language
* @param factory $factory
* @param installer $installer
*/
public function __construct(language $language, factory $factory, installer $installer)
{
$this->iohandler_factory = $factory;
$this->installer = $installer;
$this->language = $language;
parent::__construct(new \phpbb\user($language, 'datetime'));
}
/**
*
* {@inheritdoc}
*/
protected function configure()
{
$this
->setName('install:config:show')
->addArgument(
'config-file',
InputArgument::REQUIRED,
$this->language->lang('CLI_CONFIG_FILE'))
->setDescription($this->language->lang('CLI_INSTALL_SHOW_CONFIG'))
;
}
/**
* Show the validated configuration
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$this->iohandler_factory->set_environment('cli');
/** @var \phpbb\install\helper\iohandler\cli_iohandler $iohandler */
$iohandler = $this->iohandler_factory->get();
$style = new SymfonyStyle($input, $output);
$iohandler->set_style($style, $output);
$config_file = $input->getArgument('config-file');
if (!is_file($config_file))
{
$iohandler->add_error_message(array('MISSING_FILE', array($config_file)));
return;
}
try
{
$config = Yaml::parse(file_get_contents($config_file), true, false);
}
catch (ParseException $e)
{
$iohandler->add_error_message('INVALID_YAML_FILE');
return;
}
$processor = new Processor();
$configuration = new installer_configuration();
try
{
$config = $processor->processConfiguration($configuration, $config);
}
catch (Exception $e)
{
$iohandler->add_error_message('INVALID_CONFIGURATION', $e->getMessage());
return;
}
$iohandler->add_log_message(Yaml::dump(array('installer' => $config), 10, 4, true, false));
}
}

View file

@ -0,0 +1,132 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\install\console\command\install\config;
use phpbb\install\helper\iohandler\factory;
use phpbb\install\installer;
use phpbb\install\installer_configuration;
use phpbb\language\language;
use Symfony\Component\Config\Definition\Exception\Exception;
use Symfony\Component\Config\Definition\Processor;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;
class validate extends \phpbb\console\command\command
{
/**
* @var factory
*/
protected $iohandler_factory;
/**
* @var installer
*/
protected $installer;
/**
* @var language
*/
protected $language;
/**
* Constructor
*
* @param language $language
* @param factory $factory
* @param installer $installer
*/
public function __construct(language $language, factory $factory, installer $installer)
{
$this->iohandler_factory = $factory;
$this->installer = $installer;
$this->language = $language;
parent::__construct(new \phpbb\user($language, 'datetime'));
}
/**
*
* {@inheritdoc}
*/
protected function configure()
{
$this
->setName('install:config:validate')
->addArgument(
'config-file',
InputArgument::REQUIRED,
$this->language->lang('CLI_CONFIG_FILE'))
->setDescription($this->language->lang('CLI_INSTALL_VALIDATE_CONFIG'))
;
}
/**
* Validate the configuration file
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$this->iohandler_factory->set_environment('cli');
/** @var \phpbb\install\helper\iohandler\cli_iohandler $iohandler */
$iohandler = $this->iohandler_factory->get();
$style = new SymfonyStyle($input, $output);
$iohandler->set_style($style, $output);
$config_file = $input->getArgument('config-file');
if (!is_file($config_file))
{
$iohandler->add_error_message(array('MISSING_FILE', array($config_file)));
return 1;
}
try
{
$config = Yaml::parse(file_get_contents($config_file), true, false);
}
catch (ParseException $e)
{
$iohandler->add_error_message('INVALID_YAML_FILE');
return 1;
}
$processor = new Processor();
$configuration = new installer_configuration();
try
{
$config = $processor->processConfiguration($configuration, $config);
}
catch (Exception $e)
{
$iohandler->add_error_message('INVALID_CONFIGURATION', $e->getMessage());
return 1;
}
$iohandler->add_success_message('CONFIGURATION_VALID');
return 0;
}
}

View file

@ -0,0 +1,194 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\install\console\command\install;
use phpbb\install\exception\installer_exception;
use phpbb\install\helper\iohandler\cli_iohandler;
use phpbb\install\helper\iohandler\factory;
use phpbb\install\installer;
use phpbb\install\installer_configuration;
use phpbb\language\language;
use Symfony\Component\Config\Definition\Exception\Exception;
use Symfony\Component\Config\Definition\Processor;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;
class install extends \phpbb\console\command\command
{
/**
* @var factory
*/
protected $iohandler_factory;
/**
* @var installer
*/
protected $installer;
/**
* @var language
*/
protected $language;
/**
* Constructor
*
* @param language $language
* @param factory $factory
* @param installer $installer
*/
public function __construct(language $language, factory $factory, installer $installer)
{
$this->iohandler_factory = $factory;
$this->installer = $installer;
$this->language = $language;
parent::__construct(new \phpbb\user($language, 'datetime'));
}
/**
*
* {@inheritdoc}
*/
protected function configure()
{
$this
->setName('install')
->addArgument(
'config-file',
InputArgument::REQUIRED,
$this->language->lang('CLI_CONFIG_FILE'))
->setDescription($this->language->lang('CLI_INSTALL_BOARD'))
;
}
/**
* Executes the command install.
*
* Install the board
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
// @todo check that phpBB is not already installed
$this->iohandler_factory->set_environment('cli');
/** @var \phpbb\install\helper\iohandler\cli_iohandler $iohandler */
$iohandler = $this->iohandler_factory->get();
$style = new SymfonyStyle($input, $output);
$iohandler->set_style($style, $output);
$this->installer->set_iohandler($iohandler);
$config_file = $input->getArgument('config-file');
if (!is_file($config_file))
{
$iohandler->add_error_message(array('MISSING_FILE', array($config_file)));
return;
}
try
{
$config = Yaml::parse(file_get_contents($config_file), true, false);
}
catch (ParseException $e)
{
$iohandler->add_error_message('INVALID_YAML_FILE');
return;
}
$processor = new Processor();
$configuration = new installer_configuration();
try
{
$config = $processor->processConfiguration($configuration, $config);
}
catch (Exception $e)
{
$iohandler->add_error_message('INVALID_CONFIGURATION', $e->getMessage());
return;
}
$this->register_configuration($iohandler, $config);
try
{
$this->installer->run();
}
catch (installer_exception $e)
{
$iohandler->add_error_message($e->getMessage());
return;
}
}
/**
* Register the configuration to simulate the forms.
*
* @param cli_iohandler $iohandler
* @param array $config
*/
private function register_configuration(cli_iohandler $iohandler, $config)
{
$iohandler->set_input('admin_name', $config['admin']['name']);
$iohandler->set_input('admin_pass1', $config['admin']['password']);
$iohandler->set_input('admin_pass2', $config['admin']['password']);
$iohandler->set_input('board_email', $config['admin']['email']);
$iohandler->set_input('submit_admin', 'submit');
$iohandler->set_input('default_lang', $config['board']['lang']);
$iohandler->set_input('board_name', $config['board']['name']);
$iohandler->set_input('board_description', $config['board']['description']);
$iohandler->set_input('submit_board', 'submit');
$iohandler->set_input('dbms', $config['database']['dbms']);
$iohandler->set_input('dbhost', $config['database']['dbhost']);
$iohandler->set_input('dbport', $config['database']['dbport']);
$iohandler->set_input('dbuser', $config['database']['dbuser']);
$iohandler->set_input('dbpasswd', $config['database']['dbpasswd']);
$iohandler->set_input('dbname', $config['database']['dbname']);
$iohandler->set_input('table_prefix', $config['database']['table_prefix']);
$iohandler->set_input('submit_database', 'submit');
$iohandler->set_input('email_enable', $config['email']['enabled']);
$iohandler->set_input('smtp_delivery', $config['email']['smtp_delivery']);
$iohandler->set_input('smtp_host', $config['email']['smtp_host']);
$iohandler->set_input('smtp_auth', $config['email']['smtp_auth']);
$iohandler->set_input('smtp_user', $config['email']['smtp_user']);
$iohandler->set_input('smtp_pass', $config['email']['smtp_pass']);
$iohandler->set_input('submit_email', 'submit');
$iohandler->set_input('cookie_secure', $config['server']['cookie_secure']);
$iohandler->set_input('server_protocol', $config['server']['server_protocol']);
$iohandler->set_input('force_server_vars', $config['server']['force_server_vars']);
$iohandler->set_input('server_name', $config['server']['server_name']);
$iohandler->set_input('server_port', $config['server']['server_port']);
$iohandler->set_input('script_path', $config['server']['script_path']);
$iohandler->set_input('submit_server', 'submit');
}
}

View file

@ -147,6 +147,11 @@ class config
*/ */
public function get_time_remaining() public function get_time_remaining()
{ {
if ($this->system_data['max_execution_time'] <= 0)
{
return 1;
}
return ($this->system_data['start_time'] + $this->system_data['max_execution_time']) - time(); return ($this->system_data['start_time'] + $this->system_data['max_execution_time']) - time();
} }
@ -157,6 +162,11 @@ class config
*/ */
public function get_memory_remaining() public function get_memory_remaining()
{ {
if ($this->system_data['memory_limit'] <= 0)
{
return 1;
}
if (function_exists('memory_get_usage')) if (function_exists('memory_get_usage'))
{ {
return ($this->system_data['memory_limit'] - memory_get_usage()); return ($this->system_data['memory_limit'] - memory_get_usage());

View file

@ -182,6 +182,7 @@ class ajax_iohandler extends iohandler_base
'errors' => $this->errors, 'errors' => $this->errors,
'warnings' => $this->warnings, 'warnings' => $this->warnings,
'logs' => $this->logs, 'logs' => $this->logs,
'success' => $this->success,
); );
if (!empty($this->form)) if (!empty($this->form))
@ -208,6 +209,7 @@ class ajax_iohandler extends iohandler_base
$this->errors = array(); $this->errors = array();
$this->warnings = array(); $this->warnings = array();
$this->logs = array(); $this->logs = array();
$this->success = array();
$this->nav_data = array(); $this->nav_data = array();
if ($this->request_client_refresh) if ($this->request_client_refresh)

View file

@ -0,0 +1,235 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\install\helper\iohandler;
use phpbb\install\exception\installer_exception;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\OutputStyle;
/**
* Input-Output handler for the CLI frontend
*/
class cli_iohandler extends iohandler_base
{
/**
* @var OutputInterface
*/
protected $output;
/**
* @var OutputStyle
*/
protected $io;
/**
* @var array
*/
protected $input_values = array();
/**
* @var ProgressBar
*/
protected $progress_bar;
/**
* Set the style and output used to display feedback;
*
* @param OutputStyle $style
*/
public function set_style(OutputStyle $style, OutputInterface $output)
{
$this->io = $style;
$this->output = $output;
}
/**
* {@inheritdoc}
*/
public function get_input($name, $default, $multibyte = false)
{
$result = $default;
if (isset($this->input_values[$name]))
{
$result = $this->input_values[$name];
}
if ($multibyte)
{
return utf8_normalize_nfc($result);
}
return $result;
}
public function set_input($name, $value)
{
$this->input_values[$name] = $value;
}
/**
* {@inheritdoc}
*/
public function get_server_variable($name, $default = '')
{
return $default;
}
/**
* {@inheritdoc}
*/
public function get_header_variable($name, $default = '')
{
return $default;
}
/**
* {@inheritdoc}
*/
public function is_secure()
{
return false;
}
/**
* {@inheritdoc}
*/
public function add_user_form_group($title, $form)
{
throw new installer_exception('MISSING_DATA');
}
/**
* {@inheritdoc}
*/
public function send_response()
{
}
/**
* {@inheritdoc
*/
public function add_error_message($error_title, $error_description = false)
{
$this->io->newLine();
$message = $this->translate_message($error_title, $error_description);
$this->io->error($message['title'] . "\n" . $message['description']);
if ($this->progress_bar !== null)
{
$this->io->newLine(2);
$this->progress_bar->display();
}
}
/**
* {@inheritdoc
*/
public function add_warning_message($warning_title, $warning_description = false)
{
$this->io->newLine();
$message = $this->translate_message($warning_title, $warning_description);
$this->io->warning($message['title'] . "\n" . $message['description']);
if ($this->progress_bar !== null)
{
$this->io->newLine(2);
$this->progress_bar->display();
}
}
/**
* {@inheritdoc
*/
public function add_log_message($log_title, $log_description = false)
{
if ($this->output->getVerbosity() > OutputInterface::VERBOSITY_NORMAL)
{
$this->output->writeln(sprintf('[%3d/%-3d] ---- %s', $this->current_task_progress, $this->task_progress_count, $this->translate_message($log_title, $log_description)['title']));
}
}
/**
* {@inheritdoc
*/
public function add_success_message($error_title, $error_description = false)
{
$this->io->newLine();
$message = $this->translate_message($error_title, $error_description);
$this->io->success($message['title'] . "\n" . $message['description']);
if ($this->progress_bar !== null)
{
$this->io->newLine(2);
$this->progress_bar->display();
}
}
public function set_task_count($task_count)
{
parent::set_task_count($task_count);
if ($this->output->getVerbosity() === OutputInterface::VERBOSITY_NORMAL)
{
$this->progress_bar = $this->io->createProgressBar($task_count);
$this->progress_bar->setFormat(
" %current:3s%/%max:-3s% %bar% %percent:3s%%\n" .
" %message%\n");
$this->progress_bar->setBarWidth(60);
if (!defined('PHP_WINDOWS_VERSION_BUILD')) {
$this->progress_bar->setEmptyBarCharacter('░'); // light shade character \u2591
$this->progress_bar->setProgressCharacter('');
$this->progress_bar->setBarCharacter('▓'); // dark shade character \u2593
}
$this->progress_bar->setMessage('');
$this->io->newLine(2);
$this->progress_bar->start();
}
}
public function set_progress($task_lang_key, $task_number)
{
parent::set_progress($task_lang_key, $task_number);
if ($this->progress_bar !== null)
{
$this->progress_bar->setProgress($this->current_task_progress);
$this->progress_bar->setMessage($this->current_task_name);
}
else
{
$this->output->writeln(sprintf('[%3d/%-3d] %s', $this->current_task_progress, $this->task_progress_count, $this->current_task_name));
}
}
/**
* {@inheritdoc}
*/
public function finish_progress($message_lang_key)
{
parent::finish_progress($message_lang_key);
if ($this->progress_bar !== null)
{
$this->progress_bar->finish();
$this->progress_bar = null;
}
}
}

View file

@ -59,7 +59,7 @@ class factory
*/ */
public function get() public function get()
{ {
switch ($this->environment) if ($this->container->has('installer.helper.iohandler_' . $this->environment))
{ {
case 'ajax': case 'ajax':
return $this->container->get('installer.helper.iohandler_ajax'); return $this->container->get('installer.helper.iohandler_ajax');
@ -68,9 +68,14 @@ class factory
// @todo replace this // @todo replace this
return $this->container->get('installer.helper.iohandler_ajax'); return $this->container->get('installer.helper.iohandler_ajax');
break; break;
case 'cli':
return $this->container->get('installer.helper.iohandler_cli');
break;
default: default:
throw new iohandler_not_implemented_exception(); throw new iohandler_not_implemented_exception();
break; break;
} }
throw new iohandler_not_implemented_exception();
} }
} }

View file

@ -43,6 +43,13 @@ abstract class iohandler_base implements iohandler_interface
*/ */
protected $logs; protected $logs;
/**
* Array of success messages
*
* @var array
*/
protected $success;
/** /**
* @var \phpbb\language\language * @var \phpbb\language\language
*/ */
@ -71,6 +78,7 @@ abstract class iohandler_base implements iohandler_interface
$this->errors = array(); $this->errors = array();
$this->warnings = array(); $this->warnings = array();
$this->logs = array(); $this->logs = array();
$this->success = array();
$this->task_progress_count = 0; $this->task_progress_count = 0;
$this->current_task_progress = 0; $this->current_task_progress = 0;
@ -111,6 +119,14 @@ abstract class iohandler_base implements iohandler_interface
$this->logs[] = $this->translate_message($log_title, $log_description); $this->logs[] = $this->translate_message($log_title, $log_description);
} }
/**
* {@inheritdoc}
*/
public function add_success_message($success_title, $success_description = false)
{
$this->success[] = $this->translate_message($success_title, $success_description);
}
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
@ -124,11 +140,27 @@ abstract class iohandler_base implements iohandler_interface
*/ */
public function set_progress($task_lang_key, $task_number) public function set_progress($task_lang_key, $task_number)
{ {
$this->current_task_name = '';
if (!empty($task_lang_key)) if (!empty($task_lang_key))
{ {
$this->current_task_name = $this->language->lang($task_lang_key); $this->current_task_name = $this->language->lang($task_lang_key);
}
$this->current_task_progress = $task_number; $this->current_task_progress = $task_number;
} }
/**
* {@inheritdoc}
*/
public function finish_progress($message_lang_key)
{
if (!empty($message_lang_key))
{
$this->current_task_name = $this->language->lang($message_lang_key);
}
$this->current_task_progress = $this->task_progress_count;
} }
/** /**

View file

@ -85,7 +85,7 @@ interface iohandler_interface
* *
* @param string|array $warning_title Title of the warning message * @param string|array $warning_title Title of the warning message
* @param string|bool|array $warning_description Description of the warning (and possibly guidelines to resolve it), * @param string|bool|array $warning_description Description of the warning (and possibly guidelines to resolve it),
* or false if the error description is not available * or false if the warning description is not available
*/ */
public function add_warning_message($warning_title, $warning_description = false); public function add_warning_message($warning_title, $warning_description = false);
@ -96,11 +96,25 @@ interface iohandler_interface
* resolved as printf($param[0], $param[1], ...). * resolved as printf($param[0], $param[1], ...).
* *
* @param string|array $log_title Title of the log message * @param string|array $log_title Title of the log message
* @param string|bool|array $log_description Description of the log (and possibly guidelines to resolve it), * @param string|bool|array $log_description Description of the log,
* or false if the error description is not available * or false if the log description is not available
*/ */
public function add_log_message($log_title, $log_description = false); public function add_log_message($log_title, $log_description = false);
/**
* Adds a success message to the rendering queue
*
* Note: When an array is passed into the parameters below, it will be
* resolved as printf($param[0], $param[1], ...).
*
* @param string|array $success_title Title of the success message
* @param string|bool|array $success_description Description of the success,
* or false if the success description is not available
*
* @return null
*/
public function add_success_message($success_title, $success_description = false);
/** /**
* Adds a requested data group to the rendering queue * Adds a requested data group to the rendering queue
* *
@ -142,4 +156,11 @@ interface iohandler_interface
* @param array $menu_path Array to the navigation elem * @param array $menu_path Array to the navigation elem
*/ */
public function set_finished_stage_menu($menu_path); public function set_finished_stage_menu($menu_path);
/**
* Finish the progress bar
*
* @param string $message_lang_key Language key for the message
*/
public function finish_progress($message_lang_key);
} }

View file

@ -0,0 +1,140 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\install;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
class installer_configuration implements ConfigurationInterface
{
/**
* Generates the configuration tree builder.
*
* @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
*/
public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder();
$rootNode = $treeBuilder->root('installer');
$rootNode
->children()
->arrayNode('admin')
->children()
->scalarNode('name')->defaultValue('admin')->cannotBeEmpty()->end()
->scalarNode('password')->defaultValue('adminadmin')->cannotBeEmpty()->end()
->scalarNode('email')->defaultValue('admin@example.org')->cannotBeEmpty()->end()
->end()
->end()
->arrayNode('board')
->children()
->scalarNode('lang')
->defaultValue('en')
->cannotBeEmpty()
->end()
->scalarNode('name')
->defaultValue('My Board')
->cannotBeEmpty()
->end()
->scalarNode('description')
->defaultValue('My amazing new phpBB board')
->cannotBeEmpty()
->end()
->end()
->end()
->arrayNode('database')
->children()
->scalarNode('dbms')
->defaultValue('sqlite3')
->cannotBeEmpty()
->isRequired()
->end()
->scalarNode('dbhost')
->defaultValue(null)
->end()
->scalarNode('dbport')
->defaultValue(null)
->end()
->scalarNode('dbuser')
->defaultValue(null)
->end()
->scalarNode('dbpasswd')
->defaultValue(null)
->end()
->scalarNode('dbname')
->defaultValue(null)
->end()
->scalarNode('table_prefix')
->defaultValue('phpbb_')
->cannotBeEmpty()
->isRequired()
->end()
->end()
->end()
->arrayNode('email')
->canBeEnabled()
->addDefaultsIfNotSet()
->children()
->booleanNode('smtp_delivery')
->defaultValue(false)
->treatNullLike(false)
->end()
->scalarNode('smtp_host')
->defaultValue(null)
->end()
->scalarNode('smtp_auth')
->defaultValue(null)
->end()
->scalarNode('smtp_user')
->defaultValue(null)
->end()
->scalarNode('smtp_pass')
->defaultValue(null)
->end()
->end()
->end()
->arrayNode('server')
->children()
->booleanNode('cookie_secure')
->defaultValue(false)
->treatNullLike(false)
->end()
->scalarNode('server_protocol')
->defaultValue('http://')
->cannotBeEmpty()
->end()
->booleanNode('force_server_vars')
->defaultValue(false)
->treatNullLike(false)
->end()
->scalarNode('server_name')
->defaultValue('localhost')
->cannotBeEmpty()
->end()
->integerNode('server_port')
->defaultValue(80)
->min(1)
->cannotBeEmpty()
->end()
->scalarNode('script_path')
->defaultValue('/')
->cannotBeEmpty()
->end()
->end()
->end()
->end()
;
return $treeBuilder;
}
}

View file

@ -238,7 +238,7 @@ class obtain_database_data extends \phpbb\install\task_base implements \phpbb\in
$connect_test = $this->database_helper->check_database_connection($dbms, $dbhost, $dbport, $dbuser, $dbpass, $dbname, $table_prefix); $connect_test = $this->database_helper->check_database_connection($dbms, $dbhost, $dbport, $dbuser, $dbpass, $dbname, $table_prefix);
if (is_array($connect_test)) if (is_array($connect_test))
{ {
foreach ($prefix_valid as $error) foreach ($connect_test as $error)
{ {
$this->io_handler->add_error_message( $this->io_handler->add_error_message(
$error['title'], $error['title'],

View file

@ -14,6 +14,7 @@
namespace phpbb\install\module\requirements; namespace phpbb\install\module\requirements;
use phpbb\install\exception\user_interaction_required_exception; use phpbb\install\exception\user_interaction_required_exception;
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
class module extends \phpbb\install\module_base class module extends \phpbb\install\module_base
{ {