Vuetify User management in admin.

This commit is contained in:
Buster "Silver Eagle" Neece 2021-10-27 18:15:33 -05:00
parent 3c8e7c4cc1
commit b58480e0d0
No known key found for this signature in database
GPG Key ID: 6D9E12FF03411F4E
15 changed files with 360 additions and 259 deletions

View File

@ -1,59 +0,0 @@
<?php
/** @var array $roles */
return [
'elements' => [
'name' => [
'text',
[
'label' => __('Display Name'),
'class' => 'half-width',
'label_class' => 'mb-2',
],
],
'email' => [
'email',
[
'label' => __('E-mail Address'),
'required' => true,
'autocomplete' => 'new-password',
'label_class' => 'mb-2',
'form_group_class' => 'mt-3',
],
],
'new_password' => [
'password',
[
'label' => __('Reset Password'),
'description' => __('Leave blank to use the current password.'),
'autocomplete' => 'off',
'required' => false,
'label_class' => 'mb-2',
'form_group_class' => 'mt-3',
],
],
'roles' => [
'multiCheckbox',
[
'label' => __('Roles'),
'options' => $roles,
'form_group_class' => 'mt-3',
],
],
'submit' => [
'submit',
[
'type' => 'submit',
'label' => __('Save Changes'),
'class' => 'btn btn-lg btn-primary',
'form_group_class' => 'mt-3',
],
],
],
];

View File

@ -146,25 +146,9 @@ return static function (RouteCollectorProxy $app) {
->setName('admin:storage_locations:index')
->add(new Middleware\Permissions(Acl::GLOBAL_STORAGE_LOCATIONS));
$group->group(
'/users',
function (RouteCollectorProxy $group) {
$group->get('', Controller\Admin\UsersController::class . ':indexAction')
->setName('admin:users:index');
$group->map(['GET', 'POST'], '/edit/{id}', Controller\Admin\UsersController::class . ':editAction')
->setName('admin:users:edit');
$group->map(['GET', 'POST'], '/add', Controller\Admin\UsersController::class . ':editAction')
->setName('admin:users:add');
$group->get('/delete/{id}/{csrf}', Controller\Admin\UsersController::class . ':deleteAction')
->setName('admin:users:delete');
$group->get('/login-as/{id}/{csrf}', Controller\Admin\UsersController::class . ':impersonateAction')
->setName('admin:users:impersonate');
}
)->add(new Middleware\Permissions(Acl::GLOBAL_ALL));
$group->get('/users', Controller\Admin\UsersAction::class)
->setName('admin:users:index')
->add(new Middleware\Permissions(Acl::GLOBAL_ALL));
}
)
->add(Middleware\Module\Admin::class)

View File

