mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-13 14:44:43 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor(permissions): Add docs and simplify functions

Browse source 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2022-09-01 21:42:47 +02:00 • committed by Yannick Bungers
parent bdedf783ec
commit 290fea2703
1 changed files with 36 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

54
src/permissions/permissions.service.ts
View file

@ -39,29 +39,47 @@ export class PermissionsService {
) {} ) {}
public guestPermission: GuestPermission; // TODO change to configOption public guestPermission: GuestPermission; // TODO change to configOption
async mayRead(user: User | null, note: Note): Promise<boolean> {
if (await this.isOwner(user, note)) return true;
if (await this.hasPermissionUser(user, note, false)) return true; /**
* Checks if the given {@link User} is allowed to read the given {@link Note}.
// noinspection RedundantIfStatementJS *
if (await this.hasPermissionGroup(user, note, false)) return true; * @async
* @param {User} user - The user whose permission should be checked. Value is null if guest access should be checked
return false; * @param {Note} note - The note for which the permission should be checked
* @return if the user is allowed to read the note
*/
public async mayRead(user: User | null, note: Note): Promise<boolean> {
return (
(await this.isOwner(user, note)) ||
(await this.hasPermissionUser(user, note, false)) ||
(await this.hasPermissionGroup(user, note, false))
);
} }
async mayWrite(user: User | null, note: Note): Promise<boolean> { /**
if (await this.isOwner(user, note)) return true; * Checks if the given {@link User} is allowed to edit the given {@link Note}.
*
if (await this.hasPermissionUser(user, note, true)) return true; * @async
* @param {User} user - The user whose permission should be checked
// noinspection RedundantIfStatementJS * @param {Note} note - The note for which the permission should be checked. Value is null if guest access should be checked
if (await this.hasPermissionGroup(user, note, true)) return true; * @return if the user is allowed to edit the note
*/
return false; public async mayWrite(user: User | null, note: Note): Promise<boolean> {
return (
(await this.isOwner(user, note)) ||
(await this.hasPermissionUser(user, note, true)) ||
(await this.hasPermissionGroup(user, note, true))
);
} }
mayCreate(user: User | null): boolean { /**
* Checks if the given {@link User} is allowed to create notes.
*
* @async
* @param {User} user - The user whose permission should be checked. Value is null if guest access should be checked
* @return if the user is allowed to create notes
*/
public mayCreate(user: User | null): boolean {
if (user) { if (user) {
return true; return true;
} else { } else {