nextcloud / server

apps/settings/lib/Controller/CommonSettingsTrait.php

Indentation +158 added lines, -158 removed lines

@@ -29,162 +29,162 @@
  */
 trait CommonSettingsTrait {
 
-	/** @var ISettingsManager */
-	private $settingsManager;
-
-	/** @var INavigationManager */
-	private $navigationManager;
-
-	/** @var IUserSession */
-	private $userSession;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var ISubAdmin */
-	private $subAdmin;
-
-	private IDeclarativeManager $declarativeSettingsManager;
-
-	/** @var IInitialState */
-	private $initialState;
-
-	/**
-	 * @param IIconSection[][] $sections
-	 * @psalm-param 'admin'|'personal' $type
-	 * @return list<array{id: string, name: string, active: bool, icon: string}>
-	 */
-	protected function formatSections(array $sections, string $currentSection, string $type, string $currentType): array {
-		$templateParameters = [];
-		foreach ($sections as $prioritizedSections) {
-			foreach ($prioritizedSections as $section) {
-				if ($type === 'admin') {
-					$settings = $this->settingsManager->getAllowedAdminSettings($section->getID(), $this->userSession->getUser());
-				} elseif ($type === 'personal') {
-					$settings = $this->settingsManager->getPersonalSettings($section->getID());
-				}
-
-				/** @psalm-suppress PossiblyNullArgument */
-				$declarativeFormIDs = $this->declarativeSettingsManager->getFormIDs($this->userSession->getUser(), $type, $section->getID());
-
-				if (empty($settings) && empty($declarativeFormIDs)) {
-					continue;
-				}
-
-				$icon = $section->getIcon();
-
-				$active = $section->getID() === $currentSection
-					&& $type === $currentType;
-
-				$templateParameters[] = [
-					'id' => $section->getID(),
-					'name' => $section->getName(),
-					'active' => $active,
-					'icon' => $icon,
-				];
-			}
-		}
-		return $templateParameters;
-	}
-
-	/**
-	 * @return list<array{id: string, name: string, active: bool, icon: string}>
-	 */
-	protected function formatPersonalSections(string $currentType, string $currentSection): array {
-		$sections = $this->settingsManager->getPersonalSections();
-		return $this->formatSections($sections, $currentSection, 'personal', $currentType);
-	}
-
-	/**
-	 * @return list<array{id: string, name: string, active: bool, icon: string}>
-	 */
-	protected function formatAdminSections(string $currentType, string $currentSection): array {
-		$sections = $this->settingsManager->getAdminSections();
-		return $this->formatSections($sections, $currentSection, 'admin', $currentType);
-	}
-
-	/**
-	 * @param list<ISettings> $settings
-	 * @param list<DeclarativeSettingsFormSchemaWithValues> $declarativeSettings
-	 * @return array{content: string}
-	 */
-	private function formatSettings(array $settings, array $declarativeSettings): array {
-		$settings = array_merge($settings, $declarativeSettings);
-
-		usort($settings, function ($first, $second) {
-			$priorityOne = $first instanceof ISettings ? $first->getPriority() : $first['priority'];
-			$priorityTwo = $second instanceof ISettings ? $second->getPriority() : $second['priority'];
-			return $priorityOne - $priorityTwo;
-		});
-
-		$html = '';
-		foreach ($settings as $setting) {
-			if ($setting instanceof ISettings) {
-				$form = $setting->getForm();
-				$html .= $form->renderAs('')->render();
-			} else {
-				$html .= '<div id="' . $setting['app'] . '_' . $setting['id'] . '"></div>';
-			}
-		}
-		return ['content' => $html];
-	}
-
-	/**
-	 * @psalm-param 'admin'|'personal' $type
-	 */
-	private function getIndexResponse(string $type, string $section): TemplateResponse {
-		$user = $this->userSession->getUser();
-		assert($user !== null, 'No user logged in for settings');
-
-		$this->declarativeSettingsManager->loadSchemas();
-		$declarativeSettings = $this->declarativeSettingsManager->getFormsWithValues($user, $type, $section);
-
-		foreach ($declarativeSettings as &$form) {
-			foreach ($form['fields'] as &$field) {
-				if (isset($field['sensitive']) && $field['sensitive'] === true && !empty($field['value'])) {
-					$field['value'] = 'dummySecret';
-				}
-			}
-		}
-
-		if ($type === 'personal') {
-			$settings = array_values($this->settingsManager->getPersonalSettings($section));
-			if ($section === 'theming') {
-				$this->navigationManager->setActiveEntry('accessibility_settings');
-			} else {
-				$this->navigationManager->setActiveEntry('settings');
-			}
-		} elseif ($type === 'admin') {
-			$settings = array_values($this->settingsManager->getAllowedAdminSettings($section, $user));
-			if (empty($settings) && empty($declarativeSettings)) {
-				throw new NotAdminException('Logged in user does not have permission to access these settings.');
-			}
-			$this->navigationManager->setActiveEntry('admin_settings');
-		} else {
-			throw new InvalidArgumentException('$type must be either "admin" or "personal"');
-		}
-
-		if (!empty($declarativeSettings)) {
-			Util::addScript(Application::APP_ID, 'declarative-settings-forms');
-			$this->initialState->provideInitialState('declarative-settings-forms', $declarativeSettings);
-		}
-
-		$this->initialState->provideInitialState('sections', [
-			'personal' => $this->formatPersonalSections($type, $section),
-			'admin' => $this->formatAdminSections($type, $section),
-		]);
-
-		$settings = array_merge(...$settings);
-		$templateParams = $this->formatSettings($settings, $declarativeSettings);
-
-		$activeSection = $this->settingsManager->getSection($type, $section);
-		if ($activeSection) {
-			$templateParams['pageTitle'] = $activeSection->getName();
-			$templateParams['activeSectionId'] = $activeSection->getID();
-			$templateParams['activeSectionType'] = $type;
-		}
-
-		Util::addScript(Application::APP_ID, 'main', prepend: true);
-		return new TemplateResponse('settings', 'settings/frame', $templateParams);
-	}
+    /** @var ISettingsManager */
+    private $settingsManager;
+
+    /** @var INavigationManager */
+    private $navigationManager;
+
+    /** @var IUserSession */
+    private $userSession;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var ISubAdmin */
+    private $subAdmin;
+
+    private IDeclarativeManager $declarativeSettingsManager;
+
+    /** @var IInitialState */
+    private $initialState;
+
+    /**
+     * @param IIconSection[][] $sections
+     * @psalm-param 'admin'|'personal' $type
+     * @return list<array{id: string, name: string, active: bool, icon: string}>
+     */
+    protected function formatSections(array $sections, string $currentSection, string $type, string $currentType): array {
+        $templateParameters = [];
+        foreach ($sections as $prioritizedSections) {
+            foreach ($prioritizedSections as $section) {
+                if ($type === 'admin') {
+                    $settings = $this->settingsManager->getAllowedAdminSettings($section->getID(), $this->userSession->getUser());
+                } elseif ($type === 'personal') {
+                    $settings = $this->settingsManager->getPersonalSettings($section->getID());
+                }
+
+                /** @psalm-suppress PossiblyNullArgument */
+                $declarativeFormIDs = $this->declarativeSettingsManager->getFormIDs($this->userSession->getUser(), $type, $section->getID());
+
+                if (empty($settings) && empty($declarativeFormIDs)) {
+                    continue;
+                }
+
+                $icon = $section->getIcon();
+
+                $active = $section->getID() === $currentSection
+                    && $type === $currentType;
+
+                $templateParameters[] = [
+                    'id' => $section->getID(),
+                    'name' => $section->getName(),
+                    'active' => $active,
+                    'icon' => $icon,
+                ];
+            }
+        }
+        return $templateParameters;
+    }
+
+    /**
+     * @return list<array{id: string, name: string, active: bool, icon: string}>
+     */
+    protected function formatPersonalSections(string $currentType, string $currentSection): array {
+        $sections = $this->settingsManager->getPersonalSections();
+        return $this->formatSections($sections, $currentSection, 'personal', $currentType);
+    }
+
+    /**
+     * @return list<array{id: string, name: string, active: bool, icon: string}>
+     */
+    protected function formatAdminSections(string $currentType, string $currentSection): array {
+        $sections = $this->settingsManager->getAdminSections();
+        return $this->formatSections($sections, $currentSection, 'admin', $currentType);
+    }
+
+    /**
+     * @param list<ISettings> $settings
+     * @param list<DeclarativeSettingsFormSchemaWithValues> $declarativeSettings
+     * @return array{content: string}
+     */
+    private function formatSettings(array $settings, array $declarativeSettings): array {
+        $settings = array_merge($settings, $declarativeSettings);
+
+        usort($settings, function ($first, $second) {
+            $priorityOne = $first instanceof ISettings ? $first->getPriority() : $first['priority'];
+            $priorityTwo = $second instanceof ISettings ? $second->getPriority() : $second['priority'];
+            return $priorityOne - $priorityTwo;
+        });
+
+        $html = '';
+        foreach ($settings as $setting) {
+            if ($setting instanceof ISettings) {
+                $form = $setting->getForm();
+                $html .= $form->renderAs('')->render();
+            } else {
+                $html .= '<div id="' . $setting['app'] . '_' . $setting['id'] . '"></div>';
+            }
+        }
+        return ['content' => $html];
+    }
+
+    /**
+     * @psalm-param 'admin'|'personal' $type
+     */
+    private function getIndexResponse(string $type, string $section): TemplateResponse {
+        $user = $this->userSession->getUser();
+        assert($user !== null, 'No user logged in for settings');
+
+        $this->declarativeSettingsManager->loadSchemas();
+        $declarativeSettings = $this->declarativeSettingsManager->getFormsWithValues($user, $type, $section);
+
+        foreach ($declarativeSettings as &$form) {
+            foreach ($form['fields'] as &$field) {
+                if (isset($field['sensitive']) && $field['sensitive'] === true && !empty($field['value'])) {
+                    $field['value'] = 'dummySecret';
+                }
+            }
+        }
+
+        if ($type === 'personal') {
+            $settings = array_values($this->settingsManager->getPersonalSettings($section));
+            if ($section === 'theming') {
+                $this->navigationManager->setActiveEntry('accessibility_settings');
+            } else {
+                $this->navigationManager->setActiveEntry('settings');
+            }
+        } elseif ($type === 'admin') {
+            $settings = array_values($this->settingsManager->getAllowedAdminSettings($section, $user));
+            if (empty($settings) && empty($declarativeSettings)) {
+                throw new NotAdminException('Logged in user does not have permission to access these settings.');
+            }
+            $this->navigationManager->setActiveEntry('admin_settings');
+        } else {
+            throw new InvalidArgumentException('$type must be either "admin" or "personal"');
+        }
+
+        if (!empty($declarativeSettings)) {
+            Util::addScript(Application::APP_ID, 'declarative-settings-forms');
+            $this->initialState->provideInitialState('declarative-settings-forms', $declarativeSettings);
+        }
+
+        $this->initialState->provideInitialState('sections', [
+            'personal' => $this->formatPersonalSections($type, $section),
+            'admin' => $this->formatAdminSections($type, $section),
+        ]);
+
+        $settings = array_merge(...$settings);
+        $templateParams = $this->formatSettings($settings, $declarativeSettings);
+
+        $activeSection = $this->settingsManager->getSection($type, $section);
+        if ($activeSection) {
+            $templateParams['pageTitle'] = $activeSection->getName();
+            $templateParams['activeSectionId'] = $activeSection->getID();
+            $templateParams['activeSectionType'] = $type;
+        }
+
+        Util::addScript(Application::APP_ID, 'main', prepend: true);
+        return new TemplateResponse('settings', 'settings/frame', $templateParams);
+    }
 }

