github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-10-22 15:12:08 -04:00
Code Issues Projects Releases Packages Wiki Activity

feat: replace GetNotePipe with GetNoteInterceptor and RequestNote

Browse source 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2021-11-30 22:33:20 +01:00
parent 9e2a138a14
commit 6fddeebc56
4 changed files with 57 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/api/private/me/history/history.controller.ts
View file

@ -10,10 +10,10 @@ import {
Delete, Delete,
Get, Get,
NotFoundException, NotFoundException,
Param,
Post, Post,
Put, Put,
UseGuards, UseGuards,
UseInterceptors,
} from '@nestjs/common'; } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger'; import { ApiTags } from '@nestjs/swagger';
@ -26,7 +26,8 @@ import { SessionGuard } from '../../../../identity/session.guard';
import { ConsoleLoggerService } from '../../../../logger/console-logger.service'; import { ConsoleLoggerService } from '../../../../logger/console-logger.service';
import { Note } from '../../../../notes/note.entity'; import { Note } from '../../../../notes/note.entity';
import { User } from '../../../../users/user.entity'; import { User } from '../../../../users/user.entity';
import { GetNotePipe } from '../../../utils/get-note.pipe'; import { GetNoteInterceptor } from '../../../utils/get-note.interceptor';
import { RequestNote } from '../../../utils/request-note.decorator';
import { RequestUser } from '../../../utils/request-user.decorator'; import { RequestUser } from '../../../utils/request-user.decorator';
@UseGuards(SessionGuard) @UseGuards(SessionGuard)
@ -82,9 +83,10 @@ export class HistoryController {
} }
} }
@Put(':note') @Put(':noteIdOrAlias')
@UseInterceptors(GetNoteInterceptor)
async updateHistoryEntry( async updateHistoryEntry(
@Param('note', GetNotePipe) note: Note, @RequestNote() note: Note,
@RequestUser() user: User, @RequestUser() user: User,
@Body() entryUpdateDto: HistoryEntryUpdateDto, @Body() entryUpdateDto: HistoryEntryUpdateDto,
): Promise<HistoryEntryDto> { ): Promise<HistoryEntryDto> {
@ -103,9 +105,10 @@ export class HistoryController {
} }
} }
@Delete(':note') @Delete(':noteIdOrAlias')
@UseInterceptors(GetNoteInterceptor)
async deleteHistoryEntry( async deleteHistoryEntry(
@Param('note', GetNotePipe) note: Note, @RequestNote() note: Note,
@RequestUser() user: User, @RequestUser() user: User,
): Promise<void> { ): Promise<void> {
try { try {

24
src/api/private/notes/notes.controller.ts
View file

@ -14,6 +14,7 @@ import {
Param, Param,
Post, Post,
UseGuards, UseGuards,
UseInterceptors,
} from '@nestjs/common'; } from '@nestjs/common';
import { import {
@ -37,9 +38,10 @@ import { RevisionDto } from '../../../revisions/revision.dto';
import { RevisionsService } from '../../../revisions/revisions.service'; import { RevisionsService } from '../../../revisions/revisions.service';
import { User } from '../../../users/user.entity'; import { User } from '../../../users/user.entity';
import { UsersService } from '../../../users/users.service'; import { UsersService } from '../../../users/users.service';
import { GetNotePipe } from '../../utils/get-note.pipe'; import { GetNoteInterceptor } from '../../utils/get-note.interceptor';
import { MarkdownBody } from '../../utils/markdownbody-decorator'; import { MarkdownBody } from '../../utils/markdownbody-decorator';
import { PermissionsGuard } from '../../utils/permissions.guard'; import { PermissionsGuard } from '../../utils/permissions.guard';
import { RequestNote } from '../../utils/request-note.decorator';
import { RequestUser } from '../../utils/request-user.decorator'; import { RequestUser } from '../../utils/request-user.decorator';
@UseGuards(SessionGuard) @UseGuards(SessionGuard)
@ -58,10 +60,11 @@ export class NotesController {
@Get(':noteIdOrAlias') @Get(':noteIdOrAlias')
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseInterceptors(GetNoteInterceptor)
@UseGuards(PermissionsGuard) @UseGuards(PermissionsGuard)
async getNote( async getNote(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<NoteDto> { ): Promise<NoteDto> {
await this.historyService.updateHistoryEntryTimestamp(note, user); await this.historyService.updateHistoryEntryTimestamp(note, user);
return await this.noteService.toNoteDto(note); return await this.noteService.toNoteDto(note);
@ -69,10 +72,9 @@ export class NotesController {
@Get(':noteIdOrAlias/media') @Get(':noteIdOrAlias/media')
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseInterceptors(GetNoteInterceptor)
@UseGuards(PermissionsGuard) @UseGuards(PermissionsGuard)
async getNotesMedia( async getNotesMedia(@RequestNote() note: Note): Promise<MediaUploadDto[]> {
@Param('noteIdOrAlias', GetNotePipe) note: Note,
): Promise<MediaUploadDto[]> {
const media = await this.mediaService.listUploadsByNote(note); const media = await this.mediaService.listUploadsByNote(note);
return media.map((media) => this.mediaService.toMediaUploadDto(media)); return media.map((media) => this.mediaService.toMediaUploadDto(media));
} }
@ -119,10 +121,11 @@ export class NotesController {
@Delete(':noteIdOrAlias') @Delete(':noteIdOrAlias')
@HttpCode(204) @HttpCode(204)
@Permissions(Permission.OWNER) @Permissions(Permission.OWNER)
@UseInterceptors(GetNoteInterceptor)
@UseGuards(PermissionsGuard) @UseGuards(PermissionsGuard)
async deleteNote( async deleteNote(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
@Body() noteMediaDeletionDto: NoteMediaDeletionDto, @Body() noteMediaDeletionDto: NoteMediaDeletionDto,
): Promise<void> { ): Promise<void> {
const mediaUploads = await this.mediaService.listUploadsByNote(note); const mediaUploads = await this.mediaService.listUploadsByNote(note);
@ -141,10 +144,11 @@ export class NotesController {
@Get(':noteIdOrAlias/revisions') @Get(':noteIdOrAlias/revisions')
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseInterceptors(GetNoteInterceptor)
@UseGuards(PermissionsGuard) @UseGuards(PermissionsGuard)
async getNoteRevisions( async getNoteRevisions(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<RevisionMetadataDto[]> { ): Promise<RevisionMetadataDto[]> {
const revisions = await this.revisionsService.getAllRevisions(note); const revisions = await this.revisionsService.getAllRevisions(note);
return await Promise.all( return await Promise.all(
@ -157,10 +161,11 @@ export class NotesController {
@Delete(':noteIdOrAlias/revisions') @Delete(':noteIdOrAlias/revisions')
@HttpCode(204) @HttpCode(204)
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseInterceptors(GetNoteInterceptor)
@UseGuards(PermissionsGuard) @UseGuards(PermissionsGuard)
async purgeNoteRevisions( async purgeNoteRevisions(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<void> { ): Promise<void> {
this.logger.debug( this.logger.debug(
'Purging history of note: ' + note.id, 'Purging history of note: ' + note.id,
@ -176,10 +181,11 @@ export class NotesController {
@Get(':noteIdOrAlias/revisions/:revisionId') @Get(':noteIdOrAlias/revisions/:revisionId')
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseInterceptors(GetNoteInterceptor)
@UseGuards(PermissionsGuard) @UseGuards(PermissionsGuard)
async getNoteRevision( async getNoteRevision(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
@Param('revisionId') revisionId: number, @Param('revisionId') revisionId: number,
): Promise<RevisionDto> { ): Promise<RevisionDto> {
try { try {

20
src/api/public/me/me.controller.ts
View file

@ -10,9 +10,9 @@ import {
Get, Get,
HttpCode, HttpCode,
NotFoundException, NotFoundException,
Param,
Put, Put,
UseGuards, UseGuards,
UseInterceptors,
} from '@nestjs/common'; } from '@nestjs/common';
import { import {
ApiNoContentResponse, ApiNoContentResponse,
@ -42,7 +42,8 @@ import {
successfullyDeletedDescription, successfullyDeletedDescription,
unauthorizedDescription, unauthorizedDescription,
} from '../../utils/descriptions'; } from '../../utils/descriptions';
import { GetNotePipe } from '../../utils/get-note.pipe'; import { GetNoteInterceptor } from '../../utils/get-note.interceptor';
import { RequestNote } from '../../utils/request-note.decorator';
import { RequestUser } from '../../utils/request-user.decorator'; import { RequestUser } from '../../utils/request-user.decorator';
@ApiTags('me') @ApiTags('me')
@ -85,8 +86,9 @@ export class MeController {
); );
} }
@UseInterceptors(GetNoteInterceptor)
@UseGuards(TokenAuthGuard) @UseGuards(TokenAuthGuard)
@Get('history/:note') @Get('history/:noteIdOrAlias')
@ApiOkResponse({ @ApiOkResponse({
description: 'The history entry of the user which points to the note', description: 'The history entry of the user which points to the note',
type: HistoryEntryDto, type: HistoryEntryDto,
@ -95,7 +97,7 @@ export class MeController {
@ApiNotFoundResponse({ description: notFoundDescription }) @ApiNotFoundResponse({ description: notFoundDescription })
async getHistoryEntry( async getHistoryEntry(
@RequestUser() user: User, @RequestUser() user: User,
@Param('note', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<HistoryEntryDto> { ): Promise<HistoryEntryDto> {
try { try {
const foundEntry = await this.historyService.getEntryByNote(note, user); const foundEntry = await this.historyService.getEntryByNote(note, user);
@ -108,8 +110,9 @@ export class MeController {
} }
} }
@UseInterceptors(GetNoteInterceptor)
@UseGuards(TokenAuthGuard) @UseGuards(TokenAuthGuard)
@Put('history/:note') @Put('history/:noteIdOrAlias')
@ApiOkResponse({ @ApiOkResponse({
description: 'The updated history entry', description: 'The updated history entry',
type: HistoryEntryDto, type: HistoryEntryDto,
@ -118,7 +121,7 @@ export class MeController {
@ApiNotFoundResponse({ description: notFoundDescription }) @ApiNotFoundResponse({ description: notFoundDescription })
async updateHistoryEntry( async updateHistoryEntry(
@RequestUser() user: User, @RequestUser() user: User,
@Param('note', GetNotePipe) note: Note, @RequestNote() note: Note,
@Body() entryUpdateDto: HistoryEntryUpdateDto, @Body() entryUpdateDto: HistoryEntryUpdateDto,
): Promise<HistoryEntryDto> { ): Promise<HistoryEntryDto> {
// ToDo: Check if user is allowed to pin this history entry // ToDo: Check if user is allowed to pin this history entry
@ -138,15 +141,16 @@ export class MeController {
} }
} }
@UseInterceptors(GetNoteInterceptor)
@UseGuards(TokenAuthGuard) @UseGuards(TokenAuthGuard)
@Delete('history/:note') @Delete('history/:noteIdOrAlias')
@HttpCode(204) @HttpCode(204)
@ApiNoContentResponse({ description: successfullyDeletedDescription }) @ApiNoContentResponse({ description: successfullyDeletedDescription })
@ApiUnauthorizedResponse({ description: unauthorizedDescription }) @ApiUnauthorizedResponse({ description: unauthorizedDescription })
@ApiNotFoundResponse({ description: notFoundDescription }) @ApiNotFoundResponse({ description: notFoundDescription })
async deleteHistoryEntry( async deleteHistoryEntry(
@RequestUser() user: User, @RequestUser() user: User,
@Param('note', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<void> { ): Promise<void> {
// ToDo: Check if user is allowed to delete note // ToDo: Check if user is allowed to delete note
try { try {

31
src/api/public/notes/notes.controller.ts
View file

@ -16,6 +16,7 @@ import {
Post, Post,
Put, Put,
UseGuards, UseGuards,
UseInterceptors,
} from '@nestjs/common'; } from '@nestjs/common';
import { import {
ApiCreatedResponse, ApiCreatedResponse,
@ -59,9 +60,10 @@ import {
unauthorizedDescription, unauthorizedDescription,
} from '../../utils/descriptions'; } from '../../utils/descriptions';
import { FullApi } from '../../utils/fullapi-decorator'; import { FullApi } from '../../utils/fullapi-decorator';
import { GetNotePipe } from '../../utils/get-note.pipe'; import { GetNoteInterceptor } from '../../utils/get-note.interceptor';
import { MarkdownBody } from '../../utils/markdownbody-decorator'; import { MarkdownBody } from '../../utils/markdownbody-decorator';
import { PermissionsGuard } from '../../utils/permissions.guard'; import { PermissionsGuard } from '../../utils/permissions.guard';
import { RequestNote } from '../../utils/request-note.decorator';
import { RequestUser } from '../../utils/request-user.decorator'; import { RequestUser } from '../../utils/request-user.decorator';
@ApiTags('notes') @ApiTags('notes')
@ -94,6 +96,7 @@ export class NotesController {
); );
} }
@UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseGuards(TokenAuthGuard, PermissionsGuard) @UseGuards(TokenAuthGuard, PermissionsGuard)
@Get(':noteIdOrAlias') @Get(':noteIdOrAlias')
@ -104,7 +107,7 @@ export class NotesController {
@FullApi @FullApi
async getNote( async getNote(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<NoteDto> { ): Promise<NoteDto> {
await this.historyService.updateHistoryEntryTimestamp(note, user); await this.historyService.updateHistoryEntryTimestamp(note, user);
return await this.noteService.toNoteDto(note); return await this.noteService.toNoteDto(note);
@ -141,6 +144,7 @@ export class NotesController {
} }
} }
@UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @Permissions(Permission.OWNER)
@UseGuards(TokenAuthGuard, PermissionsGuard) @UseGuards(TokenAuthGuard, PermissionsGuard)
@Delete(':noteIdOrAlias') @Delete(':noteIdOrAlias')
@ -149,7 +153,7 @@ export class NotesController {
@FullApi @FullApi
async deleteNote( async deleteNote(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
@Body() noteMediaDeletionDto: NoteMediaDeletionDto, @Body() noteMediaDeletionDto: NoteMediaDeletionDto,
): Promise<void> { ): Promise<void> {
const mediaUploads = await this.mediaService.listUploadsByNote(note); const mediaUploads = await this.mediaService.listUploadsByNote(note);
@ -166,6 +170,7 @@ export class NotesController {
return; return;
} }
@UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.WRITE) @Permissions(Permission.WRITE)
@UseGuards(TokenAuthGuard, PermissionsGuard) @UseGuards(TokenAuthGuard, PermissionsGuard)
@Put(':noteIdOrAlias') @Put(':noteIdOrAlias')
@ -176,7 +181,7 @@ export class NotesController {
@FullApi @FullApi
async updateNote( async updateNote(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
@MarkdownBody() text: string, @MarkdownBody() text: string,
): Promise<NoteDto> { ): Promise<NoteDto> {
this.logger.debug('Got raw markdown:\n' + text, 'updateNote'); this.logger.debug('Got raw markdown:\n' + text, 'updateNote');
@ -185,6 +190,7 @@ export class NotesController {
); );
} }
@UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseGuards(TokenAuthGuard, PermissionsGuard) @UseGuards(TokenAuthGuard, PermissionsGuard)
@Get(':noteIdOrAlias/content') @Get(':noteIdOrAlias/content')
@ -196,11 +202,12 @@ export class NotesController {
@Header('content-type', 'text/markdown') @Header('content-type', 'text/markdown')
async getNoteContent( async getNoteContent(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<string> { ): Promise<string> {
return await this.noteService.getNoteContent(note); return await this.noteService.getNoteContent(note);
} }
@UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseGuards(TokenAuthGuard, PermissionsGuard) @UseGuards(TokenAuthGuard, PermissionsGuard)
@Get(':noteIdOrAlias/metadata') @Get(':noteIdOrAlias/metadata')
@ -211,11 +218,12 @@ export class NotesController {
@FullApi @FullApi
async getNoteMetadata( async getNoteMetadata(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<NoteMetadataDto> { ): Promise<NoteMetadataDto> {
return await this.noteService.toNoteMetadataDto(note); return await this.noteService.toNoteMetadataDto(note);
} }
@UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.OWNER) @Permissions(Permission.OWNER)
@UseGuards(TokenAuthGuard, PermissionsGuard) @UseGuards(TokenAuthGuard, PermissionsGuard)
@Put(':noteIdOrAlias/metadata/permissions') @Put(':noteIdOrAlias/metadata/permissions')
@ -226,7 +234,7 @@ export class NotesController {
@FullApi @FullApi
async updateNotePermissions( async updateNotePermissions(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
@Body() updateDto: NotePermissionsUpdateDto, @Body() updateDto: NotePermissionsUpdateDto,
): Promise<NotePermissionsDto> { ): Promise<NotePermissionsDto> {
return this.noteService.toNotePermissionsDto( return this.noteService.toNotePermissionsDto(
@ -234,6 +242,7 @@ export class NotesController {
); );
} }
@UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseGuards(TokenAuthGuard, PermissionsGuard) @UseGuards(TokenAuthGuard, PermissionsGuard)
@Get(':noteIdOrAlias/revisions') @Get(':noteIdOrAlias/revisions')
@ -245,7 +254,7 @@ export class NotesController {
@FullApi @FullApi
async getNoteRevisions( async getNoteRevisions(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<RevisionMetadataDto[]> { ): Promise<RevisionMetadataDto[]> {
const revisions = await this.revisionsService.getAllRevisions(note); const revisions = await this.revisionsService.getAllRevisions(note);
return await Promise.all( return await Promise.all(
@ -255,6 +264,7 @@ export class NotesController {
); );
} }
@UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseGuards(TokenAuthGuard, PermissionsGuard) @UseGuards(TokenAuthGuard, PermissionsGuard)
@Get(':noteIdOrAlias/revisions/:revisionId') @Get(':noteIdOrAlias/revisions/:revisionId')
@ -265,7 +275,7 @@ export class NotesController {
@FullApi @FullApi
async getNoteRevision( async getNoteRevision(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
@Param('revisionId') revisionId: number, @Param('revisionId') revisionId: number,
): Promise<RevisionDto> { ): Promise<RevisionDto> {
try { try {
@ -280,6 +290,7 @@ export class NotesController {
} }
} }
@UseInterceptors(GetNoteInterceptor)
@Permissions(Permission.READ) @Permissions(Permission.READ)
@UseGuards(TokenAuthGuard, PermissionsGuard) @UseGuards(TokenAuthGuard, PermissionsGuard)
@Get(':noteIdOrAlias/media') @Get(':noteIdOrAlias/media')
@ -291,7 +302,7 @@ export class NotesController {
@ApiUnauthorizedResponse({ description: unauthorizedDescription }) @ApiUnauthorizedResponse({ description: unauthorizedDescription })
async getNotesMedia( async getNotesMedia(
@RequestUser() user: User, @RequestUser() user: User,
@Param('noteIdOrAlias', GetNotePipe) note: Note, @RequestNote() note: Note,
): Promise<MediaUploadDto[]> { ): Promise<MediaUploadDto[]> {
const media = await this.mediaService.listUploadsByNote(note); const media = await this.mediaService.listUploadsByNote(note);
return media.map((media) => this.mediaService.toMediaUploadDto(media)); return media.map((media) => this.mediaService.toMediaUploadDto(media));