Files
Git'Fellow 4920bd1725 refactor: add PHP 8.3 types to BC-safe class constants
PHP 8.3 allows class constants to declare a type. Adopt it where doing so
cannot break third-party apps.

Typing an inheritable constant is a hard BC break: a subclass that
redeclares it untyped fails to load with "Type of C::FOO must be
compatible with P::FOO of type string". Changes are therefore limited to
constants that cannot be redeclared by a subclass:

  - private const (not inherited)
  - final public/protected const
  - constants declared in a final class or an enum

Interface constants, trait constants, and public/protected constants in
non-final (including abstract) classes are left untyped, as is all of
lib/public (OCP) and lib/unstable (NCU).

One review-requested exception: the public OBJECT_PREFIX/OBJECT_SUFFIX
constants of the app-internal CalDAV import helpers (TextImporter,
XmlImporter) are typed as well; these classes are not public API and
have no subclasses.

Only string, int and array are used. float is avoided because it would
silently coerce an int literal and change === comparisons. No constant
name or value is modified: every changed line adds only the type token,
so runtime behaviour is unchanged.

Signed-off-by: Git'Fellow <12234510+solracsf@users.noreply.github.com>
2026-08-11 13:52:52 +01:00

234 lines
6.4 KiB
PHP

<?php
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2017 ownCloud GmbH
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Core\Command\Db\Migrations;
use OC\DB\Connection;
use OC\DB\MigrationService;
use OC\Migration\ConsoleOutput;
use OCP\App\IAppManager;
use OCP\Util;
use Stecman\Component\Symfony\Console\BashCompletion\Completion\CompletionAwareInterface;
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Exception\RuntimeException;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
class GenerateCommand extends Command implements CompletionAwareInterface {
private const string TEMPLATE
= '<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: {{year}} Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace {{namespace}};
use Closure;
use OCP\DB\ISchemaWrapper;
use OCP\Migration\IOutput;
use OCP\Migration\SimpleMigrationStep;
use Override;
/**
* FIXME Auto-generated migration step: Please modify to your needs!
*/
class {{classname}} extends SimpleMigrationStep {
/**
* @param IOutput $output
* @param Closure(): ISchemaWrapper $schemaClosure
* @param array $options
*/
#[Override]
public function preSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
}
/**
* @param IOutput $output
* @param Closure(): ISchemaWrapper $schemaClosure
* @param array $options
* @return null|ISchemaWrapper
*/
#[Override]
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
{{schemabody}}
}
/**
* @param IOutput $output
* @param Closure(): ISchemaWrapper $schemaClosure
* @param array $options
*/
#[Override]
public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
}
}
';
public function __construct(
protected Connection $connection,
protected IAppManager $appManager,
) {
parent::__construct();
}
#[\Override]
protected function configure() {
$this
->setName('migrations:generate')
->addArgument('app', InputArgument::REQUIRED, 'Name of the app this migration command shall work on')
->addArgument('version', InputArgument::REQUIRED, 'Major version of this app, to allow versions on parallel development branches')
;
parent::configure();
}
#[\Override]
public function execute(InputInterface $input, OutputInterface $output): int {
$appName = $input->getArgument('app');
$version = $input->getArgument('version');
if (!preg_match('/^\d{1,16}$/', $version)) {
$output->writeln('<error>The given version is invalid. Only 0-9 are allowed (max. 16 digits)</error>');
return 1;
}
if ($appName === 'core') {
$fullVersion = implode('.', Util::getVersion());
} else {
try {
$fullVersion = $this->appManager->getAppVersion($appName, false);
} catch (\Throwable $e) {
$fullVersion = '';
}
}
if ($fullVersion) {
[$major, $minor] = explode('.', $fullVersion);
$shouldVersion = (string)((int)$major * 1000 + (int)$minor);
if ($version !== $shouldVersion) {
$output->writeln('<comment>Unexpected migration version for current version: ' . $fullVersion . '</comment>');
$output->writeln('<comment> - Pattern: XYYY </comment>');
$output->writeln('<comment> - Expected: ' . $shouldVersion . '</comment>');
$output->writeln('<comment> - Actual: ' . $version . '</comment>');
if ($input->isInteractive()) {
/** @var QuestionHelper $helper */
$helper = $this->getHelper('question');
$question = new ConfirmationQuestion('Continue with your given version? (y/n) [n] ', false);
if (!$helper->ask($input, $output, $question)) {
return 1;
}
}
}
}
$ms = new MigrationService($appName, $this->connection, new ConsoleOutput($output));
$date = date('YmdHis');
$path = $this->generateMigration($ms, 'Version' . $version . 'Date' . $date);
$output->writeln("New migration class has been generated to <info>$path</info>");
return 0;
}
/**
* @param string $optionName
* @param CompletionContext $context
* @return string[]
*/
#[\Override]
public function completeOptionValues($optionName, CompletionContext $context) {
return [];
}
/**
* @param string $argumentName
* @param CompletionContext $context
* @return string[]
*/
#[\Override]
public function completeArgumentValues($argumentName, CompletionContext $context) {
if ($argumentName === 'app') {
$allApps = $this->appManager->getAllAppsInAppsFolders();
$enabledApps = $this->appManager->getEnabledApps();
return array_diff($allApps, $enabledApps);
}
if ($argumentName === 'version') {
$appName = $context->getWordAtIndex($context->getWordIndex() - 1);
$version = explode('.', $this->appManager->getAppVersion($appName));
return [$version[0] . sprintf('%1$03d', $version[1])];
}
return [];
}
/**
* @param MigrationService $ms
* @param string $className
* @param string $schemaBody
* @return string
*/
protected function generateMigration(MigrationService $ms, $className, $schemaBody = '') {
if ($schemaBody === '') {
$schemaBody = "\t\t" . 'return null;';
}
$placeHolders = [
'{{namespace}}',
'{{classname}}',
'{{schemabody}}',
'{{year}}',
];
$replacements = [
$ms->getMigrationsNamespace(),
$className,
$schemaBody,
date('Y')
];
$code = str_replace($placeHolders, $replacements, self::TEMPLATE);
$dir = $ms->getMigrationsDirectory();
$this->ensureMigrationDirExists($dir);
$path = $dir . '/' . $className . '.php';
if (file_put_contents($path, $code) === false) {
throw new RuntimeException('Failed to generate new migration step. Could not write to ' . $path);
}
return $path;
}
protected function ensureMigrationDirExists($directory) {
if (file_exists($directory) && is_dir($directory)) {
return;
}
if (file_exists($directory)) {
throw new \RuntimeException("Could not create folder \"$directory\"");
}
$this->ensureMigrationDirExists(dirname($directory));
if (!@mkdir($directory) && !is_dir($directory)) {
throw new \RuntimeException("Could not create folder \"$directory\"");
}
}
}