nextcloud / server

settings/Controller/CommonSettingsTrait.php

Doc Comments +12 added lines

@@ -51,6 +51,9 @@ 
 		];
 	}
 
+	/**
+	 * @param string $type
+	 */
 	protected function formatSections($sections, $currentSection, $type) {
 		$templateParameters = [];
 		/** @var \OCP\Settings\ISection[] $prioritizedSections */
@@ -81,6 +84,9 @@ 
 		return $templateParameters;
 	}
 
+	/**
+	 * @param string $currentSections
+	 */
 	protected function formatPersonalSections($currentSections) {
 		$sections = $this->settingsManager->getPersonalSections();
 		$templateParameters = $this->formatSections($sections, $currentSections, 'personal');
@@ -88,6 +94,9 @@ 
 		return $templateParameters;
 	}
 
+	/**
+	 * @param string $currentSections
+	 */
 	protected function formatAdminSections($currentSections) {
 		$sections = $this->settingsManager->getAdminSections();
 		$templateParameters = $this->formatSections($sections, $currentSections, 'admin');
@@ -111,6 +120,9 @@ 
 		return ['content' => $html];
 	}
 
+	/**
+	 * @param string $section
+	 */
 	private function getIndexResponse($section) {
 		$templateParams = [];
 		$templateParams = array_merge($templateParams, $this->getNavigationParameters($section));

Indentation +91 added lines, -91 removed lines

@@ -29,95 +29,95 @@
 use OCP\Settings\ISettings;
 
 trait CommonSettingsTrait  {
-	/** @var ISettingsManager */
-	private $settingsManager;
-
-	/**
-	 * @param string $currentSection
-	 * @return array
-	 */
-	private function getNavigationParameters($currentSection) {
-		$templateParameters = [
-			'personal' => $this->formatPersonalSections($currentSection),
-			'admin' => []
-		];
-
-		if(\OC_User::isAdminUser(\OC_User::getUser())) {
-			$templateParameters['admin'] = $this->formatAdminSections($currentSection);
-		}
-
-		return [
-			'forms' => $templateParameters
-		];
-	}
-
-	protected function formatSections($sections, $currentSection, $type) {
-		$templateParameters = [];
-		/** @var \OCP\Settings\ISection[] $prioritizedSections */
-		foreach($sections as $prioritizedSections) {
-			foreach ($prioritizedSections as $section) {
-				if($type === 'admin') {
-					$settings = $this->settingsManager->getAdminSettings($section->getID());
-				} else if($type === 'personal') {
-					$settings = $this->settingsManager->getPersonalSettings($section->getID());
-				}
-				if (empty($settings)) {
-					continue;
-				}
-
-				$icon = '';
-				if ($section instanceof IIconSection) {
-					$icon = $section->getIcon();
-				}
-
-				$templateParameters[] = [
-					'anchor'       => $section->getID(),
-					'section-name' => $section->getName(),
-					'active'       => $section->getID() === $currentSection,
-					'icon'         => $icon,
-				];
-			}
-		}
-		return $templateParameters;
-	}
-
-	protected function formatPersonalSections($currentSections) {
-		$sections = $this->settingsManager->getPersonalSections();
-		$templateParameters = $this->formatSections($sections, $currentSections, 'personal');
-
-		return $templateParameters;
-	}
-
-	protected function formatAdminSections($currentSections) {
-		$sections = $this->settingsManager->getAdminSections();
-		$templateParameters = $this->formatSections($sections, $currentSections, 'admin');
-
-		return $templateParameters;
-	}
-
-	/**
-	 * @param ISettings[] $settings
-	 * @return array
-	 */
-	private function formatSettings($settings) {
-		$html = '';
-		foreach ($settings as $prioritizedSettings) {
-			foreach ($prioritizedSettings as $setting) {
-				/** @var \OCP\Settings\ISettings $setting */
-				$form = $setting->getForm();
-				$html .= $form->renderAs('')->render();
-			}
-		}
-		return ['content' => $html];
-	}
-
-	private function getIndexResponse($section) {
-		$templateParams = [];
-		$templateParams = array_merge($templateParams, $this->getNavigationParameters($section));
-		$templateParams = array_merge($templateParams, $this->getSettings($section));
-
-		return new TemplateResponse('settings', 'settings/frame', $templateParams);
-	}
-
-	abstract public function getSettings($section);
+    /** @var ISettingsManager */
+    private $settingsManager;
+
+    /**
+     * @param string $currentSection
+     * @return array
+     */
+    private function getNavigationParameters($currentSection) {
+        $templateParameters = [
+            'personal' => $this->formatPersonalSections($currentSection),
+            'admin' => []
+        ];
+
+        if(\OC_User::isAdminUser(\OC_User::getUser())) {
+            $templateParameters['admin'] = $this->formatAdminSections($currentSection);
+        }
+
+        return [
+            'forms' => $templateParameters
+        ];
+    }
+
+    protected function formatSections($sections, $currentSection, $type) {
+        $templateParameters = [];
+        /** @var \OCP\Settings\ISection[] $prioritizedSections */
+        foreach($sections as $prioritizedSections) {
+            foreach ($prioritizedSections as $section) {
+                if($type === 'admin') {
+                    $settings = $this->settingsManager->getAdminSettings($section->getID());
+                } else if($type === 'personal') {
+                    $settings = $this->settingsManager->getPersonalSettings($section->getID());
+                }
+                if (empty($settings)) {
+                    continue;
+                }
+
+                $icon = '';
+                if ($section instanceof IIconSection) {
+                    $icon = $section->getIcon();
+                }
+
+                $templateParameters[] = [
+                    'anchor'       => $section->getID(),
+                    'section-name' => $section->getName(),
+                    'active'       => $section->getID() === $currentSection,
+                    'icon'         => $icon,
+                ];
+            }
+        }
+        return $templateParameters;
+    }
+
+    protected function formatPersonalSections($currentSections) {
+        $sections = $this->settingsManager->getPersonalSections();
+        $templateParameters = $this->formatSections($sections, $currentSections, 'personal');
+
+        return $templateParameters;
+    }
+
+    protected function formatAdminSections($currentSections) {
+        $sections = $this->settingsManager->getAdminSections();
+        $templateParameters = $this->formatSections($sections, $currentSections, 'admin');
+
+        return $templateParameters;
+    }
+
+    /**
+     * @param ISettings[] $settings
+     * @return array
+     */
+    private function formatSettings($settings) {
+        $html = '';
+        foreach ($settings as $prioritizedSettings) {
+            foreach ($prioritizedSettings as $setting) {
+                /** @var \OCP\Settings\ISettings $setting */
+                $form = $setting->getForm();
+                $html .= $form->renderAs('')->render();
+            }
+        }
+        return ['content' => $html];
+    }
+
+    private function getIndexResponse($section) {
+        $templateParams = [];
+        $templateParams = array_merge($templateParams, $this->getNavigationParameters($section));
+        $templateParams = array_merge($templateParams, $this->getSettings($section));
+
+        return new TemplateResponse('settings', 'settings/frame', $templateParams);
+    }
+
+    abstract public function getSettings($section);
 }

lib/private/NavigationManager.php

Indentation +218 added lines, -218 removed lines

@@ -41,241 +41,241 @@
  */
 
 class NavigationManager implements INavigationManager {
-	protected $entries = [];
-	protected $closureEntries = [];
-	protected $activeEntry;
-	/** @var bool */
-	protected $init = false;
-	/** @var IAppManager|AppManager */
-	protected $appManager;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var IFactory */
-	private $l10nFac;
-	/** @var IUserSession */
-	private $userSession;
-	/** @var IGroupManager|Manager */
-	private $groupManager;
-	/** @var IConfig */
-	private $config;
+    protected $entries = [];
+    protected $closureEntries = [];
+    protected $activeEntry;
+    /** @var bool */
+    protected $init = false;
+    /** @var IAppManager|AppManager */
+    protected $appManager;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var IFactory */
+    private $l10nFac;
+    /** @var IUserSession */
+    private $userSession;
+    /** @var IGroupManager|Manager */
+    private $groupManager;
+    /** @var IConfig */
+    private $config;
 
-	public function __construct(IAppManager $appManager,
-						 IURLGenerator $urlGenerator,
-						 IFactory $l10nFac,
-						 IUserSession $userSession,
-						 IGroupManager $groupManager,
-						 IConfig $config) {
-		$this->appManager = $appManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->l10nFac = $l10nFac;
-		$this->userSession = $userSession;
-		$this->groupManager = $groupManager;
-		$this->config = $config;
-	}
+    public function __construct(IAppManager $appManager,
+                            IURLGenerator $urlGenerator,
+                            IFactory $l10nFac,
+                            IUserSession $userSession,
+                            IGroupManager $groupManager,
+                            IConfig $config) {
+        $this->appManager = $appManager;
+        $this->urlGenerator = $urlGenerator;
+        $this->l10nFac = $l10nFac;
+        $this->userSession = $userSession;
+        $this->groupManager = $groupManager;
+        $this->config = $config;
+    }
 
-	/**
-	 * Creates a new navigation entry
-	 *
-	 * @param array|\Closure $entry Array containing: id, name, order, icon and href key
-	 *					The use of a closure is preferred, because it will avoid
-	 * 					loading the routing of your app, unless required.
-	 * @return void
-	 */
-	public function add($entry) {
-		if ($entry instanceof \Closure) {
-			$this->closureEntries[] = $entry;
-			return;
-		}
+    /**
+     * Creates a new navigation entry
+     *
+     * @param array|\Closure $entry Array containing: id, name, order, icon and href key
+     *					The use of a closure is preferred, because it will avoid
+     * 					loading the routing of your app, unless required.
+     * @return void
+     */
+    public function add($entry) {
+        if ($entry instanceof \Closure) {
+            $this->closureEntries[] = $entry;
+            return;
+        }
 
-		$entry['active'] = false;
-		if(!isset($entry['icon'])) {
-			$entry['icon'] = '';
-		}
-		if(!isset($entry['type'])) {
-			$entry['type'] = 'link';
-		}
-		$this->entries[] = $entry;
-	}
+        $entry['active'] = false;
+        if(!isset($entry['icon'])) {
+            $entry['icon'] = '';
+        }
+        if(!isset($entry['type'])) {
+            $entry['type'] = 'link';
+        }
+        $this->entries[] = $entry;
+    }
 
-	/**
-	 * returns all the added Menu entries
-	 * @param string $type
-	 * @return array an array of the added entries
-	 */
-	public function getAll($type = 'link') {
-		$this->init();
-		foreach ($this->closureEntries as $c) {
-			$this->add($c());
-		}
-		$this->closureEntries = array();
+    /**
+     * returns all the added Menu entries
+     * @param string $type
+     * @return array an array of the added entries
+     */
+    public function getAll($type = 'link') {
+        $this->init();
+        foreach ($this->closureEntries as $c) {
+            $this->add($c());
+        }
+        $this->closureEntries = array();
 
-		if ($type === 'all') {
-			return $this->entries;
-		}
+        if ($type === 'all') {
+            return $this->entries;
+        }
 
-		return array_filter($this->entries, function($entry) use ($type) {
-			return $entry['type'] === $type;
-		});
-	}
+        return array_filter($this->entries, function($entry) use ($type) {
+            return $entry['type'] === $type;
+        });
+    }
 
-	/**
-	 * removes all the entries
-	 */
-	public function clear($loadDefaultLinks = true) {
-		$this->entries = [];
-		$this->closureEntries = [];
-		$this->init = !$loadDefaultLinks;
-	}
+    /**
+     * removes all the entries
+     */
+    public function clear($loadDefaultLinks = true) {
+        $this->entries = [];
+        $this->closureEntries = [];
+        $this->init = !$loadDefaultLinks;
+    }
 
-	/**
-	 * Sets the current navigation entry of the currently running app
-	 * @param string $id of the app entry to activate (from added $entry)
-	 */
-	public function setActiveEntry($id) {
-		$this->activeEntry = $id;
-	}
+    /**
+     * Sets the current navigation entry of the currently running app
+     * @param string $id of the app entry to activate (from added $entry)
+     */
+    public function setActiveEntry($id) {
+        $this->activeEntry = $id;
+    }
 
-	/**
-	 * gets the active Menu entry
-	 * @return string id or empty string
-	 *
-	 * This function returns the id of the active navigation entry (set by
-	 * setActiveEntry
-	 */
-	public function getActiveEntry() {
-		return $this->activeEntry;
-	}
+    /**
+     * gets the active Menu entry
+     * @return string id or empty string
+     *
+     * This function returns the id of the active navigation entry (set by
+     * setActiveEntry
+     */
+    public function getActiveEntry() {
+        return $this->activeEntry;
+    }
 
-	private function init() {
-		if ($this->init) {
-			return;
-		}
-		$this->init = true;
+    private function init() {
+        if ($this->init) {
+            return;
+        }
+        $this->init = true;
 
-		$l = $this->l10nFac->get('lib');
-		if ($this->config->getSystemValue('knowledgebaseenabled', true)) {
-			$this->add([
-				'type' => 'settings',
-				'id' => 'help',
-				'order' => 5,
-				'href' => $this->urlGenerator->linkToRoute('settings_help'),
-				'name' => $l->t('Help'),
-				'icon' => $this->urlGenerator->imagePath('settings', 'help.svg'),
-			]);
-		}
+        $l = $this->l10nFac->get('lib');
+        if ($this->config->getSystemValue('knowledgebaseenabled', true)) {
+            $this->add([
+                'type' => 'settings',
+                'id' => 'help',
+                'order' => 5,
+                'href' => $this->urlGenerator->linkToRoute('settings_help'),
+                'name' => $l->t('Help'),
+                'icon' => $this->urlGenerator->imagePath('settings', 'help.svg'),
+            ]);
+        }
 
-		if ($this->userSession->isLoggedIn()) {
-			if ($this->isAdmin()) {
-				// App management
-				$this->add([
-					'type' => 'settings',
-					'id' => 'core_apps',
-					'order' => 3,
-					'href' => $this->urlGenerator->linkToRoute('settings.AppSettings.viewApps'),
-					'icon' => $this->urlGenerator->imagePath('settings', 'apps.svg'),
-					'name' => $l->t('Apps'),
-				]);
-			}
+        if ($this->userSession->isLoggedIn()) {
+            if ($this->isAdmin()) {
+                // App management
+                $this->add([
+                    'type' => 'settings',
+                    'id' => 'core_apps',
+                    'order' => 3,
+                    'href' => $this->urlGenerator->linkToRoute('settings.AppSettings.viewApps'),
+                    'icon' => $this->urlGenerator->imagePath('settings', 'apps.svg'),
+                    'name' => $l->t('Apps'),
+                ]);
+            }
 
-			// Personal and (if applicable) admin settings
-			$this->add([
-				'type' => 'settings',
-				'id' => 'settings',
-				'order' => 1,
-				'href' => $this->urlGenerator->linkToRoute('settings_personal'),
-				'name' => $l->t('Settings'),
-				'icon' => $this->urlGenerator->imagePath('settings', 'admin.svg'),
-			]);
+            // Personal and (if applicable) admin settings
+            $this->add([
+                'type' => 'settings',
+                'id' => 'settings',
+                'order' => 1,
+                'href' => $this->urlGenerator->linkToRoute('settings_personal'),
+                'name' => $l->t('Settings'),
+                'icon' => $this->urlGenerator->imagePath('settings', 'admin.svg'),
+            ]);
 
-			// Logout
-			$this->add([
-				'type' => 'settings',
-				'id' => 'logout',
-				'order' => 99999,
-				'href' => $this->urlGenerator->linkToRouteAbsolute(
-					'core.login.logout',
-					['requesttoken' => \OCP\Util::callRegister()]
-				),
-				'name' => $l->t('Log out'),
-				'icon' => $this->urlGenerator->imagePath('core', 'actions/logout.svg'),
-			]);
+            // Logout
+            $this->add([
+                'type' => 'settings',
+                'id' => 'logout',
+                'order' => 99999,
+                'href' => $this->urlGenerator->linkToRouteAbsolute(
+                    'core.login.logout',
+                    ['requesttoken' => \OCP\Util::callRegister()]
+                ),
+                'name' => $l->t('Log out'),
+                'icon' => $this->urlGenerator->imagePath('core', 'actions/logout.svg'),
+            ]);
 
-			if ($this->isSubadmin()) {
-				// User management
-				$this->add([
-					'type' => 'settings',
-					'id' => 'core_users',
-					'order' => 4,
-					'href' => $this->urlGenerator->linkToRoute('settings_users'),
-					'name' => $l->t('Users'),
-					'icon' => $this->urlGenerator->imagePath('settings', 'users.svg'),
-				]);
-			}
-		}
+            if ($this->isSubadmin()) {
+                // User management
+                $this->add([
+                    'type' => 'settings',
+                    'id' => 'core_users',
+                    'order' => 4,
+                    'href' => $this->urlGenerator->linkToRoute('settings_users'),
+                    'name' => $l->t('Users'),
+                    'icon' => $this->urlGenerator->imagePath('settings', 'users.svg'),
+                ]);
+            }
+        }
 
-		if ($this->appManager === 'null') {
-			return;
-		}
-		foreach ($this->appManager->getInstalledApps() as $app) {
-			// load plugins and collections from info.xml
-			$info = $this->appManager->getAppInfo($app);
-			if (empty($info['navigations'])) {
-				continue;
-			}
-			foreach ($info['navigations'] as $nav) {
-				if (!isset($nav['name'])) {
-					continue;
-				}
-				if (!isset($nav['route'])) {
-					continue;
-				}
-				$role = isset($nav['@attributes']['role']) ? $nav['@attributes']['role'] : 'all';
-				if ($role === 'admin' && !$this->isAdmin()) {
-					continue;
-				}
-				$l = $this->l10nFac->get($app);
-				$id = isset($nav['id']) ? $nav['id'] : $app;
-				$order = isset($nav['order']) ? $nav['order'] : 100;
-				$type = isset($nav['type']) ? $nav['type'] : 'link';
-				$route = $this->urlGenerator->linkToRoute($nav['route']);
-				$icon = isset($nav['icon']) ? $nav['icon'] : 'app.svg';
-				foreach ([$icon, "$app.svg"] as $i) {
-					try {
-						$icon = $this->urlGenerator->imagePath($app, $i);
-						break;
-					} catch (\RuntimeException $ex) {
-						// no icon? - ignore it then
-					}
-				}
-				if ($icon === null) {
-					$icon = $this->urlGenerator->imagePath('core', 'default-app-icon');
-				}
+        if ($this->appManager === 'null') {
+            return;
+        }
+        foreach ($this->appManager->getInstalledApps() as $app) {
+            // load plugins and collections from info.xml
+            $info = $this->appManager->getAppInfo($app);
+            if (empty($info['navigations'])) {
+                continue;
+            }
+            foreach ($info['navigations'] as $nav) {
+                if (!isset($nav['name'])) {
+                    continue;
+                }
+                if (!isset($nav['route'])) {
+                    continue;
+                }
+                $role = isset($nav['@attributes']['role']) ? $nav['@attributes']['role'] : 'all';
+                if ($role === 'admin' && !$this->isAdmin()) {
+                    continue;
+                }
+                $l = $this->l10nFac->get($app);
+                $id = isset($nav['id']) ? $nav['id'] : $app;
+                $order = isset($nav['order']) ? $nav['order'] : 100;
+                $type = isset($nav['type']) ? $nav['type'] : 'link';
+                $route = $this->urlGenerator->linkToRoute($nav['route']);
+                $icon = isset($nav['icon']) ? $nav['icon'] : 'app.svg';
+                foreach ([$icon, "$app.svg"] as $i) {
+                    try {
+                        $icon = $this->urlGenerator->imagePath($app, $i);
+                        break;
+                    } catch (\RuntimeException $ex) {
+                        // no icon? - ignore it then
+                    }
+                }
+                if ($icon === null) {
+                    $icon = $this->urlGenerator->imagePath('core', 'default-app-icon');
+                }
 
-				$this->add([
-					'id' => $id,
-					'order' => $order,
-					'href' => $route,
-					'icon' => $icon,
-					'type' => $type,
-					'name' => $l->t($nav['name']),
-				]);
-			}
-		}
-	}
+                $this->add([
+                    'id' => $id,
+                    'order' => $order,
+                    'href' => $route,
+                    'icon' => $icon,
+                    'type' => $type,
+                    'name' => $l->t($nav['name']),
+                ]);
+            }
+        }
+    }
 
-	private function isAdmin() {
-		$user = $this->userSession->getUser();
-		if ($user !== null) {
-			return $this->groupManager->isAdmin($user->getUID());
-		}
-		return false;
-	}
+    private function isAdmin() {
+        $user = $this->userSession->getUser();
+        if ($user !== null) {
+            return $this->groupManager->isAdmin($user->getUID());
+        }
+        return false;
+    }
 
-	private function isSubadmin() {
-		$user = $this->userSession->getUser();
-		if ($user !== null) {
-			return $this->groupManager->getSubAdmin()->isSubAdmin($user);
-		}
-		return false;
-	}
+    private function isSubadmin() {
+        $user = $this->userSession->getUser();
+        if ($user !== null) {
+            return $this->groupManager->getSubAdmin()->isSubAdmin($user);
+        }
+        return false;
+    }
 }

lib/public/Settings/IManager.php

Indentation +77 added lines, -77 removed lines

@@ -27,89 +27,89 @@
  * @since 9.1
  */
 interface IManager {
-	/**
-	 * @since 9.1.0
-	 */
-	const KEY_ADMIN_SETTINGS = 'admin';
+    /**
+     * @since 9.1.0
+     */
+    const KEY_ADMIN_SETTINGS = 'admin';
 
-	/**
-	 * @since 9.1.0
-	 */
-	const KEY_ADMIN_SECTION  = 'admin-section';
+    /**
+     * @since 9.1.0
+     */
+    const KEY_ADMIN_SECTION  = 'admin-section';
 
-	/**
-	 * sets up settings according to data specified by an apps info.xml, within
-	 * the <settings> element.
-	 *
-	 * @param array $settings an associative array, allowed keys are as specified
-	 *                        by the KEY_ constant of  this interface. The value
-	 *                        must always be a class name, implement either
-	 *                        IAdmin or ISection. I.e. only one section and admin
-	 *                        setting can be configured per app.
-	 * @since 9.1.0
-	 */
-	public function setupSettings(array $settings);
+    /**
+     * sets up settings according to data specified by an apps info.xml, within
+     * the <settings> element.
+     *
+     * @param array $settings an associative array, allowed keys are as specified
+     *                        by the KEY_ constant of  this interface. The value
+     *                        must always be a class name, implement either
+     *                        IAdmin or ISection. I.e. only one section and admin
+     *                        setting can be configured per app.
+     * @since 9.1.0
+     */
+    public function setupSettings(array $settings);
 
-	/**
-	 * 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.
-	 *
-	 * What this does not help with is when applications change their settings
-	 * or section classes during their life time. New entries will be added,
-	 * but inactive ones will still reside in the database.
-	 *
-	 * @param string $appId
-	 * @since 9.1.0
-	 */
-	public function onAppDisabled($appId);
+    /**
+     * 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.
+     *
+     * What this does not help with is when applications change their settings
+     * or section classes during their life time. New entries will be added,
+     * but inactive ones will still reside in the database.
+     *
+     * @param string $appId
+     * @since 9.1.0
+     */
+    public function onAppDisabled($appId);
 
-	/**
-	 * The method should check all registered classes whether they are still
-	 * instantiable and remove them, if not. This method is called by a
-	 * background job once, after one or more apps were updated.
-	 *
-	 * An app`s info.xml can change during an update and make it unknown whether
-	 * a registered class name was changed or not. An old one would just stay
-	 * registered. Another case is if an admin takes a radical approach and
-	 * simply removes an app from the app folder. These unregular checks will
-	 * take care of such situations.
-	 *
-	 * @since 9.1.0
-	 */
-	public function checkForOrphanedClassNames();
+    /**
+     * The method should check all registered classes whether they are still
+     * instantiable and remove them, if not. This method is called by a
+     * background job once, after one or more apps were updated.
+     *
+     * An app`s info.xml can change during an update and make it unknown whether
+     * a registered class name was changed or not. An old one would just stay
+     * registered. Another case is if an admin takes a radical approach and
+     * simply removes an app from the app folder. These unregular checks will
+     * take care of such situations.
+     *
+     * @since 9.1.0
+     */
+    public function checkForOrphanedClassNames();
 
-	/**
-	 * returns a list of the admin sections
-	 *
-	 * @return array array of ISection[] where key is the priority
-	 * @since 9.1.0
-	 */
-	public function getAdminSections();
+    /**
+     * returns a list of the admin sections
+     *
+     * @return array array of ISection[] where key is the priority
+     * @since 9.1.0
+     */
+    public function getAdminSections();
 
-	/**
-	 * returns a list of the personal sections
-	 *
-	 * @return array array of ISection[] where key is the priority
-	 * @since 12.0.0
-	 */
-	public function getPersonalSections();
+    /**
+     * returns a list of the personal sections
+     *
+     * @return array array of ISection[] where key is the priority
+     * @since 12.0.0
+     */
+    public function getPersonalSections();
 
-	/**
-	 * returns a list of the admin settings
-	 *
-	 * @param string $section the section id for which to load the settings
-	 * @return array array of IAdmin[] where key is the priority
-	 * @since 9.1.0
-	 */
-	public function getAdminSettings($section);
+    /**
+     * returns a list of the admin settings
+     *
+     * @param string $section the section id for which to load the settings
+     * @return array array of IAdmin[] where key is the priority
+     * @since 9.1.0
+     */
+    public function getAdminSettings($section);
 
-	/**
-	 * returns a list of the personal  settings
-	 *
-	 * @param string $section the section id for which to load the settings
-	 * @return array array of IPersonal[] where key is the priority
-	 * @since 12.0.0
-	 */
-	public function getPersonalSettings($section);
+    /**
+     * returns a list of the personal  settings
+     *
+     * @param string $section the section id for which to load the settings
+     * @return array array of IPersonal[] where key is the priority
+     * @since 12.0.0
+     */
+    public function getPersonalSettings($section);
 }

settings/Controller/AdminSettingsController.php

Indentation +69 added lines, -69 removed lines

@@ -35,84 +35,84 @@
  * @package OC\Settings\Controller
  */
 class AdminSettingsController extends Controller {
-	use CommonSettingsTrait;
+    use CommonSettingsTrait;
 
-	/** @var INavigationManager */
-	private $navigationManager;
-	/** @var ISettingsManager */
-	private $settingsManager;
+    /** @var INavigationManager */
+    private $navigationManager;
+    /** @var ISettingsManager */
+    private $settingsManager;
 
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param INavigationManager $navigationManager
-	 * @param ISettingsManager $settingsManager
-	 */
-	public function __construct(
-		$appName,
-		IRequest $request,
-		INavigationManager $navigationManager,
-		ISettingsManager $settingsManager
-	) {
-		parent::__construct($appName, $request);
-		$this->navigationManager = $navigationManager;
-		$this->settingsManager = $settingsManager;
-	}
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param INavigationManager $navigationManager
+     * @param ISettingsManager $settingsManager
+     */
+    public function __construct(
+        $appName,
+        IRequest $request,
+        INavigationManager $navigationManager,
+        ISettingsManager $settingsManager
+    ) {
+        parent::__construct($appName, $request);
+        $this->navigationManager = $navigationManager;
+        $this->settingsManager = $settingsManager;
+    }
 
-	/**
-	 * @param string $section
-	 * @return TemplateResponse
-	 *
-	 * @NoCSRFRequired
-	 */
-	public function index($section) {
-		$this->navigationManager->setActiveEntry('admin');
-		return $this->getIndexResponse($section);
-	}
+    /**
+     * @param string $section
+     * @return TemplateResponse
+     *
+     * @NoCSRFRequired
+     */
+    public function index($section) {
+        $this->navigationManager->setActiveEntry('admin');
+        return $this->getIndexResponse($section);
+    }
 
-	/**
-	 * @param string $section
-	 * @return array
-	 */
-	private function getSettings($section) {
-		// PhpStorm shows this as unused, but is required by CommonSettingsTrait
-		$settings = $this->settingsManager->getAdminSettings($section);
-		$formatted = $this->formatSettings($settings);
-		if($section === 'additional') {
-			$formatted['content'] .= $this->getLegacyForms();
-		}
-		return $formatted;
-	}
+    /**
+     * @param string $section
+     * @return array
+     */
+    private function getSettings($section) {
+        // PhpStorm shows this as unused, but is required by CommonSettingsTrait
+        $settings = $this->settingsManager->getAdminSettings($section);
+        $formatted = $this->formatSettings($settings);
+        if($section === 'additional') {
+            $formatted['content'] .= $this->getLegacyForms();
+        }
+        return $formatted;
+    }
 
-	/**
-	 * @return bool|string
-	 */
-	private function getLegacyForms() {
-		$forms = \OC_App::getForms('admin');
+    /**
+     * @return bool|string
+     */
+    private function getLegacyForms() {
+        $forms = \OC_App::getForms('admin');
 
-		$forms = array_map(function ($form) {
-			if (preg_match('%(<h2(?P<class>[^>]*)>.*?</h2>)%i', $form, $regs)) {
-				$sectionName = str_replace('<h2' . $regs['class'] . '>', '', $regs[0]);
-				$sectionName = str_replace('</h2>', '', $sectionName);
-				$anchor = strtolower($sectionName);
-				$anchor = str_replace(' ', '-', $anchor);
+        $forms = array_map(function ($form) {
+            if (preg_match('%(<h2(?P<class>[^>]*)>.*?</h2>)%i', $form, $regs)) {
+                $sectionName = str_replace('<h2' . $regs['class'] . '>', '', $regs[0]);
+                $sectionName = str_replace('</h2>', '', $sectionName);
+                $anchor = strtolower($sectionName);
+                $anchor = str_replace(' ', '-', $anchor);
 
-				return array(
-					'anchor' => $anchor,
-					'section-name' => $sectionName,
-					'form' => $form
-				);
-			}
-			return array(
-				'form' => $form
-			);
-		}, $forms);
+                return array(
+                    'anchor' => $anchor,
+                    'section-name' => $sectionName,
+                    'form' => $form
+                );
+            }
+            return array(
+                'form' => $form
+            );
+        }, $forms);
 
-		$out = new Template('settings', 'admin/additional');
-		$out->assign('forms', $forms);
+        $out = new Template('settings', 'admin/additional');
+        $out->assign('forms', $forms);
 
-		return $out->fetchPage();
-	}
+        return $out->fetchPage();
+    }
 
 
 }

settings/Controller/PersonalSettingsController.php

Indentation +36 added lines, -36 removed lines

@@ -30,44 +30,44 @@
 use OCP\Settings\IManager as ISettingsManager;
 
 class PersonalSettingsController extends Controller {
-	use CommonSettingsTrait {
-		getSettings as private;
-	}
+    use CommonSettingsTrait {
+        getSettings as private;
+    }
 
-	/** @var INavigationManager */
-	private $navigationManager;
+    /** @var INavigationManager */
+    private $navigationManager;
 
-	public function __construct(
-		$appName,
-		IRequest $request,
-		INavigationManager $navigationManager,
-		ISettingsManager $settingsManager
-	) {
-		parent::__construct($appName, $request);
-		$this->navigationManager = $navigationManager;
-		$this->settingsManager = $settingsManager;
-	}
+    public function __construct(
+        $appName,
+        IRequest $request,
+        INavigationManager $navigationManager,
+        ISettingsManager $settingsManager
+    ) {
+        parent::__construct($appName, $request);
+        $this->navigationManager = $navigationManager;
+        $this->settingsManager = $settingsManager;
+    }
 
-	/**
-	 * @param string $section
-	 * @return TemplateResponse
-	 *
-	 * @NoCSRFRequired
-	 * @NoAdminRequired
-	 * @NoSubadminRequired
-	 */
-	public function index($section) {
-		$this->navigationManager->setActiveEntry('personal');
-		return $this->getIndexResponse($section);
-	}
+    /**
+     * @param string $section
+     * @return TemplateResponse
+     *
+     * @NoCSRFRequired
+     * @NoAdminRequired
+     * @NoSubadminRequired
+     */
+    public function index($section) {
+        $this->navigationManager->setActiveEntry('personal');
+        return $this->getIndexResponse($section);
+    }
 
-	/**
-	 * @param string $section
-	 * @return array
-	 */
-	private function getSettings($section) {
-		// PhpStorm shows this as unused, but is required by CommonSettingsTrait
-		$settings = $this->settingsManager->getPersonalSettings($section);
-		return $this->formatSettings($settings);
-	}
+    /**
+     * @param string $section
+     * @return array
+     */
+    private function getSettings($section) {
+        // PhpStorm shows this as unused, but is required by CommonSettingsTrait
+        $settings = $this->settingsManager->getPersonalSettings($section);
+        return $this->formatSettings($settings);
+    }
 }

settings/templates/settings/frame.php

Indentation +23 added lines, -23 removed lines

@@ -32,13 +32,13 @@ 
 	<ul>
 		<li class="settings-caption">Personal</li>
 		<?php
-		foreach($_['forms']['personal'] as $form) {
-			if (isset($form['anchor'])) {
-				$anchor = \OC::$server->getURLGenerator()->linkToRoute('settings.PersonalSettings.index', ['section' => $form['anchor']]);
-				$class = 'nav-icon-' . $form['anchor'];
-				$sectionName = $form['section-name'];
-				$active = $form['active'] ? ' class="active"' : '';
-				?>
+        foreach($_['forms']['personal'] as $form) {
+            if (isset($form['anchor'])) {
+                $anchor = \OC::$server->getURLGenerator()->linkToRoute('settings.PersonalSettings.index', ['section' => $form['anchor']]);
+                $class = 'nav-icon-' . $form['anchor'];
+                $sectionName = $form['section-name'];
+                $active = $form['active'] ? ' class="active"' : '';
+                ?>
 				<li <?php print_unescaped($form['active'] ? ' class="active"' : ''); ?>>
 					<a href="<?php p($anchor); ?>">
 						<?php if (!empty($form['icon'])) { ?>
@@ -50,24 +50,24 @@ 
 					</a>
 				</li>
 				<?php
-			}
-		}
-		?>
+            }
+        }
+        ?>
 
 		<?php
-		if(!empty($_['forms']['admin'])) {
-			?>
+        if(!empty($_['forms']['admin'])) {
+            ?>
 			<li class="settings-caption">Administration</li>
 			<?php
-		}
-		foreach($_['forms']['admin'] as $form) {
-			if (isset($form['anchor'])) {
+        }
+        foreach($_['forms']['admin'] as $form) {
+            if (isset($form['anchor'])) {
 
-				$anchor = \OC::$server->getURLGenerator()->linkToRoute('settings.AdminSettings.index', ['section' => $form['anchor']]);
-				$class = 'nav-icon-' . $form['anchor'];
-				$sectionName = $form['section-name'];
-				$active = $form['active'] ? ' class="active"' : '';
-		?>
+                $anchor = \OC::$server->getURLGenerator()->linkToRoute('settings.AdminSettings.index', ['section' => $form['anchor']]);
+                $class = 'nav-icon-' . $form['anchor'];
+                $sectionName = $form['section-name'];
+                $active = $form['active'] ? ' class="active"' : '';
+        ?>
 				<li <?php print_unescaped($form['active'] ? ' class="active"' : ''); ?>>
 					<a href="<?php p($anchor); ?>">
 						<?php if (!empty($form['icon'])) { ?>
@@ -79,9 +79,9 @@ 
 					</a>
 				</li>
 		<?php
-			}
-		}
-		?>
+            }
+        }
+        ?>
 	</ul>
 </div>
 

lib/private/Settings/Manager.php

Indentation +375 added lines, -375 removed lines

@@ -41,379 +41,379 @@
 use OCP\Settings\ISection;
 
 class Manager implements IManager {
-	const TABLE_ADMIN_SETTINGS = 'admin_settings';
-	const TABLE_ADMIN_SECTIONS = 'admin_sections';
-
-	/** @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;
-
-	/**
-	 * @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
-	 */
-	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
-	) {
-		$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;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function setupSettings(array $settings) {
-		if (isset($settings[IManager::KEY_ADMIN_SECTION])) {
-			$this->setupAdminSection($settings[IManager::KEY_ADMIN_SECTION]);
-		}
-		if (isset($settings[IManager::KEY_ADMIN_SETTINGS])) {
-			$this->setupAdminSettings($settings[IManager::KEY_ADMIN_SETTINGS]);
-		}
-	}
-
-	/**
-	 * 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(self::TABLE_ADMIN_SECTIONS, trim($appInfo['settings'][IManager::KEY_ADMIN_SECTION], '\\'));
-		}
-		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];
-		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
-	 */
-	private function setupAdminSection($sectionClassName) {
-		if (!class_exists($sectionClassName)) {
-			$this->log->debug('Could not find admin section class ' . $sectionClassName);
-			return;
-		}
-		try {
-			$section = $this->query($sectionClassName);
-		} catch (QueryException $e) {
-			// cancel
-			return;
-		}
-
-		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))) {
-			$this->addAdminSection($section);
-		} else {
-			$this->updateAdminSection($section);
-		}
-	}
-
-	private function addAdminSection(ISection $section) {
-		$this->mapper->add(self::TABLE_ADMIN_SECTIONS, [
-			'id' => $section->getID(),
-			'class' => get_class($section),
-			'priority' => $section->getPriority(),
-		]);
-	}
-
-	private function addAdminSettings(ISettings $settings) {
-		$this->mapper->add(self::TABLE_ADMIN_SETTINGS, [
-			'class' => get_class($settings),
-			'section' => $settings->getSection(),
-			'priority' => $settings->getPriority(),
-		]);
-	}
-
-	private function updateAdminSettings(ISettings $settings) {
-		$this->mapper->update(
-			self::TABLE_ADMIN_SETTINGS,
-			'class',
-			get_class($settings),
-			[
-				'section' => $settings->getSection(),
-				'priority' => $settings->getPriority(),
-			]
-		);
-	}
-
-	private function updateAdminSection(ISection $section) {
-		$this->mapper->update(
-			self::TABLE_ADMIN_SECTIONS,
-			'class',
-			get_class($section),
-			[
-				'id' => $section->getID(),
-				'priority' => $section->getPriority(),
-			]
-		);
-	}
-
-	/**
-	 * @param string $className
-	 * @return bool
-	 */
-	private function hasAdminSection($className) {
-		return $this->mapper->has(self::TABLE_ADMIN_SECTIONS, $className);
-	}
-
-	/**
-	 * @param string $className
-	 * @return bool
-	 */
-	private function hasAdminSettings($className) {
-		return $this->mapper->has(self::TABLE_ADMIN_SETTINGS, $className);
-	}
-
-	private function setupAdminSettings($settingsClassName) {
-		if (!class_exists($settingsClassName)) {
-			$this->log->debug('Could not find admin section class ' . $settingsClassName);
-			return;
-		}
-
-		try {
-			/** @var ISettings $settings */
-			$settings = $this->query($settingsClassName);
-		} catch (QueryException $e) {
-			// cancel
-			return;
-		}
-
-		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))) {
-			$this->addAdminSettings($settings);
-		} else {
-			$this->updateAdminSettings($settings);
-		}
-	}
-
-	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->l10nFactory, $this->defaults);
-				$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'))],
-		];
-		return $sections;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getPersonalSettings($section) {
-		$settings = $this->getBuiltInPersonalSettings($section);
-		return $settings;
-	}
+    const TABLE_ADMIN_SETTINGS = 'admin_settings';
+    const TABLE_ADMIN_SECTIONS = 'admin_sections';
+
+    /** @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;
+
+    /**
+     * @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
+     */
+    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
+    ) {
+        $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;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setupSettings(array $settings) {
+        if (isset($settings[IManager::KEY_ADMIN_SECTION])) {
+            $this->setupAdminSection($settings[IManager::KEY_ADMIN_SECTION]);
+        }
+        if (isset($settings[IManager::KEY_ADMIN_SETTINGS])) {
+            $this->setupAdminSettings($settings[IManager::KEY_ADMIN_SETTINGS]);
+        }
+    }
+
+    /**
+     * 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(self::TABLE_ADMIN_SECTIONS, trim($appInfo['settings'][IManager::KEY_ADMIN_SECTION], '\\'));
+        }
+        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];
+        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
+     */
+    private function setupAdminSection($sectionClassName) {
+        if (!class_exists($sectionClassName)) {
+            $this->log->debug('Could not find admin section class ' . $sectionClassName);
+            return;
+        }
+        try {
+            $section = $this->query($sectionClassName);
+        } catch (QueryException $e) {
+            // cancel
+            return;
+        }
+
+        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))) {
+            $this->addAdminSection($section);
+        } else {
+            $this->updateAdminSection($section);
+        }
+    }
+
+    private function addAdminSection(ISection $section) {
+        $this->mapper->add(self::TABLE_ADMIN_SECTIONS, [
+            'id' => $section->getID(),
+            'class' => get_class($section),
+            'priority' => $section->getPriority(),
+        ]);
+    }
+
+    private function addAdminSettings(ISettings $settings) {
+        $this->mapper->add(self::TABLE_ADMIN_SETTINGS, [
+            'class' => get_class($settings),
+            'section' => $settings->getSection(),
+            'priority' => $settings->getPriority(),
+        ]);
+    }
+
+    private function updateAdminSettings(ISettings $settings) {
+        $this->mapper->update(
+            self::TABLE_ADMIN_SETTINGS,
+            'class',
+            get_class($settings),
+            [
+                'section' => $settings->getSection(),
+                'priority' => $settings->getPriority(),
+            ]
+        );
+    }
+
+    private function updateAdminSection(ISection $section) {
+        $this->mapper->update(
+            self::TABLE_ADMIN_SECTIONS,
+            'class',
+            get_class($section),
+            [
+                'id' => $section->getID(),
+                'priority' => $section->getPriority(),
+            ]
+        );
+    }
+
+    /**
+     * @param string $className
+     * @return bool
+     */
+    private function hasAdminSection($className) {
+        return $this->mapper->has(self::TABLE_ADMIN_SECTIONS, $className);
+    }
+
+    /**
+     * @param string $className
+     * @return bool
+     */
+    private function hasAdminSettings($className) {
+        return $this->mapper->has(self::TABLE_ADMIN_SETTINGS, $className);
+    }
+
+    private function setupAdminSettings($settingsClassName) {
+        if (!class_exists($settingsClassName)) {
+            $this->log->debug('Could not find admin section class ' . $settingsClassName);
+            return;
+        }
+
+        try {
+            /** @var ISettings $settings */
+            $settings = $this->query($settingsClassName);
+        } catch (QueryException $e) {
+            // cancel
+            return;
+        }
+
+        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))) {
+            $this->addAdminSettings($settings);
+        } else {
+            $this->updateAdminSettings($settings);
+        }
+    }
+
+    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->l10nFactory, $this->defaults);
+                $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'))],
+        ];
+        return $sections;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getPersonalSettings($section) {
+        $settings = $this->getBuiltInPersonalSettings($section);
+        return $settings;
+    }
 }

