VladPolskiy/dokuwiki-plugin-oauth
1
0
Fork 0
mirror of https://github.com/cosmocode/dokuwiki-plugin-oauth.git synced 2025-07-26 15:53:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix overwrite-groups config

Browse Source 
This is a new implementation of the group handling introduced in #125

The previous implementation failed to preserve provider groups
properly. This also adds tests for the behaviour.
This commit is contained in:
Andreas Gohr
2022-10-12 12:37:54 +02:00
parent 406863f7dd
commit f81e58d4c2
2 changed files with 93 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
OAuthManager.php
View File

@ -239,12 +239,20 @@ class OAuthManager
if (!in_array($auth->cleanGroup($servicename), $localUserInfo['grps'])) {
throw new Exception('authnotenabled', [$servicename]);
}
$helper = plugin_load('helper', 'oauth');
$userdata['user'] = $localUser;
$userdata['name'] = $localUserInfo['name'];
$userdata['grps'] = $this->mergeGroups($localUserInfo['grps'], $userdata, $servicename, $auth->getConf('overwrite-groups'));
$userdata['grps'] = $this->mergeGroups(
$localUserInfo['grps'],
$userdata['grps'] ?? [],
array_keys($helper->listServices(false)),
$auth->getConf('overwrite-groups')
);
// update user
$auth->modifyUser($localUser, $userdata);
$auth->modifyUser($localUser, $userdata);
} elseif (actionOK('register') || $auth->getConf('register-on-auth')) {
if (!$auth->registerOAuthUser($userdata, $servicename)) {
throw new Exception('generic create error');
@ -260,33 +268,23 @@ class OAuthManager
* Merges local and provider user groups. Keeps internal
* Dokuwiki groups unless configured to overwrite all ('overwrite-groups' setting)
*
* @param array $localGroups Local user groups
* @param array $userdata User data from provider, may contain groups
* @param string $servicename
* @param string[] $localGroups Local user groups
* @param string[] $providerGroups Groups fetched from the provider
* @param string[] $servicenames Service names that should be kept if set
* @param bool $overwrite Config setting to overwrite local DokuWiki groups
*
* @return array
*/
protected function mergeGroups($localGroups, $userdata, $servicename, $overwrite)
protected function mergeGroups($localGroups, $providerGroups, $servicenames, $overwrite)
{
// no groups from provider, simply use local ones
if (empty($userdata['grps'])) {
return $localGroups;
}
// overwrite-groups set in config, use only groups from provider
if ($overwrite) {
return $userdata['grps'];
}
// otherwise keep reserved local groups and add those from provider
global $conf;
$helper = plugin_load('helper', 'oauth');
$services = $helper->listServices(false);
$localOauth = array_intersect($localGroups, array_keys($services));
$reservedLocal = array_merge([$conf['defaultgroup']], $localOauth);
return array_merge($userdata['grps'], $reservedLocal);
// overwrite-groups set in config - remove all local groups except services and default
if ($overwrite) {
$localGroups = array_intersect($localGroups, array_merge($servicenames, [$conf['defaultgroup']]));
}
return array_unique(array_merge($localGroups, $providerGroups));
}
/**

73
_test/MergeGroupsTest.php Normal file
View File

@ -0,0 +1,73 @@
<?php
namespace dokuwiki\plugin\oauth\test;
use dokuwiki\plugin\oauth\Exception;
use dokuwiki\plugin\oauth\OAuthManager;
use DokuWikiTest;
/**
* user data validation tests for the oauth plugin
*
* @group plugin_oauth
* @group plugins
*/
class MergeGroupsTest extends DokuWikiTest
{
protected $pluginsEnabled = ['oauth'];
/**
* @see testMergeGroups
*/
public function provideTestData()
{
return [
[
['hello', 'provider1', 'service', 'user'],
['provider1', 'provider2'],
['service', 'service2'],
false,
['hello', 'provider1', 'provider2', 'service', 'user']
],
[
['hello', 'provider1', 'service', 'user'],
['provider1', 'provider2'],
['service', 'service2'],
true,
['provider1', 'provider2', 'service', 'user']
],
[
['hello', 'provider1', 'service', 'user'],
[],
['service', 'service2'],
false,
['hello', 'provider1', 'service', 'user']
],
[
['hello', 'provider1', 'service', 'user'],
[],
['service', 'service2'],
true,
['service', 'user']
]
];
}
/**
* @dataProvider provideTestData
*/
public function testMergeGroups($localGroups, $providerGroups, $services, $overwrite, $expect)
{
$oauthMgr = new OAuthManager();
$result = $this->callInaccessibleMethod(
$oauthMgr, 'mergeGroups',
[$localGroups, $providerGroups, $services, $overwrite]
);
sort($expect);
sort($result);
$this->assertEquals($expect, $result);
}
}