nextcloud / server

lib/private/Settings/Manager.php

Doc Comments +6 added lines

@@ -273,6 +273,9 @@ 
 		return $this->mapper->has($table, 'section', $sectionId);
 	}
 
+	/**
+	 * @param string $type
+	 */
 	private function setupSettingsEntry($settingsClassName, $type) {
 		if (!class_exists($settingsClassName)) {
 			$this->log->debug('Could not find ' . $type . ' section class ' . $settingsClassName);
@@ -302,6 +305,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $type
+	 */
 	private function getSectionTableForType($type) {
 		if($type === 'admin') {
 			return Mapper::TABLE_ADMIN_SECTIONS;

Indentation +484 added lines, -484 removed lines

@@ -42,488 +42,488 @@
 use OCP\Settings\ISection;
 
 class Manager implements IManager {
-	/** @var ILogger */
-	private $log;
-	/** @var IDBConnection */
-	private $dbc;
-	/** @var Mapper */
-	private $mapper;
-	/** @var IL10N */
-	private $l;
-	/** @var IConfig */
-	private $config;
-	/** @var EncryptionManager */
-	private $encryptionManager;
-	/** @var IUserManager */
-	private $userManager;
-	/** @var ILockingProvider */
-	private $lockingProvider;
-	/** @var IRequest */
-	private $request;
-	/** @var IURLGenerator */
-	private $url;
-	/** @var AccountManager */
-	private $accountManager;
-	/** @var IGroupManager */
-	private $groupManager;
-	/** @var IFactory */
-	private $l10nFactory;
-	/** @var \OC_Defaults */
-	private $defaults;
-	/** @var IAppManager */
-	private $appManager;
-
-	/**
-	 * @param ILogger $log
-	 * @param IDBConnection $dbc
-	 * @param IL10N $l
-	 * @param IConfig $config
-	 * @param EncryptionManager $encryptionManager
-	 * @param IUserManager $userManager
-	 * @param ILockingProvider $lockingProvider
-	 * @param IRequest $request
-	 * @param Mapper $mapper
-	 * @param IURLGenerator $url
-	 * @param AccountManager $accountManager
-	 * @param IGroupManager $groupManager
-	 * @param IFactory $l10nFactory
-	 * @param \OC_Defaults $defaults
-	 */
-	public function __construct(
-		ILogger $log,
-		IDBConnection $dbc,
-		IL10N $l,
-		IConfig $config,
-		EncryptionManager $encryptionManager,
-		IUserManager $userManager,
-		ILockingProvider $lockingProvider,
-		IRequest $request,
-		Mapper $mapper,
-		IURLGenerator $url,
-		AccountManager $accountManager,
-		IGroupManager $groupManager,
-		IFactory $l10nFactory,
-		\OC_Defaults $defaults,
-		IAppManager $appManager
-	) {
-		$this->log = $log;
-		$this->dbc = $dbc;
-		$this->mapper = $mapper;
-		$this->l = $l;
-		$this->config = $config;
-		$this->encryptionManager = $encryptionManager;
-		$this->userManager = $userManager;
-		$this->lockingProvider = $lockingProvider;
-		$this->request = $request;
-		$this->url = $url;
-		$this->accountManager = $accountManager;
-		$this->groupManager = $groupManager;
-		$this->l10nFactory = $l10nFactory;
-		$this->defaults = $defaults;
-		$this->appManager = $appManager;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function setupSettings(array $settings) {
-		if (isset($settings[IManager::KEY_ADMIN_SECTION])) {
-			$this->setupSectionEntry($settings[IManager::KEY_ADMIN_SECTION], 'admin');
-		}
-		if (isset($settings[IManager::KEY_ADMIN_SETTINGS])) {
-			$this->setupSettingsEntry($settings[IManager::KEY_ADMIN_SETTINGS], 'admin');
-		}
-
-		if (isset($settings[IManager::KEY_PERSONAL_SECTION])) {
-			$this->setupSectionEntry($settings[IManager::KEY_PERSONAL_SECTION], 'personal');
-		}
-		if (isset($settings[IManager::KEY_PERSONAL_SETTINGS])) {
-			$this->setupSettingsEntry($settings[IManager::KEY_PERSONAL_SETTINGS], 'personal');
-		}
-	}
-
-	/**
-	 * attempts to remove an apps section and/or settings entry. A listener is
-	 * added centrally making sure that this method is called ones an app was
-	 * disabled.
-	 *
-	 * @param string $appId
-	 * @since 9.1.0
-	 */
-	public function onAppDisabled($appId) {
-		$appInfo = \OC_App::getAppInfo($appId); // hello static legacy
-
-		if (isset($appInfo['settings'][IManager::KEY_ADMIN_SECTION])) {
-			$this->mapper->remove(Mapper::TABLE_ADMIN_SECTIONS, trim($appInfo['settings'][IManager::KEY_ADMIN_SECTION], '\\'));
-		}
-		if (isset($appInfo['settings'][IManager::KEY_ADMIN_SETTINGS])) {
-			$this->mapper->remove(Mapper::TABLE_ADMIN_SETTINGS, trim($appInfo['settings'][IManager::KEY_ADMIN_SETTINGS], '\\'));
-		}
-
-		if (isset($appInfo['settings'][IManager::KEY_PERSONAL_SECTION])) {
-			$this->mapper->remove(Mapper::TABLE_PERSONAL_SECTIONS, trim($appInfo['settings'][IManager::KEY_PERSONAL_SECTION], '\\'));
-		}
-		if (isset($appInfo['settings'][IManager::KEY_PERSONAL_SETTINGS])) {
-			$this->mapper->remove(Mapper::TABLE_PERSONAL_SETTINGS, trim($appInfo['settings'][IManager::KEY_PERSONAL_SETTINGS], '\\'));
-		}
-	}
-
-	public function checkForOrphanedClassNames() {
-		$tables = [Mapper::TABLE_ADMIN_SECTIONS, Mapper::TABLE_ADMIN_SETTINGS, Mapper::TABLE_PERSONAL_SECTIONS, Mapper::TABLE_PERSONAL_SETTINGS];
-		foreach ($tables as $table) {
-			$classes = $this->mapper->getClasses($table);
-			foreach ($classes as $className) {
-				try {
-					\OC::$server->query($className);
-				} catch (QueryException $e) {
-					$this->mapper->remove($table, $className);
-				}
-			}
-		}
-	}
-
-	/**
-	 * @param string $sectionClassName
-	 * @param string $type either 'admin' or 'personal'
-	 */
-	private function setupSectionEntry($sectionClassName, $type) {
-		if (!class_exists($sectionClassName)) {
-			$this->log->debug('Could not find ' . ucfirst($type) . ' section class ' . $sectionClassName);
-			return;
-		}
-		try {
-			$section = $this->query($sectionClassName);
-		} catch (QueryException $e) {
-			// cancel
-			return;
-		}
-
-		if (!$section instanceof ISection) {
-			$this->log->error(
-				ucfirst($type) .' section instance must implement \OCP\ISection. Invalid class: {class}',
-				['class' => $sectionClassName]
-			);
-			return;
-		}
-		$table = $this->getSectionTableForType($type);
-		if(!$this->hasSection($section->getID(), $table)) {
-			$this->addSection($section, $table);
-		} else {
-			$this->updateSection($section, $table);
-		}
-	}
-
-	private function addSection(ISection $section, $table) {
-		$this->mapper->add($table, [
-			'id' => $section->getID(),
-			'class' => get_class($section),
-			'priority' => $section->getPriority(),
-		]);
-	}
-
-	private function addSettings(ISettings $settings, $table) {
-		$this->mapper->add($table, [
-			'class' => get_class($settings),
-			'section' => $settings->getSection(),
-			'priority' => $settings->getPriority(),
-		]);
-	}
-
-	private function updateSettings(ISettings $settings, $table) {
-		$this->mapper->update(
-			$table,
-			'section',
-			$settings->getSection(),
-			[
-				'class' => get_class($settings),
-				'priority' => $settings->getPriority(),
-			]
-		);
-	}
-
-	private function updateSection(ISection $section, $table) {
-		$this->mapper->update(
-			$table,
-			'id',
-			$section->getID(),
-			[
-				'class' => get_class($section),
-				'priority' => $section->getPriority(),
-			]
-		);
-	}
-
-	/**
-	 * @param string $sectionId
-	 * @param string $table
-	 *
-	 * @return bool
-	 */
-	private function hasSection($sectionId, $table) {
-		return $this->mapper->has($table, 'id', $sectionId);
-	}
-
-	/**
-	 * @param string $sectionId
-	 * @param $table
-	 *
-	 * @return bool
-	 */
-	private function hasSettings($sectionId, $table) {
-		return $this->mapper->has($table, 'section', $sectionId);
-	}
-
-	private function setupSettingsEntry($settingsClassName, $type) {
-		if (!class_exists($settingsClassName)) {
-			$this->log->debug('Could not find ' . $type . ' section class ' . $settingsClassName);
-			return;
-		}
-
-		try {
-			/** @var ISettings $settings */
-			$settings = $this->query($settingsClassName);
-		} catch (QueryException $e) {
-			// cancel
-			return;
-		}
-
-		if (!$settings instanceof ISettings) {
-			$this->log->error(
-				ucfirst($type) . ' section instance must implement \OCP\Settings\ISettings. Invalid class: {class}',
-				['class' => $settingsClassName]
-			);
-			return;
-		}
-		$table = $this->getSettingsTableForType($type);
-		if (!$this->hasSettings($settings->getSection(), $table)) {
-			$this->addSettings($settings, $table);
-		} else {
-			$this->updateSettings($settings, $table);
-		}
-	}
-
-	private function getSectionTableForType($type) {
-		if($type === 'admin') {
-			return Mapper::TABLE_ADMIN_SECTIONS;
-		} else if($type === 'personal') {
-			return Mapper::TABLE_PERSONAL_SECTIONS;
-		}
-		throw new \InvalidArgumentException('"admin" or "personal" expected');
-	}
-
-	private function getSettingsTableForType($type) {
-		if($type === 'admin') {
-			return Mapper::TABLE_ADMIN_SETTINGS;
-		} else if($type === 'personal') {
-			return Mapper::TABLE_PERSONAL_SETTINGS;
-		}
-		throw new \InvalidArgumentException('"admin" or "personal" expected');
-	}
-
-	private function query($className) {
-		try {
-			return \OC::$server->query($className);
-		} catch (QueryException $e) {
-			$this->log->logException($e);
-			throw $e;
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getAdminSections() {
-		// built-in sections
-		$sections = [
-			0 => [new Section('server', $this->l->t('Basic settings'), 0, $this->url->imagePath('settings', 'admin.svg'))],
-			5 => [new Section('sharing', $this->l->t('Sharing'), 0, $this->url->imagePath('core', 'actions/share.svg'))],
-			10 => [new Section('security', $this->l->t('Security'), 0, $this->url->imagePath('core', 'actions/password.svg'))],
-			45 => [new Section('encryption', $this->l->t('Encryption'), 0, $this->url->imagePath('core', 'actions/password.svg'))],
-			98 => [new Section('additional', $this->l->t('Additional settings'), 0, $this->url->imagePath('core', 'actions/settings-dark.svg'))],
-			99 => [new Section('tips-tricks', $this->l->t('Tips & tricks'), 0, $this->url->imagePath('settings', 'help.svg'))],
-		];
-
-		$rows = $this->mapper->getAdminSectionsFromDB();
-
-		foreach ($rows as $row) {
-			if (!isset($sections[$row['priority']])) {
-				$sections[$row['priority']] = [];
-			}
-			try {
-				$sections[$row['priority']][] = $this->query($row['class']);
-			} catch (QueryException $e) {
-				// skip
-			}
-		}
-
-		ksort($sections);
-
-		return $sections;
-	}
-
-	/**
-	 * @param string $section
-	 * @return ISection[]
-	 */
-	private function getBuiltInAdminSettings($section) {
-		$forms = [];
-		try {
-			if ($section === 'server') {
-				/** @var ISettings $form */
-				$form = new Admin\Server($this->dbc, $this->request, $this->config, $this->lockingProvider, $this->l);
-				$forms[$form->getPriority()] = [$form];
-				$form = new Admin\ServerDevNotice();
-				$forms[$form->getPriority()] = [$form];
-			}
-			if ($section === 'encryption') {
-				/** @var ISettings $form */
-				$form = new Admin\Encryption($this->encryptionManager, $this->userManager);
-				$forms[$form->getPriority()] = [$form];
-			}
-			if ($section === 'sharing') {
-				/** @var ISettings $form */
-				$form = new Admin\Sharing($this->config);
-				$forms[$form->getPriority()] = [$form];
-			}
-			if ($section === 'additional') {
-				/** @var ISettings $form */
-				$form = new Admin\Additional($this->config);
-				$forms[$form->getPriority()] = [$form];
-			}
-			if ($section === 'tips-tricks') {
-				/** @var ISettings $form */
-				$form = new Admin\TipsTricks($this->config);
-				$forms[$form->getPriority()] = [$form];
-			}
-		} catch (QueryException $e) {
-			// skip
-		}
-		return $forms;
-	}
-
-	/**
-	 * @param string $section
-	 * @return ISection[]
-	 */
-	private function getBuiltInPersonalSettings($section) {
-		$forms = [];
-		try {
-			if ($section === 'personal-info') {
-				/** @var ISettings $form */
-				$form = new Personal\PersonalInfo(
-					$this->config,
-					$this->userManager,
-					$this->groupManager,
-					$this->accountManager,
-					$this->appManager,
-					$this->l10nFactory,
-					$this->l
-				);
-				$forms[$form->getPriority()] = [$form];
-			}
-			if($section === 'security') {
-				/** @var ISettings $form */
-				$form = new Personal\Security();
-				$forms[$form->getPriority()] = [$form];
-			}
-			if ($section === 'additional') {
-				/** @var ISettings $form */
-				$form = new Personal\Additional($this->config);
-				$forms[$form->getPriority()] = [$form];
-			}
-		} catch (QueryException $e) {
-			// skip
-		}
-		return $forms;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getAdminSettings($section) {
-		$settings = $this->getBuiltInAdminSettings($section);
-		$dbRows = $this->mapper->getAdminSettingsFromDB($section);
-
-		foreach ($dbRows as $row) {
-			if (!isset($settings[$row['priority']])) {
-				$settings[$row['priority']] = [];
-			}
-			try {
-				$settings[$row['priority']][] = $this->query($row['class']);
-			} catch (QueryException $e) {
-				// skip
-			}
-		}
-
-		ksort($settings);
-		return $settings;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getPersonalSections() {
-		$sections = [
-			0 => [new Section('personal-info', $this->l->t('Personal info'), 0, $this->url->imagePath('core', 'actions/info.svg'))],
-			5 => [new Section('security', $this->l->t('Security'), 0, $this->url->imagePath('settings', 'password.svg'))],
-			15 => [new Section('sync-clients', $this->l->t('Sync clients'), 0, $this->url->imagePath('settings', 'change.svg'))],
-		];
-
-		$legacyForms = \OC_App::getForms('personal');
-		if(count($legacyForms) > 0 && $this->hasLegacyPersonalSettingsToRender($legacyForms)) {
-			$sections[98] = [new Section('additional', $this->l->t('Additional settings'), 0, $this->url->imagePath('core', 'actions/settings-dark.svg'))];
-		}
-
-		$rows = $this->mapper->getPersonalSectionsFromDB();
-
-		foreach ($rows as $row) {
-			if (!isset($sections[$row['priority']])) {
-				$sections[$row['priority']] = [];
-			}
-			try {
-				$sections[$row['priority']][] = $this->query($row['class']);
-			} catch (QueryException $e) {
-				// skip
-			}
-		}
-
-		ksort($sections);
-
-		return $sections;
-	}
-
-	/**
-	 * @param $forms
-	 * @return bool
-	 */
-	private function hasLegacyPersonalSettingsToRender($forms) {
-		foreach ($forms as $form) {
-			if(trim($form) !== '') {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getPersonalSettings($section) {
-		$settings = $this->getBuiltInPersonalSettings($section);
-		$dbRows = $this->mapper->getPersonalSettingsFromDB($section);
-
-		foreach ($dbRows as $row) {
-			if (!isset($settings[$row['priority']])) {
-				$settings[$row['priority']] = [];
-			}
-			try {
-				$settings[$row['priority']][] = $this->query($row['class']);
-			} catch (QueryException $e) {
-				// skip
-			}
-		}
-
-		ksort($settings);
-		return $settings;
-	}
+    /** @var ILogger */
+    private $log;
+    /** @var IDBConnection */
+    private $dbc;
+    /** @var Mapper */
+    private $mapper;
+    /** @var IL10N */
+    private $l;
+    /** @var IConfig */
+    private $config;
+    /** @var EncryptionManager */
+    private $encryptionManager;
+    /** @var IUserManager */
+    private $userManager;
+    /** @var ILockingProvider */
+    private $lockingProvider;
+    /** @var IRequest */
+    private $request;
+    /** @var IURLGenerator */
+    private $url;
+    /** @var AccountManager */
+    private $accountManager;
+    /** @var IGroupManager */
+    private $groupManager;
+    /** @var IFactory */
+    private $l10nFactory;
+    /** @var \OC_Defaults */
+    private $defaults;
+    /** @var IAppManager */
+    private $appManager;
+
+    /**
+     * @param ILogger $log
+     * @param IDBConnection $dbc
+     * @param IL10N $l
+     * @param IConfig $config
+     * @param EncryptionManager $encryptionManager
+     * @param IUserManager $userManager
+     * @param ILockingProvider $lockingProvider
+     * @param IRequest $request
+     * @param Mapper $mapper
+     * @param IURLGenerator $url
+     * @param AccountManager $accountManager
+     * @param IGroupManager $groupManager
+     * @param IFactory $l10nFactory
+     * @param \OC_Defaults $defaults
+     */
+    public function __construct(
+        ILogger $log,
+        IDBConnection $dbc,
+        IL10N $l,
+        IConfig $config,
+        EncryptionManager $encryptionManager,
+        IUserManager $userManager,
+        ILockingProvider $lockingProvider,
+        IRequest $request,
+        Mapper $mapper,
+        IURLGenerator $url,
+        AccountManager $accountManager,
+        IGroupManager $groupManager,
+        IFactory $l10nFactory,
+        \OC_Defaults $defaults,
+        IAppManager $appManager
+    ) {
+        $this->log = $log;
+        $this->dbc = $dbc;
+        $this->mapper = $mapper;
+        $this->l = $l;
+        $this->config = $config;
+        $this->encryptionManager = $encryptionManager;
+        $this->userManager = $userManager;
+        $this->lockingProvider = $lockingProvider;
+        $this->request = $request;
+        $this->url = $url;
+        $this->accountManager = $accountManager;
+        $this->groupManager = $groupManager;
+        $this->l10nFactory = $l10nFactory;
+        $this->defaults = $defaults;
+        $this->appManager = $appManager;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setupSettings(array $settings) {
+        if (isset($settings[IManager::KEY_ADMIN_SECTION])) {
+            $this->setupSectionEntry($settings[IManager::KEY_ADMIN_SECTION], 'admin');
+        }
+        if (isset($settings[IManager::KEY_ADMIN_SETTINGS])) {
+            $this->setupSettingsEntry($settings[IManager::KEY_ADMIN_SETTINGS], 'admin');
+        }
+
+        if (isset($settings[IManager::KEY_PERSONAL_SECTION])) {
+            $this->setupSectionEntry($settings[IManager::KEY_PERSONAL_SECTION], 'personal');
+        }
+        if (isset($settings[IManager::KEY_PERSONAL_SETTINGS])) {
+            $this->setupSettingsEntry($settings[IManager::KEY_PERSONAL_SETTINGS], 'personal');
+        }
+    }
+
+    /**
+     * attempts to remove an apps section and/or settings entry. A listener is
+     * added centrally making sure that this method is called ones an app was
+     * disabled.
+     *
+     * @param string $appId
+     * @since 9.1.0
+     */
+    public function onAppDisabled($appId) {
+        $appInfo = \OC_App::getAppInfo($appId); // hello static legacy
+
+        if (isset($appInfo['settings'][IManager::KEY_ADMIN_SECTION])) {
+            $this->mapper->remove(Mapper::TABLE_ADMIN_SECTIONS, trim($appInfo['settings'][IManager::KEY_ADMIN_SECTION], '\\'));
+        }
+        if (isset($appInfo['settings'][IManager::KEY_ADMIN_SETTINGS])) {
+            $this->mapper->remove(Mapper::TABLE_ADMIN_SETTINGS, trim($appInfo['settings'][IManager::KEY_ADMIN_SETTINGS], '\\'));
+        }
+
+        if (isset($appInfo['settings'][IManager::KEY_PERSONAL_SECTION])) {
+            $this->mapper->remove(Mapper::TABLE_PERSONAL_SECTIONS, trim($appInfo['settings'][IManager::KEY_PERSONAL_SECTION], '\\'));
+        }
+        if (isset($appInfo['settings'][IManager::KEY_PERSONAL_SETTINGS])) {
+            $this->mapper->remove(Mapper::TABLE_PERSONAL_SETTINGS, trim($appInfo['settings'][IManager::KEY_PERSONAL_SETTINGS], '\\'));
+        }
+    }
+
+    public function checkForOrphanedClassNames() {
+        $tables = [Mapper::TABLE_ADMIN_SECTIONS, Mapper::TABLE_ADMIN_SETTINGS, Mapper::TABLE_PERSONAL_SECTIONS, Mapper::TABLE_PERSONAL_SETTINGS];
+        foreach ($tables as $table) {
+            $classes = $this->mapper->getClasses($table);
+            foreach ($classes as $className) {
+                try {
+                    \OC::$server->query($className);
+                } catch (QueryException $e) {
+                    $this->mapper->remove($table, $className);
+                }
+            }
+        }
+    }
+
+    /**
+     * @param string $sectionClassName
+     * @param string $type either 'admin' or 'personal'
+     */
+    private function setupSectionEntry($sectionClassName, $type) {
+        if (!class_exists($sectionClassName)) {
+            $this->log->debug('Could not find ' . ucfirst($type) . ' section class ' . $sectionClassName);
+            return;
+        }
+        try {
+            $section = $this->query($sectionClassName);
+        } catch (QueryException $e) {
+            // cancel
+            return;
+        }
+
+        if (!$section instanceof ISection) {
+            $this->log->error(
+                ucfirst($type) .' section instance must implement \OCP\ISection. Invalid class: {class}',
+                ['class' => $sectionClassName]
+            );
+            return;
+        }
+        $table = $this->getSectionTableForType($type);
+        if(!$this->hasSection($section->getID(), $table)) {
+            $this->addSection($section, $table);
+        } else {
+            $this->updateSection($section, $table);
+        }
+    }
+
+    private function addSection(ISection $section, $table) {
+        $this->mapper->add($table, [
+            'id' => $section->getID(),
+            'class' => get_class($section),
+            'priority' => $section->getPriority(),
+        ]);
+    }
+
+    private function addSettings(ISettings $settings, $table) {
+        $this->mapper->add($table, [
+            'class' => get_class($settings),
+            'section' => $settings->getSection(),
+            'priority' => $settings->getPriority(),
+        ]);
+    }
+
+    private function updateSettings(ISettings $settings, $table) {
+        $this->mapper->update(
+            $table,
+            'section',
+            $settings->getSection(),
+            [
+                'class' => get_class($settings),
+                'priority' => $settings->getPriority(),
+            ]
+        );
+    }
+
+    private function updateSection(ISection $section, $table) {
+        $this->mapper->update(
+            $table,
+            'id',
+            $section->getID(),
+            [
+                'class' => get_class($section),
+                'priority' => $section->getPriority(),
+            ]
+        );
+    }
+
+    /**
+     * @param string $sectionId
+     * @param string $table
+     *
+     * @return bool
+     */
+    private function hasSection($sectionId, $table) {
+        return $this->mapper->has($table, 'id', $sectionId);
+    }
+
+    /**
+     * @param string $sectionId
+     * @param $table
+     *
+     * @return bool
+     */
+    private function hasSettings($sectionId, $table) {
+        return $this->mapper->has($table, 'section', $sectionId);
+    }
+
+    private function setupSettingsEntry($settingsClassName, $type) {
+        if (!class_exists($settingsClassName)) {
+            $this->log->debug('Could not find ' . $type . ' section class ' . $settingsClassName);
+            return;
+        }
+
+        try {
+            /** @var ISettings $settings */
+            $settings = $this->query($settingsClassName);
+        } catch (QueryException $e) {
+            // cancel
+            return;
+        }
+
+        if (!$settings instanceof ISettings) {
+            $this->log->error(
+                ucfirst($type) . ' section instance must implement \OCP\Settings\ISettings. Invalid class: {class}',
+                ['class' => $settingsClassName]
+            );
+            return;
+        }
+        $table = $this->getSettingsTableForType($type);
+        if (!$this->hasSettings($settings->getSection(), $table)) {
+            $this->addSettings($settings, $table);
+        } else {
+            $this->updateSettings($settings, $table);
+        }
+    }
+
+    private function getSectionTableForType($type) {
+        if($type === 'admin') {
+            return Mapper::TABLE_ADMIN_SECTIONS;
+        } else if($type === 'personal') {
+            return Mapper::TABLE_PERSONAL_SECTIONS;
+        }
+        throw new \InvalidArgumentException('"admin" or "personal" expected');
+    }
+
+    private function getSettingsTableForType($type) {
+        if($type === 'admin') {
+            return Mapper::TABLE_ADMIN_SETTINGS;
+        } else if($type === 'personal') {
+            return Mapper::TABLE_PERSONAL_SETTINGS;
+        }
+        throw new \InvalidArgumentException('"admin" or "personal" expected');
+    }
+
+    private function query($className) {
+        try {
+            return \OC::$server->query($className);
+        } catch (QueryException $e) {
+            $this->log->logException($e);
+            throw $e;
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getAdminSections() {
+        // built-in sections
+        $sections = [
+            0 => [new Section('server', $this->l->t('Basic settings'), 0, $this->url->imagePath('settings', 'admin.svg'))],
+            5 => [new Section('sharing', $this->l->t('Sharing'), 0, $this->url->imagePath('core', 'actions/share.svg'))],
+            10 => [new Section('security', $this->l->t('Security'), 0, $this->url->imagePath('core', 'actions/password.svg'))],
+            45 => [new Section('encryption', $this->l->t('Encryption'), 0, $this->url->imagePath('core', 'actions/password.svg'))],
+            98 => [new Section('additional', $this->l->t('Additional settings'), 0, $this->url->imagePath('core', 'actions/settings-dark.svg'))],
+            99 => [new Section('tips-tricks', $this->l->t('Tips & tricks'), 0, $this->url->imagePath('settings', 'help.svg'))],
+        ];
+
+        $rows = $this->mapper->getAdminSectionsFromDB();
+
+        foreach ($rows as $row) {
+            if (!isset($sections[$row['priority']])) {
+                $sections[$row['priority']] = [];
+            }
+            try {
+                $sections[$row['priority']][] = $this->query($row['class']);
+            } catch (QueryException $e) {
+                // skip
+            }
+        }
+
+        ksort($sections);
+
+        return $sections;
+    }
+
+    /**
+     * @param string $section
+     * @return ISection[]
+     */
+    private function getBuiltInAdminSettings($section) {
+        $forms = [];
+        try {
+            if ($section === 'server') {
+                /** @var ISettings $form */
+                $form = new Admin\Server($this->dbc, $this->request, $this->config, $this->lockingProvider, $this->l);
+                $forms[$form->getPriority()] = [$form];
+                $form = new Admin\ServerDevNotice();
+                $forms[$form->getPriority()] = [$form];
+            }
+            if ($section === 'encryption') {
+                /** @var ISettings $form */
+                $form = new Admin\Encryption($this->encryptionManager, $this->userManager);
+                $forms[$form->getPriority()] = [$form];
+            }
+            if ($section === 'sharing') {
+                /** @var ISettings $form */
+                $form = new Admin\Sharing($this->config);
+                $forms[$form->getPriority()] = [$form];
+            }
+            if ($section === 'additional') {
+                /** @var ISettings $form */
+                $form = new Admin\Additional($this->config);
+                $forms[$form->getPriority()] = [$form];
+            }
+            if ($section === 'tips-tricks') {
+                /** @var ISettings $form */
+                $form = new Admin\TipsTricks($this->config);
+                $forms[$form->getPriority()] = [$form];
+            }
+        } catch (QueryException $e) {
+            // skip
+        }
+        return $forms;
+    }
+
+    /**
+     * @param string $section
+     * @return ISection[]
+     */
+    private function getBuiltInPersonalSettings($section) {
+        $forms = [];
+        try {
+            if ($section === 'personal-info') {
+                /** @var ISettings $form */
+                $form = new Personal\PersonalInfo(
+                    $this->config,
+                    $this->userManager,
+                    $this->groupManager,
+                    $this->accountManager,
+                    $this->appManager,
+                    $this->l10nFactory,
+                    $this->l
+                );
+                $forms[$form->getPriority()] = [$form];
+            }
+            if($section === 'security') {
+                /** @var ISettings $form */
+                $form = new Personal\Security();
+                $forms[$form->getPriority()] = [$form];
+            }
+            if ($section === 'additional') {
+                /** @var ISettings $form */
+                $form = new Personal\Additional($this->config);
+                $forms[$form->getPriority()] = [$form];
+            }
+        } catch (QueryException $e) {
+            // skip
+        }
+        return $forms;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getAdminSettings($section) {
+        $settings = $this->getBuiltInAdminSettings($section);
+        $dbRows = $this->mapper->getAdminSettingsFromDB($section);
+
+        foreach ($dbRows as $row) {
+            if (!isset($settings[$row['priority']])) {
+                $settings[$row['priority']] = [];
+            }
+            try {
+                $settings[$row['priority']][] = $this->query($row['class']);
+            } catch (QueryException $e) {
+                // skip
+            }
+        }
+
+        ksort($settings);
+        return $settings;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getPersonalSections() {
+        $sections = [
+            0 => [new Section('personal-info', $this->l->t('Personal info'), 0, $this->url->imagePath('core', 'actions/info.svg'))],
+            5 => [new Section('security', $this->l->t('Security'), 0, $this->url->imagePath('settings', 'password.svg'))],
+            15 => [new Section('sync-clients', $this->l->t('Sync clients'), 0, $this->url->imagePath('settings', 'change.svg'))],
+        ];
+
+        $legacyForms = \OC_App::getForms('personal');
+        if(count($legacyForms) > 0 && $this->hasLegacyPersonalSettingsToRender($legacyForms)) {
+            $sections[98] = [new Section('additional', $this->l->t('Additional settings'), 0, $this->url->imagePath('core', 'actions/settings-dark.svg'))];
+        }
+
+        $rows = $this->mapper->getPersonalSectionsFromDB();
+
+        foreach ($rows as $row) {
+            if (!isset($sections[$row['priority']])) {
+                $sections[$row['priority']] = [];
+            }
+            try {
+                $sections[$row['priority']][] = $this->query($row['class']);
+            } catch (QueryException $e) {
+                // skip
+            }
+        }
+
+        ksort($sections);
+
+        return $sections;
+    }
+
+    /**
+     * @param $forms
+     * @return bool
+     */
+    private function hasLegacyPersonalSettingsToRender($forms) {
+        foreach ($forms as $form) {
+            if(trim($form) !== '') {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getPersonalSettings($section) {
+        $settings = $this->getBuiltInPersonalSettings($section);
+        $dbRows = $this->mapper->getPersonalSettingsFromDB($section);
+
+        foreach ($dbRows as $row) {
+            if (!isset($settings[$row['priority']])) {
+                $settings[$row['priority']] = [];
+            }
+            try {
+                $settings[$row['priority']][] = $this->query($row['class']);
+            } catch (QueryException $e) {
+                // skip
+            }
+        }
+
+        ksort($settings);
+        return $settings;
+    }
 }

Spacing +12 added lines, -12 removed lines

@@ -188,7 +188,7 @@ 
 	 */
 	private function setupSectionEntry($sectionClassName, $type) {
 		if (!class_exists($sectionClassName)) {
-			$this->log->debug('Could not find ' . ucfirst($type) . ' section class ' . $sectionClassName);
+			$this->log->debug('Could not find '.ucfirst($type).' section class '.$sectionClassName);
 			return;
 		}
 		try {
@@ -200,13 +200,13 @@ 
 
 		if (!$section instanceof ISection) {
 			$this->log->error(
-				ucfirst($type) .' section instance must implement \OCP\ISection. Invalid class: {class}',
+				ucfirst($type).' section instance must implement \OCP\ISection. Invalid class: {class}',
 				['class' => $sectionClassName]
 			);
 			return;
 		}
 		$table = $this->getSectionTableForType($type);
-		if(!$this->hasSection($section->getID(), $table)) {
+		if (!$this->hasSection($section->getID(), $table)) {
 			$this->addSection($section, $table);
 		} else {
 			$this->updateSection($section, $table);
@@ -275,7 +275,7 @@ 
 
 	private function setupSettingsEntry($settingsClassName, $type) {
 		if (!class_exists($settingsClassName)) {
-			$this->log->debug('Could not find ' . $type . ' section class ' . $settingsClassName);
+			$this->log->debug('Could not find '.$type.' section class '.$settingsClassName);
 			return;
 		}
 
@@ -289,7 +289,7 @@ 
 
 		if (!$settings instanceof ISettings) {
 			$this->log->error(
-				ucfirst($type) . ' section instance must implement \OCP\Settings\ISettings. Invalid class: {class}',
+				ucfirst($type).' section instance must implement \OCP\Settings\ISettings. Invalid class: {class}',
 				['class' => $settingsClassName]
 			);
 			return;
@@ -303,18 +303,18 @@ 
 	}
 
 	private function getSectionTableForType($type) {
-		if($type === 'admin') {
+		if ($type === 'admin') {
 			return Mapper::TABLE_ADMIN_SECTIONS;
-		} else if($type === 'personal') {
+		} else if ($type === 'personal') {
 			return Mapper::TABLE_PERSONAL_SECTIONS;
 		}
 		throw new \InvalidArgumentException('"admin" or "personal" expected');
 	}
 
 	private function getSettingsTableForType($type) {
-		if($type === 'admin') {
+		if ($type === 'admin') {
 			return Mapper::TABLE_ADMIN_SETTINGS;
-		} else if($type === 'personal') {
+		} else if ($type === 'personal') {
 			return Mapper::TABLE_PERSONAL_SETTINGS;
 		}
 		throw new \InvalidArgumentException('"admin" or "personal" expected');
@@ -421,7 +421,7 @@ 
 				);
 				$forms[$form->getPriority()] = [$form];
 			}
-			if($section === 'security') {
+			if ($section === 'security') {
 				/** @var ISettings $form */
 				$form = new Personal\Security();
 				$forms[$form->getPriority()] = [$form];
@@ -470,7 +470,7 @@ 
 		];
 
 		$legacyForms = \OC_App::getForms('personal');
-		if(count($legacyForms) > 0 && $this->hasLegacyPersonalSettingsToRender($legacyForms)) {
+		if (count($legacyForms) > 0 && $this->hasLegacyPersonalSettingsToRender($legacyForms)) {
 			$sections[98] = [new Section('additional', $this->l->t('Additional settings'), 0, $this->url->imagePath('core', 'actions/settings-dark.svg'))];
 		}
 
@@ -498,7 +498,7 @@ 
 	 */
 	private function hasLegacyPersonalSettingsToRender($forms) {
 		foreach ($forms as $form) {
-			if(trim($form) !== '') {
+			if (trim($form) !== '') {
 				return true;
 			}
 		}

lib/private/Settings/Mapper.php

Indentation +186 added lines, -186 removed lines

@@ -26,191 +26,191 @@
 use OCP\IDBConnection;
 
 class Mapper {
-	const TABLE_ADMIN_SETTINGS = 'admin_settings';
-	const TABLE_ADMIN_SECTIONS = 'admin_sections';
-	const TABLE_PERSONAL_SETTINGS = 'personal_settings';
-	const TABLE_PERSONAL_SECTIONS = 'personal_sections';
-
-	/** @var IDBConnection */
-	private $dbc;
-
-	/**
-	 * @param IDBConnection $dbc
-	 */
-	public function __construct(IDBConnection $dbc) {
-		$this->dbc = $dbc;
-	}
-
-	/**
-	 * Get the configured admin settings from the database for the provided section
-	 *
-	 * @param string $section
-	 * @return array[] [['class' => string, 'priority' => int], ...]
-	 */
-	public function getAdminSettingsFromDB($section) {
-		return $this->getSettingsFromDB(self::TABLE_ADMIN_SETTINGS, $section);
-	}
-
-	/**
-	 * Get the configured personal settings from the database for the provided section
-	 *
-	 * @param string $section
-	 * @return array[] [['class' => string, 'priority' => int], ...]
-	 */
-	public function getPersonalSettingsFromDB($section) {
-		return $this->getSettingsFromDB(self::TABLE_PERSONAL_SETTINGS, $section);
-	}
-
-	/**
-	 * Get the configured settings from the database for the provided table and section
-	 *
-	 * @param $table
-	 * @param $section
-	 * @return array
-	 */
-	private function getSettingsFromDB($table, $section) {
-		$query = $this->dbc->getQueryBuilder();
-		$query->select(['class', 'priority'])
-			->from($table)
-			->where($query->expr()->eq('section', $this->dbc->getQueryBuilder()->createParameter('section')))
-			->setParameter('section', $section);
-
-		$result = $query->execute();
-		return $result->fetchAll();
-	}
-
-	/**
-	 * Get the configured admin sections from the database
-	 *
-	 * @return array[] [['class' => string, 'priority' => int], ...]
-	 */
-	public function getAdminSectionsFromDB() {
-		return $this->getSectionsFromDB('admin');
-	}
-
-	/**
-	 * Get the configured admin sections from the database
-	 *
-	 * @return array[] [['class' => string, 'priority' => int], ...]
-	 */
-	public function getPersonalSectionsFromDB() {
-		return $this->getSectionsFromDB('personal');
-	}
-
-	/**
-	 * Get the configured sections from the database by table
-	 *
-	 * @param string $type either 'personal' or 'admin'
-	 * @return array[] [['class' => string, 'priority' => int], ...]
-	 */
-	public function getSectionsFromDB($type) {
-		if($type === 'admin') {
-			$sectionsTable = self::TABLE_ADMIN_SECTIONS;
-			$settingsTable = self::TABLE_ADMIN_SETTINGS;
-		} else if($type === 'personal') {
-			$sectionsTable = self::TABLE_PERSONAL_SECTIONS;
-			$settingsTable = self::TABLE_PERSONAL_SETTINGS;
-		} else {
-			throw new \InvalidArgumentException('"admin" or "personal" expected');
-		}
-		$query = $this->dbc->getQueryBuilder();
-		$query->selectDistinct('s.class')
-			->addSelect('s.priority')
-			->from($sectionsTable, 's')
-			->from($settingsTable, '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 one of the Mapper::TABLE_* constants
-	 * @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 string $table one of the Mapper::TABLE_* constants
-	 * @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);
-	}
-
-	/**
-	 * Check if a class is configured in the database
-	 *
-	 * @param string $table one of the Mapper::TABLE_* constants
-	 * @param $field
-	 * @param string $sectionId
-	 * @return bool
-	 */
-	public function has($table, $field, $sectionId) {
-		$query = $this->dbc->getQueryBuilder();
-		$query->select('id')
-			->from($table)
-			->where($query->expr()->eq($field, $query->createNamedParameter($sectionId)))
-			->setMaxResults(1);
-
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		return (bool)$row;
-	}
-
-	/**
-	 * deletes an settings or admin entry from the given table
-	 *
-	 * @param string $table one of the Mapper::TABLE_* constants
-	 * @param string $className
-	 */
-	public function remove($table, $className) {
-		$query = $this->dbc->getQueryBuilder();
-		$query->delete($table)
-			->where($query->expr()->eq('class', $query->createNamedParameter($className)));
-
-		$query->execute();
-	}
-
-	/**
-	 * @param string $table one of the Mapper::TABLE_* constants
-	 * @param string $idCol
-	 * @param string $id
-	 * @param array $values
-	 * @suppress SqlInjectionChecker
-	 */
-	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();
-	}
+    const TABLE_ADMIN_SETTINGS = 'admin_settings';
+    const TABLE_ADMIN_SECTIONS = 'admin_sections';
+    const TABLE_PERSONAL_SETTINGS = 'personal_settings';
+    const TABLE_PERSONAL_SECTIONS = 'personal_sections';
+
+    /** @var IDBConnection */
+    private $dbc;
+
+    /**
+     * @param IDBConnection $dbc
+     */
+    public function __construct(IDBConnection $dbc) {
+        $this->dbc = $dbc;
+    }
+
+    /**
+     * Get the configured admin settings from the database for the provided section
+     *
+     * @param string $section
+     * @return array[] [['class' => string, 'priority' => int], ...]
+     */
+    public function getAdminSettingsFromDB($section) {
+        return $this->getSettingsFromDB(self::TABLE_ADMIN_SETTINGS, $section);
+    }
+
+    /**
+     * Get the configured personal settings from the database for the provided section
+     *
+     * @param string $section
+     * @return array[] [['class' => string, 'priority' => int], ...]
+     */
+    public function getPersonalSettingsFromDB($section) {
+        return $this->getSettingsFromDB(self::TABLE_PERSONAL_SETTINGS, $section);
+    }
+
+    /**
+     * Get the configured settings from the database for the provided table and section
+     *
+     * @param $table
+     * @param $section
+     * @return array
+     */
+    private function getSettingsFromDB($table, $section) {
+        $query = $this->dbc->getQueryBuilder();
+        $query->select(['class', 'priority'])
+            ->from($table)
+            ->where($query->expr()->eq('section', $this->dbc->getQueryBuilder()->createParameter('section')))
+            ->setParameter('section', $section);
+
+        $result = $query->execute();
+        return $result->fetchAll();
+    }
+
+    /**
+     * Get the configured admin sections from the database
+     *
+     * @return array[] [['class' => string, 'priority' => int], ...]
+     */
+    public function getAdminSectionsFromDB() {
+        return $this->getSectionsFromDB('admin');
+    }
+
+    /**
+     * Get the configured admin sections from the database
+     *
+     * @return array[] [['class' => string, 'priority' => int], ...]
+     */
+    public function getPersonalSectionsFromDB() {
+        return $this->getSectionsFromDB('personal');
+    }
+
+    /**
+     * Get the configured sections from the database by table
+     *
+     * @param string $type either 'personal' or 'admin'
+     * @return array[] [['class' => string, 'priority' => int], ...]
+     */
+    public function getSectionsFromDB($type) {
+        if($type === 'admin') {
+            $sectionsTable = self::TABLE_ADMIN_SECTIONS;
+            $settingsTable = self::TABLE_ADMIN_SETTINGS;
+        } else if($type === 'personal') {
+            $sectionsTable = self::TABLE_PERSONAL_SECTIONS;
+            $settingsTable = self::TABLE_PERSONAL_SETTINGS;
+        } else {
+            throw new \InvalidArgumentException('"admin" or "personal" expected');
+        }
+        $query = $this->dbc->getQueryBuilder();
+        $query->selectDistinct('s.class')
+            ->addSelect('s.priority')
+            ->from($sectionsTable, 's')
+            ->from($settingsTable, '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 one of the Mapper::TABLE_* constants
+     * @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 string $table one of the Mapper::TABLE_* constants
+     * @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);
+    }
+
+    /**
+     * Check if a class is configured in the database
+     *
+     * @param string $table one of the Mapper::TABLE_* constants
+     * @param $field
+     * @param string $sectionId
+     * @return bool
+     */
+    public function has($table, $field, $sectionId) {
+        $query = $this->dbc->getQueryBuilder();
+        $query->select('id')
+            ->from($table)
+            ->where($query->expr()->eq($field, $query->createNamedParameter($sectionId)))
+            ->setMaxResults(1);
+
+        $result = $query->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        return (bool)$row;
+    }
+
+    /**
+     * deletes an settings or admin entry from the given table
+     *
+     * @param string $table one of the Mapper::TABLE_* constants
+     * @param string $className
+     */
+    public function remove($table, $className) {
+        $query = $this->dbc->getQueryBuilder();
+        $query->delete($table)
+            ->where($query->expr()->eq('class', $query->createNamedParameter($className)));
+
+        $query->execute();
+    }
+
+    /**
+     * @param string $table one of the Mapper::TABLE_* constants
+     * @param string $idCol
+     * @param string $id
+     * @param array $values
+     * @suppress SqlInjectionChecker
+     */
+    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();
+    }
 
 }