Database build completed!']);
+
+ foreach ($dataClasses as $dataClass) {
+ DataObject::singleton($dataClass)->onAfterBuild();
+ }
+
+ ClassInfo::reset_db_cache();
+
+ $this->extend('onAfterBuild', $output, $populate, $testMode);
+ }
+
+ public function getOptions(): array
+ {
+ return [
+ new InputOption(
+ 'no-populate',
+ null,
+ InputOption::VALUE_NONE,
+ 'Don\'t run `requireDefaultRecords()` on the models when building.'
+ . 'This will build the table but not insert any records'
+ ),
+ ];
+ }
+
+ public function providePermissions(): array
+ {
+ return [
+ 'CAN_DEV_BUILD' => [
+ 'name' => _t(__CLASS__ . '.CAN_DEV_BUILD_DESCRIPTION', 'Can execute /dev/build'),
+ 'help' => _t(__CLASS__ . '.CAN_DEV_BUILD_HELP', 'Can execute the build command (/dev/build).'),
+ 'category' => DevelopmentAdmin::permissionsCategory(),
+ 'sort' => 100
+ ],
+ ];
+ }
+
+ /**
+ * Given a base data class, a field name and a mapping of class replacements, look for obsolete
+ * values in the $dataClass's $fieldName column and replace it with $mapping
+ *
+ * @param string $dataClass The data class to look up
+ * @param string $fieldName The field name to look in for obsolete class names
+ * @param string[] $mapping Map of old to new classnames
+ */
+ protected function updateLegacyClassNameField(string $dataClass, string $fieldName, array $mapping): void
+ {
+ $schema = DataObject::getSchema();
+ // Check first to ensure that the class has the specified field to update
+ if (!$schema->databaseField($dataClass, $fieldName, false)) {
+ return;
+ }
+
+ // Load a list of any records that have obsolete class names
+ $table = $schema->tableName($dataClass);
+ $currentClassNameList = DB::query("SELECT DISTINCT(\"{$fieldName}\") FROM \"{$table}\"")->column();
+
+ // Get all invalid classes for this field
+ $invalidClasses = array_intersect($currentClassNameList ?? [], array_keys($mapping ?? []));
+ if (!$invalidClasses) {
+ return;
+ }
+
+ $numberClasses = count($invalidClasses ?? []);
+ DB::alteration_message(
+ "Correcting obsolete {$fieldName} values for {$numberClasses} outdated types",
+ 'obsolete'
+ );
+
+ // Build case assignment based on all intersected legacy classnames
+ $cases = [];
+ $params = [];
+ foreach ($invalidClasses as $invalidClass) {
+ $cases[] = "WHEN \"{$fieldName}\" = ? THEN ?";
+ $params[] = $invalidClass;
+ $params[] = $mapping[$invalidClass];
+ }
+
+ foreach ($this->getClassTables($dataClass) as $table) {
+ $casesSQL = implode(' ', $cases);
+ $sql = "UPDATE \"{$table}\" SET \"{$fieldName}\" = CASE {$casesSQL} ELSE \"{$fieldName}\" END";
+ DB::prepared_query($sql, $params);
+ }
+ }
+
+ /**
+ * Get tables to update for this class
+ */
+ protected function getClassTables(string $dataClass): iterable
+ {
+ $schema = DataObject::getSchema();
+ $table = $schema->tableName($dataClass);
+
+ // Base table
+ yield $table;
+
+ // Remap versioned table class name values as well
+ /** @var Versioned|DataObject $dataClass */
+ $dataClass = DataObject::singleton($dataClass);
+ if ($dataClass->hasExtension(Versioned::class)) {
+ if ($dataClass->hasStages()) {
+ yield "{$table}_Live";
+ }
+ yield "{$table}_Versions";
+ }
+ }
+
+ /**
+ * Find all DBClassName fields on valid subclasses of DataObject that should be remapped. This includes
+ * `ClassName` fields as well as polymorphic class name fields.
+ *
+ * @return array[]
+ */
+ protected function getClassNameRemappingFields(): array
+ {
+ $dataClasses = ClassInfo::getValidSubClasses(DataObject::class);
+ $schema = DataObject::getSchema();
+ $remapping = [];
+
+ foreach ($dataClasses as $className) {
+ $fieldSpecs = $schema->fieldSpecs($className);
+ foreach ($fieldSpecs as $fieldName => $fieldSpec) {
+ if (Injector::inst()->create($fieldSpec, 'Dummy') instanceof DBClassName) {
+ $remapping[$className][] = $fieldName;
+ }
+ }
+ }
+
+ return $remapping;
+ }
+
+ /**
+ * Migrate all class names
+ */
+ protected function migrateClassNames(): void
+ {
+ $remappingConfig = static::config()->get('classname_value_remapping');
+ $remappingFields = $this->getClassNameRemappingFields();
+ foreach ($remappingFields as $className => $fieldNames) {
+ foreach ($fieldNames as $fieldName) {
+ $this->updateLegacyClassNameField($className, $fieldName, $remappingConfig);
+ }
+ }
+ }
+
+ /**
+ * Returns the timestamp of the time that the database was last built
+ * or an empty string if we can't find that information.
+ */
+ public static function lastBuilt(): string
+ {
+ $file = static::getLastGeneratedFilePath();
+ if (file_exists($file)) {
+ return filemtime($file);
+ }
+ return '';
+ }
+
+ /**
+ * Check whether this command can be run in CLI via sake
+ */
+ public static function canRunInCli(): bool
+ {
+ return parent::canRunInCli() || !Security::database_is_ready();
+ }
+
+ /**
+ * Check whether this command can be run in the browser via a web request
+ */
+ public static function canRunInBrowser(): bool
+ {
+ return parent::canRunInBrowser() || !Security::database_is_ready();
+ }
+
+ private static function getLastGeneratedFilePath(): string
+ {
+ return TEMP_PATH
+ . DIRECTORY_SEPARATOR
+ . 'database-last-generated-'
+ . str_replace(['\\', '/', ':'], '.', Director::baseFolder());
+ }
+}
diff --git a/src/Dev/HybridExecution/Command/DevBuildCleanup.php b/src/Dev/HybridExecution/Command/DevBuildCleanup.php
new file mode 100644
index 00000000000..390f638b08e
--- /dev/null
+++ b/src/Dev/HybridExecution/Command/DevBuildCleanup.php
@@ -0,0 +1,79 @@
+baseDataTable($baseClass);
+ $subclasses = ClassInfo::subclassesFor($baseClass);
+ unset($subclasses[0]);
+ foreach ($subclasses as $k => $subclass) {
+ if (!DataObject::getSchema()->classHasTable($subclass)) {
+ unset($subclasses[$k]);
+ }
+ }
+
+ if ($subclasses) {
+ $records = DB::query("SELECT * FROM \"$baseTable\"");
+
+
+ foreach ($subclasses as $subclass) {
+ $subclassTable = $schema->tableName($subclass);
+ $recordExists[$subclass] =
+ DB::query("SELECT \"ID\" FROM \"$subclassTable\"")->keyedColumn();
+ }
+
+ foreach ($records as $record) {
+ foreach ($subclasses as $subclass) {
+ $subclassTable = $schema->tableName($subclass);
+ $id = $record['ID'];
+ if (($record['ClassName'] != $subclass)
+ && (!is_subclass_of($record['ClassName'], $subclass ?? ''))
+ && isset($recordExists[$subclass][$id])
+ ) {
+ $sql = "DELETE FROM \"$subclassTable\" WHERE \"ID\" = ?";
+ echo "$sql [{$id}]";
+ DB::prepared_query($sql, [$id]);
+ }
+ }
+ }
+ }
+ }
+ return Command::SUCCESS;
+ }
+}
diff --git a/src/Dev/HybridExecution/Command/DevBuildDefaults.php b/src/Dev/HybridExecution/Command/DevBuildDefaults.php
new file mode 100644
index 00000000000..2d6f9e5e2a7
--- /dev/null
+++ b/src/Dev/HybridExecution/Command/DevBuildDefaults.php
@@ -0,0 +1,68 @@
+renderHeader();
+ echo $renderer->renderInfo("Defaults Builder", Director::absoluteBaseURL());
+ echo "";
+ }
+
+ $dataClasses = ClassInfo::subclassesFor(DataObject::class);
+ array_shift($dataClasses);
+
+ if (!Director::is_cli()) {
+ echo "
";
+ }
+
+ foreach ($dataClasses as $dataClass) {
+ singleton($dataClass)->requireDefaultRecords();
+ if (Director::is_cli()) {
+ echo "Defaults loaded for $dataClass\n";
+ } else {
+ echo "- Defaults loaded for $dataClass
\n";
+ }
+ }
+
+ if (!Director::is_cli()) {
+ echo "
";
+ }
+
+ if (!Director::is_cli()) {
+ echo "
',
+ options: HybridOutput::OUTPUT_RAW
+ );
+
+ $output->write(Yaml::dump(Config::inst()->getAll(), 99, 2, Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE));
+
+ $output->writeForContext(
+ HybridOutput::CONTEXT_HTTP,
+ '
',
+ options: HybridOutput::OUTPUT_RAW
+ );
+ return Command::SUCCESS;
+ }
+
+ public function providePermissions(): array
+ {
+ return [
+ 'CAN_DEV_CONFIG' => [
+ 'name' => _t(__CLASS__ . '.CAN_DEV_CONFIG_DESCRIPTION', 'Can view /dev/config'),
+ 'help' => _t(__CLASS__ . '.CAN_DEV_CONFIG_HELP', 'Can view all application configuration (/dev/config).'),
+ 'category' => DevelopmentAdmin::permissionsCategory(),
+ 'sort' => 100
+ ],
+ ];
+ }
+}
diff --git a/src/Dev/HybridExecution/Command/DevConfigAudit.php b/src/Dev/HybridExecution/Command/DevConfigAudit.php
new file mode 100644
index 00000000000..c6e3a471d15
--- /dev/null
+++ b/src/Dev/HybridExecution/Command/DevConfigAudit.php
@@ -0,0 +1,90 @@
+getAll(), 2) as $className => $props) {
+ $props = array_keys($props ?? []);
+
+ if (!count($props ?? [])) {
+ // We can skip this entry
+ continue;
+ }
+
+ if ($className == strtolower(Injector::class)) {
+ // We don't want to check the injector config
+ continue;
+ }
+
+ foreach ($props as $prop) {
+ $defined = false;
+ // Check ancestry (private properties don't inherit natively)
+ foreach (ClassInfo::ancestry($className) as $cn) {
+ if (property_exists($cn, $prop ?? '')) {
+ $defined = true;
+ break;
+ }
+ }
+
+ if ($defined) {
+ // No need to record this property
+ continue;
+ }
+
+ $missing[] = sprintf("%s::$%s\n", $className, $prop);
+ }
+ }
+
+ $body = count($missing ?? [])
+ ? implode("\n", $missing)
+ : "All configured properties are defined\n";
+
+ $output->writeForContext(
+ HybridOutput::CONTEXT_HTTP,
+ '',
+ options: HybridOutput::OUTPUT_RAW
+ );
+ $output->write($body);
+ $output->writeForContext(
+ HybridOutput::CONTEXT_HTTP,
+ '
',
+ options: HybridOutput::OUTPUT_RAW
+ );
+
+ return Command::SUCCESS;
+ }
+}
diff --git a/src/Dev/HybridExecution/Command/HybridCommand.php b/src/Dev/HybridExecution/Command/HybridCommand.php
new file mode 100644
index 00000000000..6fbf641b756
--- /dev/null
+++ b/src/Dev/HybridExecution/Command/HybridCommand.php
@@ -0,0 +1,145 @@
+
+ */
+ public function getOptions(): array
+ {
+ return [];
+ }
+
+ /**
+ * Check whether this command can be run in CLI via sake
+ */
+ public static function canRunInCli(): bool
+ {
+ static::checkPrerequisites();
+ return Director::isDev()
+ || static::config()->get('can_run_in_cli')
+ || DevelopmentAdmin::config()->get('allow_all_cli');
+ }
+
+ /**
+ * Check whether this command can be run in the browser via a web request
+ */
+ public static function canRunInBrowser(): bool
+ {
+ static::checkPrerequisites();
+ // Can always run in browser in dev mode
+ if (Director::isDev()) {
+ return true;
+ }
+ // If allowed to be run in browser, check user has correct permissions
+ return static::config()->get('can_run_in_browser')
+ && Permission::check(static::config()->get('permissions_for_browser_execution'));
+ }
+
+ private static function checkPrerequisites(): void
+ {
+ $mandatoryConfig = [
+ 'permissions_for_browser_execution',
+ ];
+ foreach ($mandatoryConfig as $config) {
+ if (!static::config()->get($config)) {
+ throw new RuntimeException($config . ' configuration property needs to be set.');
+ }
+ }
+ $mandatoryProperties = [
+ 'commandName',
+ 'description',
+ ];
+ foreach ($mandatoryProperties as $property) {
+ if (!static::$$property) {
+ throw new RuntimeException($property . ' property needs to be set.');
+ }
+ }
+ }
+}
diff --git a/src/Dev/HybridExecution/HtmlOutputFormatter.php b/src/Dev/HybridExecution/HtmlOutputFormatter.php
new file mode 100644
index 00000000000..07eb277313f
--- /dev/null
+++ b/src/Dev/HybridExecution/HtmlOutputFormatter.php
@@ -0,0 +1,58 @@
+ansiFormatter = $formatter;
+ $this->ansiConverter = AnsiToHtmlConverter::create();
+ }
+
+ public function setDecorated(bool $decorated): void
+ {
+ $this->ansiFormatter->setDecorated($decorated);
+ }
+
+ public function isDecorated(): bool
+ {
+ return $this->ansiFormatter->isDecorated();
+ }
+
+ public function setStyle(string $name, OutputFormatterStyleInterface $style): void
+ {
+ $this->ansiFormatter->setStyle($name, $style);
+ }
+
+ public function hasStyle(string $name): bool
+ {
+ return $this->ansiFormatter->hasStyle($name);
+ }
+
+ public function getStyle(string $name): OutputFormatterStyleInterface
+ {
+ return $this->ansiFormatter->getStyle($name);
+ }
+
+ public function format(?string $message): ?string
+ {
+ $formatted = $this->ansiFormatter->format($message);
+ if ($this->isDecorated()) {
+ return $this->ansiConverter->convert($formatted);
+ }
+ return $formatted;
+ }
+}
diff --git a/src/Dev/HybridExecution/HttpRequestInput.php b/src/Dev/HybridExecution/HttpRequestInput.php
new file mode 100644
index 00000000000..eb0990949e3
--- /dev/null
+++ b/src/Dev/HybridExecution/HttpRequestInput.php
@@ -0,0 +1,94 @@
+ $commandOptions Any options that apply for the command itself.
+ * Do not include global options (e.g. flush) - they are added explicitly in the constructor.
+ */
+ public function __construct(HTTPRequest $request, array $commandOptions = [])
+ {
+ $definition = new InputDefinition([
+ // Also add global options that are applicable for HTTP requests
+ new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Do not output any message'),
+ new InputOption('--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug'),
+ new InputOption('--flush', '-f', InputOption::VALUE_NONE, 'Flush the cache before running the command'),
+ ...$commandOptions
+ ]);
+ $optionValues = $this->getOptionValuesFromRequest($request, $definition);
+ parent::__construct($optionValues, $definition);
+ }
+
+ /**
+ * Get the verbosity that should be used based on the request vars.
+ * This is used to set the verbosity for HybridOutput.
+ */
+ public function getVerbosity(): int
+ {
+ if ($this->getOption('quiet')) {
+ return OutputInterface::VERBOSITY_QUIET;
+ }
+ $verbose = $this->getOption('verbose');
+ if ($verbose === '1') {
+ return OutputInterface::VERBOSITY_VERBOSE;
+ }
+ if ($verbose === '2') {
+ return OutputInterface::VERBOSITY_VERY_VERBOSE;
+ }
+ if ($verbose === '3') {
+ return OutputInterface::VERBOSITY_DEBUG;
+ }
+ return OutputInterface::VERBOSITY_NORMAL;
+ }
+
+ private function getOptionValuesFromRequest(HTTPRequest $request, InputDefinition $definition): array
+ {
+ $options = [];
+ foreach ($definition->getOptions() as $option) {
+ // We'll check for the long name and all shortcuts.
+ // Note the `--` and `-` prefixes are already stripped at this point.
+ $candidateParams = [$option->getName()];
+ $shortcutString = $option->getShortcut();
+ if ($shortcutString !== null) {
+ $shortcuts = explode('|', $shortcutString);
+ foreach ($shortcuts as $shortcut) {
+ $candidateParams[] = $shortcut;
+ }
+ }
+ // Get a value if there is one
+ $value = null;
+ foreach ($candidateParams as $candidateParam) {
+ $value = $request->requestVar($candidateParam);
+ if ($value !== null) {
+ // Verbosity shortcuts are handled differently to everything else
+ $value = match ($candidateParam) {
+ 'v' => '1',
+ 'vv' => '2',
+ 'vvv' => '3',
+ default => $value
+ };
+ break;
+ }
+ }
+ // We need to prefix with `--` so the superclass knows it's an
+ // option rather than an argument.
+ if ($value !== null || $option->acceptValue()) {
+ $options['--' . $option->getName()] = $value;
+ }
+ }
+ return $options;
+ }
+}
diff --git a/src/Dev/HybridExecution/HybridOutput.php b/src/Dev/HybridExecution/HybridOutput.php
new file mode 100644
index 00000000000..1c051739ff2
--- /dev/null
+++ b/src/Dev/HybridExecution/HybridOutput.php
@@ -0,0 +1,220 @@
+context = $context;
+ switch ($context) {
+ case HybridOutput::CONTEXT_CLI:
+ $this->consoleOutput = $consoleOutput ?? Injector::inst()->create(ConsoleOutput::class);
+ // Give console output a debug verbosity - that way it'll output everything we tell it to.
+ // Actual verbosity is handled by HybridOutput's parent Output class.
+ $this->consoleOutput->setVerbosity(Output::VERBOSITY_DEBUG);
+ $this->setFormatter(new OutputFormatter());
+ break;
+ case HybridOutput::CONTEXT_HTTP:
+ if ($consoleOutput) {
+ throw new InvalidArgumentException('Cannot use consoleOutput in HTTP context');
+ }
+ $this->setFormatter(HtmlOutputFormatter::create(new OutputFormatter()));
+ break;
+ default:
+ throw new InvalidArgumentException("Unexpected context - got '$context'.");
+ }
+ // Intentionally don't call parent constructor, because it doesn't use the setter methods.
+ $this->setDecorated($decorated);
+ $this->setVerbosity($verbosity);
+ }
+
+ /**
+ * Writes messages to the ouput - but only if we're in the given context.
+ *
+ * @param string $listType One of the LIST_* consts, e.g. HybridOutput::LIST_UNORDERED
+ * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants),
+ * 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
+ */
+ public function writeForContext(
+ string $context,
+ string|iterable $messages,
+ bool $newline = false,
+ int $options = Output::OUTPUT_NORMAL
+ ): void {
+ if ($this->context === $context) {
+ $this->write($messages, $newline, $options);
+ }
+ }
+
+ /**
+ * Start a list.
+ * In HTTP context this will write the opening `` or `` tag.
+ * In CLI context this will provide information for how to render list items.
+ *
+ * Call writeListItem() to add items to the list, then call stopList() when you're done.
+ *
+ * @param string $listType One of the LIST_* consts, e.g. HybridOutput::LIST_UNORDERED
+ * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants),
+ * 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
+ */
+ public function startList(string $listType = HybridOutput::LIST_UNORDERED, int $options = Output::OUTPUT_NORMAL): void
+ {
+ $this->listTypeStack[] = ['type' => $listType, 'options' => $options];
+ if ($this->context === HybridOutput::CONTEXT_HTTP) {
+ $this->write("<{$listType}>", options: $this->forceRawOutput($options));
+ }
+ }
+
+ /**
+ * Stop a list.
+ * In HTTP context this will write the closing `
` or `` tag.
+ * In CLI context this will mark the list as closed (useful when nesting lists)
+ */
+ public function stopList(): void
+ {
+ if (empty($this->listTypeStack)) {
+ throw new LogicException('No list to close.');
+ }
+ $info = array_pop($this->listTypeStack);
+ if ($this->context === HybridOutput::CONTEXT_HTTP) {
+ $this->write("", options: $this->forceRawOutput($info['options']));
+ }
+ }
+
+ /**
+ * Writes messages formatted as a list.
+ * Make sure to call startList() before writing list items, and call stopList() when you're done.
+ *
+ * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants),
+ * by default this will inherit the options used to start the list.
+ */
+ public function writeListItem(string|iterable $items, ?int $options = null): void
+ {
+ if (empty($this->listTypeStack)) {
+ throw new LogicException('No lists started. Call startList() first.');
+ }
+ if (is_string($items)) {
+ $items = [$items];
+ }
+ $method = "writeListItem{$this->context}";
+ $this->$method($items, $options);
+ }
+
+ public function write(string|iterable $messages, bool $newline = false, int $options = Output::OUTPUT_NORMAL): void
+ {
+ if ($this->context === HybridOutput::CONTEXT_CLI) {
+ $this->consoleOutput->write($messages, $newline, $options);
+ return;
+ }
+ // This will do some pre-processing before handing off to doWrite()
+ parent::write($messages, $newline, $options);
+ }
+
+ public function setDecorated(bool $decorated): void
+ {
+ parent::setDecorated($decorated);
+ $this->consoleOutput?->setDecorated($decorated);
+ }
+
+ public function setFormatter(OutputFormatterInterface $formatter): void
+ {
+ parent::setFormatter($formatter);
+ $this->consoleOutput?->setFormatter($formatter);
+ }
+
+ protected function doWrite(string $message, bool $newline): void
+ {
+ if ($this->context !== HybridOutput::CONTEXT_HTTP) {
+ throw new BadMethodCallException('Something went wrong - doWrite should only be called in HTTP context');
+ }
+ echo $message . ($newline ? "
\n" : '');
+ }
+
+ private function writeListItemHttp(iterable $items, ?int $options): void
+ {
+ if ($options === null) {
+ $listInfo = $this->listTypeStack[array_key_last($this->listTypeStack)];
+ $options = $listInfo['options'];
+ }
+ foreach ($items as $item) {
+ $this->write('', options: $this->forceRawOutput($options));
+ $this->write($item, options: $options);
+ $this->write('', options: $this->forceRawOutput($options));
+ }
+ }
+
+ private function writeListItemCli(iterable $items, ?int $options): void
+ {
+ $listInfo = $this->listTypeStack[array_key_last($this->listTypeStack)];
+ $listType = $listInfo['type'];
+ if ($options === null) {
+ $options = $listInfo['options'];
+ }
+ foreach ($items as $i => $item) {
+ switch ($listType) {
+ case HybridOutput::LIST_UNORDERED:
+ $bullet = '*';
+ break;
+ case HybridOutput::LIST_UNORDERED:
+ // Start at 1
+ $bullet = $i + 1 . '.';
+ break;
+ default:
+ throw new InvalidArgumentException("Unexpected list type - got '$listType'.");
+ }
+ $indent = str_repeat(' ', count($this->listTypeStack));
+ $this->writeln("{$indent}{$bullet} {$item}", $options);
+ }
+ }
+
+ private function getVerbosityOption(int $options): int
+ {
+ $verbosities = Output::VERBOSITY_QUIET | Output::VERBOSITY_NORMAL | Output::VERBOSITY_VERBOSE | Output::VERBOSITY_VERY_VERBOSE | Output::VERBOSITY_DEBUG;
+ return $verbosities & $options ?: Output::VERBOSITY_NORMAL;
+ }
+
+ private function forceRawOutput(int $options): int
+ {
+ return $this->getVerbosityOption($options) | Output::OUTPUT_RAW;
+ }
+}
diff --git a/src/Dev/State/ExtensionTestState.php b/src/Dev/State/ExtensionTestState.php
index 0cf274367a7..088673eeb72 100644
--- a/src/Dev/State/ExtensionTestState.php
+++ b/src/Dev/State/ExtensionTestState.php
@@ -88,7 +88,7 @@ public function setUpOnce($class)
}
// clear singletons, they're caching old extension info
- // which is used in DatabaseAdmin->doBuild()
+ // which is used in DevBuild->doBuild()
Injector::inst()->unregisterObjects([
DataObject::class,
Extension::class
diff --git a/src/Dev/Validation/DatabaseAdminExtension.php b/src/Dev/Validation/DevBuildExtension.php
similarity index 55%
rename from src/Dev/Validation/DatabaseAdminExtension.php
rename to src/Dev/Validation/DevBuildExtension.php
index fbcf5ffc244..a9950e0ce18 100644
--- a/src/Dev/Validation/DatabaseAdminExtension.php
+++ b/src/Dev/Validation/DevBuildExtension.php
@@ -4,24 +4,21 @@
use ReflectionException;
use SilverStripe\Core\Extension;
-use SilverStripe\ORM\DatabaseAdmin;
+use SilverStripe\Dev\HybridExecution\Command\DevBuild;
/**
* Hook up static validation to the deb/build process
*
- * @extends Extension
+ * @extends Extension
*/
-class DatabaseAdminExtension extends Extension
+class DevBuildExtension extends Extension
{
/**
- * Extension point in @see DatabaseAdmin::doBuild()
+ * Extension point in @see DevBuild::doBuild()
*
- * @param bool $quiet
- * @param bool $populate
- * @param bool $testMode
* @throws ReflectionException
*/
- public function onAfterBuild(bool $quiet, bool $populate, bool $testMode): void
+ public function onAfterBuild(): void
{
$service = RelationValidationService::singleton();
diff --git a/src/ORM/ArrayLib.php b/src/ORM/ArrayLib.php
index 371d0f6dfca..b5dbc8ed684 100644
--- a/src/ORM/ArrayLib.php
+++ b/src/ORM/ArrayLib.php
@@ -85,6 +85,32 @@ public static function array_values_recursive($array)
return ArrayLib::flatten($array, false);
}
+
+ /**
+ * Returns all the keys of a multi-dimensional array while maintining any nested structure
+ */
+ public static function arrayKeysRecursive(
+ array $array,
+ int $maxdepth = 20,
+ int $depth = 0,
+ array $arrayKeys = []
+ ): array {
+ if ($depth < $maxdepth) {
+ $depth++;
+ $keys = array_keys($array ?? []);
+
+ foreach ($keys as $key) {
+ if (!is_array($array[$key])) {
+ continue;
+ }
+
+ $arrayKeys[$key] = static::arrayKeysRecursive($array[$key], $maxdepth, $depth);
+ }
+ }
+
+ return $arrayKeys;
+ }
+
/**
* Filter an array by keys (useful for only allowing certain form-input to
* be saved).
diff --git a/src/ORM/Connect/TempDatabase.php b/src/ORM/Connect/TempDatabase.php
index ced43d8469d..af620a3fa2b 100644
--- a/src/ORM/Connect/TempDatabase.php
+++ b/src/ORM/Connect/TempDatabase.php
@@ -233,7 +233,7 @@ protected function rebuildTables($extraDataObjects = [])
{
DataObject::reset();
- // clear singletons, they're caching old extension info which is used in DatabaseAdmin->doBuild()
+ // clear singletons, they're caching old extension info which is used in DevBuild->doBuild()
Injector::inst()->unregisterObjects(DataObject::class);
$dataClasses = ClassInfo::subclassesFor(DataObject::class);
diff --git a/src/ORM/DataObject.php b/src/ORM/DataObject.php
index 43414fc301a..28e80a8f2e9 100644
--- a/src/ORM/DataObject.php
+++ b/src/ORM/DataObject.php
@@ -3807,7 +3807,7 @@ public function requireDefaultRecords()
* Invoked after every database build is complete (including after table creation and
* default record population).
*
- * See {@link DatabaseAdmin::doBuild()} for context.
+ * See {@link DevBuild::doBuild()} for context.
*/
public function onAfterBuild()
{
diff --git a/src/ORM/DatabaseAdmin.php b/src/ORM/DatabaseAdmin.php
deleted file mode 100644
index 8d08336fc22..00000000000
--- a/src/ORM/DatabaseAdmin.php
+++ /dev/null
@@ -1,538 +0,0 @@
- 'SilverStripe\\Assets\\File',
- 'Image' => 'SilverStripe\\Assets\\Image',
- 'Folder' => 'SilverStripe\\Assets\\Folder',
- 'Group' => 'SilverStripe\\Security\\Group',
- 'LoginAttempt' => 'SilverStripe\\Security\\LoginAttempt',
- 'Member' => 'SilverStripe\\Security\\Member',
- 'MemberPassword' => 'SilverStripe\\Security\\MemberPassword',
- 'Permission' => 'SilverStripe\\Security\\Permission',
- 'PermissionRole' => 'SilverStripe\\Security\\PermissionRole',
- 'PermissionRoleCode' => 'SilverStripe\\Security\\PermissionRoleCode',
- 'RememberLoginHash' => 'SilverStripe\\Security\\RememberLoginHash',
- ];
-
- /**
- * Config setting to enabled/disable the display of record counts on the dev/build output
- */
- private static $show_record_counts = true;
-
- protected function init()
- {
- parent::init();
-
- if (!$this->canInit()) {
- Security::permissionFailure(
- $this,
- "This page is secured and you need elevated permissions to access it. " .
- "Enter your credentials below and we will send you right along."
- );
- }
- }
-
- /**
- * Get the data classes, grouped by their root class
- *
- * @return array Array of data classes, grouped by their root class
- */
- public function groupedDataClasses()
- {
- // Get all root data objects
- $allClasses = get_declared_classes();
- $rootClasses = [];
- foreach ($allClasses as $class) {
- if (get_parent_class($class ?? '') == DataObject::class) {
- $rootClasses[$class] = [];
- }
- }
-
- // Assign every other data object one of those
- foreach ($allClasses as $class) {
- if (!isset($rootClasses[$class]) && is_subclass_of($class, DataObject::class)) {
- foreach ($rootClasses as $rootClass => $dummy) {
- if (is_subclass_of($class, $rootClass ?? '')) {
- $rootClasses[$rootClass][] = $class;
- break;
- }
- }
- }
- }
- return $rootClasses;
- }
-
-
- /**
- * When we're called as /dev/build, that's actually the index. Do the same
- * as /dev/build/build.
- */
- public function index()
- {
- return $this->build();
- }
-
- /**
- * Updates the database schema, creating tables & fields as necessary.
- */
- public function build()
- {
- // The default time limit of 30 seconds is normally not enough
- Environment::increaseTimeLimitTo(600);
-
- // If this code is being run outside of a dev/build or without a ?flush query string param,
- // the class manifest hasn't been flushed, so do it here
- $request = $this->getRequest();
- if (!array_key_exists('flush', $request->getVars() ?? []) && strpos($request->getURL() ?? '', 'dev/build') !== 0) {
- ClassLoader::inst()->getManifest()->regenerate(false);
- }
-
- $url = $this->getReturnURL();
- if ($url) {
- echo "Setting up the database; you will be returned to your site shortly....
";
- $this->doBuild(true);
- echo "Done!
";
- $this->redirect($url);
- } else {
- $quiet = $this->request->requestVar('quiet') !== null;
- $fromInstaller = $this->request->requestVar('from_installer') !== null;
- $populate = $this->request->requestVar('dont_populate') === null;
- $this->doBuild($quiet || $fromInstaller, $populate);
- }
- }
-
- /**
- * Gets the url to return to after build
- *
- * @return string|null
- */
- protected function getReturnURL()
- {
- $url = $this->request->getVar('returnURL');
-
- // Check that this url is a site url
- if (empty($url) || !Director::is_site_url($url)) {
- return null;
- }
-
- // Convert to absolute URL
- return Director::absoluteURL((string) $url, true);
- }
-
- /**
- * Build the default data, calling requireDefaultRecords on all
- * DataObject classes
- */
- public function buildDefaults()
- {
- $dataClasses = ClassInfo::subclassesFor(DataObject::class);
- array_shift($dataClasses);
-
- if (!Director::is_cli()) {
- echo "";
- }
-
- foreach ($dataClasses as $dataClass) {
- singleton($dataClass)->requireDefaultRecords();
- if (Director::is_cli()) {
- echo "Defaults loaded for $dataClass\n";
- } else {
- echo "- Defaults loaded for $dataClass
\n";
- }
- }
-
- if (!Director::is_cli()) {
- echo "
";
- }
- }
-
- /**
- * Returns the timestamp of the time that the database was last built
- *
- * @return string Returns the timestamp of the time that the database was
- * last built
- */
- public static function lastBuilt()
- {
- $file = TEMP_PATH
- . DIRECTORY_SEPARATOR
- . 'database-last-generated-'
- . str_replace(['\\', '/', ':'], '.', Director::baseFolder() ?? '');
-
- if (file_exists($file ?? '')) {
- return filemtime($file ?? '');
- }
- return null;
- }
-
-
- /**
- * Updates the database schema, creating tables & fields as necessary.
- *
- * @param boolean $quiet Don't show messages
- * @param boolean $populate Populate the database, as well as setting up its schema
- * @param bool $testMode
- */
- public function doBuild($quiet = false, $populate = true, $testMode = false)
- {
- $this->extend('onBeforeBuild', $quiet, $populate, $testMode);
-
- if ($quiet) {
- DB::quiet();
- } else {
- $conn = DB::get_conn();
- // Assumes database class is like "MySQLDatabase" or "MSSQLDatabase" (suffixed with "Database")
- $dbType = substr(get_class($conn), 0, -8);
- $dbVersion = $conn->getVersion();
- $databaseName = $conn->getSelectedDatabase();
-
- if (Director::is_cli()) {
- echo sprintf("\n\nBuilding database %s using %s %s\n\n", $databaseName, $dbType, $dbVersion);
- } else {
- echo sprintf("Building database %s using %s %s
", $databaseName, $dbType, $dbVersion);
- }
- }
-
- // Set up the initial database
- if (!DB::is_active()) {
- if (!$quiet) {
- echo 'Creating database
';
- }
-
- // Load parameters from existing configuration
- $databaseConfig = DB::getConfig();
- if (empty($databaseConfig) && empty($_REQUEST['db'])) {
- throw new BadMethodCallException("No database configuration available");
- }
- $parameters = (!empty($databaseConfig)) ? $databaseConfig : $_REQUEST['db'];
-
- // Check database name is given
- if (empty($parameters['database'])) {
- throw new BadMethodCallException(
- "No database name given; please give a value for SS_DATABASE_NAME or set SS_DATABASE_CHOOSE_NAME"
- );
- }
- $database = $parameters['database'];
-
- // Establish connection
- unset($parameters['database']);
- DB::connect($parameters);
-
- // Check to ensure that the re-instated SS_DATABASE_SUFFIX functionality won't unexpectedly
- // rename the database. To be removed for SS5
- if ($suffix = Environment::getEnv('SS_DATABASE_SUFFIX')) {
- $previousName = preg_replace("/{$suffix}$/", '', $database ?? '');
-
- if (!isset($_GET['force_suffix_rename']) && DB::get_conn()->databaseExists($previousName)) {
- throw new DatabaseException(
- "SS_DATABASE_SUFFIX was previously broken, but has now been fixed. This will result in your "
- . "database being named \"{$database}\" instead of \"{$previousName}\" from now on. If this "
- . "change is intentional, please visit dev/build?force_suffix_rename=1 to continue"
- );
- }
- }
-
- // Create database
- DB::create_database($database);
- }
-
- // Build the database. Most of the hard work is handled by DataObject
- $dataClasses = ClassInfo::subclassesFor(DataObject::class);
- array_shift($dataClasses);
-
- if (!$quiet) {
- if (Director::is_cli()) {
- echo "\nCREATING DATABASE TABLES\n\n";
- } else {
- echo "\nCreating database tables
\n\n";
- }
- }
-
- $showRecordCounts = (boolean)$this->config()->show_record_counts;
-
- // Initiate schema update
- $dbSchema = DB::get_schema();
- $tableBuilder = TableBuilder::singleton();
- $tableBuilder->buildTables($dbSchema, $dataClasses, [], $quiet, $testMode, $showRecordCounts);
- ClassInfo::reset_db_cache();
-
- if (!$quiet && !Director::is_cli()) {
- echo "
";
- }
-
- if ($populate) {
- if (!$quiet) {
- if (Director::is_cli()) {
- echo "\nCREATING DATABASE RECORDS\n\n";
- } else {
- echo "\nCreating database records
\n\n";
- }
- }
-
- // Remap obsolete class names
- $this->migrateClassNames();
-
- // Require all default records
- foreach ($dataClasses as $dataClass) {
- // Check if class exists before trying to instantiate - this sidesteps any manifest weirdness
- // Test_ indicates that it's the data class is part of testing system
- if (strpos($dataClass ?? '', 'Test_') === false && class_exists($dataClass ?? '')) {
- if (!$quiet) {
- if (Director::is_cli()) {
- echo " * $dataClass\n";
- } else {
- echo "- $dataClass
\n";
- }
- }
-
- DataObject::singleton($dataClass)->requireDefaultRecords();
- }
- }
-
- if (!$quiet && !Director::is_cli()) {
- echo "
";
- }
- }
-
- touch(TEMP_PATH
- . DIRECTORY_SEPARATOR
- . 'database-last-generated-'
- . str_replace(['\\', '/', ':'], '.', Director::baseFolder() ?? ''));
-
- if (isset($_REQUEST['from_installer'])) {
- echo "OK";
- }
-
- if (!$quiet) {
- echo (Director::is_cli()) ? "\n Database build completed!\n\n" : "Database build completed!
";
- }
-
- foreach ($dataClasses as $dataClass) {
- DataObject::singleton($dataClass)->onAfterBuild();
- }
-
- ClassInfo::reset_db_cache();
-
- $this->extend('onAfterBuild', $quiet, $populate, $testMode);
- }
-
- public function canInit(): bool
- {
- // We allow access to this controller regardless of live-status or ADMIN permission only
- // if on CLI or with the database not ready. The latter makes it less error-prone to do an
- // initial schema build without requiring a default-admin login.
- // Access to this controller is always allowed in "dev-mode", or of the user is ADMIN.
- $allowAllCLI = DevelopmentAdmin::config()->get('allow_all_cli');
- return (
- Director::isDev()
- || !Security::database_is_ready()
- // We need to ensure that DevelopmentAdminTest can simulate permission failures when running
- // "dev/tests" from CLI.
- || (Director::is_cli() && $allowAllCLI)
- || Permission::check(DevBuildController::config()->get('init_permissions'))
- );
- }
-
- /**
- * Given a base data class, a field name and a mapping of class replacements, look for obsolete
- * values in the $dataClass's $fieldName column and replace it with $mapping
- *
- * @param string $dataClass The data class to look up
- * @param string $fieldName The field name to look in for obsolete class names
- * @param string[] $mapping Map of old to new classnames
- */
- protected function updateLegacyClassNameField($dataClass, $fieldName, $mapping)
- {
- $schema = DataObject::getSchema();
- // Check first to ensure that the class has the specified field to update
- if (!$schema->databaseField($dataClass, $fieldName, false)) {
- return;
- }
-
- // Load a list of any records that have obsolete class names
- $table = $schema->tableName($dataClass);
- $currentClassNameList = DB::query("SELECT DISTINCT(\"{$fieldName}\") FROM \"{$table}\"")->column();
-
- // Get all invalid classes for this field
- $invalidClasses = array_intersect($currentClassNameList ?? [], array_keys($mapping ?? []));
- if (!$invalidClasses) {
- return;
- }
-
- $numberClasses = count($invalidClasses ?? []);
- DB::alteration_message(
- "Correcting obsolete {$fieldName} values for {$numberClasses} outdated types",
- 'obsolete'
- );
-
- // Build case assignment based on all intersected legacy classnames
- $cases = [];
- $params = [];
- foreach ($invalidClasses as $invalidClass) {
- $cases[] = "WHEN \"{$fieldName}\" = ? THEN ?";
- $params[] = $invalidClass;
- $params[] = $mapping[$invalidClass];
- }
-
- foreach ($this->getClassTables($dataClass) as $table) {
- $casesSQL = implode(' ', $cases);
- $sql = "UPDATE \"{$table}\" SET \"{$fieldName}\" = CASE {$casesSQL} ELSE \"{$fieldName}\" END";
- DB::prepared_query($sql, $params);
- }
- }
-
- /**
- * Get tables to update for this class
- *
- * @param string $dataClass
- * @return Generator|string[]
- */
- protected function getClassTables($dataClass)
- {
- $schema = DataObject::getSchema();
- $table = $schema->tableName($dataClass);
-
- // Base table
- yield $table;
-
- // Remap versioned table class name values as well
- /** @var Versioned|DataObject $dataClass */
- $dataClass = DataObject::singleton($dataClass);
- if ($dataClass->hasExtension(Versioned::class)) {
- if ($dataClass->hasStages()) {
- yield "{$table}_Live";
- }
- yield "{$table}_Versions";
- }
- }
-
- /**
- * Find all DBClassName fields on valid subclasses of DataObject that should be remapped. This includes
- * `ClassName` fields as well as polymorphic class name fields.
- *
- * @return array[]
- */
- protected function getClassNameRemappingFields()
- {
- $dataClasses = ClassInfo::getValidSubClasses(DataObject::class);
- $schema = DataObject::getSchema();
- $remapping = [];
-
- foreach ($dataClasses as $className) {
- $fieldSpecs = $schema->fieldSpecs($className);
- foreach ($fieldSpecs as $fieldName => $fieldSpec) {
- if (Injector::inst()->create($fieldSpec, 'Dummy') instanceof DBClassName) {
- $remapping[$className][] = $fieldName;
- }
- }
- }
-
- return $remapping;
- }
-
- /**
- * Remove invalid records from tables - that is, records that don't have
- * corresponding records in their parent class tables.
- */
- public function cleanup()
- {
- $baseClasses = [];
- foreach (ClassInfo::subclassesFor(DataObject::class) as $class) {
- if (get_parent_class($class ?? '') == DataObject::class) {
- $baseClasses[] = $class;
- }
- }
-
- $schema = DataObject::getSchema();
- foreach ($baseClasses as $baseClass) {
- // Get data classes
- $baseTable = $schema->baseDataTable($baseClass);
- $subclasses = ClassInfo::subclassesFor($baseClass);
- unset($subclasses[0]);
- foreach ($subclasses as $k => $subclass) {
- if (!DataObject::getSchema()->classHasTable($subclass)) {
- unset($subclasses[$k]);
- }
- }
-
- if ($subclasses) {
- $records = DB::query("SELECT * FROM \"$baseTable\"");
-
-
- foreach ($subclasses as $subclass) {
- $subclassTable = $schema->tableName($subclass);
- $recordExists[$subclass] =
- DB::query("SELECT \"ID\" FROM \"$subclassTable\"")->keyedColumn();
- }
-
- foreach ($records as $record) {
- foreach ($subclasses as $subclass) {
- $subclassTable = $schema->tableName($subclass);
- $id = $record['ID'];
- if (($record['ClassName'] != $subclass)
- && (!is_subclass_of($record['ClassName'], $subclass ?? ''))
- && isset($recordExists[$subclass][$id])
- ) {
- $sql = "DELETE FROM \"$subclassTable\" WHERE \"ID\" = ?";
- echo "$sql [{$id}]";
- DB::prepared_query($sql, [$id]);
- }
- }
- }
- }
- }
- }
-
- /**
- * Migrate all class names
- */
- protected function migrateClassNames()
- {
- $remappingConfig = $this->config()->get('classname_value_remapping');
- $remappingFields = $this->getClassNameRemappingFields();
- foreach ($remappingFields as $className => $fieldNames) {
- foreach ($fieldNames as $fieldName) {
- $this->updateLegacyClassNameField($className, $fieldName, $remappingConfig);
- }
- }
- }
-}
diff --git a/src/Security/Security.php b/src/Security/Security.php
index 214dbcb47d8..01d7291b444 100644
--- a/src/Security/Security.php
+++ b/src/Security/Security.php
@@ -1067,7 +1067,7 @@ public static function encrypt_password($password, $salt = null, $algorithm = nu
/**
* Checks the database is in a state to perform security checks.
- * See {@link DatabaseAdmin->init()} for more information.
+ * See DevBuild permission checks for more information.
*
* @return bool
*/