BookStack/app/Auth/Access/ExternalAuthService.php

76 lines
2.4 KiB
PHP
Raw Normal View History

2019-08-07 06:07:21 -04:00
<?php namespace BookStack\Auth\Access;
use BookStack\Auth\Role;
use BookStack\Auth\User;
2019-08-07 09:31:10 -04:00
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
2019-08-07 06:07:21 -04:00
class ExternalAuthService
{
/**
* Check a role against an array of group names to see if it matches.
* Checked against role 'external_auth_id' if set otherwise the name of the role.
*/
protected function roleMatchesGroupNames(Role $role, array $groupNames): bool
2019-08-07 06:07:21 -04:00
{
if ($role->external_auth_id) {
return $this->externalIdMatchesGroupNames($role->external_auth_id, $groupNames);
2019-08-07 06:07:21 -04:00
}
$roleName = str_replace(' ', '-', trim(strtolower($role->display_name)));
return in_array($roleName, $groupNames);
}
/**
* Check if the given external auth ID string matches one of the given group names.
*/
protected function externalIdMatchesGroupNames(string $externalId, array $groupNames): bool
{
$externalAuthIds = explode(',', strtolower($externalId));
foreach ($externalAuthIds as $externalAuthId) {
if (in_array(trim($externalAuthId), $groupNames)) {
return true;
}
}
return false;
}
2019-08-07 06:07:21 -04:00
/**
* Match an array of group names to BookStack system roles.
* Formats group names to be lower-case and hyphenated.
*/
protected function matchGroupsToSystemsRoles(array $groupNames): Collection
2019-08-07 06:07:21 -04:00
{
foreach ($groupNames as $i => $groupName) {
$groupNames[$i] = str_replace(' ', '-', trim(strtolower($groupName)));
}
$roles = Role::query()->get(['id', 'external_auth_id', 'display_name']);
2019-08-07 06:07:21 -04:00
$matchedRoles = $roles->filter(function (Role $role) use ($groupNames) {
return $this->roleMatchesGroupNames($role, $groupNames);
});
return $matchedRoles->pluck('id');
}
/**
* Sync the groups to the user roles for the current user
*/
public function syncWithGroups(User $user, array $userGroups): void
2019-08-07 06:07:21 -04:00
{
// Get the ids for the roles from the names
2019-08-07 09:31:10 -04:00
$groupsAsRoles = $this->matchGroupsToSystemsRoles($userGroups);
2019-08-07 06:07:21 -04:00
// Sync groups
if ($this->config['remove_from_groups']) {
2019-08-07 09:31:10 -04:00
$user->roles()->sync($groupsAsRoles);
$user->attachDefaultRole();
2019-08-07 06:07:21 -04:00
} else {
2019-08-07 09:31:10 -04:00
$user->roles()->syncWithoutDetaching($groupsAsRoles);
2019-08-07 06:07:21 -04:00
}
}
}