open-dsi
/
nextcloud-server
mirror of https://github.com/nextcloud/server
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

add route and controller. consolidate common settings functions in a trait.

Browse Source 
Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
pull/4890/head
Arthur Schiwon 9 years ago
parent d9beeaec90
commit 247b305b79
No known key found for this signature in database
GPG Key ID: 7424F1874854DF23
4 changed files with 204 additions and 51 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 56
      settings/Controller/AdminSettingsController.php
  2. 123
      settings/Controller/CommonSettingsTrait.php
  3. 73
      settings/Controller/PersonalSettingsController.php
  4. 3
      settings/routes.php

56
settings/Controller/AdminSettingsController.php
Unescape View File

@ -28,15 +28,15 @@ use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\INavigationManager;
use OCP\IRequest;
use OCP\Settings\IIconSection;
use OCP\Settings\IManager as ISettingsManager;
use OCP\Settings\ISection;
use OCP\Template;
/**
* @package OC\Settings\Controller
*/
class AdminSettingsController extends Controller {
use CommonSettingsTrait;
/** @var INavigationManager */
private $navigationManager;
/** @var ISettingsManager */
@ -67,12 +67,7 @@ class AdminSettingsController extends Controller {
*/
public function index($section) {
$this->navigationManager->setActiveEntry('admin');
$templateParams = [];
$templateParams = array_merge($templateParams, $this->getNavigationParameters($section));
$templateParams = array_merge($templateParams, $this->getSettings($section));
return new TemplateResponse('settings', 'admin/frame', $templateParams);
return $this->getIndexResponse($section);
}
/**
@ -80,19 +75,13 @@ class AdminSettingsController extends Controller {
* @return array
*/
private function getSettings($section) {
$html = '';
// PhpStorm shows this as unused, but is required by CommonSettingsTrait
$settings = $this->settingsManager->getAdminSettings($section);
foreach ($settings as $prioritizedSettings) {
foreach ($prioritizedSettings as $setting) {
/** @var \OCP\Settings\ISettings $setting */
$form = $setting->getForm();
$html .= $form->renderAs('')->render();
}
}
$formatted = $this->formatSettings($settings);
if($section === 'additional') {
$html .= $this->getLegacyForms();
$formatted['content'] .= $this->getLegacyForms();
}
return ['content' => $html];
return $formatted;
}
/**
@ -125,36 +114,5 @@ class AdminSettingsController extends Controller {
return $out->fetchPage();
}
/**
* @param string $currentSection
* @return array
*/
private function getNavigationParameters($currentSection) {
$sections = $this->settingsManager->getAdminSections();
$templateParameters = [];
/** @var \OC\Settings\Section[] $prioritizedSections */
foreach($sections as $prioritizedSections) {
foreach ($prioritizedSections as $section) {
if (empty($this->settingsManager->getAdminSettings($section->getID()))) {
continue;
}
$icon = '';
if ($section instanceof IIconSection) {
$icon = $section->getIcon();
}
$templateParameters[] = [
'anchor' => $section->getID(),
'section-name' => $section->getName(),
'active' => $section->getID() === $currentSection,
'icon' => $icon,
];
}
}
return [
'forms' => $templateParameters
];
}
}

123
settings/Controller/CommonSettingsTrait.php
Unescape View File

@ -0,0 +1,123 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\Settings\Controller;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\Settings\IManager as ISettingsManager;
use OCP\Settings\IIconSection;
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);
}

73
settings/Controller/PersonalSettingsController.php
Unescape View File

@ -0,0 +1,73 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\Settings\Controller;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\INavigationManager;
use OCP\IRequest;
use OCP\Settings\IManager as ISettingsManager;
class PersonalSettingsController extends Controller {
use CommonSettingsTrait {
getSettings as private;
}
/** @var INavigationManager */
private $navigationManager;
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 array
*/
private function getSettings($section) {
// PhpStorm shows this as unused, but is required by CommonSettingsTrait
$settings = $this->settingsManager->getPersonalSettings($section);
return $this->formatSettings($settings);
}
}

3
settings/routes.php
Unescape View File

@ -65,6 +65,7 @@ $application->registerRoutes($this, [
['name' => 'Certificate#removePersonalRootCertificate', 'url' => '/settings/personal/certificate/{certificateIdentifier}', 'verb' => 'DELETE'],
['name' => 'Certificate#addSystemRootCertificate', 'url' => '/settings/admin/certificate', 'verb' => 'POST'],
['name' => 'Certificate#removeSystemRootCertificate', 'url' => '/settings/admin/certificate/{certificateIdentifier}', 'verb' => 'DELETE'],
['name' => 'PersonalSettings#index', 'url' => '/settings/personal/{section}', 'verb' => 'GET', 'defaults' => ['section' => 'personal-info']],
['name' => 'AdminSettings#index', 'url' => '/settings/admin/{section}', 'verb' => 'GET', 'defaults' => ['section' => 'server']],
['name' => 'AdminSettings#form', 'url' => '/settings/admin/{section}', 'verb' => 'GET'],
['name' => 'ChangePassword#changePersonalPassword', 'url' => '/settings/personal/changepassword', 'verb' => 'POST'],
@ -82,8 +83,6 @@ $application->registerRoutes($this, [
// Settings pages
$this->create('settings_help', '/settings/help')
->actionInclude('settings/help.php');
$this->create('settings_personal', '/settings/personal')
->actionInclude('settings/personal.php');
$this->create('settings_users', '/settings/users')
->actionInclude('settings/users.php');
// Settings ajax actions

Write Preview
Loading…
Cancel
Save