@ -17,6 +17,10 @@ return static function (RouteCollectorProxy $app) {
$group->get('/logout', Controller\Frontend\Account\LogoutAction::class)
->setName('account:logout');
$group->get('/login-as/{id}/{csrf}', Controller\Frontend\Account\MasqueradeAction::class)
->setName('account:masquerade')
->add(new Middleware\Permissions(App\Acl::GLOBAL_ALL));
$group->get('/endsession', Controller\Frontend\Account\EndMasqueradeAction::class)
->setName('account:endmasquerade');

View File

@ -0,0 +1,101 @@
<template>
<div>
<b-card no-body>
<b-card-header header-bg-variant="primary-dark">
<h2 class="card-title" key="lang_title" v-translate>Users</h2>
</b-card-header>
<b-card-body body-class="card-padding-sm">
<b-button variant="outline-primary" @click.prevent="doCreate">
<icon icon="add"></icon>
<translate key="lang_add_btn">Add User</translate>
</b-button>
</b-card-body>
<data-table ref="datatable" id="users" :fields="fields" :show-toolbar="false" :api-url="listUrl">
<template #cell(name)="row">
<h5 class="mb-0" v-if="row.item.name !== ''">{{ row.item.name }}</h5>
<a :href="'mailto:'+row.item.email">{{ row.item.email }}</a>
<span v-if="isMe(row.item.id)" class="badge badge-primary">
<translate key="lang_is_me">You</translate>
</span>
</template>
<template #cell(roles)="row">
<div v-for="role in row.item.roles" :key="role.id">
{{ role.name }}
</div>
</template>
<template #cell(actions)="row">
<b-button-group size="sm" v-if="!isMe(row.item.id)">
<b-button size="sm" variant="secondary" :href="row.item.links.masquerade" target="_blank">
<translate key="lang_btn_masquerade">Log In</translate>
</b-button>
<b-button size="sm" variant="primary" @click.prevent="doEdit(row.item.links.self)">
<translate key="lang_btn_edit">Edit</translate>
</b-button>
<b-button size="sm" variant="danger" @click.prevent="doDelete(row.item.links.self)">
<translate key="lang_btn_delete">Delete</translate>
</b-button>
</b-button-group>
</template>
</data-table>
</b-card>
<edit-modal ref="editModal" :create-url="listUrl" :roles="roles" @relist="relist"></edit-modal>
</div>
</template>
<script>
import DataTable from '~/components/Common/DataTable';
import EditModal from './Users/EditModal';
import Icon from '~/components/Common/Icon';
import InfoCard from '~/components/Common/InfoCard';
import '~/vendor/sweetalert.js';
export default {
name: 'AdminPermissions',
components: {InfoCard, Icon, EditModal, DataTable},
props: {
listUrl: String,
currentUserId: Number,
roles: Object
},
data() {
return {
fields: [
{key: 'name', isRowHeader: true, label: this.$gettext('User Name'), sortable: false},
{key: 'roles', label: this.$gettext('Roles'), sortable: false},
{key: 'actions', label: this.$gettext('Actions'), sortable: false, class: 'shrink'}
]
};
},
methods: {
isMe(userId) {
return this.currentUserId === userId;
},
relist() {
this.$refs.datatable.refresh();
},
doCreate() {
this.$refs.editModal.create();
},
doEdit(url) {
this.$refs.editModal.edit(url);
},
doDelete(url) {
this.$confirmDelete({
title: this.$gettext('Delete User?'),
}).then((result) => {
if (result.value) {
this.$wrapWithLoading(
this.axios.delete(url)
).then((resp) => {
this.$notifySuccess(resp.data.message);
this.relist();
});
}
});
}
}
};
</script>

View File

@ -0,0 +1,69 @@
<template>
<modal-form ref="modal" :loading="loading" :title="langTitle" :error="error"
:disable-save-button="$v.form.$invalid"
@submit="doSubmit" @hidden="clearContents">
<admin-users-form :form="$v.form" :roles="roles" :is-edit-mode="isEditMode"></admin-users-form>
</modal-form>
</template>
<script>
import {validationMixin} from 'vuelidate';
import {email, required} from 'vuelidate/dist/validators.min.js';
import BaseEditModal from '~/components/Common/BaseEditModal';
import AdminUsersForm from './Form.vue';
import _ from 'lodash';
import validatePassword from "~/functions/validatePassword";
export default {
name: 'AdminUsersEditModal',
components: {AdminUsersForm},
mixins: [validationMixin, BaseEditModal],
props: {
roles: Object
},
computed: {
langTitle() {
return this.isEditMode
? this.$gettext('Edit User')
: this.$gettext('Add User');
}
},
validations() {
let validations = {
form: {
name: {},
email: {required, email},
roles: {}
}
};
if (this.isEditMode) {
validations.form.new_password = {validatePassword};
} else {
validations.form.new_password = {required, validatePassword};
}
return validations;
},
methods: {
resetForm() {
this.form = {
name: '',
email: '',
new_password: '',
roles: [],
};
},
populateForm(data) {
this.form = {
name: data.name,
email: data.email,
new_password: '',
roles: _.map(data.roles, 'id')
};
},
}
};
</script>

View File

@ -0,0 +1,59 @@
<template>
<b-form-group>
<b-form-row>
<b-wrapped-form-group class="col-md-6" id="edit_form_email" :field="form.email" input-type="email">
<template #label="{lang}">
<translate :key="lang">E-mail Address</translate>
</template>
</b-wrapped-form-group>
<b-wrapped-form-group class="col-md-6" id="edit_form_new_password" :field="form.new_password"
input-type="password">
<template #label="{lang}">
<translate v-if="isEditMode" :key="lang+'a'">Reset Password</translate>
<translate v-else :key="lang+'b'">Password</translate>
</template>
<template v-if="isEditMode" #description="{lang}">
<translate :key="lang">Leave blank to use the current password.</translate>
</template>
</b-wrapped-form-group>
<b-wrapped-form-group class="col-md-12" id="edit_form_name" :field="form.name">
<template #label="{lang}">
<translate :key="lang">Display Name</translate>
</template>
</b-wrapped-form-group>
<b-wrapped-form-group class="col-md-12" id="edit_form_roles"
:field="form.roles">
<template #label="{lang}">
<translate :key="lang">Roles</translate>
</template>
<template #default="props">
<b-form-checkbox-group :id="props.id" :options="roleOptions" v-model="props.field.$model">
</b-form-checkbox-group>
</template>
</b-wrapped-form-group>
</b-form-row>
</b-form-group>
</template>
<script>
import BWrappedFormGroup from "~/components/Form/BWrappedFormGroup";
import objectToFormOptions from "~/functions/objectToFormOptions";
export default {
name: 'AdminUserForm',
components: {BWrappedFormGroup},
props: {
form: Object,
roles: Object,
isEditMode: Boolean
},
computed: {
roleOptions() {
return objectToFormOptions(this.roles);
}
}
};
</script>

View File

@ -0,0 +1,7 @@
import initBase from '~/base.js';
import '~/vendor/bootstrapVue.js';
import AdminUsers from '~/components/Admin/Users.vue';
export default initBase(AdminUsers);

View File

@ -16,6 +16,7 @@ module.exports = {
AdminShoutcast: '~/pages/Admin/Shoutcast.js',
AdminStations: '~/pages/Admin/Stations.js',
AdminStorageLocations: '~/pages/Admin/StorageLocations.js',
AdminUsers: '~/pages/Admin/Users.js',
PublicFullPlayer: '~/pages/Public/FullPlayer.js',
PublicHistory: '~/pages/Public/History.js',
PublicOnDemand: '~/pages/Public/OnDemand.js',

View File

@ -0,0 +1,33 @@
<?php
declare(strict_types=1);
namespace App\Controller\Admin;
use App\Entity\Repository\RoleRepository;
use App\Http\Response;
use App\Http\ServerRequest;
use Psr\Http\Message\ResponseInterface;
class UsersAction
{
public function __invoke(
ServerRequest $request,
Response $response,
RoleRepository $roleRepo
): ResponseInterface {
$router = $request->getRouter();
return $request->getView()->renderVuePage(
response: $response,
component: 'Vue_AdminUsers',
id: 'admin-users',
title: __('Users'),
props: [
'listUrl' => (string)$router->fromHere('api:admin:users'),
'currentUserId' => $request->getUser()->getIdRequired(),
'roles' => $roleRepo->fetchSelect(),
]
);
}
}

View File

@ -1,118 +0,0 @@
<?php
declare(strict_types=1);
namespace App\Controller\Admin;
use App\Entity;
use App\Exception\NotFoundException;
use App\Form\UserForm;
use App\Http\Response;
use App\Http\ServerRequest;
use App\Session\Flash;
use DI\FactoryInterface;
use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
use Psr\Http\Message\ResponseInterface;
class UsersController extends AbstractAdminCrudController
{
public function __construct(FactoryInterface $factory)
{
parent::__construct($factory->make(UserForm::class));
$this->csrf_namespace = 'admin_users';
}
public function indexAction(ServerRequest $request, Response $response): ResponseInterface
{
$users = $this->em->createQuery(
<<<'DQL'
SELECT u, r
FROM App\Entity\User u
LEFT JOIN u.roles r
ORDER BY u.name ASC
DQL
)->execute();
return $request->getView()->renderToResponse($response, 'admin/users/index', [
'user' => $request->getAttribute('user'),
'users' => $users,
'csrf' => $request->getCsrf()->generate($this->csrf_namespace),
]);
}
public function editAction(ServerRequest $request, Response $response, int $id = null): ResponseInterface
{
try {
if (false !== $this->doEdit($request, $id)) {
$request->getFlash()->addMessage(($id ? __('User updated.') : __('User added.')), Flash::SUCCESS);
return $response->withRedirect((string)$request->getRouter()->named('admin:users:index'));
}
} catch (UniqueConstraintViolationException) {
$request->getFlash()->addMessage(
__('Another user already exists with this e-mail address. Please update the e-mail address.'),
Flash::ERROR
);
}
return $request->getView()->renderToResponse(
$response,
'system/form_page',
[
'form' => $this->form,
'render_mode' => 'edit',
'title' => $id ? __('Edit User') : __('Add User'),
]
);
}
public function deleteAction(
ServerRequest $request,
Response $response,
int $id,
string $csrf
): ResponseInterface {
$request->getCsrf()->verify($csrf, $this->csrf_namespace);
$user = $this->record_repo->find($id);
$current_user = $request->getUser();
if ($user === $current_user) {
$request->getFlash()->addMessage('<b>' . __('You cannot delete your own account.') . '</b>', Flash::ERROR);
} elseif ($user instanceof Entity\User) {
$this->em->remove($user);
$this->em->flush();
$request->getFlash()->addMessage('<b>' . __('User deleted.') . '</b>', Flash::SUCCESS);
}
return $response->withRedirect((string)$request->getRouter()->named('admin:users:index'));
}
public function impersonateAction(
ServerRequest $request,
Response $response,
int $id,
string $csrf
): ResponseInterface {
$request->getCsrf()->verify($csrf, $this->csrf_namespace);
$user = $this->record_repo->find($id);
if (!($user instanceof Entity\User)) {
throw new NotFoundException(__('User not found.'));
}
$auth = $request->getAuth();
$auth->masqueradeAsUser($user);
$request->getFlash()->addMessage(
'<b>' . __('Logged in successfully.') . '</b><br>' . $user->getEmail(),
Flash::SUCCESS
);
return $response->withRedirect((string)$request->getRouter()->named('dashboard'));
}
}

View File

@ -81,10 +81,9 @@ abstract class AbstractApiCrudController
if ($record instanceof IdentifiableEntityInterface) {
$return['links'] = [
'self' => (string)$router->fromHere(
$this->resourceRouteName,
['id' => $record->getIdRequired()],
[],
!$isInternal
route_name: $this->resourceRouteName,
route_params: ['id' => $record->getIdRequired()],
absolute: !$isInternal
),
];
}

View File

@ -4,6 +4,7 @@ declare(strict_types=1);
namespace App\Controller\Api\Admin;
use App\Controller\Frontend\Account\MasqueradeAction;
use App\Entity;
use App\Http\Response;
use App\Http\ServerRequest;
@ -80,6 +81,37 @@ class UsersController extends AbstractAdminApiCrudController
* )
*/
protected function viewRecord(object $record, ServerRequest $request): mixed
{
if (!($record instanceof $this->entityClass)) {
throw new \InvalidArgumentException(sprintf('Record must be an instance of %s.', $this->entityClass));
}
$return = $this->toArray($record);
$isInternal = ('true' === $request->getParam('internal', 'false'));
$router = $request->getRouter();
$csrf = $request->getCsrf();
$return['links'] = [
'self' => (string)$router->fromHere(
route_name: $this->resourceRouteName,
route_params: ['id' => $record->getIdRequired()],
absolute: !$isInternal
),
'masquerade' => (string)$router->fromHere(
route_name: 'account:masquerade',
route_params: [
'id' => $record->getIdRequired(),
'csrf' => $csrf->generate(MasqueradeAction::CSRF_NAMESPACE),
],
absolute: !$isInternal
),
];
return $return;
}
/**
* @OA\Delete(path="/admin/user/{id}",
* tags={"Administration: Users"},

View File

@ -0,0 +1,43 @@
<?php
declare(strict_types=1);
namespace App\Controller\Frontend\Account;
use App\Entity;
use App\Exception\NotFoundException;
use App\Http\Response;
use App\Http\ServerRequest;
use App\Session\Flash;
use Psr\Http\Message\ResponseInterface;
class MasqueradeAction
{
public const CSRF_NAMESPACE = 'user_masquerade';
public function __invoke(
ServerRequest $request,
Response $response,
Entity\Repository\UserRepository $userRepo,
int $id,
string $csrf
): ResponseInterface {
$request->getCsrf()->verify($csrf, self::CSRF_NAMESPACE);
$user = $userRepo->find($id);
if (!($user instanceof Entity\User)) {
throw new NotFoundException(__('User not found.'));
}
$auth = $request->getAuth();
$auth->masqueradeAsUser($user);
$request->getFlash()->addMessage(
'<b>' . __('Logged in successfully.') . '</b><br>' . $user->getEmail(),
Flash::SUCCESS
);
return $response->withRedirect((string)$request->getRouter()->named('dashboard'));
}
}

View File

@ -1,59 +0,0 @@
<?php $this->layout('main', ['title' => __('User Accounts'), 'manual' => true]); ?>
<div class="card">
<div class="card-header bg-primary-dark">
<h2 class="card-title"><?=__('User Accounts') ?></h2>
</div>
<div class="card-actions">
<a class="btn btn-outline-primary" role="button" href="<?=$router->named('admin:users:add') ?>">
<i class="material-icons" aria-hidden="true">add</i>
<?=__('Add User') ?>
</a>
</div>
<table class="table table-responsive-md table-striped mb-0">
<colgroup>
<col width="30%">
<col width="35%">
<col width="35%">
</colgroup>
<thead>
<tr>
<th><?=__('Actions') ?></th>
<th><?=__('E-mail Address') ?></th>
<th><?=__('Roles') ?></th>
</tr>
</thead>
<tbody>
<?php foreach($users as $user_row): ?>
<?php /** @var \App\Entity\User $user_row */ ?>
<tr class="align-middle">
<td>
<div class="btn-group btn-group-sm">
<?php if ($user_row->getId() !== $user->getId()): ?>
<a class="btn btn-sm btn-primary" href="<?=$router->named('admin:users:impersonate', ['id' => $user_row->getId(), 'csrf' => $csrf]) ?>"><?=__('Log In') ?></a>
<?php endif; ?>
<a class="btn btn-sm btn-dark" href="<?=$router->named('admin:users:edit', ['id' => $user_row->getId()]) ?>"><?=__('Edit') ?></a>
<?php if ($user_row->getId() !== $user->getId()): ?>
<a class="btn btn-sm btn-danger" data-confirm-title="<?=$this->e(__('Delete user "%s"?', $user_row->getEmail())) ?>" href="<?=$router->named('admin:users:delete', ['id' => $user_row->getId(), 'csrf' => $csrf]) ?>"><?=__('Delete') ?></a>
<?php else: ?>
<a class="btn btn-sm btn-danger disabled" href=""><?=__('Delete') ?></a>
<?php endif; ?>
</div>
</td>
<td>
<div class="text-lg-left"><?=$this->e($user_row->getName()) ?></div>
<div>
<?=$this->mailto($user_row->getEmail()) ?>
<?php if ($user_row->getId() === $user->getId()): ?><?=__('(You)') ?><?php endif; ?>
</div>
</td>
<td>
<?php foreach($user_row->getRoles() as $role): ?>
<div><?=$this->e($role->getName()) ?></div>
<?php endforeach; ?>
</td>
</tr>
<?php endforeach; ?>
</tbody>
</table>
</div>

View File

@ -12,6 +12,10 @@ class Admin_RecordsCest extends CestAbstract
// User homepage
$I->amOnPage('/admin/users');
$I->seeResponseCodeIs(200);
/*
* TODO: Acceptance Testing with Vue Rendering
$I->see($this->login_username);
// Edit existing user
@ -39,6 +43,7 @@ class Admin_RecordsCest extends CestAbstract
$I->seeCurrentUrlEquals('/admin/users');
$I->dontSee('test@azuracast.com');
*/
}
/**