From 0a982374ecbfe05d28faf3385ec84a98eb84b4e8 Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Wed, 28 May 2025 12:39:22 +0200 Subject: [PATCH] refactor(core): migrate core application to `IBootstrap` Signed-off-by: Ferdinand Thiessen --- build/psalm-baseline.xml | 6 - core/Application.php | 303 +++--------------- core/Listener/AddMissingIndicesListener.php | 214 +++++++++++++ .../Listener/AddMissingPrimaryKeyListener.php | 68 ++++ lib/composer/composer/autoload_classmap.php | 2 + lib/composer/composer/autoload_static.php | 2 + 6 files changed, 327 insertions(+), 268 deletions(-) create mode 100644 core/Listener/AddMissingIndicesListener.php create mode 100644 core/Listener/AddMissingPrimaryKeyListener.php diff --git a/build/psalm-baseline.xml b/build/psalm-baseline.xml index ba87b47b50e..9b70702914c 100644 --- a/build/psalm-baseline.xml +++ b/build/psalm-baseline.xml @@ -2873,12 +2873,6 @@ - - - - - - diff --git a/core/Application.php b/core/Application.php index 17640f2ce0d..e3560741063 100644 --- a/core/Application.php +++ b/core/Application.php @@ -17,16 +17,19 @@ use OC\Authentication\Listeners\UserDeletedStoreCleanupListener; use OC\Authentication\Listeners\UserDeletedTokenCleanupListener; use OC\Authentication\Listeners\UserDeletedWebAuthnCleanupListener; use OC\Authentication\Notifications\Notifier as AuthenticationNotifier; +use OC\Core\Listener\AddMissingIndicesListener; +use OC\Core\Listener\AddMissingPrimaryKeyListener; use OC\Core\Listener\BeforeTemplateRenderedListener; use OC\Core\Notification\CoreNotifier; use OC\TagManager; use OCP\AppFramework\App; +use OCP\AppFramework\Bootstrap\IBootContext; +use OCP\AppFramework\Bootstrap\IBootstrap; +use OCP\AppFramework\Bootstrap\IRegistrationContext; use OCP\AppFramework\Http\Events\BeforeLoginTemplateRenderedEvent; use OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent; use OCP\DB\Events\AddMissingIndicesEvent; use OCP\DB\Events\AddMissingPrimaryKeyEvent; -use OCP\EventDispatcher\IEventDispatcher; -use OCP\Notification\IManager as INotificationManager; use OCP\User\Events\BeforeUserDeletedEvent; use OCP\User\Events\UserDeletedEvent; use OCP\Util; @@ -36,273 +39,49 @@ use OCP\Util; * * @package OC\Core */ -class Application extends App { - public function __construct() { - parent::__construct('core'); +class Application extends App implements IBootstrap { - $container = $this->getContainer(); + public const APP_ID = 'core'; - $container->registerService('defaultMailAddress', function () { + /** + * Application constructor. + */ + public function __construct(array $urlParams = []) { + parent::__construct(self::APP_ID, $urlParams); + } + + public function register(IRegistrationContext $context): void { + $context->registerService('defaultMailAddress', function () { return Util::getDefaultEmailAddress('lostpassword-noreply'); }); - $server = $container->getServer(); - /** @var IEventDispatcher $eventDispatcher */ - $eventDispatcher = $server->get(IEventDispatcher::class); + // register notifier + $context->registerNotifierService(CoreNotifier::class); + $context->registerNotifierService(AuthenticationNotifier::class); - $notificationManager = $server->get(INotificationManager::class); - $notificationManager->registerNotifierService(CoreNotifier::class); - $notificationManager->registerNotifierService(AuthenticationNotifier::class); - - $eventDispatcher->addListener(AddMissingIndicesEvent::class, function (AddMissingIndicesEvent $event): void { - $event->addMissingIndex( - 'share', - 'share_with_index', - ['share_with'] - ); - $event->addMissingIndex( - 'share', - 'parent_index', - ['parent'] - ); - $event->addMissingIndex( - 'share', - 'owner_index', - ['uid_owner'] - ); - $event->addMissingIndex( - 'share', - 'initiator_index', - ['uid_initiator'] - ); - - $event->addMissingIndex( - 'filecache', - 'fs_mtime', - ['mtime'] - ); - $event->addMissingIndex( - 'filecache', - 'fs_size', - ['size'] - ); - $event->addMissingIndex( - 'filecache', - 'fs_storage_path_prefix', - ['storage', 'path'], - ['lengths' => [null, 64]] - ); - $event->addMissingIndex( - 'filecache', - 'fs_parent', - ['parent'] - ); - $event->addMissingIndex( - 'filecache', - 'fs_name_hash', - ['name'] - ); - - $event->addMissingIndex( - 'twofactor_providers', - 'twofactor_providers_uid', - ['uid'] - ); - - $event->addMissingUniqueIndex( - 'login_flow_v2', - 'poll_token', - ['poll_token'], - [], - true - ); - $event->addMissingUniqueIndex( - 'login_flow_v2', - 'login_token', - ['login_token'], - [], - true - ); - $event->addMissingIndex( - 'login_flow_v2', - 'timestamp', - ['timestamp'], - [], - true - ); - - $event->addMissingIndex( - 'whats_new', - 'version', - ['version'], - [], - true - ); - - $event->addMissingIndex( - 'cards', - 'cards_abiduri', - ['addressbookid', 'uri'], - [], - true - ); - - $event->replaceIndex( - 'cards_properties', - ['cards_prop_abid'], - 'cards_prop_abid_name_value', - ['addressbookid', 'name', 'value'], - false, - ); - - $event->addMissingIndex( - 'calendarobjects_props', - 'calendarobject_calid_index', - ['calendarid', 'calendartype'] - ); - - $event->addMissingIndex( - 'schedulingobjects', - 'schedulobj_principuri_index', - ['principaluri'] - ); - - $event->addMissingIndex( - 'schedulingobjects', - 'schedulobj_lastmodified_idx', - ['lastmodified'] - ); - - $event->addMissingIndex( - 'properties', - 'properties_path_index', - ['userid', 'propertypath'] - ); - $event->addMissingIndex( - 'properties', - 'properties_pathonly_index', - ['propertypath'] - ); - $event->addMissingIndex( - 'properties', - 'properties_name_path_user', - ['propertyname', 'propertypath', 'userid'] - ); - - - $event->addMissingIndex( - 'jobs', - 'job_lastcheck_reserved', - ['last_checked', 'reserved_at'] - ); - - $event->addMissingIndex( - 'direct_edit', - 'direct_edit_timestamp', - ['timestamp'] - ); - - $event->addMissingIndex( - 'preferences', - 'prefs_uid_lazy_i', - ['userid', 'lazy'] - ); - $event->addMissingIndex( - 'preferences', - 'prefs_app_key_ind_fl_i', - ['appid', 'configkey', 'indexed', 'flags'] - ); - - $event->addMissingIndex( - 'mounts', - 'mounts_class_index', - ['mount_provider_class'] - ); - $event->addMissingIndex( - 'mounts', - 'mounts_user_root_path_index', - ['user_id', 'root_id', 'mount_point'], - ['lengths' => [null, null, 128]] - ); - - $event->addMissingIndex( - 'systemtag_object_mapping', - 'systag_by_tagid', - ['systemtagid', 'objecttype'] - ); - - $event->addMissingIndex( - 'systemtag_object_mapping', - 'systag_by_objectid', - ['objectid'] - ); - - $event->addMissingIndex( - 'systemtag_object_mapping', - 'systag_objecttype', - ['objecttype'] - ); - }); - - $eventDispatcher->addListener(AddMissingPrimaryKeyEvent::class, function (AddMissingPrimaryKeyEvent $event): void { - $event->addMissingPrimaryKey( - 'federated_reshares', - 'federated_res_pk', - ['share_id'], - 'share_id_index' - ); - - $event->addMissingPrimaryKey( - 'systemtag_object_mapping', - 'som_pk', - ['objecttype', 'objectid', 'systemtagid'], - 'mapping' - ); - - $event->addMissingPrimaryKey( - 'comments_read_markers', - 'crm_pk', - ['user_id', 'object_type', 'object_id'], - 'comments_marker_index' - ); - - $event->addMissingPrimaryKey( - 'collres_resources', - 'crr_pk', - ['collection_id', 'resource_type', 'resource_id'], - 'collres_unique_res' - ); - - $event->addMissingPrimaryKey( - 'collres_accesscache', - 'cra_pk', - ['user_id', 'collection_id', 'resource_type', 'resource_id'], - 'collres_unique_user' - ); - - $event->addMissingPrimaryKey( - 'filecache_extended', - 'fce_pk', - ['fileid'], - 'fce_fileid_idx' - ); - }); - - $eventDispatcher->addServiceListener(BeforeTemplateRenderedEvent::class, BeforeTemplateRenderedListener::class); - $eventDispatcher->addServiceListener(BeforeLoginTemplateRenderedEvent::class, BeforeTemplateRenderedListener::class); - $eventDispatcher->addServiceListener(RemoteWipeStarted::class, RemoteWipeActivityListener::class); - $eventDispatcher->addServiceListener(RemoteWipeStarted::class, RemoteWipeNotificationsListener::class); - $eventDispatcher->addServiceListener(RemoteWipeStarted::class, RemoteWipeEmailListener::class); - $eventDispatcher->addServiceListener(RemoteWipeFinished::class, RemoteWipeActivityListener::class); - $eventDispatcher->addServiceListener(RemoteWipeFinished::class, RemoteWipeNotificationsListener::class); - $eventDispatcher->addServiceListener(RemoteWipeFinished::class, RemoteWipeEmailListener::class); - $eventDispatcher->addServiceListener(UserDeletedEvent::class, UserDeletedStoreCleanupListener::class); - $eventDispatcher->addServiceListener(UserDeletedEvent::class, UserDeletedTokenCleanupListener::class); - $eventDispatcher->addServiceListener(BeforeUserDeletedEvent::class, UserDeletedFilesCleanupListener::class); - $eventDispatcher->addServiceListener(UserDeletedEvent::class, UserDeletedFilesCleanupListener::class); - $eventDispatcher->addServiceListener(UserDeletedEvent::class, UserDeletedWebAuthnCleanupListener::class); + // register event listeners + $context->registerEventListener(AddMissingIndicesEvent::class, AddMissingIndicesListener::class); + $context->registerEventListener(AddMissingPrimaryKeyEvent::class, AddMissingPrimaryKeyListener::class); + $context->registerEventListener(BeforeTemplateRenderedEvent::class, BeforeTemplateRenderedListener::class); + $context->registerEventListener(BeforeLoginTemplateRenderedEvent::class, BeforeTemplateRenderedListener::class); + $context->registerEventListener(RemoteWipeStarted::class, RemoteWipeActivityListener::class); + $context->registerEventListener(RemoteWipeStarted::class, RemoteWipeNotificationsListener::class); + $context->registerEventListener(RemoteWipeStarted::class, RemoteWipeEmailListener::class); + $context->registerEventListener(RemoteWipeFinished::class, RemoteWipeActivityListener::class); + $context->registerEventListener(RemoteWipeFinished::class, RemoteWipeNotificationsListener::class); + $context->registerEventListener(RemoteWipeFinished::class, RemoteWipeEmailListener::class); + $context->registerEventListener(UserDeletedEvent::class, UserDeletedStoreCleanupListener::class); + $context->registerEventListener(UserDeletedEvent::class, UserDeletedTokenCleanupListener::class); + $context->registerEventListener(BeforeUserDeletedEvent::class, UserDeletedFilesCleanupListener::class); + $context->registerEventListener(UserDeletedEvent::class, UserDeletedFilesCleanupListener::class); + $context->registerEventListener(UserDeletedEvent::class, UserDeletedWebAuthnCleanupListener::class); // Tags - $eventDispatcher->addServiceListener(UserDeletedEvent::class, TagManager::class); + $context->registerEventListener(UserDeletedEvent::class, TagManager::class); } + + public function boot(IBootContext $context): void { + // ... + } + } diff --git a/core/Listener/AddMissingIndicesListener.php b/core/Listener/AddMissingIndicesListener.php new file mode 100644 index 00000000000..f54dc7e17fe --- /dev/null +++ b/core/Listener/AddMissingIndicesListener.php @@ -0,0 +1,214 @@ + + */ +class AddMissingIndicesListener implements IEventListener { + + public function handle(Event $event): void { + if (!($event instanceof AddMissingIndicesEvent)) { + return; + } + + $event->addMissingIndex( + 'share', + 'share_with_index', + ['share_with'] + ); + $event->addMissingIndex( + 'share', + 'parent_index', + ['parent'] + ); + $event->addMissingIndex( + 'share', + 'owner_index', + ['uid_owner'] + ); + $event->addMissingIndex( + 'share', + 'initiator_index', + ['uid_initiator'] + ); + + $event->addMissingIndex( + 'filecache', + 'fs_mtime', + ['mtime'] + ); + $event->addMissingIndex( + 'filecache', + 'fs_size', + ['size'] + ); + $event->addMissingIndex( + 'filecache', + 'fs_storage_path_prefix', + ['storage', 'path'], + ['lengths' => [null, 64]] + ); + $event->addMissingIndex( + 'filecache', + 'fs_parent', + ['parent'] + ); + $event->addMissingIndex( + 'filecache', + 'fs_name_hash', + ['name'] + ); + + $event->addMissingIndex( + 'twofactor_providers', + 'twofactor_providers_uid', + ['uid'] + ); + + $event->addMissingUniqueIndex( + 'login_flow_v2', + 'poll_token', + ['poll_token'], + [], + true + ); + $event->addMissingUniqueIndex( + 'login_flow_v2', + 'login_token', + ['login_token'], + [], + true + ); + $event->addMissingIndex( + 'login_flow_v2', + 'timestamp', + ['timestamp'], + [], + true + ); + + $event->addMissingIndex( + 'whats_new', + 'version', + ['version'], + [], + true + ); + + $event->addMissingIndex( + 'cards', + 'cards_abiduri', + ['addressbookid', 'uri'], + [], + true + ); + + $event->replaceIndex( + 'cards_properties', + ['cards_prop_abid'], + 'cards_prop_abid_name_value', + ['addressbookid', 'name', 'value'], + false, + ); + + $event->addMissingIndex( + 'calendarobjects_props', + 'calendarobject_calid_index', + ['calendarid', 'calendartype'] + ); + + $event->addMissingIndex( + 'schedulingobjects', + 'schedulobj_principuri_index', + ['principaluri'] + ); + + $event->addMissingIndex( + 'schedulingobjects', + 'schedulobj_lastmodified_idx', + ['lastmodified'] + ); + + $event->addMissingIndex( + 'properties', + 'properties_path_index', + ['userid', 'propertypath'] + ); + $event->addMissingIndex( + 'properties', + 'properties_pathonly_index', + ['propertypath'] + ); + $event->addMissingIndex( + 'properties', + 'properties_name_path_user', + ['propertyname', 'propertypath', 'userid'] + ); + + + $event->addMissingIndex( + 'jobs', + 'job_lastcheck_reserved', + ['last_checked', 'reserved_at'] + ); + + $event->addMissingIndex( + 'direct_edit', + 'direct_edit_timestamp', + ['timestamp'] + ); + + $event->addMissingIndex( + 'preferences', + 'prefs_uid_lazy_i', + ['userid', 'lazy'] + ); + $event->addMissingIndex( + 'preferences', + 'prefs_app_key_ind_fl_i', + ['appid', 'configkey', 'indexed', 'flags'] + ); + + $event->addMissingIndex( + 'mounts', + 'mounts_class_index', + ['mount_provider_class'] + ); + $event->addMissingIndex( + 'mounts', + 'mounts_user_root_path_index', + ['user_id', 'root_id', 'mount_point'], + ['lengths' => [null, null, 128]] + ); + + $event->addMissingIndex( + 'systemtag_object_mapping', + 'systag_by_tagid', + ['systemtagid', 'objecttype'] + ); + + $event->addMissingIndex( + 'systemtag_object_mapping', + 'systag_by_objectid', + ['objectid'] + ); + + $event->addMissingIndex( + 'systemtag_object_mapping', + 'systag_objecttype', + ['objecttype'] + ); + } +} diff --git a/core/Listener/AddMissingPrimaryKeyListener.php b/core/Listener/AddMissingPrimaryKeyListener.php new file mode 100644 index 00000000000..1cd6951c9a1 --- /dev/null +++ b/core/Listener/AddMissingPrimaryKeyListener.php @@ -0,0 +1,68 @@ + + */ +class AddMissingPrimaryKeyListener implements IEventListener { + + public function handle(Event $event): void { + if (!($event instanceof AddMissingPrimaryKeyEvent)) { + return; + } + + $event->addMissingPrimaryKey( + 'federated_reshares', + 'federated_res_pk', + ['share_id'], + 'share_id_index' + ); + + $event->addMissingPrimaryKey( + 'systemtag_object_mapping', + 'som_pk', + ['objecttype', 'objectid', 'systemtagid'], + 'mapping' + ); + + $event->addMissingPrimaryKey( + 'comments_read_markers', + 'crm_pk', + ['user_id', 'object_type', 'object_id'], + 'comments_marker_index' + ); + + $event->addMissingPrimaryKey( + 'collres_resources', + 'crr_pk', + ['collection_id', 'resource_type', 'resource_id'], + 'collres_unique_res' + ); + + $event->addMissingPrimaryKey( + 'collres_accesscache', + 'cra_pk', + ['user_id', 'collection_id', 'resource_type', 'resource_id'], + 'collres_unique_user' + ); + + $event->addMissingPrimaryKey( + 'filecache_extended', + 'fce_pk', + ['fileid'], + 'fce_fileid_idx' + ); + } +} diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 9f4321129af..ce5ea7ed649 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -1385,6 +1385,8 @@ return array( 'OC\\Core\\Exception\\LoginFlowV2ClientForbiddenException' => $baseDir . '/core/Exception/LoginFlowV2ClientForbiddenException.php', 'OC\\Core\\Exception\\LoginFlowV2NotFoundException' => $baseDir . '/core/Exception/LoginFlowV2NotFoundException.php', 'OC\\Core\\Exception\\ResetPasswordException' => $baseDir . '/core/Exception/ResetPasswordException.php', + 'OC\\Core\\Listener\\AddMissingIndicesListener' => $baseDir . '/core/Listener/AddMissingIndicesListener.php', + 'OC\\Core\\Listener\\AddMissingPrimaryKeyListener' => $baseDir . '/core/Listener/AddMissingPrimaryKeyListener.php', 'OC\\Core\\Listener\\BeforeMessageLoggedEventListener' => $baseDir . '/core/Listener/BeforeMessageLoggedEventListener.php', 'OC\\Core\\Listener\\BeforeTemplateRenderedListener' => $baseDir . '/core/Listener/BeforeTemplateRenderedListener.php', 'OC\\Core\\Listener\\FeedBackHandler' => $baseDir . '/core/Listener/FeedBackHandler.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 26e0a34275d..2ba3a5faba8 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -1426,6 +1426,8 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 'OC\\Core\\Exception\\LoginFlowV2ClientForbiddenException' => __DIR__ . '/../../..' . '/core/Exception/LoginFlowV2ClientForbiddenException.php', 'OC\\Core\\Exception\\LoginFlowV2NotFoundException' => __DIR__ . '/../../..' . '/core/Exception/LoginFlowV2NotFoundException.php', 'OC\\Core\\Exception\\ResetPasswordException' => __DIR__ . '/../../..' . '/core/Exception/ResetPasswordException.php', + 'OC\\Core\\Listener\\AddMissingIndicesListener' => __DIR__ . '/../../..' . '/core/Listener/AddMissingIndicesListener.php', + 'OC\\Core\\Listener\\AddMissingPrimaryKeyListener' => __DIR__ . '/../../..' . '/core/Listener/AddMissingPrimaryKeyListener.php', 'OC\\Core\\Listener\\BeforeMessageLoggedEventListener' => __DIR__ . '/../../..' . '/core/Listener/BeforeMessageLoggedEventListener.php', 'OC\\Core\\Listener\\BeforeTemplateRenderedListener' => __DIR__ . '/../../..' . '/core/Listener/BeforeTemplateRenderedListener.php', 'OC\\Core\\Listener\\FeedBackHandler' => __DIR__ . '/../../..' . '/core/Listener/FeedBackHandler.php',