Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(install): Make installing more verbose #41214

Merged
merged 1 commit into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion core/Command/Maintenance/Install.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@

use bantu\IniGetWrapper\IniGetWrapper;
use InvalidArgumentException;
use OC\Console\TimestampFormatter;
use OC\Installer;
use OC\Migration\ConsoleOutput;
use OC\Setup;
use OC\SystemConfig;
use OCP\Defaults;
Expand Down Expand Up @@ -98,8 +100,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int
// validate user input
$options = $this->validateInput($input, $output, array_keys($sysInfo['databases']));

if ($output->isVerbose()) {
// Prepend each line with a little timestamp
$timestampFormatter = new TimestampFormatter(null, $output->getFormatter());
$output->setFormatter($timestampFormatter);
$migrationOutput = new ConsoleOutput($output);
} else {
$migrationOutput = null;
}

// perform installation
$errors = $setupHelper->install($options);
$errors = $setupHelper->install($options, $migrationOutput);
if (count($errors) > 0) {
$this->printErrors($output, $errors);
return 1;
Expand Down
19 changes: 12 additions & 7 deletions lib/private/Console/TimestampFormatter.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@
use Symfony\Component\Console\Formatter\OutputFormatterStyleInterface;

class TimestampFormatter implements OutputFormatterInterface {
/** @var IConfig */
/** @var ?IConfig */
protected $config;

/** @var OutputFormatterInterface */
protected $formatter;

/**
* @param IConfig $config
* @param ?IConfig $config
* @param OutputFormatterInterface $formatter
*/
public function __construct(IConfig $config, OutputFormatterInterface $formatter) {
public function __construct(?IConfig $config, OutputFormatterInterface $formatter) {
$this->config = $config;
$this->formatter = $formatter;
}
Expand Down Expand Up @@ -104,11 +104,16 @@ public function format(?string $message): ?string {
return $this->formatter->format($message);
}

$timeZone = $this->config->getSystemValue('logtimezone', 'UTC');
$timeZone = $timeZone !== null ? new \DateTimeZone($timeZone) : null;
if ($this->config instanceof IConfig) {
$timeZone = $this->config->getSystemValue('logtimezone', 'UTC');
$timeZone = $timeZone !== null ? new \DateTimeZone($timeZone) : null;

$time = new \DateTime('now', $timeZone);
$timestampInfo = $time->format($this->config->getSystemValue('logdateformat', \DateTimeInterface::ATOM));
$time = new \DateTime('now', $timeZone);
$timestampInfo = $time->format($this->config->getSystemValue('logdateformat', \DateTimeInterface::ATOM));
} else {
$time = new \DateTime('now');
$timestampInfo = $time->format(\DateTimeInterface::ATOM);
}

return $timestampInfo . ' ' . $this->formatter->format($message);
}
Expand Down
6 changes: 6 additions & 0 deletions lib/private/DB/MigrationService.php
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@ public function setOutput(IOutput $output): void {
*/
public function migrate(string $to = 'latest', bool $schemaOnly = false): void {
if ($schemaOnly) {
$this->output->debug('Migrating schema only');
$this->migrateSchemaOnly($to);
return;
}
Expand Down Expand Up @@ -421,6 +422,7 @@ public function migrateSchemaOnly(string $to = 'latest'): void {

$toSchema = null;
foreach ($toBeExecuted as $version) {
$this->output->debug('- Reading ' . $version);
$instance = $this->createInstance($version);

$toSchema = $instance->changeSchema($this->output, function () use ($toSchema): ISchemaWrapper {
Expand All @@ -429,16 +431,20 @@ public function migrateSchemaOnly(string $to = 'latest'): void {
}

if ($toSchema instanceof SchemaWrapper) {
$this->output->debug('- Checking target database schema');
$targetSchema = $toSchema->getWrappedSchema();
$this->ensureUniqueNamesConstraints($targetSchema);
if ($this->checkOracle) {
$beforeSchema = $this->connection->createSchema();
$this->ensureOracleConstraints($beforeSchema, $targetSchema, strlen($this->connection->getPrefix()));
}

$this->output->debug('- Migrate database schema');
$this->connection->migrateToSchema($targetSchema);
$toSchema->performDropTableCalls();
}

$this->output->debug('- Mark migrations as executed');
foreach ($toBeExecuted as $version) {
$this->markAsExecuted($version);
}
Expand Down
23 changes: 18 additions & 5 deletions lib/private/Installer.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
use OCP\Http\Client\IClientService;
use OCP\IConfig;
use OCP\ITempManager;
use OCP\Migration\IOutput;
use phpseclib\File\X509;
use Psr\Log\LoggerInterface;

Expand Down Expand Up @@ -536,7 +537,10 @@ public function installAppBundle(Bundle $bundle) {
* working ownCloud at the end instead of an aborted update.
* @return array Array of error messages (appid => Exception)
*/
public static function installShippedApps($softErrors = false) {
public static function installShippedApps($softErrors = false, ?IOutput $output = null) {
if ($output instanceof IOutput) {
$output->debug('Installing shipped apps');
}
$appManager = \OC::$server->getAppManager();
$config = \OC::$server->getConfig();
$errors = [];
Expand All @@ -551,7 +555,7 @@ public static function installShippedApps($softErrors = false) {
&& $config->getAppValue($filename, 'enabled') !== 'no') {
if ($softErrors) {
try {
Installer::installShippedApp($filename);
Installer::installShippedApp($filename, $output);
} catch (HintException $e) {
if ($e->getPrevious() instanceof TableExistsException) {
$errors[$filename] = $e;
Expand All @@ -560,7 +564,7 @@ public static function installShippedApps($softErrors = false) {
throw $e;
}
} else {
Installer::installShippedApp($filename);
Installer::installShippedApp($filename, $output);
}
$config->setAppValue($filename, 'enabled', 'yes');
}
Expand All @@ -578,16 +582,22 @@ public static function installShippedApps($softErrors = false) {
/**
* install an app already placed in the app folder
* @param string $app id of the app to install
* @return integer
* @return string
*/
public static function installShippedApp($app) {
public static function installShippedApp($app, ?IOutput $output = null) {
if ($output instanceof IOutput) {
$output->debug('Installing ' . $app);
}
//install the database
$appPath = OC_App::getAppPath($app);
\OC_App::registerAutoloading($app, $appPath);

$config = \OC::$server->getConfig();

$ms = new MigrationService($app, \OC::$server->get(Connection::class));
if ($output instanceof IOutput) {
$ms->setOutput($output);
}
$previousVersion = $config->getAppValue($app, 'installed_version', false);
$ms->migrate('latest', !$previousVersion);

Expand All @@ -598,6 +608,9 @@ public static function installShippedApp($app) {
if (is_null($info)) {
return false;
}
if ($output instanceof IOutput) {
$output->debug('Registering tasks of ' . $app);
}
\OC_App::setupBackgroundJobs($info['background-jobs']);

OC_App::executeRepairSteps($app, $info['repair-steps']['install']);
Expand Down
4 changes: 4 additions & 0 deletions lib/private/Migration/ConsoleOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ public function __construct(OutputInterface $output) {
$this->output = $output;
}

public function debug(string $message): void {
$this->output->writeln($message, OutputInterface::VERBOSITY_VERBOSE);
}

/**
* @param string $message
*/
Expand Down
4 changes: 4 additions & 0 deletions lib/private/Migration/SimpleOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ public function __construct(LoggerInterface $logger, $appName) {
$this->appName = $appName;
}

public function debug(string $message): void {
$this->logger->debug($message, ['app' => $this->appName]);
}

/**
* @param string $message
* @since 9.1.0
Expand Down
3 changes: 3 additions & 0 deletions lib/private/Repair.php
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,9 @@ public static function getBeforeUpgradeRepairSteps() {
return $steps;
}

public function debug(string $message): void {
}

/**
* @param string $message
*/
Expand Down
20 changes: 17 additions & 3 deletions lib/private/Setup.php
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
use OCP\Defaults;
use OCP\IGroup;
use OCP\IL10N;
use OCP\Migration\IOutput;
use OCP\Security\ISecureRandom;
use Psr\Log\LoggerInterface;

Expand Down Expand Up @@ -275,7 +276,7 @@ public function getSystemInfo($allowAllDatabases = false) {
* @param $options
* @return array
*/
public function install($options) {
public function install($options, ?IOutput $output = null) {
$l = $this->l10n;

$error = [];
Expand Down Expand Up @@ -349,6 +350,7 @@ public function install($options) {

$this->config->setValues($newConfigValues);

$this->outputDebug($output, 'Configuring database');
$dbSetup->initialize($options);
try {
$dbSetup->setupDatabase($username);
Expand All @@ -367,9 +369,11 @@ public function install($options) {
];
return $error;
}

$this->outputDebug($output, 'Run server migrations');
try {
// apply necessary migrations
$dbSetup->runMigrations();
$dbSetup->runMigrations($output);
} catch (Exception $e) {
$error[] = [
'error' => 'Error while trying to initialise the database: ' . $e->getMessage(),
Expand All @@ -379,6 +383,7 @@ public function install($options) {
return $error;
}

$this->outputDebug($output, 'Create admin user');
//create the user and group
$user = null;
try {
Expand Down Expand Up @@ -407,16 +412,19 @@ public function install($options) {
}

// Install shipped apps and specified app bundles
Installer::installShippedApps();
$this->outputDebug($output, 'Install default apps');
Installer::installShippedApps(false, $output);

// create empty file in data dir, so we can later find
// out that this is indeed an ownCloud data directory
$this->outputDebug($output, 'Setup data directory');
file_put_contents($config->getSystemValueString('datadirectory', \OC::$SERVERROOT . '/data') . '/.ocdata', '');

// Update .htaccess files
self::updateHtaccess();
self::protectDataDirectory();

$this->outputDebug($output, 'Install background jobs');
self::installBackgroundJobs();

//and we are done
Expand Down Expand Up @@ -616,4 +624,10 @@ public function shouldRemoveCanInstallFile() {
public function canInstallFileExists() {
return is_file(\OC::$configDir.'/CAN_INSTALL');
}

protected function outputDebug(?IOutput $output, string $message): void {
if ($output instanceof IOutput) {
$output->debug($message);
}
}
}
5 changes: 3 additions & 2 deletions lib/private/Setup/AbstractDatabase.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
use OC\DB\MigrationService;
use OC\SystemConfig;
use OCP\IL10N;
use OCP\Migration\IOutput;
use OCP\Security\ISecureRandom;
use Psr\Log\LoggerInterface;

Expand Down Expand Up @@ -150,11 +151,11 @@ protected function connect(array $configOverwrite = []): Connection {
*/
abstract public function setupDatabase($username);

public function runMigrations() {
public function runMigrations(?IOutput $output = null) {
if (!is_dir(\OC::$SERVERROOT."/core/Migrations")) {
return;
}
$ms = new MigrationService('core', \OC::$server->get(Connection::class));
$ms = new MigrationService('core', \OC::$server->get(Connection::class), $output);
$ms->migrate('latest', true);
}
}
7 changes: 7 additions & 0 deletions lib/public/Migration/IOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@
* @since 9.1.0
*/
interface IOutput {
/**
* @param string $message
* @return void
* @since 28.0.0
*/
public function debug(string $message): void;

/**
* @param string $message
* @return void
Expand Down
Loading