Skip to content

Move admin_audit to proper event listeners v2 - #47865

Merged
come-nc merged 8 commits into
masterfrom
admin_audit/enh/move-to-event-listeners-v2
Sep 13, 2024
Merged

Move admin_audit to proper event listeners v2#47865
come-nc merged 8 commits into
masterfrom
admin_audit/enh/move-to-event-listeners-v2

Conversation

@come-nc

@come-nccome-nc commented Sep 10, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

See #32128

Summary

Rebased version of #37193
Part of original PR were already done in master so some commit endup a bit empty, but everything should work.

Does not fix all cases of deprecated mecanism but this is already a good improvement and as such it should be merged before it conflicts again.

Checklist

github-advanced-security[bot]
github-advanced-securityAI found potential problems Sep 10, 2024
View reviewed changes

@github-advanced-securitygithub-advanced-securityAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@come-nccome-nc changed the title Admin audit/enh/move to event listeners v2Move admin_audit to proper event listeners v2Sep 10, 2024
@come-nccome-nc self-assigned this Sep 10, 2024
@come-nccome-nc added 2. developing Work in progress technical debt 🧱 🤔🚀 labels Sep 10, 2024
@come-nccome-nc added this to the Nextcloud 31 milestone Sep 10, 2024
github-advanced-security[bot]
github-advanced-securityAI found potential problems Sep 10, 2024
View reviewed changes
Comment threadapps/admin_audit/lib/AppInfo/Application.php Fixed
Comment threadapps/admin_audit/lib/Listener/AppManagementEventListener.php
$this->appEnable($event);
} elseif ($event instanceof AppDisableEvent) {
$this->appDisable($event);
} elseif ($event instanceof AppUpdateEvent) {

Check notice

Code scanning / Psalm

RedundantConditionGivenDocblockType

Docblock-defined type OCP\App\Events\AppUpdateEvent for $event is always OCP\App\Events\AppUpdateEvent
Comment threadapps/admin_audit/lib/Listener/AuthEventListener.php
$this->beforeUserLoggedIn($event);
} elseif ($event instanceof UserLoggedInWithCookieEvent || $event instanceof UserLoggedInEvent) {
$this->userLoggedIn($event);
} elseif ($event instanceof BeforeUserLoggedOutEvent) {

Check notice

Code scanning / Psalm

RedundantConditionGivenDocblockType

Docblock-defined type OCP\User\Events\BeforeUserLoggedOutEvent for $event is always OCP\User\Events\BeforeUserLoggedOutEvent
Comment threadapps/admin_audit/lib/Listener/ConsoleEventListener.php Fixed
Comment threadapps/admin_audit/lib/Listener/ConsoleEventListener.php
*/
class ConsoleEventListener extends Action implements IEventListener {
public function handle(Event $event): void {
if ($event instanceof ConsoleEvent) {

Check notice

Code scanning / Psalm

RedundantConditionGivenDocblockType

Docblock-defined type OCP\Console\ConsoleEvent for $event is always OCP\Console\ConsoleEvent
Comment threadapps/admin_audit/lib/Listener/UserManagementEventListener.php
$this->passwordUpdated($event);
} elseif ($event instanceof UserIdAssignedEvent) {
$this->userIdAssigned($event);
} elseif ($event instanceof UserIdUnassignedEvent) {

Check notice

Code scanning / Psalm

RedundantConditionGivenDocblockType

Docblock-defined type OCP\User\Events\UserIdUnassignedEvent for $event is always OCP\User\Events\UserIdUnassignedEvent
Comment threadapps/user_ldap/lib/Access.php
} elseif (!$isUser) {
$this->dispatcher->dispatchTyped(new UserIdAssignedEvent($name));
if ($this->ncUserManager instanceof PublicEmitter) {
$this->ncUserManager->emit('\OC\User', 'assignedUserId', [$name]);

Check notice

Code scanning / Psalm

DeprecatedMethod

The method OC\Hooks\PublicEmitter::emit has been marked as deprecated
Comment threadapps/user_ldap/lib/Jobs/Sync.php
parent::__construct($timeFactory);
$this->setInterval(
(int)\OC::$server->getConfig()->getAppValue(
(int)$this->config->getAppValue(

Check notice

Code scanning / Psalm

DeprecatedMethod

The method OCP\IConfig::getAppValue has been marked as deprecated
Comment threadapps/user_ldap/lib/Jobs/Sync.php

$cycleData = [
'prefix' => $this->config->getAppValue('user_ldap', 'background_sync_prefix', null),
'prefix' => $this->config->getAppValue('user_ldap', 'background_sync_prefix', 'none'),

Check notice

Code scanning / Psalm

DeprecatedMethod

The method OCP\IConfig::getAppValue has been marked as deprecated
Comment threadapps/user_ldap/lib/Jobs/Sync.php
public function setCycle(array $cycleData): void {
$this->config->setAppValue('user_ldap', 'background_sync_prefix', $cycleData['prefix']);
$this->config->setAppValue('user_ldap', 'background_sync_offset', $cycleData['offset']);
$this->config->setAppValue('user_ldap', 'background_sync_offset', (string)$cycleData['offset']);

Check notice

Code scanning / Psalm

DeprecatedMethod

The method OCP\IConfig::setAppValue has been marked as deprecated
tcitworldand others added 5 commits September 10, 2024 14:05
@tcitworld@come-nc
feat: Add mimetype into BeforePreviewFetchedEvent event
c2150bd
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
@tcitworld@come-nc
chore: Code cleanup in lib/private/Console/Application
82ba7d7
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
@CarlSchwan@come-nc
feat(user_ldap): Introduce user id assigned typed events for LDAP usage
986a3d4
Based on work from #32019
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
@tcitworld@come-nc
feat(admin_audit): Move admin_audit hooks to modern event listeners
f532d3b
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
@come-nc
chore(admin_audit): Fix License headers on new files
ec37338
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
@come-nc
come-ncforce-pushed the admin_audit/enh/move-to-event-listeners-v2 branch from f52dda0 to ec37338CompareSeptember 10, 2024 12:06
@come-nccome-nc added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Sep 10, 2024
@come-nc
come-nc marked this pull request as ready for review September 10, 2024 12:32
github-advanced-security[bot]
github-advanced-securityAI found potential problems Sep 10, 2024
View reviewed changes
Comment threadapps/admin_audit/lib/Listener/FileEventListener.php
*/
class FileEventListener extends Action implements IEventListener {
public function handle(Event $event): void {
if ($event instanceof BeforePreviewFetchedEvent) {

Check notice

Code scanning / Psalm

RedundantConditionGivenDocblockType

Docblock-defined type OCP\Preview\BeforePreviewFetchedEvent for $event is always OCP\Preview\BeforePreviewFetchedEvent
Comment threadapps/admin_audit/lib/Listener/FileEventListener.php Fixed
@come-nc
fix(admin_audit): Remove now unused methods and classes
957ac81
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
@come-nc
come-ncforce-pushed the admin_audit/enh/move-to-event-listeners-v2 branch from 01f9bb4 to 957ac81CompareSeptember 10, 2024 12:48
@come-nccome-nc added the pending documentation This pull request needs an associated documentation update label Sep 10, 2024
kesselb
kesselb approved these changes Sep 10, 2024
View reviewed changes
Comment threadapps/user_ldap/tests/AccessTest.php
Comment threadlib/public/User/Events/BeforeUserIdUnassignedEvent.php Outdated
Comment threadlib/public/User/Events/UserIdAssignedEvent.php Outdated
Comment threadlib/public/User/Events/UserIdUnassignedEvent.php Outdated
Comment threadlib/public/User/Events/UserIdAssignedEvent.php Outdated
Comment threadlib/public/User/Events/UserIdUnassignedEvent.php Outdated
Comment threadlib/public/User/Events/UserIdUnassignedEvent.php
Comment threadapps/admin_audit/lib/Listener/SecurityEventListener.php
public function handle(Event $event): void {
if ($event instanceof TwoFactorProviderChallengePassed) {
$this->twoFactorProviderChallengePassed($event);
} elseif ($event instanceof TwoFactorProviderChallengeFailed) {

@kesselbkesselbSep 10, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it's safe to ignore the psalm warning.
If you want to get rid of it, add "Event" to template-implements.

Comment threadlib/private/Preview/Generator.php
@come-nc
chore: Add descriptions for new events and fix copyright year
7d881b1
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
@come-nc
come-nc requested review from a team, artonge and icewind1991 and removed request for a teamSeptember 10, 2024 14:45
@come-nc
come-nc requested a review from nfebeSeptember 10, 2024 14:45
miaulalala
miaulalala approved these changes Sep 13, 2024
View reviewed changes

@miaulalalamiaulalala left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some nitpicks you could implement but don't have to. Otherwise LGTM.

Comment threadapps/admin_audit/lib/Listener/AppManagementEventListener.php
Comment threadapps/admin_audit/lib/Listener/AppManagementEventListener.php
Comment threadapps/admin_audit/lib/Listener/AuthEventListener.php
Comment threadapps/admin_audit/lib/Listener/GroupManagementEventListener.php
Comment threadapps/admin_audit/lib/Listener/SecurityEventListener.php
Comment threadapps/admin_audit/lib/Listener/SharingEventListener.php
Comment threadapps/admin_audit/lib/Listener/UserManagementEventListener.php
Comment threadlib/public/Preview/BeforePreviewFetchedEvent.php Outdated
Comment threadlib/public/Preview/BeforePreviewFetchedEvent.php Outdated
Comment threadlib/public/Preview/BeforePreviewFetchedEvent.php Outdated
@come-nc@miaulalala
fix: Fix phpdoc wording
d767455
Co-authored-by: Anna <anna@nextcloud.com>
Signed-off-by: Côme Chilliet <91878298+come-nc@users.noreply.github.com>
@come-nccome-nc added 4. to release Ready to be released and/or waiting for tests to finish and removed 3. to review Waiting for reviews labels Sep 13, 2024
@come-nc
come-nc merged commit dfa994e into masterSep 13, 2024
@come-nc
come-nc deleted the admin_audit/enh/move-to-event-listeners-v2 branch September 13, 2024 14:21
This was referenced Sep 13, 2024
Closed
Open
@kesselbkesselb mentioned this pull request Sep 16, 2024
Merged
7 tasks
@joshtrichardsjoshtrichards mentioned this pull request Sep 18, 2024
Closed
8 tasks
@skjnldsvskjnldsv mentioned this pull request Jan 7, 2025
Merged
@joshtrichardsjoshtrichards mentioned this pull request Feb 7, 2025
Merged
2 tasks
@susnuxsusnux mentioned this pull request Mar 12, 2025
Closed
@provokateurinprovokateurin mentioned this pull request Mar 25, 2025
Merged
@come-nccome-nc mentioned this pull request Apr 3, 2025
Merged
@come-nccome-nc removed the pending documentation This pull request needs an associated documentation update label Apr 3, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kesselbkesselbkesselb approved these changes
@miaulalalamiaulalalamiaulalala approved these changes
@susnuxsusnuxAwaiting requested review from susnux
@tcitworldtcitworldAwaiting requested review from tcitworld
@CarlSchwanCarlSchwanAwaiting requested review from CarlSchwan
@icewind1991icewind1991Awaiting requested review from icewind1991icewind1991 is a code owner automatically assigned from nextcloud/server-backend
@artongeartongeAwaiting requested review from artongeartonge is a code owner automatically assigned from nextcloud/server-backend
@nfebenfebeAwaiting requested review from nfebenfebe is a code owner automatically assigned from nextcloud/server-backend

Assignees

@come-nccome-nc

Labels

4. to releaseReady to be released and/or waiting for tests to finishtechnical debt🧱 🤔🚀

Projects

None yet

Milestone

Nextcloud 31

Development

Successfully merging this pull request may close these issues.

6 participants

@come-nc@kesselb@miaulalala@github-advanced-security@tcitworld@CarlSchwan