Move admin_audit hooks to proper event listeners #37193

tcitworld · 2023-03-13T10:26:31Z

Requires #35677

Summary

Moves all of the hooks used by admin_audit to event listeners, where appropriate typed events already exist.

Bases itself on Introduced app enable/disable/update typed events #35677 to have app management events
Adds a new ConsoleEventV2 typed event to replace the legacy ConsoleEvent event in OCP (already depreciated). However, this doesn't seem used anywhere else, so we could replace it straight away.
Adds preview details on the BeforePreviewFetchedEvent event

Part of #14552. Follow #37194 to track all of the hooks left.

TODO

Add tests for the new listeners

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

github-advanced-security

Psalm found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

come-nc · 2023-03-13T15:19:48Z

See #32128 as well

come-nc · 2023-03-13T15:24:03Z

Is that different/better than #32019 ?

tcitworld · 2023-03-13T16:21:32Z

I missed this one, thanks. 🙈

Well, there's more stuff in mine. I'll simply take the LDAP stuff from Carl's PR, and take over #32018 as well.

tcitworld · 2023-03-13T18:16:49Z

apps/admin_audit/lib/Listener/SharingEventListener.php

+
+		$params = [
+			'itemType' => $share->getNodeType(),
+			'path' => $share->getNode()->getPath(),


question: Unfortunately, this makes extra calls to get the Node. Should the share or the event hold this information?

Extra PHP calls? Or extra database queries?
Does not seem that overkill to me.

apps/admin_audit/lib/AppInfo/Application.php

apps/admin_audit/lib/Listener/AppManagementEventListener.php

come-nc · 2023-03-14T17:01:40Z

apps/admin_audit/lib/Listener/SharingEventListener.php

+
+		$params = [
+			'itemType' => $share->getNodeType(),
+			'path' => $share->getNode()->getPath(),


Extra PHP calls? Or extra database queries?
Does not seem that overkill to me.

lib/public/Console/ConsoleEventV2.php

lib/public/User/Events/BeforeUserIdUnassignedEvent.php

come-nc · 2023-03-14T17:10:43Z

Please strict type the hell out of this, return types on all new methods and strict_type declare on all new files, otherwise nice cleanup!

Signed-off-by: Thomas Citharel <tcit@tcit.fr>

…epreciated ConsoleEvent event Signed-off-by: Thomas Citharel <tcit@tcit.fr>

Based on work from #32019 Signed-off-by: Thomas Citharel <tcit@tcit.fr>

Signed-off-by: Thomas Citharel <tcit@tcit.fr>

blizzz

some remarks, but nothing fundamental

blizzz · 2023-05-03T08:44:04Z

apps/admin_audit/lib/Actions/UserManagement.php

@@ -94,53 +63,4 @@ public function unassign(string $uid): void {
 			[ 'uid' ]


left over? I guess the whole class can be trashed just as well.

blizzz · 2023-05-03T08:46:24Z

apps/admin_audit/lib/Listener/AppManagementEventListener.php

+use OCP\EventDispatcher\IEventListener;
+
+/**
+ * @template-implements UserManagementEventListener<AppEnableEvent|AppDisableEvent|AppUpdateEvent>


Suggested change

* @template-implements UserManagementEventListener<AppEnableEvent|AppDisableEvent|AppUpdateEvent>

* @template-implements AppManagementEventListener<AppEnableEvent|AppDisableEvent|AppUpdateEvent>

blizzz · 2023-05-03T08:47:25Z

apps/admin_audit/lib/Listener/AuthEventListener.php

+use OCP\User\Events\UserLoggedInWithCookieEvent;
+
+/**
+ * @template-implements UserManagementEventListener<BeforeUserLoggedInEvent|UserLoggedInWithCookieEvent|UserLoggedInEvent|BeforeUserLoggedOutEvent>


Suggested change

* @template-implements UserManagementEventListener<BeforeUserLoggedInEvent|UserLoggedInWithCookieEvent|UserLoggedInEvent|BeforeUserLoggedOutEvent>

* @template-implements AuthEventListener<BeforeUserLoggedInEvent|UserLoggedInWithCookieEvent|UserLoggedInEvent|BeforeUserLoggedOutEvent>

blizzz · 2023-05-03T08:49:34Z

apps/admin_audit/lib/Listener/ConsoleEventListener.php

+use OCP\EventDispatcher\IEventListener;
+
+/**
+ * @template-implements UserManagementEventListener<ConsoleEventV2>


Suggested change

* @template-implements UserManagementEventListener<ConsoleEventV2>

* @template-implements ConsoleEventListener<ConsoleEventV2>

blizzz · 2023-05-03T08:50:56Z

apps/admin_audit/lib/Listener/CriticalActionPerformedEventListener.php

@@ -30,6 +30,9 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\Log\Audit\CriticalActionPerformedEvent;

+/**
+ * @template-implements UserManagementEventListener<CriticalActionPerformedEvent>


Suggested change

* @template-implements UserManagementEventListener<CriticalActionPerformedEvent>

* @template-implements CriticalActionPerformedEventListener<CriticalActionPerformedEvent>

blizzz · 2023-05-03T08:59:01Z

apps/admin_audit/lib/Listener/SharingEventListener.php

+				[
+					'itemType',
+					'path',
+					'itemSource',
+					'permissions',
+					'id',
+				]


array_keys($params)? 😅

blizzz · 2023-05-03T09:02:42Z

apps/admin_audit/lib/Listener/SharingEventListener.php

+			'id' => $share->getId()
+		];
+
+		match ($share->getShareType()) {


The type could also be parameterized, saving some lines. It's not translated after all.

blizzz · 2023-05-03T09:04:29Z

apps/admin_audit/lib/Listener/UserManagementEventListener.php

+/**
+ * @template-implements UserManagementEventListener<UserCreatedEvent|UserDeletedEvent|UserChangedEvent|PasswordUpdatedEvent|UserIdAssignedEvent|UserIdUnassignedEvent>
+ */
+class UserManagementEventListener extends Action implements IEventListener {


there are more issues with the docblock, check the static scanner remarks

blizzz · 2023-05-03T09:11:04Z

apps/user_ldap/lib/Jobs/Sync.php

+		$this->mapper = $userMapping;
+		$this->connectionFactory = $connectionFactory;
+
+		$this->accessFactory = new AccessFactory(


It should be safe to inject the AccessFactory directly.

blizzz · 2023-05-03T09:16:15Z

lib/private/Console/Application.php

 								IRequest $request,
 								LoggerInterface $logger,
-								MemoryInfo $memoryInfo) {
-		$defaults = \OC::$server->getThemingDefaults();
+								MemoryInfo $memoryInfo, Defaults $defaults) {


codes style, one argument per line pls

tcitworld added 2. developing Work in progress technical debt labels Mar 13, 2023

tcitworld added this to the Nextcloud 27 milestone Mar 13, 2023

tcitworld requested review from ChristophWurst, juliushaertl, come-nc, a team, ArtificialOwl and blizzz and removed request for a team March 13, 2023 10:26

tcitworld mentioned this pull request Mar 13, 2023

Create typed events for all remaining hooks used by admin_audit #37194

Open

17 tasks

tcitworld added this to In progress in Thomas things to do via automation Mar 13, 2023

github-advanced-security bot found potential problems Mar 13, 2023

View reviewed changes

tcitworld force-pushed the admin_audit/enh/move-to-event-listeners branch 2 times, most recently from 921aa53 to 82b9461 Compare March 13, 2023 10:54

tcitworld force-pushed the admin_audit/enh/move-to-event-listeners branch from 82b9461 to 3fb14cc Compare March 13, 2023 17:54

tcitworld mentioned this pull request Mar 13, 2023

Start porting Admin audit to new events #32019

Closed

tcitworld force-pushed the admin_audit/enh/move-to-event-listeners branch 2 times, most recently from 01e64ac to b543f31 Compare March 13, 2023 18:14

tcitworld commented Mar 13, 2023

View reviewed changes

come-nc reviewed Mar 14, 2023

View reviewed changes

tcitworld added 2 commits May 2, 2023 14:53

Add preview specifications into BeforePreviewFetchedEvent event

268f5cd

Signed-off-by: Thomas Citharel <tcit@tcit.fr>

feat(event): Introduce a new ConsoleEventV2 modern event to replace d…

73291ba

…epreciated ConsoleEvent event Signed-off-by: Thomas Citharel <tcit@tcit.fr>

tcitworld force-pushed the admin_audit/enh/move-to-event-listeners branch from b543f31 to 52a289c Compare May 2, 2023 13:39

CarlSchwan and others added 2 commits May 2, 2023 15:54

Introduce user id assigned typed events for LDAP usage

ac0c201

Based on work from #32019 Signed-off-by: Thomas Citharel <tcit@tcit.fr>

Move admin_audit hooks to modern event listeners

7f5ff6c

Signed-off-by: Thomas Citharel <tcit@tcit.fr>

tcitworld force-pushed the admin_audit/enh/move-to-event-listeners branch from 52a289c to 7f5ff6c Compare May 2, 2023 13:54

skjnldsv mentioned this pull request May 3, 2023

27.0.0 beta 1 #38038

Merged

blizzz requested changes May 3, 2023

View reviewed changes

This was referenced May 9, 2023

27.0.0 beta 2 #38137

Closed

27.0.0 beta 2 #38139

Merged

blizzz mentioned this pull request May 17, 2023

27.0.0 RC1 #38341

Merged

blizzz modified the milestones: Nextcloud 27, Nextcloud 28 May 23, 2023

tcitworld mentioned this pull request Jun 9, 2023

feat: add width, height, crop and mode to BeforePreviewFetchedEvent #38679

Merged

5 tasks

skjnldsv mentioned this pull request Nov 1, 2023

chore: 28.0.0 beta 1 #41228

Merged

This was referenced Nov 6, 2023

28.0.0 beta 2 #41314

Merged

28.0.0 beta 3 #41379

Merged

This was referenced Nov 14, 2023

28.0.0 beta 4 #41477

Merged

28.0.0 RC1 #41621

Merged

blizzz modified the milestones: Nextcloud 28, Nextcloud 29 Nov 23, 2023

This was referenced Mar 12, 2024

29.0.0 beta 2 #44152

Merged

29.0.0 beta 3 #44186

Merged

29.0.0 beta 4 #44275

Merged

This was referenced Mar 20, 2024

29.0.0 beta 5 #44361

Merged

29.0.0 beta 6 #44449

Merged

skjnldsv mentioned this pull request Mar 28, 2024

29.0.0 RC1 #44552

Merged

81 tasks

skjnldsv modified the milestones: Nextcloud 29, Nextcloud 30 Mar 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move admin_audit hooks to proper event listeners #37193

Move admin_audit hooks to proper event listeners #37193

tcitworld commented Mar 13, 2023 •

edited

Loading

github-advanced-security bot left a comment

come-nc commented Mar 13, 2023

come-nc commented Mar 13, 2023

tcitworld commented Mar 13, 2023

tcitworld Mar 13, 2023 •

edited

Loading

come-nc Mar 14, 2023

come-nc Mar 14, 2023

come-nc commented Mar 14, 2023

blizzz left a comment

blizzz May 3, 2023

blizzz May 3, 2023

blizzz May 3, 2023

blizzz May 3, 2023

blizzz May 3, 2023

blizzz May 3, 2023

blizzz May 3, 2023

blizzz May 3, 2023

blizzz May 3, 2023

blizzz May 3, 2023

		@@ -94,53 +63,4 @@ public function unassign(string $uid): void {
		[ 'uid' ]

	* @template-implements UserManagementEventListener<AppEnableEvent\|AppDisableEvent\|AppUpdateEvent>
	* @template-implements AppManagementEventListener<AppEnableEvent\|AppDisableEvent\|AppUpdateEvent>

	* @template-implements UserManagementEventListener<BeforeUserLoggedInEvent\|UserLoggedInWithCookieEvent\|UserLoggedInEvent\|BeforeUserLoggedOutEvent>
	* @template-implements AuthEventListener<BeforeUserLoggedInEvent\|UserLoggedInWithCookieEvent\|UserLoggedInEvent\|BeforeUserLoggedOutEvent>

	* @template-implements UserManagementEventListener<ConsoleEventV2>
	* @template-implements ConsoleEventListener<ConsoleEventV2>

	* @template-implements UserManagementEventListener<CriticalActionPerformedEvent>
	* @template-implements CriticalActionPerformedEventListener<CriticalActionPerformedEvent>

Move admin_audit hooks to proper event listeners #37193

Are you sure you want to change the base?

Move admin_audit hooks to proper event listeners #37193

Conversation

tcitworld commented Mar 13, 2023 • edited Loading

Summary

TODO

Checklist

github-advanced-security bot left a comment

Choose a reason for hiding this comment

come-nc commented Mar 13, 2023

come-nc commented Mar 13, 2023

tcitworld commented Mar 13, 2023

tcitworld Mar 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

come-nc commented Mar 14, 2023

blizzz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tcitworld commented Mar 13, 2023 •

edited

Loading

tcitworld Mar 13, 2023 •

edited

Loading