Skip to content

Commit

Permalink
Add profile default setting for admin
Browse files Browse the repository at this point in the history
Signed-off-by: Christopher Ng <chrng8@gmail.com>
  • Loading branch information
Pytal committed Mar 17, 2022
1 parent e17a5ca commit 99bc520
Show file tree
Hide file tree
Showing 106 changed files with 422 additions and 142 deletions.
16 changes: 16 additions & 0 deletions apps/settings/lib/Settings/Admin/Server.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,25 @@
*/
namespace OCA\Settings\Settings\Admin;

use OC\Profile\ProfileManager;
use OC\Profile\TProfileHelper;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\AppFramework\Services\IInitialState;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IL10N;
use OCP\Settings\IDelegatedSettings;

class Server implements IDelegatedSettings {
use TProfileHelper;

/** @var IDBConnection */
private $connection;
/** @var IInitialState */
private $initialStateService;
/** @var ProfileManager */
private $profileManager;
/** @var ITimeFactory */
private $timeFactory;
/** @var IConfig */
Expand All @@ -44,10 +52,14 @@ class Server implements IDelegatedSettings {
private $l;

public function __construct(IDBConnection $connection,
IInitialState $initialStateService,
ProfileManager $profileManager,
ITimeFactory $timeFactory,
IConfig $config,
IL10N $l) {
$this->connection = $connection;
$this->initialStateService = $initialStateService;
$this->profileManager = $profileManager;
$this->timeFactory = $timeFactory;
$this->config = $config;
$this->l = $l;
Expand All @@ -65,8 +77,12 @@ public function getForm() {
'cronErrors' => $this->config->getAppValue('core', 'cronErrors'),
'cli_based_cron_possible' => function_exists('posix_getpwuid'),
'cli_based_cron_user' => function_exists('posix_getpwuid') ? posix_getpwuid(fileowner(\OC::$configDir . 'config.php'))['name'] : '',
'profileEnabledGlobally' => $this->profileManager->isProfileEnabled(),
];

$this->initialStateService->provideInitialState('profileEnabledGlobally', $this->profileManager->isProfileEnabled());
$this->initialStateService->provideInitialState('profileEnabledByDefault', $this->isProfileEnabledByDefault($this->config));

return new TemplateResponse('settings', 'settings/admin/server', $parameters, '');
}

Expand Down
101 changes: 101 additions & 0 deletions apps/settings/src/components/BasicSettings/ProfileSettings.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<!--
- @copyright 2022 Christopher Ng <chrng8@gmail.com>
-
- @author Christopher Ng <chrng8@gmail.com>
-
- @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/>.
-
-->

<template>
<div id="profile-settings"
class="section">
<h2 class="inlineblock">
{{ t('settings', 'Profile') }}
</h2>

<p class="settings-hint">
{{ t('settings', 'Enable or disable profile by default for new users.') }}
</p>

<CheckboxRadioSwitch type="switch"
:checked.sync="initialProfileEnabledByDefault"
@update:checked="onProfileDefaultChange">
{{ t('settings', 'Enable') }}
</CheckboxRadioSwitch>
</div>
</template>

<script>
import { loadState } from '@nextcloud/initial-state'
import { showError } from '@nextcloud/dialogs'

import { saveProfileDefault } from '../../service/ProfileService'
import { validateBoolean } from '../../utils/validate'

import CheckboxRadioSwitch from '@nextcloud/vue/dist/Components/CheckboxRadioSwitch'

const profileEnabledByDefault = loadState('settings', 'profileEnabledByDefault', true)

export default {
name: 'ProfileSettings',

components: {
CheckboxRadioSwitch,
},

data() {
return {
initialProfileEnabledByDefault: profileEnabledByDefault,
}
},

methods: {
async onProfileDefaultChange(isEnabled) {
if (validateBoolean(isEnabled)) {
await this.updateProfileDefault(isEnabled)
}
},

async updateProfileDefault(isEnabled) {
try {
const responseData = await saveProfileDefault(isEnabled)
this.handleResponse({
isEnabled,
status: responseData.ocs?.meta?.status,
})
} catch (e) {
this.handleResponse({
errorMessage: t('settings', 'Unable to update profile default setting'),
error: e,
})
}
},

handleResponse({ isEnabled, status, errorMessage, error }) {
if (status === 'ok') {
this.initialProfileEnabledByDefault = isEnabled
} else {
showError(errorMessage)
this.logger.error(errorMessage, error)
}
},
},
}
</script>

<style lang="scss" scoped>
</style>
49 changes: 49 additions & 0 deletions apps/settings/src/main-admin-basic-settings.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/**
* @copyright 2022 Christopher Ng <chrng8@gmail.com>
*
* @author Christopher Ng <chrng8@gmail.com>
*
* @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/>.
*
*/

import Vue from 'vue'
import { getRequestToken } from '@nextcloud/auth'
import { loadState } from '@nextcloud/initial-state'
import { translate as t } from '@nextcloud/l10n'
import '@nextcloud/dialogs/styles/toast.scss'

import logger from './logger'

import ProfileSettings from './components/BasicSettings/ProfileSettings'

__webpack_nonce__ = btoa(getRequestToken())

const profileEnabledGlobally = loadState('settings', 'profileEnabledGlobally', true)

Vue.mixin({
props: {
logger,
},
methods: {
t,
},
})

if (profileEnabledGlobally) {
const ProfileSettingsView = Vue.extend(ProfileSettings)
new ProfileSettingsView().$mount('.vue-admin-profile-settings')
}
24 changes: 24 additions & 0 deletions apps/settings/src/service/ProfileService.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,27 @@ export const saveProfileParameterVisibility = async (paramId, visibility) => {

return res.data
}

/**
* Save profile default
*
* @param {boolean} isEnabled the default
* @return {object}
*/
export const saveProfileDefault = async (isEnabled) => {
// Convert to string for compatibility
isEnabled = isEnabled ? '1' : '0'

const url = generateOcsUrl('/apps/provisioning_api/api/v1/config/apps/{appId}/{key}', {
appId: 'settings',
key: 'profile_enabled_by_default',
})

await confirmPassword()

const res = await axios.post(url, {
value: isEnabled,
})

return res.data
}
7 changes: 7 additions & 0 deletions apps/settings/templates/settings/admin/server.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
/** @var \OCP\IL10N $l */
/** @var array $_ */

script('settings', [
'vue-settings-admin-basic-settings',
]);
?>

<div class="section" id="backgroundjobs">
Expand Down Expand Up @@ -112,3 +115,7 @@
</fieldset>
</form>
</div>

<?php if ($_['profileEnabledGlobally']) : ?>
<div class="vue-admin-profile-settings"></div>
<?php endif; ?>
11 changes: 11 additions & 0 deletions apps/settings/tests/Settings/Admin/ServerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@
*/
namespace OCA\Settings\Tests\Settings\Admin;

use OC\Profile\ProfileManager;
use OCA\Settings\Settings\Admin\Server;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\AppFramework\Services\IInitialState;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\IConfig;
use OCP\IDBConnection;
Expand All @@ -48,6 +50,10 @@ class ServerTest extends TestCase {
private $admin;
/** @var IDBConnection */
private $connection;
/** @var IInitialState */
private $initialStateService;
/** @var ProfileManager */
private $profileManager;
/** @var ITimeFactory|MockObject */
private $timeFactory;
/** @var IConfig|MockObject */
Expand All @@ -58,6 +64,8 @@ class ServerTest extends TestCase {
protected function setUp(): void {
parent::setUp();
$this->connection = \OC::$server->getDatabaseConnection();
$this->initialStateService = $this->createMock(IInitialState::class);
$this->profileManager = $this->createMock(ProfileManager::class);
$this->timeFactory = $this->createMock(ITimeFactory::class);
$this->config = $this->createMock(IConfig::class);
$this->l10n = $this->createMock(IL10N::class);
Expand All @@ -66,6 +74,8 @@ protected function setUp(): void {
->onlyMethods(['cronMaxAge'])
->setConstructorArgs([
$this->connection,
$this->initialStateService,
$this->profileManager,
$this->timeFactory,
$this->config,
$this->l10n,
Expand Down Expand Up @@ -106,6 +116,7 @@ public function testGetForm(): void {
'cronMaxAge' => 1337,
'cli_based_cron_possible' => true,
'cli_based_cron_user' => function_exists('posix_getpwuid') ? posix_getpwuid(fileowner(\OC::$configDir . 'config.php'))['name'] : '', // to not explode here because of posix extension not being disabled - which is already checked in the line above
'profileEnabledGlobally' => true,
],
''
);
Expand Down
Loading

0 comments on commit 99bc520

Please sign in to comment.