Skip to content
Snippets Groups Projects
Commit 811f6804 authored by Bart Visscher's avatar Bart Visscher
Browse files

Merge pull request #4623 from owncloud/convert-oc_preferences 

Convert OC_Preference to object interface
parents 28918d61 0a2a4cb1
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
lib/db.php
+ 5
− 1
View file @ 811f6804
...@@ -87,6 +87,7 @@ class OC_DB { ...@@ -87,6 +87,7 @@ class OC_DB {
'driver' => 'pdo_sqlite', 'driver' => 'pdo_sqlite',
); );
$connectionParams['adapter'] = '\OC\DB\AdapterSqlite'; $connectionParams['adapter'] = '\OC\DB\AdapterSqlite';
$connectionParams['wrapperClass'] = 'OC\DB\Connection';
break; break;
case 'mysql': case 'mysql':
$connectionParams = array( $connectionParams = array(
...@@ -99,6 +100,7 @@ class OC_DB { ...@@ -99,6 +100,7 @@ class OC_DB {
'driver' => 'pdo_mysql', 'driver' => 'pdo_mysql',
); );
$connectionParams['adapter'] = '\OC\DB\Adapter'; $connectionParams['adapter'] = '\OC\DB\Adapter';
$connectionParams['wrapperClass'] = 'OC\DB\Connection';
break; break;
case 'pgsql': case 'pgsql':
$connectionParams = array( $connectionParams = array(
...@@ -110,6 +112,7 @@ class OC_DB { ...@@ -110,6 +112,7 @@ class OC_DB {
'driver' => 'pdo_pgsql', 'driver' => 'pdo_pgsql',
); );
$connectionParams['adapter'] = '\OC\DB\AdapterPgSql'; $connectionParams['adapter'] = '\OC\DB\AdapterPgSql';
$connectionParams['wrapperClass'] = 'OC\DB\Connection';
break; break;
case 'oci': case 'oci':
$connectionParams = array( $connectionParams = array(
...@@ -124,6 +127,7 @@ class OC_DB { ...@@ -124,6 +127,7 @@ class OC_DB {
$connectionParams['port'] = $port; $connectionParams['port'] = $port;
} }
$connectionParams['adapter'] = '\OC\DB\AdapterOCI8'; $connectionParams['adapter'] = '\OC\DB\AdapterOCI8';
$connectionParams['wrapperClass'] = 'OC\DB\OracleConnection';
$eventManager->addEventSubscriber(new \Doctrine\DBAL\Event\Listeners\OracleSessionInit); $eventManager->addEventSubscriber(new \Doctrine\DBAL\Event\Listeners\OracleSessionInit);
break; break;
case 'mssql': case 'mssql':
...@@ -137,11 +141,11 @@ class OC_DB { ...@@ -137,11 +141,11 @@ class OC_DB {
'driver' => 'pdo_sqlsrv', 'driver' => 'pdo_sqlsrv',
); );
$connectionParams['adapter'] = '\OC\DB\AdapterSQLSrv'; $connectionParams['adapter'] = '\OC\DB\AdapterSQLSrv';
$connectionParams['wrapperClass'] = 'OC\DB\Connection';
break; break;
default: default:
return false; return false;
} }
$connectionParams['wrapperClass'] = 'OC\DB\Connection';
$connectionParams['tablePrefix'] = OC_Config::getValue('dbtableprefix', 'oc_' ); $connectionParams['tablePrefix'] = OC_Config::getValue('dbtableprefix', 'oc_' );
try { try {
self::$connection = \Doctrine\DBAL\DriverManager::getConnection($connectionParams, $config, $eventManager); self::$connection = \Doctrine\DBAL\DriverManager::getConnection($connectionParams, $config, $eventManager);
......
lib/db/oracleconnection.php 0 → 100644
+ 50
− 0
View file @ 811f6804
<?php
/**
* Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OC\DB;
class OracleConnection extends Connection {
/**
* Quote the keys of the array
*/
private function quoteKeys(array $data) {
$return = array();
foreach($data as $key => $value) {
$return[$this->quoteIdentifier($key)] = $value;
}
return $return;
}
/*
* {@inheritDoc}
*/
public function insert($tableName, array $data, array $types = array()) {
$tableName = $this->quoteIdentifier($tableName);
$data = $this->quoteKeys($data);
return parent::insert($tableName, $data, $types);
}
/*
* {@inheritDoc}
*/
public function update($tableName, array $data, array $identifier, array $types = array()) {
$tableName = $this->quoteIdentifier($tableName);
$data = $this->quoteKeys($data);
$identifier = $this->quoteKeys($identifier);
return parent::update($tableName, $data, $identifier, $types);
}
/*
* {@inheritDoc}
*/
public function delete($tableName, array $identifier) {
$tableName = $this->quoteIdentifier($tableName);
$identifier = $this->quoteKeys($identifier);
return parent::delete($tableName, $identifier);
}
}
lib/legacy/preferences.php 0 → 100644
+ 146
− 0
View file @ 811f6804
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @author Jakob Sack
* @copyright 2012 Frank Karlitschek frank@owncloud.org
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* This class provides an easy way for storing user preferences.
*/
OC_Preferences::$object = new \OC\Preferences(OC_DB::getConnection());
class OC_Preferences{
public static $object;
/**
* @brief Get all users using the preferences
* @return array with user ids
*
* This function returns a list of all users that have at least one entry
* in the preferences table.
*/
public static function getUsers() {
return self::$object->getUsers();
}
/**
* @brief Get all apps of a user
* @param string $user user
* @return array with app ids
*
* This function returns a list of all apps of the user that have at least
* one entry in the preferences table.
*/
public static function getApps( $user ) {
return self::$object->getApps( $user );
}
/**
* @brief Get the available keys for an app
* @param string $user user
* @param string $app the app we are looking for
* @return array with key names
*
* This function gets all keys of an app of an user. Please note that the
* values are not returned.
*/
public static function getKeys( $user, $app ) {
return self::$object->getKeys( $user, $app );
}
/**
* @brief Gets the preference
* @param string $user user
* @param string $app app
* @param string $key key
* @param string $default = null, default value if the key does not exist
* @return string the value or $default
*
* This function gets a value from the preferences table. If the key does
* not exist the default value will be returned
*/
public static function getValue( $user, $app, $key, $default = null ) {
return self::$object->getValue( $user, $app, $key, $default );
}
/**
* @brief sets a value in the preferences
* @param string $user user
* @param string $app app
* @param string $key key
* @param string $value value
* @return bool
*
* Adds a value to the preferences. If the key did not exist before, it
* will be added automagically.
*/
public static function setValue( $user, $app, $key, $value ) {
self::$object->setValue( $user, $app, $key, $value );
return true;
}
/**
* @brief Deletes a key
* @param string $user user
* @param string $app app
* @param string $key key
*
* Deletes a key.
*/
public static function deleteKey( $user, $app, $key ) {
self::$object->deleteKey( $user, $app, $key );
return true;
}
/**
* @brief Remove app of user from preferences
* @param string $user user
* @param string $app app
* @return bool
*
* Removes all keys in preferences belonging to the app and the user.
*/
public static function deleteApp( $user, $app ) {
self::$object->deleteApp( $user, $app );
return true;
}
/**
* @brief Remove user from preferences
* @param string $user user
* @return bool
*
* Removes all keys in preferences belonging to the user.
*/
public static function deleteUser( $user ) {
self::$object->deleteUser( $user );
return true;
}
/**
* @brief Remove app from all users
* @param string $app app
* @return bool
*
* Removes all keys in preferences belonging to the app.
*/
public static function deleteAppFromAllUsers( $app ) {
self::$object->deleteAppFromAllUsers( $app );
return true;
}
}
lib/preferences.php
+ 81
− 72
View file @ 811f6804
...@@ -34,10 +34,21 @@ ...@@ -34,10 +34,21 @@
* *
*/ */
namespace OC;
use \OC\DB\Connection;
/** /**
* This class provides an easy way for storing user preferences. * This class provides an easy way for storing user preferences.
*/ */
class OC_Preferences{ class Preferences {
protected $conn;
public function __construct(Connection $conn) {
$this->conn = $conn;
}
/** /**
* @brief Get all users using the preferences * @brief Get all users using the preferences
* @return array with user ids * @return array with user ids
...@@ -45,14 +56,13 @@ class OC_Preferences{ ...@@ -45,14 +56,13 @@ class OC_Preferences{
* This function returns a list of all users that have at least one entry * This function returns a list of all users that have at least one entry
* in the preferences table. * in the preferences table.
*/ */
public static function getUsers() { public function getUsers() {
// No need for more comments $query = 'SELECT DISTINCT `userid` FROM `*PREFIX*preferences`';
$query = OC_DB::prepare( 'SELECT DISTINCT( `userid` ) FROM `*PREFIX*preferences`' ); $result = $this->conn->executeQuery( $query );
$result = $query->execute();
$users = array(); $users = array();
while( $row = $result->fetchRow()) { while( $userid = $result->fetchColumn()) {
$users[] = $row["userid"]; $users[] = $userid;
} }
return $users; return $users;
...@@ -66,14 +76,13 @@ class OC_Preferences{ ...@@ -66,14 +76,13 @@ class OC_Preferences{
* This function returns a list of all apps of the user that have at least * This function returns a list of all apps of the user that have at least
* one entry in the preferences table. * one entry in the preferences table.
*/ */
public static function getApps( $user ) { public function getApps( $user ) {
// No need for more comments $query = 'SELECT DISTINCT `appid` FROM `*PREFIX*preferences` WHERE `userid` = ?';
$query = OC_DB::prepare( 'SELECT DISTINCT( `appid` ) FROM `*PREFIX*preferences` WHERE `userid` = ?' ); $result = $this->conn->executeQuery( $query, array( $user ) );
$result = $query->execute( array( $user ));
$apps = array(); $apps = array();
while( $row = $result->fetchRow()) { while( $appid = $result->fetchColumn()) {
$apps[] = $row["appid"]; $apps[] = $appid;
} }
return $apps; return $apps;
...@@ -88,14 +97,13 @@ class OC_Preferences{ ...@@ -88,14 +97,13 @@ class OC_Preferences{
* This function gets all keys of an app of an user. Please note that the * This function gets all keys of an app of an user. Please note that the
* values are not returned. * values are not returned.
*/ */
public static function getKeys( $user, $app ) { public function getKeys( $user, $app ) {
// No need for more comments $query = 'SELECT `configkey` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ?';
$query = OC_DB::prepare( 'SELECT `configkey` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ?' ); $result = $this->conn->executeQuery( $query, array( $user, $app ));
$result = $query->execute( array( $user, $app ));
$keys = array(); $keys = array();
while( $row = $result->fetchRow()) { while( $key = $result->fetchColumn()) {
$keys[] = $row["configkey"]; $keys[] = $key;
} }
return $keys; return $keys;
...@@ -112,16 +120,14 @@ class OC_Preferences{ ...@@ -112,16 +120,14 @@ class OC_Preferences{
* This function gets a value from the preferences table. If the key does * This function gets a value from the preferences table. If the key does
* not exist the default value will be returned * not exist the default value will be returned
*/ */
public static function getValue( $user, $app, $key, $default = null ) { public function getValue( $user, $app, $key, $default = null ) {
// Try to fetch the value, return default if not exists. // Try to fetch the value, return default if not exists.
$query = OC_DB::prepare( 'SELECT `configvalue` FROM `*PREFIX*preferences`' $query = 'SELECT `configvalue` FROM `*PREFIX*preferences`'
.' WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?' ); .' WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
$result = $query->execute( array( $user, $app, $key )); $row = $this->conn->fetchAssoc( $query, array( $user, $app, $key ));
$row = $result->fetchRow();
if($row) { if($row) {
return $row["configvalue"]; return $row["configvalue"];
}else{ } else {
return $default; return $default;
} }
} }
...@@ -132,29 +138,36 @@ class OC_Preferences{ ...@@ -132,29 +138,36 @@ class OC_Preferences{
* @param string $app app * @param string $app app
* @param string $key key * @param string $key key
* @param string $value value * @param string $value value
* @return bool
* *
* Adds a value to the preferences. If the key did not exist before, it * Adds a value to the preferences. If the key did not exist before, it
* will be added automagically. * will be added automagically.
*/ */
public static function setValue( $user, $app, $key, $value ) { public function setValue( $user, $app, $key, $value ) {
// Check if the key does exist // Check if the key does exist
$query = OC_DB::prepare( 'SELECT `configvalue` FROM `*PREFIX*preferences`' $query = 'SELECT COUNT(*) FROM `*PREFIX*preferences`'
.' WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?' ); .' WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
$values=$query->execute(array($user, $app, $key))->fetchAll(); $count = $this->conn->fetchColumn( $query, array( $user, $app, $key ));
$exists=(count($values)>0); $exists = $count > 0;
if( !$exists ) { if( !$exists ) {
$query = OC_DB::prepare( 'INSERT INTO `*PREFIX*preferences`' $data = array(
.' ( `userid`, `appid`, `configkey`, `configvalue` ) VALUES( ?, ?, ?, ? )' ); 'userid' => $user,
$query->execute( array( $user, $app, $key, $value )); 'appid' => $app,
'configkey' => $key,
'configvalue' => $value,
);
$this->conn->insert('*PREFIX*preferences', $data);
} else {
$data = array(
'configvalue' => $value,
);
$where = array(
'userid' => $user,
'appid' => $app,
'configkey' => $key,
);
$this->conn->update('*PREFIX*preferences', $data, $where);
} }
else{
$query = OC_DB::prepare( 'UPDATE `*PREFIX*preferences` SET `configvalue` = ?'
.' WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?' );
$query->execute( array( $value, $user, $app, $key ));
}
return true;
} }
/** /**
...@@ -162,62 +175,58 @@ class OC_Preferences{ ...@@ -162,62 +175,58 @@ class OC_Preferences{
* @param string $user user * @param string $user user
* @param string $app app * @param string $app app
* @param string $key key * @param string $key key
* @return bool
* *
* Deletes a key. * Deletes a key.
*/ */
public static function deleteKey( $user, $app, $key ) { public function deleteKey( $user, $app, $key ) {
// No need for more comments $where = array(
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*preferences`' 'userid' => $user,
.' WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?' ); 'appid' => $app,
$query->execute( array( $user, $app, $key )); 'configkey' => $key,
);
return true; $this->conn->delete('*PREFIX*preferences', $where);
} }
/** /**
* @brief Remove app of user from preferences * @brief Remove app of user from preferences
* @param string $user user * @param string $user user
* @param string $app app * @param string $app app
* @return bool
* *
* Removes all keys in appconfig belonging to the app and the user. * Removes all keys in preferences belonging to the app and the user.
*/ */
public static function deleteApp( $user, $app ) { public function deleteApp( $user, $app ) {
// No need for more comments $where = array(
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ?' ); 'userid' => $user,
$query->execute( array( $user, $app )); 'appid' => $app,
);
return true; $this->conn->delete('*PREFIX*preferences', $where);
} }
/** /**
* @brief Remove user from preferences * @brief Remove user from preferences
* @param string $user user * @param string $user user
* @return bool
* *
* Removes all keys in appconfig belonging to the user. * Removes all keys in preferences belonging to the user.
*/ */
public static function deleteUser( $user ) { public function deleteUser( $user ) {
// No need for more comments $where = array(
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*preferences` WHERE `userid` = ?' ); 'userid' => $user,
$query->execute( array( $user )); );
$this->conn->delete('*PREFIX*preferences', $where);
return true;
} }
/** /**
* @brief Remove app from all users * @brief Remove app from all users
* @param string $app app * @param string $app app
* @return bool
* *
* Removes all keys in preferences belonging to the app. * Removes all keys in preferences belonging to the app.
*/ */
public static function deleteAppFromAllUsers( $app ) { public function deleteAppFromAllUsers( $app ) {
// No need for more comments $where = array(
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*preferences` WHERE `appid` = ?' ); 'appid' => $app,
$query->execute( array( $app )); );
$this->conn->delete('*PREFIX*preferences', $where);
return true;
} }
} }
require_once __DIR__.'/legacy/'.basename(__FILE__);
tests/lib/preferences.php
+ 179
− 0
View file @ 811f6804
<?php <?php
/** /**
* Copyright (c) 2013 Christopher Schäpers <christopher@schaepers.it> * Copyright (c) 2013 Christopher Schäpers <christopher@schaepers.it>
* Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
* This file is licensed under the Affero General Public License version 3 or * This file is licensed under the Affero General Public License version 3 or
* later. * later.
* See the COPYING-README file. * See the COPYING-README file.
...@@ -124,3 +125,181 @@ class Test_Preferences extends PHPUnit_Framework_TestCase { ...@@ -124,3 +125,181 @@ class Test_Preferences extends PHPUnit_Framework_TestCase {
$this->assertEquals(0, $result->numRows()); $this->assertEquals(0, $result->numRows());
} }
} }
class Test_Preferences_Object extends PHPUnit_Framework_TestCase {
public function testGetUsers()
{
$statementMock = $this->getMock('\Doctrine\DBAL\Statement', array(), array(), '', false);
$statementMock->expects($this->exactly(2))
->method('fetchColumn')
->will($this->onConsecutiveCalls('foo', false));
$connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false);
$connectionMock->expects($this->once())
->method('executeQuery')
->with($this->equalTo('SELECT DISTINCT `userid` FROM `*PREFIX*preferences`'))
->will($this->returnValue($statementMock));
$preferences = new OC\Preferences($connectionMock);
$apps = $preferences->getUsers();
$this->assertEquals(array('foo'), $apps);
}
public function testGetApps()
{
$statementMock = $this->getMock('\Doctrine\DBAL\Statement', array(), array(), '', false);
$statementMock->expects($this->exactly(2))
->method('fetchColumn')
->will($this->onConsecutiveCalls('foo', false));
$connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false);
$connectionMock->expects($this->once())
->method('executeQuery')
->with($this->equalTo('SELECT DISTINCT `appid` FROM `*PREFIX*preferences` WHERE `userid` = ?'),
$this->equalTo(array('bar')))
->will($this->returnValue($statementMock));
$preferences = new OC\Preferences($connectionMock);
$apps = $preferences->getApps('bar');
$this->assertEquals(array('foo'), $apps);
}
public function testGetKeys()
{
$statementMock = $this->getMock('\Doctrine\DBAL\Statement', array(), array(), '', false);
$statementMock->expects($this->exactly(2))
->method('fetchColumn')
->will($this->onConsecutiveCalls('foo', false));
$connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false);
$connectionMock->expects($this->once())
->method('executeQuery')
->with($this->equalTo('SELECT `configkey` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ?'),
$this->equalTo(array('bar', 'moo')))
->will($this->returnValue($statementMock));
$preferences = new OC\Preferences($connectionMock);
$keys = $preferences->getKeys('bar', 'moo');
$this->assertEquals(array('foo'), $keys);
}
public function testGetValue()
{
$connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false);
$connectionMock->expects($this->exactly(2))
->method('fetchAssoc')
->with($this->equalTo('SELECT `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'),
$this->equalTo(array('grg', 'bar', 'red')))
->will($this->onConsecutiveCalls(array('configvalue'=>'foo'), null));
$preferences = new OC\Preferences($connectionMock);
$value = $preferences->getValue('grg', 'bar', 'red');
$this->assertEquals('foo', $value);
$value = $preferences->getValue('grg', 'bar', 'red', 'def');
$this->assertEquals('def', $value);
}
public function testSetValue()
{
$connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false);
$connectionMock->expects($this->exactly(2))
->method('fetchColumn')
->with($this->equalTo('SELECT COUNT(*) FROM `*PREFIX*preferences`'
.' WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'),
$this->equalTo(array('grg', 'bar', 'foo')))
->will($this->onConsecutiveCalls(0, 1));
$connectionMock->expects($this->once())
->method('insert')
->with($this->equalTo('*PREFIX*preferences'),
$this->equalTo(
array(
'userid' => 'grg',
'appid' => 'bar',
'configkey' => 'foo',
'configvalue' => 'v1',
)
));
$connectionMock->expects($this->once())
->method('update')
->with($this->equalTo('*PREFIX*preferences'),
$this->equalTo(
array(
'configvalue' => 'v2',
)),
$this->equalTo(
array(
'userid' => 'grg',
'appid' => 'bar',
'configkey' => 'foo',
)
));
$preferences = new OC\Preferences($connectionMock);
$preferences->setValue('grg', 'bar', 'foo', 'v1');
$preferences->setValue('grg', 'bar', 'foo', 'v2');
}
public function testDeleteKey()
{
$connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false);
$connectionMock->expects($this->once())
->method('delete')
->with($this->equalTo('*PREFIX*preferences'),
$this->equalTo(
array(
'userid' => 'grg',
'appid' => 'bar',
'configkey' => 'foo',
)
));
$preferences = new OC\Preferences($connectionMock);
$preferences->deleteKey('grg', 'bar', 'foo');
}
public function testDeleteApp()
{
$connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false);
$connectionMock->expects($this->once())
->method('delete')
->with($this->equalTo('*PREFIX*preferences'),
$this->equalTo(
array(
'userid' => 'grg',
'appid' => 'bar',
)
));
$preferences = new OC\Preferences($connectionMock);
$preferences->deleteApp('grg', 'bar');
}
public function testDeleteUser()
{
$connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false);
$connectionMock->expects($this->once())
->method('delete')
->with($this->equalTo('*PREFIX*preferences'),
$this->equalTo(
array(
'userid' => 'grg',
)
));
$preferences = new OC\Preferences($connectionMock);
$preferences->deleteUser('grg');
}
public function testDeleteAppFromAllUsers()
{
$connectionMock = $this->getMock('\OC\DB\Connection', array(), array(), '', false);
$connectionMock->expects($this->once())
->method('delete')
->with($this->equalTo('*PREFIX*preferences'),
$this->equalTo(
array(
'appid' => 'bar',
)
));
$preferences = new OC\Preferences($connectionMock);
$preferences->deleteAppFromAllUsers('bar');
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment