Inject DBConnection

* Use query builder
* Minor unit tests additions
This commit is contained in:
Roeland Jago Douma 2015-12-30 14:16:51 +01:00
parent 53e37804ec
commit 3c8f4784e9
3 changed files with 173 additions and 82 deletions

View File

@ -53,6 +53,27 @@ class OC_Group_Database extends OC_Group_Backend {
/** @var string[] */ /** @var string[] */
private $groupCache = []; private $groupCache = [];
/** @var \OCP\IDBConnection */
private $dbConn;
/**
* OC_Group_Database constructor.
*
* @param \OCP\IDBConnection|null $dbConn
*/
public function __construct(\OCP\IDBConnection $dbConn = null) {
$this->dbConn = $dbConn;
}
/**
* FIXME: This function should not be required!
*/
private function fixDI() {
if ($this->dbConn === null) {
$this->dbConn = \OC::$server->getDatabaseConnection();
}
}
/** /**
* Try to create a new group * Try to create a new group
* @param string $gid The name of the group to create * @param string $gid The name of the group to create
@ -62,15 +83,20 @@ class OC_Group_Database extends OC_Group_Backend {
* be returned. * be returned.
*/ */
public function createGroup( $gid ) { public function createGroup( $gid ) {
$this->fixDI();
// Check cache first // Check cache first
if (isset($this->groupCache[$gid])) { if (isset($this->groupCache[$gid])) {
return false; return false;
} else { } else {
// Check for existence in DB // Check for existence in DB
$stmt = OC_DB::prepare( "SELECT `gid` FROM `*PREFIX*groups` WHERE `gid` = ?" ); $qb = $this->dbConn->getQueryBuilder();
$result = $stmt->execute( [$gid] ); $result = $qb->select('gid')
->from('groups')
->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
->execute();
if( $result->fetchRow() ) { if( $result->fetch() ) {
// Can not add an existing group // Can not add an existing group
// Add to cache // Add to cache
@ -81,8 +107,10 @@ class OC_Group_Database extends OC_Group_Backend {
} }
// Add group and exit // Add group and exit
$stmt = OC_DB::prepare( "INSERT INTO `*PREFIX*groups` ( `gid` ) VALUES( ? )" ); $qb = $this->dbConn->getQueryBuilder();
$result = $stmt->execute( [$gid] ); $result = $qb->insert('groups')
->setValue('gid', $qb->createNamedParameter($gid))
->execute();
if (!$result) { if (!$result) {
return false; return false;
@ -102,17 +130,25 @@ class OC_Group_Database extends OC_Group_Backend {
* Deletes a group and removes it from the group_user-table * Deletes a group and removes it from the group_user-table
*/ */
public function deleteGroup( $gid ) { public function deleteGroup( $gid ) {
$this->fixDI();
// Delete the group // Delete the group
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*groups` WHERE `gid` = ?" ); $qb = $this->dbConn->getQueryBuilder();
$stmt->execute( array( $gid )); $qb->delete('groups')
->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
->execute();
// Delete the group-user relation // Delete the group-user relation
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*group_user` WHERE `gid` = ?" ); $qb = $this->dbConn->getQueryBuilder();
$stmt->execute( array( $gid )); $qb->delete('group_user')
->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
->execute();
// Delete the group-groupadmin relation // Delete the group-groupadmin relation
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*group_admin` WHERE `gid` = ?" ); $qb = $this->dbConn->getQueryBuilder();
$stmt->execute( array( $gid )); $qb->delete('group_admin')
->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
->execute();
// Delete from cache // Delete from cache
unset($this->groupCache[$gid]); unset($this->groupCache[$gid]);
@ -129,11 +165,17 @@ class OC_Group_Database extends OC_Group_Backend {
* Checks whether the user is member of a group or not. * Checks whether the user is member of a group or not.
*/ */
public function inGroup( $uid, $gid ) { public function inGroup( $uid, $gid ) {
// check $this->fixDI();
$stmt = OC_DB::prepare( "SELECT `uid` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` = ?" );
$result = $stmt->execute( array( $gid, $uid ));
return $result->fetchRow() ? true : false; // check
$qb = $this->dbConn->getQueryBuilder();
$result = $qb->select('uid')
->from('group_user')
->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
->execute();
return $result->fetch() ? true : false;
} }
/** /**
@ -145,10 +187,15 @@ class OC_Group_Database extends OC_Group_Backend {
* Adds a user to a group. * Adds a user to a group.
*/ */
public function addToGroup( $uid, $gid ) { public function addToGroup( $uid, $gid ) {
$this->fixDI();
// No duplicate entries! // No duplicate entries!
if( !$this->inGroup( $uid, $gid )) { if( !$this->inGroup( $uid, $gid )) {
$stmt = OC_DB::prepare( "INSERT INTO `*PREFIX*group_user` ( `uid`, `gid` ) VALUES( ?, ? )" ); $qb = $this->dbConn->getQueryBuilder();
$stmt->execute( array( $uid, $gid )); $qb->insert('group_user')
->setValue('uid', $qb->createNamedParameter($uid))
->setValue('gid', $qb->createNamedParameter($gid))
->execute();
return true; return true;
}else{ }else{
return false; return false;
@ -164,8 +211,13 @@ class OC_Group_Database extends OC_Group_Backend {
* removes the user from a group. * removes the user from a group.
*/ */
public function removeFromGroup( $uid, $gid ) { public function removeFromGroup( $uid, $gid ) {
$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*group_user` WHERE `uid` = ? AND `gid` = ?" ); $this->fixDI();
$stmt->execute( array( $uid, $gid ));
$qb = $this->dbConn->getQueryBuilder();
$qb->delete('group_user')
->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
->execute();
return true; return true;
} }
@ -179,12 +231,17 @@ class OC_Group_Database extends OC_Group_Backend {
* if the user exists at all. * if the user exists at all.
*/ */
public function getUserGroups( $uid ) { public function getUserGroups( $uid ) {
$this->fixDI();
// No magic! // No magic!
$stmt = OC_DB::prepare( "SELECT `gid` FROM `*PREFIX*group_user` WHERE `uid` = ?" ); $qb = $this->dbConn->getQueryBuilder();
$result = $stmt->execute( array( $uid )); $result = $qb->select('gid')
->from('group_user')
->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
->execute();
$groups = []; $groups = [];
while( $row = $result->fetchRow()) { while( $row = $result->fetch()) {
$groups[] = $row["gid"]; $groups[] = $row["gid"];
$this->groupCache[$row['gid']] = $row['gid']; $this->groupCache[$row['gid']] = $row['gid'];
} }
@ -224,13 +281,21 @@ class OC_Group_Database extends OC_Group_Backend {
* @return bool * @return bool
*/ */
public function groupExists($gid) { public function groupExists($gid) {
$this->fixDI();
// Check cache first // Check cache first
if (isset($this->groupCache[$gid])) { if (isset($this->groupCache[$gid])) {
return true; return true;
} }
$query = OC_DB::prepare('SELECT `gid` FROM `*PREFIX*groups` WHERE `gid` = ?'); $qb = $this->dbConn->getQueryBuilder();
$result = $query->execute(array($gid))->fetchOne(); $cursor = $qb->select('gid')
->from('groups')
->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
->execute();
$result = $cursor->fetch();
$cursor->closeCursor();
if ($result !== false) { if ($result !== false) {
return true; return true;
} }

View File

@ -1,24 +1,28 @@
<?php <?php
/** /**
* ownCloud * @author Arthur Schiwon <blizzz@owncloud.com>
* * @author Felix Moeller <mail@felixmoeller.de>
* @author Robin Appelman * @author Joas Schilling <nickvergessen@owncloud.com>
* @copyright 2012 Robin Appelman icewind@owncloud.com * @author Robin Appelman <icewind@owncloud.com>
* * @author Scrutinizer Auto-Fixer <auto-fixer@scrutinizer-ci.com>
* This library is free software; you can redistribute it and/or * @author Thomas Müller <thomas.mueller@tmit.eu>
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE *
* License as published by the Free Software Foundation; either * @copyright Copyright (c) 2015, ownCloud, Inc.
* version 3 of the License, or any later version. * @license AGPL-3.0
* *
* This library is distributed in the hope that it will be useful, * This code is free software: you can redistribute it and/or modify
* but WITHOUT ANY WARRANTY; without even the implied warranty of * it under the terms of the GNU Affero General Public License, version 3,
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * as published by the Free Software Foundation.
* GNU AFFERO GENERAL PUBLIC LICENSE for more details. *
* * This program is distributed in the hope that it will be useful,
* You should have received a copy of the GNU Affero General Public * but WITHOUT ANY WARRANTY; without even the implied warranty of
* License along with this library. If not, see <http://www.gnu.org/licenses/>. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* * GNU Affero General Public License for more details.
*/ *
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
/** /**
* Class Test_Group_Backend * Class Test_Group_Backend
@ -34,10 +38,11 @@ abstract class Test_Group_Backend extends \Test\TestCase {
/** /**
* get a new unique group name * get a new unique group name
* test cases can override this in order to clean up created groups * test cases can override this in order to clean up created groups
*
* @return string * @return string
*/ */
public function getGroupName($name = null) { public function getGroupName($name = null) {
if(is_null($name)) { if (is_null($name)) {
return $this->getUniqueID('test_'); return $this->getUniqueID('test_');
} else { } else {
return $name; return $name;
@ -47,6 +52,7 @@ abstract class Test_Group_Backend extends \Test\TestCase {
/** /**
* get a new unique user name * get a new unique user name
* test cases can override this in order to clean up created user * test cases can override this in order to clean up created user
*
* @return string * @return string
*/ */
public function getUserName() { public function getUserName() {
@ -55,36 +61,36 @@ abstract class Test_Group_Backend extends \Test\TestCase {
public function testAddRemove() { public function testAddRemove() {
//get the number of groups we start with, in case there are exising groups //get the number of groups we start with, in case there are exising groups
$startCount=count($this->backend->getGroups()); $startCount = count($this->backend->getGroups());
$name1=$this->getGroupName(); $name1 = $this->getGroupName();
$name2=$this->getGroupName(); $name2 = $this->getGroupName();
$this->backend->createGroup($name1); $this->backend->createGroup($name1);
$count=count($this->backend->getGroups())-$startCount; $count = count($this->backend->getGroups()) - $startCount;
$this->assertEquals(1, $count); $this->assertEquals(1, $count);
$this->assertTrue((array_search($name1, $this->backend->getGroups())!==false)); $this->assertTrue((array_search($name1, $this->backend->getGroups()) !== false));
$this->assertFalse((array_search($name2, $this->backend->getGroups())!==false)); $this->assertFalse((array_search($name2, $this->backend->getGroups()) !== false));
$this->backend->createGroup($name2); $this->backend->createGroup($name2);
$count=count($this->backend->getGroups())-$startCount; $count = count($this->backend->getGroups()) - $startCount;
$this->assertEquals(2, $count); $this->assertEquals(2, $count);
$this->assertTrue((array_search($name1, $this->backend->getGroups())!==false)); $this->assertTrue((array_search($name1, $this->backend->getGroups()) !== false));
$this->assertTrue((array_search($name2, $this->backend->getGroups())!==false)); $this->assertTrue((array_search($name2, $this->backend->getGroups()) !== false));
$this->backend->deleteGroup($name2); $this->backend->deleteGroup($name2);
$count=count($this->backend->getGroups())-$startCount; $count = count($this->backend->getGroups()) - $startCount;
$this->assertEquals(1, $count); $this->assertEquals(1, $count);
$this->assertTrue((array_search($name1, $this->backend->getGroups())!==false)); $this->assertTrue((array_search($name1, $this->backend->getGroups()) !== false));
$this->assertFalse((array_search($name2, $this->backend->getGroups())!==false)); $this->assertFalse((array_search($name2, $this->backend->getGroups()) !== false));
} }
public function testUser() { public function testUser() {
$group1=$this->getGroupName(); $group1 = $this->getGroupName();
$group2=$this->getGroupName(); $group2 = $this->getGroupName();
$this->backend->createGroup($group1); $this->backend->createGroup($group1);
$this->backend->createGroup($group2); $this->backend->createGroup($group2);
$user1=$this->getUserName(); $user1 = $this->getUserName();
$user2=$this->getUserName(); $user2 = $this->getUserName();
$this->assertFalse($this->backend->inGroup($user1, $group1)); $this->assertFalse($this->backend->inGroup($user1, $group1));
$this->assertFalse($this->backend->inGroup($user2, $group1)); $this->assertFalse($this->backend->inGroup($user2, $group1));
@ -143,4 +149,11 @@ abstract class Test_Group_Backend extends \Test\TestCase {
$result = $this->backend->countUsersInGroup($group, 'bar'); $result = $this->backend->countUsersInGroup($group, 'bar');
$this->assertSame(2, $result); $this->assertSame(2, $result);
} }
public function testAddDouble() {
$group = $this->getGroupName();
$this->backend->createGroup($group);
$this->backend->createGroup($group);
}
} }

View File

@ -1,24 +1,27 @@
<?php <?php
/** /**
* ownCloud * @author Arthur Schiwon <blizzz@owncloud.com>
* * @author Joas Schilling <nickvergessen@owncloud.com>
* @author Robin Appelman * @author Robin Appelman <icewind@owncloud.com>
* @copyright 2012 Robin Appelman icewind@owncloud.com * @author Scrutinizer Auto-Fixer <auto-fixer@scrutinizer-ci.com>
* * @author Thomas Müller <thomas.mueller@tmit.eu>
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE * @copyright Copyright (c) 2015, ownCloud, Inc.
* License as published by the Free Software Foundation; either * @license AGPL-3.0
* version 3 of the License, or any later version. *
* * This code is free software: you can redistribute it and/or modify
* This library is distributed in the hope that it will be useful, * it under the terms of the GNU Affero General Public License, version 3,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * as published by the Free Software Foundation.
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU AFFERO GENERAL PUBLIC LICENSE for more details. * This program is distributed in the hope that it will be useful,
* * but WITHOUT ANY WARRANTY; without even the implied warranty of
* You should have received a copy of the GNU Affero General Public * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* License along with this library. If not, see <http://www.gnu.org/licenses/>. * GNU Affero General Public License for more details.
* *
*/ * You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
/** /**
* Class Test_Group_Database * Class Test_Group_Database
@ -26,11 +29,12 @@
* @group DB * @group DB
*/ */
class Test_Group_Database extends Test_Group_Backend { class Test_Group_Database extends Test_Group_Backend {
private $groups=array(); private $groups = array();
/** /**
* get a new unique group name * get a new unique group name
* test cases can override this in order to clean up created groups * test cases can override this in order to clean up created groups
*
* @return string * @return string
*/ */
public function getGroupName($name = null) { public function getGroupName($name = null) {
@ -41,13 +45,22 @@ class Test_Group_Database extends Test_Group_Backend {
protected function setUp() { protected function setUp() {
parent::setUp(); parent::setUp();
$this->backend=new OC_Group_Database(); $this->backend = new OC_Group_Database();
} }
protected function tearDown() { protected function tearDown() {
foreach($this->groups as $group) { foreach ($this->groups as $group) {
$this->backend->deleteGroup($group); $this->backend->deleteGroup($group);
} }
parent::tearDown(); parent::tearDown();
} }
public function testAddDoubleNoCache() {
$group = $this->getGroupName();
$this->backend->createGroup($group);
$backend = new OC_Group_Database();
$this->assertFalse($backend->createGroup($group));
}
} }