Page MenuHomeWickedGov Phorge
Files F4071272

UserGroupsHookHandler.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

UserGroupsHookHandler.php
View Options

<?php
namespace MediaWiki\Extension\CentralAuth\Hooks\Handlers;
use MediaWiki\Config\Config;
use MediaWiki\Context\DerivativeContext;
use MediaWiki\Extension\CentralAuth\CentralAuthAutomaticGlobalGroupManager;
use MediaWiki\Extension\CentralAuth\GlobalGroup\GlobalGroupLookup;
use MediaWiki\Extension\CentralAuth\Special\SpecialGlobalGroupMembership;
use MediaWiki\Extension\CentralAuth\User\CentralAuthUser;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Permissions\UltimateAuthority;
use MediaWiki\Title\TitleFactory;
use MediaWiki\User\Hook\UserGroupsChangedHook;
use MediaWiki\User\UserNamePrefixSearch;
use MediaWiki\User\UserNameUtils;
class UserGroupsHookHandler implements UserGroupsChangedHook {
private TitleFactory $titleFactory;
private UserNamePrefixSearch $userNamePrefixSearch;
private UserNameUtils $userNameUtils;
private CentralAuthAutomaticGlobalGroupManager $automaticGroupManager;
private GlobalGroupLookup $globalGroupLookup;
public function __construct(
Config $config,
TitleFactory $titleFactory,
UserNamePrefixSearch $userNamePrefixSearch,
UserNameUtils $userNameUtils,
CentralAuthAutomaticGlobalGroupManager $automaticGroupManager,
GlobalGroupLookup $globalGroupLookup
) {
$this->titleFactory = $titleFactory;
$this->userNamePrefixSearch = $userNamePrefixSearch;
$this->userNameUtils = $userNameUtils;
$this->automaticGroupManager = $automaticGroupManager;
$this->globalGroupLookup = $globalGroupLookup;
}
/**
* Add users to (or remove users from) global groups, if configured to do so.
*
* @inheritDoc
*/
public function onUserGroupsChanged(
$user,
$added,
$removed,
$performer,
$reason,
$oldUGMs,
$newUGMs
) {
$globalUser = CentralAuthUser::getPrimaryInstance( $user );
if ( !( $globalUser->exists() && $globalUser->isAttached() ) ) {
return;
}
// Clear cache for CentralAuthUser::getLocalGroups()
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
$cache->delete( $cache->makeGlobalKey( 'centralauthuser-getlocalgroups', $globalUser->getId() ) );
// T387523: Return if no performer is set to avoid throwing an exception, which occurs when
// the user is autopromoted into a group through $wgAutopromoteOnce. Updating automatic
// global groups on autopromote is not supported.
if ( !$performer ) {
return;
}
// To do: Have a service that the special page, APIs and hook handler call: T270857
$specialPage = new SpecialGlobalGroupMembership(
$this->titleFactory,
$this->userNamePrefixSearch,
$this->userNameUtils,
$this->automaticGroupManager,
$this->globalGroupLookup
);
// Automatic global groups must be updated, even if this user does not have
// the rights to do so. Do now rather than via a maintenance script so that
// the change is made immediately and the performer who changed the local
// group is logged.
$context = new DerivativeContext( $specialPage->getContext() );
$context->setAuthority( new UltimateAuthority( $performer ) );
$specialPage->setContext( $context );
// Automatic global groups are managed in ::doSaveUserGroups.
$reason = Message::newFromKey( 'centralauth-automatic-global-groups-reason-local' )
->inContentLanguage()
->text();
$specialPage->doSaveUserGroups(
$globalUser,
[],
[],
$reason
);
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 17 2026, 03:26 (11 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
7c/34/8d0951c8dd7e377817fa066a8a6e
Default Alt Text
UserGroupsHookHandler.php (3 KB)

Event Timeline