apps/settings/tests/Controller/AdminSettingsControllerTest.php

Indentation +98 added lines, -98 removed lines

@@ -32,113 +32,113 @@
 #[\PHPUnit\Framework\Attributes\Group(name: 'DB')]
 class AdminSettingsControllerTest extends TestCase {
 
-	private IRequest&MockObject $request;
-	private INavigationManager&MockObject $navigationManager;
-	private IManager&MockObject $settingsManager;
-	private IUserSession&MockObject $userSession;
-	private IGroupManager&MockObject $groupManager;
-	private ISubAdmin&MockObject $subAdmin;
-	private IDeclarativeManager&MockObject $declarativeSettingsManager;
-	private IInitialState&MockObject $initialState;
+    private IRequest&MockObject $request;
+    private INavigationManager&MockObject $navigationManager;
+    private IManager&MockObject $settingsManager;
+    private IUserSession&MockObject $userSession;
+    private IGroupManager&MockObject $groupManager;
+    private ISubAdmin&MockObject $subAdmin;
+    private IDeclarativeManager&MockObject $declarativeSettingsManager;
+    private IInitialState&MockObject $initialState;
 
-	private string $adminUid = 'lololo';
-	private AdminSettingsController $adminSettingsController;
+    private string $adminUid = 'lololo';
+    private AdminSettingsController $adminSettingsController;
 
-	protected function setUp(): void {
-		parent::setUp();
+    protected function setUp(): void {
+        parent::setUp();
 
-		$this->request = $this->createMock(IRequest::class);
-		$this->navigationManager = $this->createMock(INavigationManager::class);
-		$this->settingsManager = $this->createMock(IManager::class);
-		$this->userSession = $this->createMock(IUserSession::class);
-		$this->groupManager = $this->createMock(IGroupManager::class);
-		$this->subAdmin = $this->createMock(ISubAdmin::class);
-		$this->declarativeSettingsManager = $this->createMock(IDeclarativeManager::class);
-		$this->initialState = $this->createMock(IInitialState::class);
+        $this->request = $this->createMock(IRequest::class);
+        $this->navigationManager = $this->createMock(INavigationManager::class);
+        $this->settingsManager = $this->createMock(IManager::class);
+        $this->userSession = $this->createMock(IUserSession::class);
+        $this->groupManager = $this->createMock(IGroupManager::class);
+        $this->subAdmin = $this->createMock(ISubAdmin::class);
+        $this->declarativeSettingsManager = $this->createMock(IDeclarativeManager::class);
+        $this->initialState = $this->createMock(IInitialState::class);
 
-		$this->adminSettingsController = new AdminSettingsController(
-			'settings',
-			$this->request,
-			$this->navigationManager,
-			$this->settingsManager,
-			$this->userSession,
-			$this->groupManager,
-			$this->subAdmin,
-			$this->declarativeSettingsManager,
-			$this->initialState,
-		);
+        $this->adminSettingsController = new AdminSettingsController(
+            'settings',
+            $this->request,
+            $this->navigationManager,
+            $this->settingsManager,
+            $this->userSession,
+            $this->groupManager,
+            $this->subAdmin,
+            $this->declarativeSettingsManager,
+            $this->initialState,
+        );
 
-		$user = Server::get(IUserManager::class)->createUser($this->adminUid, 'mylongrandompassword');
-		\OC_User::setUserId($user->getUID());
-		Server::get(IGroupManager::class)->createGroup('admin')->addUser($user);
-	}
+        $user = Server::get(IUserManager::class)->createUser($this->adminUid, 'mylongrandompassword');
+        \OC_User::setUserId($user->getUID());
+        Server::get(IGroupManager::class)->createGroup('admin')->addUser($user);
+    }
 
-	protected function tearDown(): void {
-		Server::get(IUserManager::class)
-			->get($this->adminUid)
-			->delete();
-		\OC_User::setUserId(null);
-		Server::get(IUserSession::class)->setUser(null);
+    protected function tearDown(): void {
+        Server::get(IUserManager::class)
+            ->get($this->adminUid)
+            ->delete();
+        \OC_User::setUserId(null);
+        Server::get(IUserSession::class)->setUser(null);
 
-		parent::tearDown();
-	}
+        parent::tearDown();
+    }
 
-	public function testIndex(): void {
-		$user = $this->createMock(IUser::class);
-		$this->userSession
-			->method('getUser')
-			->willReturn($user);
-		$user->method('getUID')->willReturn('user123');
-		$this->groupManager
-			->method('isAdmin')
-			->with('user123')
-			->willReturn(true);
-		$this->subAdmin
-			->method('isSubAdmin')
-			->with($user)
-			->willReturn(false);
+    public function testIndex(): void {
+        $user = $this->createMock(IUser::class);
+        $this->userSession
+            ->method('getUser')
+            ->willReturn($user);
+        $user->method('getUID')->willReturn('user123');
+        $this->groupManager
+            ->method('isAdmin')
+            ->with('user123')
+            ->willReturn(true);
+        $this->subAdmin
+            ->method('isSubAdmin')
+            ->with($user)
+            ->willReturn(false);
 
-		$form = new TemplateResponse('settings', 'settings/empty');
-		$setting = $this->createMock(ServerDevNotice::class);
-		$setting->expects(self::any())
-			->method('getForm')
-			->willReturn($form);
-		$this->settingsManager
-			->expects($this->once())
-			->method('getAdminSections')
-			->willReturn([]);
-		$this->settingsManager
-			->expects($this->once())
-			->method('getPersonalSections')
-			->willReturn([]);
-		$this->settingsManager
-			->expects($this->once())
-			->method('getAllowedAdminSettings')
-			->with('test')
-			->willReturn([5 => [$setting]]);
-		$this->declarativeSettingsManager
-			->expects($this->any())
-			->method('getFormIDs')
-			->with($user, 'admin', 'test')
-			->willReturn([]);
+        $form = new TemplateResponse('settings', 'settings/empty');
+        $setting = $this->createMock(ServerDevNotice::class);
+        $setting->expects(self::any())
+            ->method('getForm')
+            ->willReturn($form);
+        $this->settingsManager
+            ->expects($this->once())
+            ->method('getAdminSections')
+            ->willReturn([]);
+        $this->settingsManager
+            ->expects($this->once())
+            ->method('getPersonalSections')
+            ->willReturn([]);
+        $this->settingsManager
+            ->expects($this->once())
+            ->method('getAllowedAdminSettings')
+            ->with('test')
+            ->willReturn([5 => [$setting]]);
+        $this->declarativeSettingsManager
+            ->expects($this->any())
+            ->method('getFormIDs')
+            ->with($user, 'admin', 'test')
+            ->willReturn([]);
 
-		$initialState = [];
-		$this->initialState->expects(self::atLeastOnce())
-			->method('provideInitialState')
-			->willReturnCallback(function () use (&$initialState) {
-				$initialState[] = func_get_args();
-			});
+        $initialState = [];
+        $this->initialState->expects(self::atLeastOnce())
+            ->method('provideInitialState')
+            ->willReturnCallback(function () use (&$initialState) {
+                $initialState[] = func_get_args();
+            });
 
-		$expected = new TemplateResponse(
-			'settings',
-			'settings/frame',
-			[
-				'content' => ''
-			],
-		);
-		$this->assertEquals($expected, $this->adminSettingsController->index('test'));
-		$this->assertEquals([
-			['sections', ['admin' => [], 'personal' => []]],
-		], $initialState);
-	}
+        $expected = new TemplateResponse(
+            'settings',
+            'settings/frame',
+            [
+                'content' => ''
+            ],
+        );
+        $this->assertEquals($expected, $this->adminSettingsController->index('test'));
+        $this->assertEquals([
+            ['sections', ['admin' => [], 'personal' => []]],
+        ], $initialState);
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -125,7 +125,7 @@
 		$initialState = [];
 		$this->initialState->expects(self::atLeastOnce())
 			->method('provideInitialState')
-			->willReturnCallback(function () use (&$initialState) {
+			->willReturnCallback(function() use (&$initialState) {
 				$initialState[] = func_get_args();
 			});