Skip to content

Internal: Normalize roles (ROLE_*), derive status from roles; fix teacher picker & admin menu #6792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2025
Merged

Internal: Normalize roles (ROLE_*), derive status from roles; fix teacher picker & admin menu #6792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions public/main/admin/user_add.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,7 @@ function updateStatus(){
$template = isset($user['email_template_option']) ? $user['email_template_option'] : [];

$roles = $user['roles'] ?? [];
$roles = array_values(array_unique(array_map('api_normalize_role_code', $roles)));
$status = api_status_from_roles($roles);
if ((int) ($user['admin']['platform_admin'] ?? 0) === 1) {
$status = COURSEMANAGER;
Expand Down Expand Up @@ -467,13 +468,20 @@ function updateStatus(){
}

$repo = Container::getUserRepository();
/* @var User $userEntity */
$userEntity = $repo->find($user_id);

if ($userEntity) {
$userEntity->setRoles($roles);
$repo->updateUser($userEntity);
}

if (api_has_admin_role($roles)) {
UserManager::addUserAsAdmin($userEntity);
} else {
UserManager::removeUserAdmin($userEntity);
}

$extraFieldValues = new ExtraFieldValue('user');
$user['item_id'] = $user_id;
$extraFieldValues->saveFieldValues($user);
Expand Down
8 changes: 8 additions & 0 deletions public/main/admin/user_edit.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,7 @@ function confirmation(name) {
}

$roles = $user['roles'] ?? [];
$roles = array_values(array_unique(array_map('api_normalize_role_code', $roles)));
$newStatus = api_status_from_roles($roles);
if ($newStatus === DRH && CourseManager::is_user_subscribed_in_course((int) $user_id)) {
$error_drh = true;
Expand Down Expand Up @@ -556,12 +557,19 @@ function confirmation(name) {
}

$repo = Container::getUserRepository();
/* @var User $userEntity */
$userEntity = $repo->find($user_id);
if ($userEntity) {
$userEntity->setRoles($roles);
$repo->updateUser($userEntity);
}

if (api_has_admin_role($roles)) {
UserManager::addUserAsAdmin($userEntity);
} else {
UserManager::removeUserAdmin($userEntity);
}

$extraFieldValue = new ExtraFieldValue('user');
$extraFieldValue->saveFieldValues($user);
$userInfo = api_get_user_info($user_id);
Expand Down
55 changes: 37 additions & 18 deletions public/main/inc/lib/api.lib.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6425,39 +6425,58 @@ function api_get_roles(): array
/**
* Normalizes a role code to canonical "ROLE_*" uppercase form.
*/
function api_normalize_role_code(string $code): string
{
$code = strtoupper(trim($code));
return str_starts_with($code, 'ROLE_') ? $code : 'ROLE_'.$code;
function api_normalize_role_code(string $code): string {
$c = strtoupper(trim($code));
$map = [
'STUDENT' => 'ROLE_STUDENT',
'TEACHER' => 'ROLE_TEACHER',
'HR' => 'ROLE_HR',
'SESSION_MANAGER' => 'ROLE_SESSION_MANAGER',
'STUDENT_BOSS' => 'ROLE_STUDENT_BOSS',
'INVITEE' => 'ROLE_INVITEE',
'QUESTION_MANAGER' => 'ROLE_QUESTION_MANAGER',
'ADMIN' => 'ROLE_ADMIN',
'GLOBAL_ADMIN' => 'ROLE_GLOBAL_ADMIN',
'SUPER_ADMIN' => 'ROLE_GLOBAL_ADMIN',
'ROLE_SUPER_ADMIN' => 'ROLE_GLOBAL_ADMIN',
];
if (!str_starts_with($c, 'ROLE_')) {
return $map[$c] ?? ('ROLE_'.$c);
}
return $map[$c] ?? $c;
}

/**
* Priority when deriving legacy status from roles (first match wins).
*/
function api_roles_priority(): array
{
function api_roles_priority(): array {
return [
'ROLE_GLOBAL_ADMIN',
'ROLE_ADMIN',
'ROLE_SESSION_MANAGER',
'ROLE_HR',
'ROLE_TEACHER',
'ROLE_HR',
'ROLE_STUDENT_BOSS',
'ROLE_INVITEE',
'ROLE_STUDENT',
];
}

/**
* Canonical role -> legacy status map.
*/
function api_role_status_map(): array
{
function api_has_admin_role(array $roles): bool {
$n = array_map('api_normalize_role_code', $roles);
return in_array('ROLE_ADMIN', $n, true) || in_array('ROLE_GLOBAL_ADMIN', $n, true);
}

function api_role_status_map(): array {
return [
'ROLE_SESSION_MANAGER' => SESSIONADMIN,
'ROLE_HR' => DRH,
'ROLE_TEACHER' => COURSEMANAGER,
'ROLE_STUDENT_BOSS' => STUDENT_BOSS,
'ROLE_INVITEE' => INVITEE,
'ROLE_STUDENT' => STUDENT,
'ROLE_GLOBAL_ADMIN' => COURSEMANAGER, // 1
'ROLE_ADMIN' => COURSEMANAGER, // 1
'ROLE_SESSION_MANAGER'=> COURSEMANAGER, // 1
'ROLE_TEACHER' => COURSEMANAGER, // 1
'ROLE_HR' => DRH, // 4
'ROLE_STUDENT_BOSS' => STUDENT_BOSS,
'ROLE_INVITEE' => INVITEE,
'ROLE_STUDENT' => STUDENT, // 5 (fallback)
];
}

Expand Down
38 changes: 32 additions & 6 deletions public/main/install/install.lib.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1546,19 +1546,45 @@ function finishInstallationWithContainer(
->setTimezone($timezone)
;

$existingRoles = method_exists($admin, 'getRoles') ? $admin->getRoles() : [];
$normalized = array_map('api_normalize_role_code', $existingRoles);
$mustHave = ['ROLE_ADMIN', 'ROLE_GLOBAL_ADMIN'];
$roles = array_values(array_unique(array_merge($normalized, $mustHave)));

$admin->setRoles($roles);
$repo->updateUser($admin);

if (in_array('ROLE_ADMIN', $roles, true) || in_array('ROLE_GLOBAL_ADMIN', $roles, true)) {
UserManager::addUserAsAdmin($admin);
} else {
UserManager::removeUserAdmin($admin);
}

/** @var User $anonUser */
$anonUser = $repo->findOneBy(['username' => 'anon']);
$anonUser->addAuthSourceByAuthentication(UserAuthSource::PLATFORM, $accessUrl);

$repo->updateUser($anonUser);
if ($anonUser) {
$anonUser->addAuthSourceByAuthentication(UserAuthSource::PLATFORM, $accessUrl);
$anonRoles = method_exists($anonUser, 'getRoles') ? (array) $anonUser->getRoles() : [];
if (empty($anonRoles)) {
$anonUser->setRoles(['ROLE_USER']);
} else {
$anonUser->setRoles(array_values(array_unique(array_map('api_normalize_role_code', $anonRoles))));
}
$repo->updateUser($anonUser);
}

/** @var User $fallbackUser */
$fallbackUser = $repo->findOneBy(['username' => 'fallback_user']);
$fallbackUser->addAuthSourceByAuthentication(UserAuthSource::PLATFORM, $accessUrl);

$repo->updateUser($fallbackUser);
if ($fallbackUser) {
$fallbackUser->addAuthSourceByAuthentication(UserAuthSource::PLATFORM, $accessUrl);
$fallbackRoles = method_exists($fallbackUser, 'getRoles') ? $fallbackUser->getRoles() : [];
if (empty($fallbackRoles)) {
$fallbackUser->setRoles(['ROLE_USER']);
} else {
$fallbackUser->setRoles(array_values(array_unique(array_map('api_normalize_role_code', $fallbackRoles))));
}
$repo->updateUser($fallbackUser);
}

// Set default language
Database::update(
Expand Down
Loading