split db logic from settings manager

Signed-off-by: Robin Appelman <robin@icewind.nl>

3 files changed, 204 insertions, 142 deletions

diff --git a/lib/private/Settings/Admin/Encryption.php b/lib/private/Settings/Admin/Encryption.php
index 6e93407f1a3..63020c6bce7 100644
--- a/lib/private/Settings/Admin/Encryption.php
+++ b/lib/private/Settings/Admin/Encryption.php
@@ -23,23 +23,23 @@
 
 namespace OC\Settings\Admin;
 
-use OC\Encryption\Manager;
 use OCP\AppFramework\Http\TemplateResponse;
+use OCP\Encryption\IManager;
 use OCP\IUserManager;
 use OCP\Settings\ISettings;
 
 class Encryption implements ISettings {
-	/** @var Manager */
+	/** @var IManager */
 	private $manager;
 
 	/** @var IUserManager */
 	private $userManager;
 
 	/**
-	 * @param Manager $manager
+	 * @param IManager $manager
 	 * @param IUserManager $userManager
 	 */
-	public function __construct(Manager $manager, IUserManager $userManager) {
+	public function __construct(IManager $manager, IUserManager $userManager) {
 		$this->manager = $manager;
 		$this->userManager = $userManager;
 	}
diff --git a/lib/private/Settings/Manager.php b/lib/private/Settings/Manager.php
index 990750848d3..949826aa246 100644
--- a/lib/private/Settings/Manager.php
+++ b/lib/private/Settings/Manager.php
@@ -43,6 +43,8 @@ class Manager implements IManager {
 	private $log;
 	/** @var IDBConnection */
 	private $dbc;
+	/** @var Mapper */
+	private $mapper;
 	/** @var IL10N */
 	private $l;
 	/** @var IConfig */
@@ -62,6 +64,8 @@ class Manager implements IManager {
 	 * @param EncryptionManager $encryptionManager
 	 * @param IUserManager $userManager
 	 * @param ILockingProvider $lockingProvider
+	 * @param Mapper $mapper
+	 * @internal param IDBConnection $dbc
 	 */
 	public function __construct(
 		ILogger $log,
@@ -70,10 +74,12 @@ class Manager implements IManager {
 		IConfig $config,
 		EncryptionManager $encryptionManager,
 		IUserManager $userManager,
-		ILockingProvider $lockingProvider
+		ILockingProvider $lockingProvider,
+		Mapper $mapper
 	) {
 		$this->log = $log;
 		$this->dbc = $dbc;
+		$this->mapper = $mapper;
 		$this->l = $l;
 		$this->config = $config;
 		$this->encryptionManager = $encryptionManager;
@@ -85,10 +91,10 @@ class Manager implements IManager {
 	 * @inheritdoc
 	 */
 	public function setupSettings(array $settings) {
-		if(isset($settings[IManager::KEY_ADMIN_SECTION])) {
+		if (isset($settings[IManager::KEY_ADMIN_SECTION])) {
 			$this->setupAdminSection($settings[IManager::KEY_ADMIN_SECTION]);
 		}
-		if(isset($settings[IManager::KEY_ADMIN_SETTINGS])) {
+		if (isset($settings[IManager::KEY_ADMIN_SETTINGS])) {
 			$this->setupAdminSettings($settings[IManager::KEY_ADMIN_SETTINGS]);
 		}
 	}
@@ -104,50 +110,33 @@ class Manager implements IManager {
 	public function onAppDisabled($appId) {
 		$appInfo = \OC_App::getAppInfo($appId); // hello static legacy
 
-		if(isset($appInfo['settings'][IManager::KEY_ADMIN_SECTION])) {
-			$this->remove(self::TABLE_ADMIN_SECTIONS, trim($appInfo['settings'][IManager::KEY_ADMIN_SECTION], '\\'));
+		if (isset($appInfo['settings'][IManager::KEY_ADMIN_SECTION])) {
+			$this->mapper->remove(self::TABLE_ADMIN_SECTIONS, trim($appInfo['settings'][IManager::KEY_ADMIN_SECTION], '\\'));
 		}
-		if(isset($appInfo['settings'][IManager::KEY_ADMIN_SETTINGS])) {
-			$this->remove(self::TABLE_ADMIN_SETTINGS, trim($appInfo['settings'][IManager::KEY_ADMIN_SETTINGS], '\\'));
+		if (isset($appInfo['settings'][IManager::KEY_ADMIN_SETTINGS])) {
+			$this->mapper->remove(self::TABLE_ADMIN_SETTINGS, trim($appInfo['settings'][IManager::KEY_ADMIN_SETTINGS], '\\'));
 		}
 	}
 
 	public function checkForOrphanedClassNames() {
-		$tables = [ self::TABLE_ADMIN_SECTIONS, self::TABLE_ADMIN_SETTINGS ];
+		$tables = [self::TABLE_ADMIN_SECTIONS, self::TABLE_ADMIN_SETTINGS];
 		foreach ($tables as $table) {
-			$classes = $this->getClasses($table);
-			foreach($classes as $className) {
+			$classes = $this->mapper->getClasses($table);
+			foreach ($classes as $className) {
 				try {
 					\OC::$server->query($className);
 				} catch (QueryException $e) {
-					$this->remove($table, $className);
+					$this->mapper->remove($table, $className);
 				}
 			}
 		}
 	}
 
 	/**
-	 * returns the registerd classes in the given table
-	 *
-	 * @param $table
-	 * @return string[]
-	 */
-	private function getClasses($table) {
-		$q = $this->dbc->getQueryBuilder();
-		$resultStatement = $q->select('class')
-			->from($table)
-			->execute();
-		$data = $resultStatement->fetchAll();
-		$resultStatement->closeCursor();
-
-		return array_map(function($row) { return $row['class']; }, $data);
-	}
-
-	/**
 	 * @param string $sectionClassName
 	 */
 	private function setupAdminSection($sectionClassName) {
-		if(!class_exists($sectionClassName)) {
+		if (!class_exists($sectionClassName)) {
 			$this->log->debug('Could not find admin section class ' . $sectionClassName);
 			return;
 		}
@@ -158,14 +147,14 @@ class Manager implements IManager {
 			return;
 		}
 
-		if(!$section instanceof ISection) {
+		if (!$section instanceof ISection) {
 			$this->log->error(
 				'Admin section instance must implement \OCP\ISection. Invalid class: {class}',
 				['class' => $sectionClassName]
 			);
 			return;
 		}
-		if(!$this->hasAdminSection(get_class($section))) {
+		if (!$this->hasAdminSection(get_class($section))) {
 			$this->addAdminSection($section);
 		} else {
 			$this->updateAdminSection($section);
@@ -173,7 +162,7 @@ class Manager implements IManager {
 	}
 
 	private function addAdminSection(ISection $section) {
-		$this->add(self::TABLE_ADMIN_SECTIONS, [
+		$this->mapper->add(self::TABLE_ADMIN_SECTIONS, [
 			'id' => $section->getID(),
 			'class' => get_class($section),
 			'priority' => $section->getPriority(),
@@ -181,28 +170,15 @@ class Manager implements IManager {
 	}
 
 	private function addAdminSettings(ISettings $settings) {
-		$this->add(self::TABLE_ADMIN_SETTINGS, [
+		$this->mapper->add(self::TABLE_ADMIN_SETTINGS, [
 			'class' => get_class($settings),
 			'section' => $settings->getSection(),
 			'priority' => $settings->getPriority(),
 		]);
 	}
 
-	/**
-	 * @param string $table
-	 * @param array $values
-	 */
-	private function add($table, array $values) {
-		$query = $this->dbc->getQueryBuilder();
-		$values = array_map(function($value) use ($query) {
-			return $query->createNamedParameter($value);
-		}, $values);
-		$query->insert($table)->values($values);
-		$query->execute();
-	}
-
 	private function updateAdminSettings(ISettings $settings) {
-		$this->update(
+		$this->mapper->update(
 			self::TABLE_ADMIN_SETTINGS,
 			'class',
 			get_class($settings),
@@ -214,35 +190,23 @@ class Manager implements IManager {
 	}
 
 	private function updateAdminSection(ISection $section) {
-		$this->update(
+		$this->mapper->update(
 			self::TABLE_ADMIN_SECTIONS,
 			'class',
 			get_class($section),
 			[
-				'id'       => $section->getID(),
+				'id' => $section->getID(),
 				'priority' => $section->getPriority(),
 			]
 		);
 	}
 
-	private function update($table, $idCol, $id, $values) {
-		$query = $this->dbc->getQueryBuilder();
-		$query->update($table);
-		foreach($values as $key => $value) {
-			$query->set($key, $query->createNamedParameter($value));
-		}
-		$query
-			->where($query->expr()->eq($idCol, $query->createParameter($idCol)))
-			->setParameter($idCol, $id)
-			->execute();
-	}
-
 	/**
 	 * @param string $className
 	 * @return bool
 	 */
 	private function hasAdminSection($className) {
-		return $this->has(self::TABLE_ADMIN_SECTIONS, $className);
+		return $this->mapper->has(self::TABLE_ADMIN_SECTIONS, $className);
 	}
 
 	/**
@@ -250,44 +214,11 @@ class Manager implements IManager {
 	 * @return bool
 	 */
 	private function hasAdminSettings($className) {
-		return $this->has(self::TABLE_ADMIN_SETTINGS, $className);
-	}
-
-	/**
-	 * @param string $table
-	 * @param string $className
-	 * @return bool
-	 */
-	private function has($table, $className) {
-		$query = $this->dbc->getQueryBuilder();
-		$query->select('class')
-			->from($table)
-			->where($query->expr()->eq('class', $query->createNamedParameter($className)))
-			->setMaxResults(1);
-
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		return (bool) $row;
-	}
-
-	/**
-	 * deletes an settings or admin entry from the given table
-	 *
-	 * @param $table
-	 * @param $className
-	 */
-	private function remove($table, $className) {
-		$query = $this->dbc->getQueryBuilder();
-		$query->delete($table)
-			->where($query->expr()->eq('class', $query->createNamedParameter($className)));
-
-		$query->execute();
+		return $this->mapper->has(self::TABLE_ADMIN_SETTINGS, $className);
 	}
 
 	private function setupAdminSettings($settingsClassName) {
-		if(!class_exists($settingsClassName)) {
+		if (!class_exists($settingsClassName)) {
 			$this->log->debug('Could not find admin section class ' . $settingsClassName);
 			return;
 		}
@@ -300,14 +231,14 @@ class Manager implements IManager {
 			return;
 		}
 
-		if(!$settings instanceof ISettings) {
+		if (!$settings instanceof ISettings) {
 			$this->log->error(
 				'Admin section instance must implement \OCP\Settings\ISection. Invalid class: {class}',
 				['class' => $settingsClassName]
 			);
 			return;
 		}
-		if(!$this->hasAdminSettings(get_class($settings))) {
+		if (!$this->hasAdminSettings(get_class($settings))) {
 			$this->addAdminSettings($settings);
 		} else {
 			$this->updateAdminSettings($settings);
@@ -329,24 +260,17 @@ class Manager implements IManager {
 	public function getAdminSections() {
 		// built-in sections
 		$sections = [
-			 0 => [new Section('server',        $this->l->t('Server settings'), 0)],
-			 5 => [new Section('sharing',       $this->l->t('Sharing'), 0)],
-			45 => [new Section('encryption',    $this->l->t('Encryption'), 0)],
-			98 => [new Section('additional',    $this->l->t('Additional settings'), 0)],
-			99 => [new Section('tips-tricks',   $this->l->t('Tips & tricks'), 0)],
+			0 => [new Section('server', $this->l->t('Server settings'), 0)],
+			5 => [new Section('sharing', $this->l->t('Sharing'), 0)],
+			45 => [new Section('encryption', $this->l->t('Encryption'), 0)],
+			98 => [new Section('additional', $this->l->t('Additional settings'), 0)],
+			99 => [new Section('tips-tricks', $this->l->t('Tips & tricks'), 0)],
 		];
 
-		$query = $this->dbc->getQueryBuilder();
-		$query->selectDistinct('s.class')
-			->addSelect('s.priority')
-			->from(self::TABLE_ADMIN_SECTIONS, 's')
-			->from(self::TABLE_ADMIN_SETTINGS, 'f')
-			->where($query->expr()->eq('s.id', 'f.section'))
-		;
-		$result = $query->execute();
+		$rows = $this->mapper->getAdminSectionsFromDB();
 
-		while($row = $result->fetch()) {
-			if(!isset($sections[$row['priority']])) {
+		foreach ($rows as $row) {
+			if (!isset($sections[$row['priority']])) {
 				$sections[$row['priority']] = [];
 			}
 			try {
@@ -355,38 +279,42 @@ class Manager implements IManager {
 				// skip
 			}
 		}
-		$result->closeCursor();
 
 		ksort($sections);
+
 		return $sections;
 	}
 
+	/**
+	 * @param string $section
+	 * @return ISection[]
+	 */
 	private function getBuiltInAdminSettings($section) {
 		$forms = [];
 		try {
-			if($section === 'server') {
+			if ($section === 'server') {
 				/** @var ISettings $form */
 				$form = new Admin\Server($this->dbc, $this->config, $this->lockingProvider, $this->l);
 				$forms[$form->getPriority()] = [$form];
 				$form = new Admin\ServerDevNotice();
 				$forms[$form->getPriority()] = [$form];
 			}
-			if($section === 'encryption') {
+			if ($section === 'encryption') {
 				/** @var ISettings $form */
 				$form = new Admin\Encryption($this->encryptionManager, $this->userManager);
 				$forms[$form->getPriority()] = [$form];
 			}
-			if($section === 'sharing') {
+			if ($section === 'sharing') {
 				/** @var ISettings $form */
 				$form = new Admin\Sharing($this->config);
 				$forms[$form->getPriority()] = [$form];
 			}
-			if($section === 'additional') {
+			if ($section === 'additional') {
 				/** @var ISettings $form */
 				$form = new Admin\Additional($this->config);
 				$forms[$form->getPriority()] = [$form];
 			}
-			if($section === 'tips-tricks') {
+			if ($section === 'tips-tricks') {
 				/** @var ISettings $form */
 				$form = new Admin\TipsTricks($this->config);
 				$forms[$form->getPriority()] = [$form];
@@ -397,16 +325,15 @@ class Manager implements IManager {
 		return $forms;
 	}
 
-	private function getAdminSettingsFromDB($section, &$settings) {
-		$query = $this->dbc->getQueryBuilder();
-		$query->select(['class', 'priority'])
-			->from(self::TABLE_ADMIN_SETTINGS)
-			->where($query->expr()->eq('section', $this->dbc->getQueryBuilder()->createParameter('section')))
-			->setParameter('section', $section);
+	/**
+	 * @inheritdoc
+	 */
+	public function getAdminSettings($section) {
+		$settings = $this->getBuiltInAdminSettings($section);
+		$dbRows = $this->mapper->getAdminSettingsFromDB($section);
 
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			if(!isset($settings[$row['priority']])) {
+		foreach ($dbRows as $row) {
+			if (!isset($settings[$row['priority']])) {
 				$settings[$row['priority']] = [];
 			}
 			try {
@@ -415,17 +342,8 @@ class Manager implements IManager {
 				// skip
 			}
 		}
-		$result->closeCursor();
 
 		ksort($settings);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getAdminSettings($section) {
-		$settings = $this->getBuiltInAdminSettings($section);
-		$this->getAdminSettingsFromDB($section, $settings);
 		return $settings;
 	}
 }
diff --git a/lib/private/Settings/Mapper.php b/lib/private/Settings/Mapper.php
new file mode 100644
index 00000000000..9a7b3f64af2
--- /dev/null
+++ b/lib/private/Settings/Mapper.php
@@ -0,0 +1,144 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Robin Appelman <robin@icewind.nl>
+ *
+ * @author Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Settings;
+
+use OCP\IDBConnection;
+
+class Mapper {
+	const TABLE_ADMIN_SETTINGS = 'admin_settings';
+	const TABLE_ADMIN_SECTIONS = 'admin_sections';
+
+	/** @var IDBConnection */
+	private $dbc;
+
+	/**
+	 * @param IDBConnection $dbc
+	 */
+	public function __construct(IDBConnection $dbc) {
+		$this->dbc = $dbc;
+	}
+
+	public function getAdminSettingsFromDB($section) {
+		$query = $this->dbc->getQueryBuilder();
+		$query->select(['class', 'priority'])
+			->from(self::TABLE_ADMIN_SETTINGS)
+			->where($query->expr()->eq('section', $this->dbc->getQueryBuilder()->createParameter('section')))
+			->setParameter('section', $section);
+
+		$result = $query->execute();
+		return $result->fetchAll();
+	}
+
+	public function getAdminSectionsFromDB() {
+		$query = $this->dbc->getQueryBuilder();
+		$query->selectDistinct('s.class')
+			->addSelect('s.priority')
+			->from(self::TABLE_ADMIN_SECTIONS, 's')
+			->from(self::TABLE_ADMIN_SETTINGS, 'f')
+			->where($query->expr()->eq('s.id', 'f.section'));
+		$result = $query->execute();
+		return array_map(function ($row) {
+			$row['priority'] = (int)$row['priority'];
+			return $row;
+		}, $result->fetchAll());
+	}
+
+	/**
+	 * @param string $table
+	 * @param array $values
+	 */
+	public function add($table, array $values) {
+		$query = $this->dbc->getQueryBuilder();
+		$values = array_map(function ($value) use ($query) {
+			return $query->createNamedParameter($value);
+		}, $values);
+		$query->insert($table)->values($values);
+		$query->execute();
+	}
+
+	/**
+	 * returns the registered classes in the given table
+	 *
+	 * @param $table
+	 * @return string[]
+	 */
+	public function getClasses($table) {
+		$q = $this->dbc->getQueryBuilder();
+		$resultStatement = $q->select('class')
+			->from($table)
+			->execute();
+		$data = $resultStatement->fetchAll();
+		$resultStatement->closeCursor();
+
+		return array_map(function ($row) {
+			return $row['class'];
+		}, $data);
+	}
+
+	/**
+	 * @param string $table
+	 * @param string $className
+	 * @return bool
+	 */
+	public function has($table, $className) {
+		$query = $this->dbc->getQueryBuilder();
+		$query->select('class')
+			->from($table)
+			->where($query->expr()->eq('class', $query->createNamedParameter($className)))
+			->setMaxResults(1);
+
+		$result = $query->execute();
+		$row = $result->fetch();
+		$result->closeCursor();
+
+		return (bool)$row;
+	}
+
+	/**
+	 * deletes an settings or admin entry from the given table
+	 *
+	 * @param $table
+	 * @param $className
+	 */
+	public function remove($table, $className) {
+		$query = $this->dbc->getQueryBuilder();
+		$query->delete($table)
+			->where($query->expr()->eq('class', $query->createNamedParameter($className)));
+
+		$query->execute();
+	}
+
+	public function update($table, $idCol, $id, $values) {
+		$query = $this->dbc->getQueryBuilder();
+		$query->update($table);
+		foreach ($values as $key => $value) {
+			$query->set($key, $query->createNamedParameter($value));
+		}
+		$query
+			->where($query->expr()->eq($idCol, $query->createParameter($idCol)))
+			->setParameter($idCol, $id)
+			->execute();
+	}
+
+}