Merge pull request #1668 from nextcloud/user_ldap_use_appconfig

Do not query data that is already in the appconfig
This commit is contained in:
Morris Jobke 2016-10-10 15:37:44 +02:00 committed by GitHub
commit 2c6913ff9f
27 changed files with 165 additions and 61 deletions

View File

@ -32,7 +32,7 @@ OCP\JSON::checkAppEnabled('user_ldap');
OCP\JSON::callCheck(); OCP\JSON::callCheck();
$prefix = (string)$_POST['ldap_serverconfig_chooser']; $prefix = (string)$_POST['ldap_serverconfig_chooser'];
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
if($helper->deleteServerConfiguration($prefix)) { if($helper->deleteServerConfiguration($prefix)) {
OCP\JSON::success(); OCP\JSON::success();
} else { } else {

View File

@ -27,7 +27,7 @@ OCP\JSON::checkAdminUser();
OCP\JSON::checkAppEnabled('user_ldap'); OCP\JSON::checkAppEnabled('user_ldap');
OCP\JSON::callCheck(); OCP\JSON::callCheck();
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
$serverConnections = $helper->getServerConfigurationPrefixes(); $serverConnections = $helper->getServerConfigurationPrefixes();
sort($serverConnections); sort($serverConnections);
$lk = array_pop($serverConnections); $lk = array_pop($serverConnections);

View File

@ -60,7 +60,9 @@ $userManager = new \OCA\User_LDAP\User\Manager(
\OC::$server->getDatabaseConnection(), \OC::$server->getDatabaseConnection(),
\OC::$server->getUserManager()); \OC::$server->getUserManager());
$access = new \OCA\User_LDAP\Access($con, $ldapWrapper, $userManager, new \OCA\User_LDAP\Helper()); $access = new \OCA\User_LDAP\Access($con, $ldapWrapper, $userManager, new \OCA\User_LDAP\Helper(
\OC::$server->getConfig()
));
$wizard = new \OCA\User_LDAP\Wizard($configuration, $ldapWrapper, $access); $wizard = new \OCA\User_LDAP\Wizard($configuration, $ldapWrapper, $access);

View File

@ -27,7 +27,7 @@
* *
*/ */
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
$configPrefixes = $helper->getServerConfigurationPrefixes(true); $configPrefixes = $helper->getServerConfigurationPrefixes(true);
$ldapWrapper = new OCA\User_LDAP\LDAP(); $ldapWrapper = new OCA\User_LDAP\LDAP();
$ocConfig = \OC::$server->getConfig(); $ocConfig = \OC::$server->getConfig();

View File

@ -26,5 +26,5 @@ if($state === 'doSet') {
OCP\Config::setSystemValue('ldapIgnoreNamingRules', false); OCP\Config::setSystemValue('ldapIgnoreNamingRules', false);
} }
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
$helper->setLDAPProvider(); $helper->setLDAPProvider();

View File

@ -30,7 +30,7 @@ use OCA\User_LDAP\User\DeletedUsersIndex;
$dbConnection = \OC::$server->getDatabaseConnection(); $dbConnection = \OC::$server->getDatabaseConnection();
$userMapping = new UserMapping($dbConnection); $userMapping = new UserMapping($dbConnection);
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$ocConfig = \OC::$server->getConfig(); $ocConfig = \OC::$server->getConfig();
$uBackend = new User_Proxy( $uBackend = new User_Proxy(
$helper->getServerConfigurationPrefixes(true), $helper->getServerConfigurationPrefixes(true),

View File

@ -20,5 +20,5 @@
* *
*/ */
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
$helper->setLDAPProvider(); $helper->setLDAPProvider();

View File

@ -102,7 +102,7 @@ class Search extends Command {
} }
protected function execute(InputInterface $input, OutputInterface $output) { protected function execute(InputInterface $input, OutputInterface $output) {
$helper = new Helper(); $helper = new Helper($this->ocConfig);
$configPrefixes = $helper->getServerConfigurationPrefixes(true); $configPrefixes = $helper->getServerConfigurationPrefixes(true);
$ldapWrapper = new LDAP(); $ldapWrapper = new LDAP();

View File

@ -57,7 +57,7 @@ class SetConfig extends Command {
} }
protected function execute(InputInterface $input, OutputInterface $output) { protected function execute(InputInterface $input, OutputInterface $output) {
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$availableConfigs = $helper->getServerConfigurationPrefixes(); $availableConfigs = $helper->getServerConfigurationPrefixes();
$configID = $input->getArgument('configID'); $configID = $input->getArgument('configID');
if(!in_array($configID, $availableConfigs)) { if(!in_array($configID, $availableConfigs)) {

View File

@ -47,7 +47,7 @@ class TestConfig extends Command {
} }
protected function execute(InputInterface $input, OutputInterface $output) { protected function execute(InputInterface $input, OutputInterface $output) {
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$availableConfigs = $helper->getServerConfigurationPrefixes(); $availableConfigs = $helper->getServerConfigurationPrefixes();
$configID = $input->getArgument('configID'); $configID = $input->getArgument('configID');
if(!in_array($configID, $availableConfigs)) { if(!in_array($configID, $availableConfigs)) {

View File

@ -87,7 +87,7 @@ class Connection extends LDAPUtility {
if($memcache->isAvailable()) { if($memcache->isAvailable()) {
$this->cache = $memcache->create(); $this->cache = $memcache->create();
} }
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$this->doNotValidate = !in_array($this->configPrefix, $this->doNotValidate = !in_array($this->configPrefix,
$helper->getServerConfigurationPrefixes()); $helper->getServerConfigurationPrefixes());
$this->hasPagedResultSupport = $this->hasPagedResultSupport =

View File

@ -30,8 +30,22 @@
namespace OCA\User_LDAP; namespace OCA\User_LDAP;
use OCP\IConfig;
class Helper { class Helper {
/** @var IConfig */
private $config;
/**
* Helper constructor.
*
* @param IConfig $config
*/
public function __construct(IConfig $config) {
$this->config = $config;
}
/** /**
* returns prefixes for each saved LDAP/AD server configuration. * returns prefixes for each saved LDAP/AD server configuration.
* @param bool $activeConfigurations optional, whether only active configuration shall be * @param bool $activeConfigurations optional, whether only active configuration shall be
@ -55,30 +69,16 @@ class Helper {
public function getServerConfigurationPrefixes($activeConfigurations = false) { public function getServerConfigurationPrefixes($activeConfigurations = false) {
$referenceConfigkey = 'ldap_configuration_active'; $referenceConfigkey = 'ldap_configuration_active';
$sql = ' $keys = $this->getServersConfig($referenceConfigkey);
SELECT DISTINCT `configkey`
FROM `*PREFIX*appconfig`
WHERE `appid` = \'user_ldap\'
AND `configkey` LIKE ?
';
if($activeConfigurations) { $prefixes = [];
if (\OC::$server->getConfig()->getSystemValue( 'dbtype', 'sqlite' ) === 'oci') { foreach ($keys as $key) {
//FIXME oracle hack: need to explicitly cast CLOB to CHAR for comparison if ($activeConfigurations && $this->config->getAppValue('user_ldap', $key, '0') !== '1') {
$sql .= ' AND to_char(`configvalue`)=\'1\''; continue;
} else {
$sql .= ' AND `configvalue` = \'1\'';
} }
}
$stmt = \OCP\DB::prepare($sql); $len = strlen($key) - strlen($referenceConfigkey);
$prefixes[] = substr($key, 0, $len);
$serverConfigs = $stmt->execute(array('%'.$referenceConfigkey))->fetchAll();
$prefixes = array();
foreach($serverConfigs as $serverConfig) {
$len = strlen($serverConfig['configkey']) - strlen($referenceConfigkey);
$prefixes[] = substr($serverConfig['configkey'], 0, $len);
} }
return $prefixes; return $prefixes;
@ -93,20 +93,27 @@ class Helper {
public function getServerConfigurationHosts() { public function getServerConfigurationHosts() {
$referenceConfigkey = 'ldap_host'; $referenceConfigkey = 'ldap_host';
$query = ' $keys = $this->getServersConfig($referenceConfigkey);
SELECT DISTINCT `configkey`, `configvalue`
FROM `*PREFIX*appconfig`
WHERE `appid` = \'user_ldap\'
AND `configkey` LIKE ?
';
$query = \OCP\DB::prepare($query);
$configHosts = $query->execute(array('%'.$referenceConfigkey))->fetchAll();
$result = array();
foreach($configHosts as $configHost) { $result = array();
$len = strlen($configHost['configkey']) - strlen($referenceConfigkey); foreach($keys as $key) {
$prefix = substr($configHost['configkey'], 0, $len); $len = strlen($key) - strlen($referenceConfigkey);
$result[$prefix] = $configHost['configvalue']; $prefix = substr($key, 0, $len);
$result[$prefix] = $this->config->getAppValue('user_ldap', $key);
}
return $result;
}
private function getServersConfig($value) {
$regex = '/' . $value . '$/S';
$keys = $this->config->getAppKeys('user_ldap');
$result = [];
foreach ($keys as $key) {
if (preg_match($regex, $key) === 1) {
$result[] = $key;
}
} }
return $result; return $result;
@ -262,7 +269,7 @@ class Helper {
} }
//ain't it ironic? //ain't it ironic?
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$configPrefixes = $helper->getServerConfigurationPrefixes(true); $configPrefixes = $helper->getServerConfigurationPrefixes(true);
$ldapWrapper = new LDAP(); $ldapWrapper = new LDAP();

View File

@ -83,7 +83,7 @@ class CleanUp extends TimedJob {
if(isset($arguments['helper'])) { if(isset($arguments['helper'])) {
$this->ldapHelper = $arguments['helper']; $this->ldapHelper = $arguments['helper'];
} else { } else {
$this->ldapHelper = new Helper(); $this->ldapHelper = new Helper(\OC::$server->getConfig());
} }
if(isset($arguments['ocConfig'])) { if(isset($arguments['ocConfig'])) {

View File

@ -172,7 +172,7 @@ class UpdateGroups extends \OC\BackgroundJob\TimedJob {
if(!is_null(self::$groupBE)) { if(!is_null(self::$groupBE)) {
return self::$groupBE; return self::$groupBE;
} }
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$configPrefixes = $helper->getServerConfigurationPrefixes(true); $configPrefixes = $helper->getServerConfigurationPrefixes(true);
$ldapWrapper = new LDAP(); $ldapWrapper = new LDAP();
if(count($configPrefixes) === 1) { if(count($configPrefixes) === 1) {

View File

@ -52,7 +52,7 @@ class LDAPProviderFactory implements ILDAPProviderFactory {
public function getLDAPProvider() { public function getLDAPProvider() {
$dbConnection = $this->serverContainer->getDatabaseConnection(); $dbConnection = $this->serverContainer->getDatabaseConnection();
$userMapping = new UserMapping($dbConnection); $userMapping = new UserMapping($dbConnection);
return new LDAPProvider($this->serverContainer, new Helper(), return new LDAPProvider($this->serverContainer, new Helper($this->serverContainer->getConfig()),
new DeletedUsersIndex($this->serverContainer->getConfig(), new DeletedUsersIndex($this->serverContainer->getConfig(),
$dbConnection, $userMapping)); $dbConnection, $userMapping));
} }

View File

@ -77,7 +77,7 @@ abstract class Proxy {
$userManager = $userManager =
new Manager($ocConfig, $fs, $log, $avatarM, new \OCP\Image(), $db, $coreUserManager); new Manager($ocConfig, $fs, $log, $avatarM, new \OCP\Image(), $db, $coreUserManager);
$connector = new Connection($this->ldap, $configPrefix); $connector = new Connection($this->ldap, $configPrefix);
$access = new Access($connector, $this->ldap, $userManager, new Helper()); $access = new Access($connector, $this->ldap, $userManager, new Helper(\OC::$server->getConfig()));
$access->setUserMapper($userMap); $access->setUserMapper($userMap);
$access->setGroupMapper($groupMap); $access->setGroupMapper($groupMap);
self::$accesses[$configPrefix] = $access; self::$accesses[$configPrefix] = $access;

View File

@ -45,7 +45,7 @@ class Admin implements ISettings {
* @return TemplateResponse * @return TemplateResponse
*/ */
public function getForm() { public function getForm() {
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$prefixes = $helper->getServerConfigurationPrefixes(); $prefixes = $helper->getServerConfigurationPrefixes();
$hosts = $helper->getServerConfigurationHosts(); $hosts = $helper->getServerConfigurationHosts();

View File

@ -724,7 +724,7 @@ class Wizard extends LDAPUtility {
//this did not help :( //this did not help :(
//Let's see whether we can parse the Host URL and convert the domain to //Let's see whether we can parse the Host URL and convert the domain to
//a base DN //a base DN
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$domain = $helper->getDomainFromURL($this->configuration->ldapHost); $domain = $helper->getDomainFromURL($this->configuration->ldapHost);
if(!$domain) { if(!$domain) {
return false; return false;

View File

@ -67,7 +67,7 @@ class AccessTest extends \Test\TestCase {
$this->createMock(Image::class), $this->createMock(Image::class),
$this->createMock(IDBConnection::class), $this->createMock(IDBConnection::class),
$this->createMock(IUserManager::class))); $this->createMock(IUserManager::class)));
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
return array($lw, $connector, $um, $helper); return array($lw, $connector, $um, $helper);
} }

View File

@ -54,7 +54,7 @@ class Group_LDAPTest extends \Test\TestCase {
$um = $this->getMockBuilder('\OCA\User_LDAP\User\Manager') $um = $this->getMockBuilder('\OCA\User_LDAP\User\Manager')
->disableOriginalConstructor() ->disableOriginalConstructor()
->getMock(); ->getMock();
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
$access = $this->getMock('\OCA\User_LDAP\Access', $access = $this->getMock('\OCA\User_LDAP\Access',
$accMethods, $accMethods,
array($connector, $lw, $um, $helper)); array($connector, $lw, $um, $helper));

View File

@ -0,0 +1,95 @@
<?php
namespace OCA\User_LDAP\Tests;
use OCA\User_LDAP\Helper;
use OCP\IConfig;
class HelperTest extends \Test\TestCase {
/** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */
private $config;
/** @var Helper */
private $helper;
public function setUp() {
parent::setUp();
$this->config = $this->createMock(IConfig::class);
$this->helper = new Helper($this->config);
}
public function testGetServerConfigurationPrefixes() {
$this->config->method('getAppKeys')
->with($this->equalTo('user_ldap'))
->willReturn([
'foo',
'ldap_configuration_active',
's1ldap_configuration_active',
]);
$result = $this->helper->getServerConfigurationPrefixes(false);
$this->assertEquals(['', 's1'], $result);
}
public function testGetServerConfigurationPrefixesActive() {
$this->config->method('getAppKeys')
->with($this->equalTo('user_ldap'))
->willReturn([
'foo',
'ldap_configuration_active',
's1ldap_configuration_active',
]);
$this->config->method('getAppValue')
->will($this->returnCallback(function($app, $key, $default) {
if ($app !== 'user_ldap') {
$this->fail('wrong app');
}
if ($key === 's1ldap_configuration_active') {
return '1';
}
return $default;
}));
$result = $this->helper->getServerConfigurationPrefixes(true);
$this->assertEquals(['s1'], $result);
}
public function testGetServerConfigurationHost() {
$this->config->method('getAppKeys')
->with($this->equalTo('user_ldap'))
->willReturn([
'foo',
'ldap_host',
's1ldap_host',
's02ldap_host',
]);
$this->config->method('getAppValue')
->will($this->returnCallback(function($app, $key, $default) {
if ($app !== 'user_ldap') {
$this->fail('wrong app');
}
if ($key === 'ldap_host') {
return 'example.com';
}
if ($key === 's1ldap_host') {
return 'foo.bar.com';
}
return $default;
}));
$result = $this->helper->getServerConfigurationHosts();
$this->assertEquals([
'' => 'example.com',
's1' => 'foo.bar.com',
's02' => '',
], $result);
}
}

View File

@ -113,7 +113,7 @@ abstract class AbstractIntegrationTest {
* initializes the test Helper * initializes the test Helper
*/ */
protected function initHelper() { protected function initHelper() {
$this->helper = new Helper(); $this->helper = new Helper(\OC::$server->getConfig());
} }
/** /**

View File

@ -121,7 +121,7 @@ class LDAPProviderTest extends \Test\TestCase {
$server = $this->getServerMock($backend); $server = $this->getServerMock($backend);
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
$ldapProvider = $this->getLDAPProvider($server); $ldapProvider = $this->getLDAPProvider($server);
$this->assertEquals( $this->assertEquals(
@ -137,7 +137,7 @@ class LDAPProviderTest extends \Test\TestCase {
$server = $this->getServerMock($backend); $server = $this->getServerMock($backend);
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
$ldapProvider = $this->getLDAPProvider($server); $ldapProvider = $this->getLDAPProvider($server);
$this->assertEquals( $this->assertEquals(

View File

@ -55,7 +55,7 @@ class AdminTest extends TestCase {
*/ */
public function testGetForm() { public function testGetForm() {
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$prefixes = $helper->getServerConfigurationPrefixes(); $prefixes = $helper->getServerConfigurationPrefixes();
$hosts = $helper->getServerConfigurationHosts(); $hosts = $helper->getServerConfigurationHosts();

View File

@ -81,7 +81,7 @@ class UserTest extends \Test\TestCase {
$umMethods, array($cfMock, $fsMock, $logMock, $avaMgr, $im, $dbc, $userMgr)); $umMethods, array($cfMock, $fsMock, $logMock, $avaMgr, $im, $dbc, $userMgr));
$connector = $this->getMock('\OCA\User_LDAP\Connection', $connector = $this->getMock('\OCA\User_LDAP\Connection',
$conMethods, array($lw, null, null)); $conMethods, array($lw, null, null));
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
$access = $this->getMock('\OCA\User_LDAP\Access', $access = $this->getMock('\OCA\User_LDAP\Access',
$accMethods, array($connector, $lw, $um, $helper)); $accMethods, array($connector, $lw, $um, $helper));

View File

@ -97,7 +97,7 @@ class User_LDAPTest extends TestCase {
->method('getDeletedUser') ->method('getDeletedUser')
->will($this->returnValue($offlineUser)); ->will($this->returnValue($offlineUser));
$helper = new Helper(); $helper = new Helper(\OC::$server->getConfig());
$access = $this->getMockBuilder(Access::class) $access = $this->getMockBuilder(Access::class)
->setMethodsExcept(['getConnection']) ->setMethodsExcept(['getConnection'])

View File

@ -70,7 +70,7 @@ class WizardTest extends \Test\TestCase {
$um = $this->getMockBuilder('\OCA\User_LDAP\User\Manager') $um = $this->getMockBuilder('\OCA\User_LDAP\User\Manager')
->disableOriginalConstructor() ->disableOriginalConstructor()
->getMock(); ->getMock();
$helper = new \OCA\User_LDAP\Helper(); $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig());
$access = $this->getMock('\OCA\User_LDAP\Access', $access = $this->getMock('\OCA\User_LDAP\Access',
$accMethods, array($connector, $lw, $um, $helper)); $accMethods, array($connector, $lw, $um, $helper));