lib/private/Settings/Personal/PersonalInfo.php

Indentation +169 added lines, -169 removed lines

@@ -34,173 +34,173 @@
 use OCP\Settings\ISettings;
 
 class PersonalInfo implements ISettings {
-	/** @var IConfig */
-	private $config;
-	/** @var IUserManager */
-	private $userManager;
-	/** @var AccountManager */
-	private $accountManager;
-	/** @var IGroupManager */
-	private $groupManager;
-	/** @var IFactory */
-	private $l10nFactory;
-
-	const COMMON_LANGUAGE_CODES = [
-		'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it',
-		'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko'
-	];
-	/** @var \OC_Defaults */
-	private $defaults;
-
-	/**
-	 * @param IConfig $config
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param AccountManager $accountManager
-	 * @param IFactory $l10nFactory
-	 */
-	public function __construct(
-		IConfig $config,
-		IUserManager $userManager,
-		IGroupManager $groupManager,
-		AccountManager $accountManager,
-		IFactory $l10nFactory,
-		\OC_Defaults $defaults
-	) {
-		$this->config = $config;
-		$this->userManager = $userManager;
-		$this->accountManager = $accountManager;
-		$this->groupManager = $groupManager;
-		$this->l10nFactory = $l10nFactory;
-		$this->defaults = $defaults;
-	}
-
-	/**
-	 * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
-	 * @since 9.1
-	 */
-	public function getForm() {
-		$lookupServerUploadEnabled = $this->config->getAppValue('files_sharing', 'lookupServerUploadEnabled', 'yes');
-		$lookupServerUploadEnabled = $lookupServerUploadEnabled === 'yes';
-
-		$uid = \OC_User::getUser();
-		$user = $this->userManager->get($uid);
-
-		$userData = $this->accountManager->getUser($user);
-		list($activeLanguage, $commonLanguages, $languages) = $this->getLanguages($user);
-
-		//links to clients
-		$clients = [
-			'desktop' => $this->config->getSystemValue('customclient_desktop', $this->defaults->getSyncClientUrl()),
-			'android' => $this->config->getSystemValue('customclient_android', $this->defaults->getAndroidClientUrl()),
-			'ios'     => $this->config->getSystemValue('customclient_ios', $this->defaults->getiOSClientUrl())
-		];
-
-		$parameters = [
-			'avatarChangeSupported' => \OC_User::canUserChangeAvatar($uid),
-			'lookupServerUploadEnabled' => $lookupServerUploadEnabled,
-			'avatar_scope' => $userData[AccountManager::PROPERTY_AVATAR]['scope'],
-			'displayNameChangeSupported' => \OC_User::canUserChangeDisplayName($uid),
-			'displayName' => $userData[AccountManager::PROPERTY_DISPLAYNAME]['value'],
-			'email' => $userData[AccountManager::PROPERTY_EMAIL]['value'],
-			'emailScope' => $userData[AccountManager::PROPERTY_EMAIL]['scope'],
-			'emailMesage' => '',
-			'emailVerification' => $userData[AccountManager::PROPERTY_EMAIL]['verified'],
-			'phone' => $userData[AccountManager::PROPERTY_PHONE]['value'],
-			'phoneScope' => $userData[AccountManager::PROPERTY_PHONE]['scope'],
-			'address', $userData[AccountManager::PROPERTY_ADDRESS]['value'],
-			'addressScope', $userData[AccountManager::PROPERTY_ADDRESS]['scope'],
-			'website' =>  $userData[AccountManager::PROPERTY_WEBSITE]['value'],
-			'websiteScope' =>  $userData[AccountManager::PROPERTY_WEBSITE]['scope'],
-			'websiteVerification' => $userData[AccountManager::PROPERTY_WEBSITE]['verified'],
-			'twitter' => $userData[AccountManager::PROPERTY_TWITTER]['value'],
-			'twitterScope' => $userData[AccountManager::PROPERTY_TWITTER]['scope'],
-			'twitterVerification' => $userData[AccountManager::PROPERTY_TWITTER]['verified'],
-			'groups' => $this->groupManager->getUserGroups($user),
-			'passwordChangeSupported' => \OC_User::canUserChangePassword($uid),
-			'activelanguage' => $activeLanguage,
-			'commonlanguages' => $commonLanguages,
-			'languages' => $languages,
-			'clients' => $clients,
-		];
-
-
-		return new TemplateResponse('settings', 'settings/personal/personal.info', $parameters, '');
-	}
-
-	/**
-	 * @return string the section ID, e.g. 'sharing'
-	 * @since 9.1
-	 */
-	public function getSection() {
-		return 'personal-info';
-	}
-
-	/**
-	 * @return int whether the form should be rather on the top or bottom of
-	 * the admin section. The forms are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 *
-	 * E.g.: 70
-	 * @since 9.1
-	 */
-	public function getPriority() {
-		return 10;
-	}
-
-	private function getLanguages(IUser $user) {
-		$uid = $user->getUID();
-
-		$commonLanguages = [];
-		$userLang = $this->config->getUserValue($uid, 'core', 'lang', $this->l10nFactory->findLanguage());
-		$languageCodes = $this->l10nFactory->findAvailableLanguages();
-		foreach($languageCodes as $lang) {
-			$l = \OC::$server->getL10N('settings', $lang);
-			// TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
-			$potentialName = (string) $l->t('__language_name__');
-			if($l->getLanguageCode() === $lang && substr($potentialName, 0, 1) !== '_') {//first check if the language name is in the translation file
-				$ln = array('code' => $lang, 'name' => $potentialName);
-			} elseif ($lang === 'en') {
-				$ln = ['code' => $lang, 'name' => 'English (US)'];
-			}else{//fallback to language code
-				$ln=array('code'=>$lang, 'name'=>$lang);
-			}
-
-			// put appropriate languages into appropriate arrays, to print them sorted
-			// used language -> common languages -> divider -> other languages
-			if ($lang === $userLang) {
-				$userLang = $ln;
-			} elseif (in_array($lang, self::COMMON_LANGUAGE_CODES)) {
-				$commonLanguages[array_search($lang, self::COMMON_LANGUAGE_CODES)]=$ln;
-			} else {
-				$languages[]=$ln;
-			}
-		}
-
-		// if user language is not available but set somehow: show the actual code as name
-		if (!is_array($userLang)) {
-			$userLang = [
-				'code' => $userLang,
-				'name' => $userLang,
-			];
-		}
-
-		ksort($commonLanguages);
-
-		// sort now by displayed language not the iso-code
-		usort( $languages, function ($a, $b) {
-			if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
-				// If a doesn't have a name, but b does, list b before a
-				return 1;
-			}
-			if ($a['code'] !== $a['name'] && $b['code'] === $b['name']) {
-				// If a does have a name, but b doesn't, list a before b
-				return -1;
-			}
-			// Otherwise compare the names
-			return strcmp($a['name'], $b['name']);
-		});
-
-		return [$userLang, $commonLanguages, $languages];
-	}
+    /** @var IConfig */
+    private $config;
+    /** @var IUserManager */
+    private $userManager;
+    /** @var AccountManager */
+    private $accountManager;
+    /** @var IGroupManager */
+    private $groupManager;
+    /** @var IFactory */
+    private $l10nFactory;
+
+    const COMMON_LANGUAGE_CODES = [
+        'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it',
+        'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko'
+    ];
+    /** @var \OC_Defaults */
+    private $defaults;
+
+    /**
+     * @param IConfig $config
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param AccountManager $accountManager
+     * @param IFactory $l10nFactory
+     */
+    public function __construct(
+        IConfig $config,
+        IUserManager $userManager,
+        IGroupManager $groupManager,
+        AccountManager $accountManager,
+        IFactory $l10nFactory,
+        \OC_Defaults $defaults
+    ) {
+        $this->config = $config;
+        $this->userManager = $userManager;
+        $this->accountManager = $accountManager;
+        $this->groupManager = $groupManager;
+        $this->l10nFactory = $l10nFactory;
+        $this->defaults = $defaults;
+    }
+
+    /**
+     * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
+     * @since 9.1
+     */
+    public function getForm() {
+        $lookupServerUploadEnabled = $this->config->getAppValue('files_sharing', 'lookupServerUploadEnabled', 'yes');
+        $lookupServerUploadEnabled = $lookupServerUploadEnabled === 'yes';
+
+        $uid = \OC_User::getUser();
+        $user = $this->userManager->get($uid);
+
+        $userData = $this->accountManager->getUser($user);
+        list($activeLanguage, $commonLanguages, $languages) = $this->getLanguages($user);
+
+        //links to clients
+        $clients = [
+            'desktop' => $this->config->getSystemValue('customclient_desktop', $this->defaults->getSyncClientUrl()),
+            'android' => $this->config->getSystemValue('customclient_android', $this->defaults->getAndroidClientUrl()),
+            'ios'     => $this->config->getSystemValue('customclient_ios', $this->defaults->getiOSClientUrl())
+        ];
+
+        $parameters = [
+            'avatarChangeSupported' => \OC_User::canUserChangeAvatar($uid),
+            'lookupServerUploadEnabled' => $lookupServerUploadEnabled,
+            'avatar_scope' => $userData[AccountManager::PROPERTY_AVATAR]['scope'],
+            'displayNameChangeSupported' => \OC_User::canUserChangeDisplayName($uid),
+            'displayName' => $userData[AccountManager::PROPERTY_DISPLAYNAME]['value'],
+            'email' => $userData[AccountManager::PROPERTY_EMAIL]['value'],
+            'emailScope' => $userData[AccountManager::PROPERTY_EMAIL]['scope'],
+            'emailMesage' => '',
+            'emailVerification' => $userData[AccountManager::PROPERTY_EMAIL]['verified'],
+            'phone' => $userData[AccountManager::PROPERTY_PHONE]['value'],
+            'phoneScope' => $userData[AccountManager::PROPERTY_PHONE]['scope'],
+            'address', $userData[AccountManager::PROPERTY_ADDRESS]['value'],
+            'addressScope', $userData[AccountManager::PROPERTY_ADDRESS]['scope'],
+            'website' =>  $userData[AccountManager::PROPERTY_WEBSITE]['value'],
+            'websiteScope' =>  $userData[AccountManager::PROPERTY_WEBSITE]['scope'],
+            'websiteVerification' => $userData[AccountManager::PROPERTY_WEBSITE]['verified'],
+            'twitter' => $userData[AccountManager::PROPERTY_TWITTER]['value'],
+            'twitterScope' => $userData[AccountManager::PROPERTY_TWITTER]['scope'],
+            'twitterVerification' => $userData[AccountManager::PROPERTY_TWITTER]['verified'],
+            'groups' => $this->groupManager->getUserGroups($user),
+            'passwordChangeSupported' => \OC_User::canUserChangePassword($uid),
+            'activelanguage' => $activeLanguage,
+            'commonlanguages' => $commonLanguages,
+            'languages' => $languages,
+            'clients' => $clients,
+        ];
+
+
+        return new TemplateResponse('settings', 'settings/personal/personal.info', $parameters, '');
+    }
+
+    /**
+     * @return string the section ID, e.g. 'sharing'
+     * @since 9.1
+     */
+    public function getSection() {
+        return 'personal-info';
+    }
+
+    /**
+     * @return int whether the form should be rather on the top or bottom of
+     * the admin section. The forms are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     *
+     * E.g.: 70
+     * @since 9.1
+     */
+    public function getPriority() {
+        return 10;
+    }
+
+    private function getLanguages(IUser $user) {
+        $uid = $user->getUID();
+
+        $commonLanguages = [];
+        $userLang = $this->config->getUserValue($uid, 'core', 'lang', $this->l10nFactory->findLanguage());
+        $languageCodes = $this->l10nFactory->findAvailableLanguages();
+        foreach($languageCodes as $lang) {
+            $l = \OC::$server->getL10N('settings', $lang);
+            // TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
+            $potentialName = (string) $l->t('__language_name__');
+            if($l->getLanguageCode() === $lang && substr($potentialName, 0, 1) !== '_') {//first check if the language name is in the translation file
+                $ln = array('code' => $lang, 'name' => $potentialName);
+            } elseif ($lang === 'en') {
+                $ln = ['code' => $lang, 'name' => 'English (US)'];
+            }else{//fallback to language code
+                $ln=array('code'=>$lang, 'name'=>$lang);
+            }
+
+            // put appropriate languages into appropriate arrays, to print them sorted
+            // used language -> common languages -> divider -> other languages
+            if ($lang === $userLang) {
+                $userLang = $ln;
+            } elseif (in_array($lang, self::COMMON_LANGUAGE_CODES)) {
+                $commonLanguages[array_search($lang, self::COMMON_LANGUAGE_CODES)]=$ln;
+            } else {
+                $languages[]=$ln;
+            }
+        }
+
+        // if user language is not available but set somehow: show the actual code as name
+        if (!is_array($userLang)) {
+            $userLang = [
+                'code' => $userLang,
+                'name' => $userLang,
+            ];
+        }
+
+        ksort($commonLanguages);
+
+        // sort now by displayed language not the iso-code
+        usort( $languages, function ($a, $b) {
+            if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
+                // If a doesn't have a name, but b does, list b before a
+                return 1;
+            }
+            if ($a['code'] !== $a['name'] && $b['code'] === $b['name']) {
+                // If a does have a name, but b doesn't, list a before b
+                return -1;
+            }
+            // Otherwise compare the names
+            return strcmp($a['name'], $b['name']);
+        });
+
+        return [$userLang, $commonLanguages, $languages];
+    }
 }

lib/private/Settings/Mapper.php

Indentation +133 added lines, -133 removed lines

@@ -26,138 +26,138 @@
 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;
-	}
-
-	/**
-	 * 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) {
-		$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();
-	}
-
-	/**
-	 * Get the configured admin sections from the database
-	 *
-	 * @return array[] [['class' => string, 'priority' => int], ...]
-	 */
-	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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
-	 * @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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
-	 * @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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
-	 * @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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
-	 * @param $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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
-	 * @param string $idCol
-	 * @param string $id
-	 * @param array $values
-	 */
-	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';
+
+    /** @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) {
+        $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();
+    }
+
+    /**
+     * Get the configured admin sections from the database
+     *
+     * @return array[] [['class' => string, 'priority' => int], ...]
+     */
+    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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
+     * @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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
+     * @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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
+     * @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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
+     * @param $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 Mapper::TABLE_ADMIN_SECTIONS or Mapper::TABLE_ADMIN_SETTINGS
+     * @param string $idCol
+     * @param string $id
+     * @param array $values
+     */
+    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();
+    }
 
 }