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

refactor: rename "Permissions" decorator to "RequirePermission"

Browse source 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2023-05-19 13:43:18 +02:00
parent 4c384cc8de
commit 6b73016583
5 changed files with 40 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

4
backend/src/api/private/media/media.controller.ts
View file

@ -23,10 +23,10 @@ import { MediaUploadDto } from '../../../media/media-upload.dto';
import { MediaService } from '../../../media/media.service'; import { MediaService } from '../../../media/media.service';
import { MulterFile } from '../../../media/multer-file.interface'; import { MulterFile } from '../../../media/multer-file.interface';
import { Note } from '../../../notes/note.entity'; import { Note } from '../../../notes/note.entity';
import { Permissions } from '../../../permissions/permissions.decorator';
import { Permission } from '../../../permissions/permissions.enum'; import { Permission } from '../../../permissions/permissions.enum';
import { PermissionsGuard } from '../../../permissions/permissions.guard'; import { PermissionsGuard } from '../../../permissions/permissions.guard';
import { PermissionsService } from '../../../permissions/permissions.service'; import { PermissionsService } from '../../../permissions/permissions.service';
import { RequirePermission } from '../../../permissions/require-permission.decorator';
import { User } from '../../../users/user.entity'; import { User } from '../../../users/user.entity';
import { NoteHeaderInterceptor } from '../../utils/note-header.interceptor'; import { NoteHeaderInterceptor } from '../../utils/note-header.interceptor';
import { OpenApi } from '../../utils/openapi.decorator'; import { OpenApi } from '../../utils/openapi.decorator';
@ -66,7 +66,7 @@ export class MediaController {
@UseGuards(PermissionsGuard) @UseGuards(PermissionsGuard)
@UseInterceptors(FileInterceptor('file')) @UseInterceptors(FileInterceptor('file'))
@UseInterceptors(NoteHeaderInterceptor) @UseInterceptors(NoteHeaderInterceptor)
@Permissions(Permission.WRITE) @RequirePermission(Permission.WRITE)
@OpenApi( @OpenApi(
{ {
code: 201, code: 201,

30
backend/src/api/private/notes/notes.controller.ts
View file

@ -30,10 +30,10 @@ import { NoteDto } from '../../../notes/note.dto';
import { Note } from '../../../notes/note.entity'; import { Note } from '../../../notes/note.entity';
import { NoteMediaDeletionDto } from '../../../notes/note.media-deletion.dto'; import { NoteMediaDeletionDto } from '../../../notes/note.media-deletion.dto';
import { NotesService } from '../../../notes/notes.service'; import { NotesService } from '../../../notes/notes.service';
import { Permissions } from '../../../permissions/permissions.decorator';
import { Permission } from '../../../permissions/permissions.enum'; import { Permission } from '../../../permissions/permissions.enum';
import { PermissionsGuard } from '../../../permissions/permissions.guard'; import { PermissionsGuard } from '../../../permissions/permissions.guard';
import { PermissionsService } from '../../../permissions/permissions.service'; import { PermissionsService } from '../../../permissions/permissions.service';
import { RequirePermission } from '../../../permissions/require-permission.decorator';
import { RevisionMetadataDto } from '../../../revisions/revision-metadata.dto'; import { RevisionMetadataDto } from '../../../revisions/revision-metadata.dto';
import { RevisionDto } from '../../../revisions/revision.dto'; import { RevisionDto } from '../../../revisions/revision.dto';
import { RevisionsService } from '../../../revisions/revisions.service'; import { RevisionsService } from '../../../revisions/revisions.service';
@ -65,7 +65,7 @@ export class NotesController {
@Get(':noteIdOrAlias') @Get(':noteIdOrAlias')
@OpenApi(200) @OpenApi(200)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
async getNote( async getNote(
@RequestUser({ guestsAllowed: true }) user: User | null, @RequestUser({ guestsAllowed: true }) user: User | null,
@ -77,7 +77,7 @@ export class NotesController {
@Get(':noteIdOrAlias/media') @Get(':noteIdOrAlias/media')
@OpenApi(200) @OpenApi(200)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
async getNotesMedia(@RequestNote() note: Note): Promise<MediaUploadDto[]> { async getNotesMedia(@RequestNote() note: Note): Promise<MediaUploadDto[]> {
const media = await this.mediaService.listUploadsByNote(note); const media = await this.mediaService.listUploadsByNote(note);
@ -88,7 +88,7 @@ export class NotesController {
@Post() @Post()
@OpenApi(201, 413) @OpenApi(201, 413)
@Permissions(Permission.CREATE) @RequirePermission(Permission.CREATE)
async createNote( async createNote(
@RequestUser({ guestsAllowed: true }) user: User | null, @RequestUser({ guestsAllowed: true }) user: User | null,
@MarkdownBody() text: string, @MarkdownBody() text: string,
@ -101,7 +101,7 @@ export class NotesController {
@Post(':noteAlias') @Post(':noteAlias')
@OpenApi(201, 400, 404, 409, 413) @OpenApi(201, 400, 404, 409, 413)
@Permissions(Permission.CREATE) @RequirePermission(Permission.CREATE)
async createNamedNote( async createNamedNote(
@RequestUser({ guestsAllowed: true }) user: User | null, @RequestUser({ guestsAllowed: true }) user: User | null,
@Param('noteAlias') noteAlias: string, @Param('noteAlias') noteAlias: string,
@ -115,7 +115,7 @@ export class NotesController {
@Delete(':noteIdOrAlias') @Delete(':noteIdOrAlias')
@OpenApi(204, 404, 500) @OpenApi(204, 404, 500)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
async deleteNote( async deleteNote(
@RequestUser() user: User, @RequestUser() user: User,
@ -137,7 +137,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@Get(':noteIdOrAlias/metadata') @Get(':noteIdOrAlias/metadata')
async getNoteMetadata( async getNoteMetadata(
@RequestUser({ guestsAllowed: true }) user: User | null, @RequestUser({ guestsAllowed: true }) user: User | null,
@ -148,7 +148,7 @@ export class NotesController {
@Get(':noteIdOrAlias/revisions') @Get(':noteIdOrAlias/revisions')
@OpenApi(200, 404) @OpenApi(200, 404)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
async getNoteRevisions( async getNoteRevisions(
@RequestUser({ guestsAllowed: true }) user: User | null, @RequestUser({ guestsAllowed: true }) user: User | null,
@ -164,7 +164,7 @@ export class NotesController {
@Delete(':noteIdOrAlias/revisions') @Delete(':noteIdOrAlias/revisions')
@OpenApi(204, 404) @OpenApi(204, 404)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
async purgeNoteRevisions( async purgeNoteRevisions(
@RequestUser() user: User, @RequestUser() user: User,
@ -184,7 +184,7 @@ export class NotesController {
@Get(':noteIdOrAlias/revisions/:revisionId') @Get(':noteIdOrAlias/revisions/:revisionId')
@OpenApi(200, 404) @OpenApi(200, 404)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
async getNoteRevision( async getNoteRevision(
@RequestUser({ guestsAllowed: true }) user: User | null, @RequestUser({ guestsAllowed: true }) user: User | null,
@ -199,7 +199,7 @@ export class NotesController {
@Put(':noteIdOrAlias/metadata/permissions/users/:userName') @Put(':noteIdOrAlias/metadata/permissions/users/:userName')
@OpenApi(200, 403, 404) @OpenApi(200, 403, 404)
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
async setUserPermission( async setUserPermission(
@RequestUser() user: User, @RequestUser() user: User,
@RequestNote() note: Note, @RequestNote() note: Note,
@ -216,7 +216,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Delete(':noteIdOrAlias/metadata/permissions/users/:userName') @Delete(':noteIdOrAlias/metadata/permissions/users/:userName')
async removeUserPermission( async removeUserPermission(
@RequestUser() user: User, @RequestUser() user: User,
@ -241,7 +241,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Put(':noteIdOrAlias/metadata/permissions/groups/:groupName') @Put(':noteIdOrAlias/metadata/permissions/groups/:groupName')
async setGroupPermission( async setGroupPermission(
@RequestUser() user: User, @RequestUser() user: User,
@ -259,7 +259,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@UseGuards(PermissionsGuard) @UseGuards(PermissionsGuard)
@Delete(':noteIdOrAlias/metadata/permissions/groups/:groupName') @Delete(':noteIdOrAlias/metadata/permissions/groups/:groupName')
async removeGroupPermission( async removeGroupPermission(
@ -276,7 +276,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Put(':noteIdOrAlias/metadata/permissions/owner') @Put(':noteIdOrAlias/metadata/permissions/owner')
async changeOwner( async changeOwner(
@RequestUser() user: User, @RequestUser() user: User,

4
backend/src/api/public/media/media.controller.ts
View file

@ -29,10 +29,10 @@ import { MediaUploadDto } from '../../../media/media-upload.dto';
import { MediaService } from '../../../media/media.service'; import { MediaService } from '../../../media/media.service';
import { MulterFile } from '../../../media/multer-file.interface'; import { MulterFile } from '../../../media/multer-file.interface';
import { Note } from '../../../notes/note.entity'; import { Note } from '../../../notes/note.entity';
import { Permissions } from '../../../permissions/permissions.decorator';
import { Permission } from '../../../permissions/permissions.enum'; import { Permission } from '../../../permissions/permissions.enum';
import { PermissionsGuard } from '../../../permissions/permissions.guard'; import { PermissionsGuard } from '../../../permissions/permissions.guard';
import { PermissionsService } from '../../../permissions/permissions.service'; import { PermissionsService } from '../../../permissions/permissions.service';
import { RequirePermission } from '../../../permissions/require-permission.decorator';
import { User } from '../../../users/user.entity'; import { User } from '../../../users/user.entity';
import { NoteHeaderInterceptor } from '../../utils/note-header.interceptor'; import { NoteHeaderInterceptor } from '../../utils/note-header.interceptor';
import { OpenApi } from '../../utils/openapi.decorator'; import { OpenApi } from '../../utils/openapi.decorator';
@ -84,7 +84,7 @@ export class MediaController {
@UseGuards(PermissionsGuard) @UseGuards(PermissionsGuard)
@UseInterceptors(FileInterceptor('file')) @UseInterceptors(FileInterceptor('file'))
@UseInterceptors(NoteHeaderInterceptor) @UseInterceptors(NoteHeaderInterceptor)
@Permissions(Permission.WRITE) @RequirePermission(Permission.WRITE)
async uploadMedia( async uploadMedia(
@RequestUser() user: User, @RequestUser() user: User,
@UploadedFile() file: MulterFile, @UploadedFile() file: MulterFile,

36
backend/src/api/public/notes/notes.controller.ts
View file

@ -33,10 +33,10 @@ import { NoteDto } from '../../../notes/note.dto';
import { Note } from '../../../notes/note.entity'; import { Note } from '../../../notes/note.entity';
import { NoteMediaDeletionDto } from '../../../notes/note.media-deletion.dto'; import { NoteMediaDeletionDto } from '../../../notes/note.media-deletion.dto';
import { NotesService } from '../../../notes/notes.service'; import { NotesService } from '../../../notes/notes.service';
import { Permissions } from '../../../permissions/permissions.decorator';
import { Permission } from '../../../permissions/permissions.enum'; import { Permission } from '../../../permissions/permissions.enum';
import { PermissionsGuard } from '../../../permissions/permissions.guard'; import { PermissionsGuard } from '../../../permissions/permissions.guard';
import { PermissionsService } from '../../../permissions/permissions.service'; import { PermissionsService } from '../../../permissions/permissions.service';
import { RequirePermission } from '../../../permissions/require-permission.decorator';
import { RevisionMetadataDto } from '../../../revisions/revision-metadata.dto'; import { RevisionMetadataDto } from '../../../revisions/revision-metadata.dto';
import { RevisionDto } from '../../../revisions/revision.dto'; import { RevisionDto } from '../../../revisions/revision.dto';
import { RevisionsService } from '../../../revisions/revisions.service'; import { RevisionsService } from '../../../revisions/revisions.service';
@ -67,7 +67,7 @@ export class NotesController {
this.logger.setContext(NotesController.name); this.logger.setContext(NotesController.name);
} }
@Permissions(Permission.CREATE) @RequirePermission(Permission.CREATE)
@Post() @Post()
@OpenApi(201, 403, 409, 413) @OpenApi(201, 403, 409, 413)
async createNote( async createNote(
@ -81,7 +81,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@Get(':noteIdOrAlias') @Get(':noteIdOrAlias')
@OpenApi( @OpenApi(
{ {
@ -100,7 +100,7 @@ export class NotesController {
return await this.noteService.toNoteDto(note); return await this.noteService.toNoteDto(note);
} }
@Permissions(Permission.CREATE) @RequirePermission(Permission.CREATE)
@Post(':noteAlias') @Post(':noteAlias')
@OpenApi( @OpenApi(
{ {
@ -125,7 +125,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Delete(':noteIdOrAlias') @Delete(':noteIdOrAlias')
@OpenApi(204, 403, 404, 500) @OpenApi(204, 403, 404, 500)
async deleteNote( async deleteNote(
@ -148,7 +148,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.WRITE) @RequirePermission(Permission.WRITE)
@Put(':noteIdOrAlias') @Put(':noteIdOrAlias')
@OpenApi( @OpenApi(
{ {
@ -171,7 +171,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@Get(':noteIdOrAlias/content') @Get(':noteIdOrAlias/content')
@OpenApi( @OpenApi(
{ {
@ -190,7 +190,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@Get(':noteIdOrAlias/metadata') @Get(':noteIdOrAlias/metadata')
@OpenApi( @OpenApi(
{ {
@ -209,7 +209,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Put(':noteIdOrAlias/metadata/permissions') @Put(':noteIdOrAlias/metadata/permissions')
@OpenApi( @OpenApi(
{ {
@ -231,7 +231,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@Get(':noteIdOrAlias/metadata/permissions') @Get(':noteIdOrAlias/metadata/permissions')
@OpenApi( @OpenApi(
{ {
@ -250,7 +250,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Put(':noteIdOrAlias/metadata/permissions/users/:userName') @Put(':noteIdOrAlias/metadata/permissions/users/:userName')
@OpenApi( @OpenApi(
{ {
@ -277,7 +277,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Delete(':noteIdOrAlias/metadata/permissions/users/:userName') @Delete(':noteIdOrAlias/metadata/permissions/users/:userName')
@OpenApi( @OpenApi(
{ {
@ -311,7 +311,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Put(':noteIdOrAlias/metadata/permissions/groups/:groupName') @Put(':noteIdOrAlias/metadata/permissions/groups/:groupName')
@OpenApi( @OpenApi(
{ {
@ -338,7 +338,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Delete(':noteIdOrAlias/metadata/permissions/groups/:groupName') @Delete(':noteIdOrAlias/metadata/permissions/groups/:groupName')
@OpenApi( @OpenApi(
{ {
@ -363,7 +363,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @RequirePermission(Permission.OWNER)
@Put(':noteIdOrAlias/metadata/permissions/owner') @Put(':noteIdOrAlias/metadata/permissions/owner')
@OpenApi( @OpenApi(
{ {
@ -386,7 +386,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@Get(':noteIdOrAlias/revisions') @Get(':noteIdOrAlias/revisions')
@OpenApi( @OpenApi(
{ {
@ -411,7 +411,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@Get(':noteIdOrAlias/revisions/:revisionId') @Get(':noteIdOrAlias/revisions/:revisionId')
@OpenApi( @OpenApi(
{ {
@ -433,7 +433,7 @@ export class NotesController {
} }
@UseInterceptors(GetNoteInterceptor) @UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @RequirePermission(Permission.READ)
@Get(':noteIdOrAlias/media') @Get(':noteIdOrAlias/media')
@OpenApi({ @OpenApi({
code: 200, code: 200,

5
backend/src/permissions/permissions.decorator.ts → backend/src/permissions/require-permission.decorator.ts
View file

@ -13,5 +13,6 @@ import { Permission } from './permissions.enum';
* @constructor * @constructor
*/ */
// eslint-disable-next-line func-style,@typescript-eslint/naming-convention // eslint-disable-next-line func-style,@typescript-eslint/naming-convention
export const Permissions = (...permissions: Permission[]): CustomDecorator => export const RequirePermission = (
SetMetadata('permissions', permissions); ...permissions: Permission[]
): CustomDecorator => SetMetadata('permissions', permissions);