mirror of https://github.com/ghostfolio/ghostfolio
Browse Source
* Deprecate access endpoints in favor of accesses endpoints * Update changelogpull/8307/head
Thomas Kaul
2 days ago
committed by
GitHub
GitHub
20 changed files with 338 additions and 21 deletions
@ -0,0 +1,250 @@ |
|||
import { AllowDuringImpersonation } from '@ghostfolio/api/decorators/allow-during-impersonation.decorator'; |
|||
import { HasPermission } from '@ghostfolio/api/decorators/has-permission.decorator'; |
|||
import { HasPermissionGuard } from '@ghostfolio/api/guards/has-permission.guard'; |
|||
import { AccessService } from '@ghostfolio/api/services/access/access.service'; |
|||
import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service'; |
|||
import { CreateAccessDto, UpdateAccessDto } from '@ghostfolio/common/dtos'; |
|||
import { SubscriptionType } from '@ghostfolio/common/enums'; |
|||
import { |
|||
canApplyFiltersToAccess, |
|||
isValidGranteeOfAccess |
|||
} from '@ghostfolio/common/helper'; |
|||
import { |
|||
AccessResponse, |
|||
AccessSettings, |
|||
AccessesResponse |
|||
} from '@ghostfolio/common/interfaces'; |
|||
import { permissions } from '@ghostfolio/common/permissions'; |
|||
import { getScopesOfAccess } from '@ghostfolio/common/scopes'; |
|||
import type { RequestWithUser } from '@ghostfolio/common/types'; |
|||
|
|||
import { |
|||
Body, |
|||
Controller, |
|||
Delete, |
|||
Get, |
|||
HttpException, |
|||
Inject, |
|||
Param, |
|||
Post, |
|||
Put, |
|||
UseGuards |
|||
} from '@nestjs/common'; |
|||
import { REQUEST } from '@nestjs/core'; |
|||
import { AuthGuard } from '@nestjs/passport'; |
|||
import { Access as AccessModel } from '@prisma/client'; |
|||
import { StatusCodes, getReasonPhrase } from 'http-status-codes'; |
|||
|
|||
@AllowDuringImpersonation() |
|||
@Controller('accesses') |
|||
export class AccessesController { |
|||
public constructor( |
|||
private readonly accessService: AccessService, |
|||
private readonly configurationService: ConfigurationService, |
|||
@Inject(REQUEST) private readonly request: RequestWithUser |
|||
) {} |
|||
|
|||
@HasPermission(permissions.createAccess) |
|||
@Post() |
|||
@UseGuards(AuthGuard('jwt'), HasPermissionGuard) |
|||
public async createAccess( |
|||
@Body() data: CreateAccessDto |
|||
): Promise<AccessResponse> { |
|||
if ( |
|||
this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') && |
|||
this.request.user.subscription?.type === SubscriptionType.Basic |
|||
) { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.FORBIDDEN), |
|||
StatusCodes.FORBIDDEN |
|||
); |
|||
} |
|||
|
|||
const type = data.type ?? (data.granteeUserId ? 'PRIVATE' : 'PUBLIC'); |
|||
|
|||
if ( |
|||
type === 'MCP' && |
|||
!this.configurationService.get('ENABLE_FEATURE_MCP') |
|||
) { |
|||
// The client hides the type while the feature is disabled, hence an
|
|||
// access of this type must not become a credential which is dormant
|
|||
// until the feature is enabled
|
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.BAD_REQUEST), |
|||
StatusCodes.BAD_REQUEST |
|||
); |
|||
} |
|||
|
|||
if (!isValidGranteeOfAccess({ granteeUserId: data.granteeUserId, type })) { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.BAD_REQUEST), |
|||
StatusCodes.BAD_REQUEST |
|||
); |
|||
} |
|||
|
|||
if (data.filters?.length && !canApplyFiltersToAccess({ type })) { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.BAD_REQUEST), |
|||
StatusCodes.BAD_REQUEST |
|||
); |
|||
} |
|||
|
|||
try { |
|||
const access = await this.accessService.createAccess({ |
|||
type, |
|||
alias: data.alias || undefined, |
|||
expiresAt: new Date(data.expiresAt), |
|||
granteeUser: data.granteeUserId |
|||
? { connect: { id: data.granteeUserId } } |
|||
: undefined, |
|||
scopes: getScopesOfAccess({ |
|||
type, |
|||
scopes: data.scopes |
|||
}), |
|||
settings: this.accessService.buildSettings(data.filters), |
|||
user: { connect: { id: this.request.user.id } } |
|||
}); |
|||
|
|||
return this.getAccessResponse(access); |
|||
} catch { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.BAD_REQUEST), |
|||
StatusCodes.BAD_REQUEST |
|||
); |
|||
} |
|||
} |
|||
|
|||
@Delete(':id') |
|||
@HasPermission(permissions.deleteAccess) |
|||
@UseGuards(AuthGuard('jwt'), HasPermissionGuard) |
|||
public async deleteAccess(@Param('id') id: string): Promise<void> { |
|||
const originalAccess = await this.accessService.access({ |
|||
id, |
|||
OR: [ |
|||
{ granteeUserId: this.request.user.id }, |
|||
{ userId: this.request.user.id } |
|||
] |
|||
}); |
|||
|
|||
if (!originalAccess) { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.FORBIDDEN), |
|||
StatusCodes.FORBIDDEN |
|||
); |
|||
} |
|||
|
|||
await this.accessService.deleteAccess({ |
|||
id |
|||
}); |
|||
} |
|||
|
|||
@Get() |
|||
@UseGuards(AuthGuard('jwt'), HasPermissionGuard) |
|||
public async getAllAccesses(): Promise<AccessesResponse> { |
|||
const accesses = await this.accessService.accesses({ |
|||
orderBy: [{ granteeUserId: 'desc' }, { createdAt: 'asc' }], |
|||
where: { userId: this.request.user.id } |
|||
}); |
|||
|
|||
return { |
|||
accesses: accesses.map((access) => { |
|||
return this.getAccessResponse(access); |
|||
}) |
|||
}; |
|||
} |
|||
|
|||
@HasPermission(permissions.updateAccess) |
|||
@Put(':id') |
|||
@UseGuards(AuthGuard('jwt'), HasPermissionGuard) |
|||
public async updateAccess( |
|||
@Body() data: UpdateAccessDto, |
|||
@Param('id') id: string |
|||
): Promise<AccessResponse> { |
|||
if ( |
|||
this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') && |
|||
this.request.user.subscription?.type === SubscriptionType.Basic |
|||
) { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.FORBIDDEN), |
|||
StatusCodes.FORBIDDEN |
|||
); |
|||
} |
|||
|
|||
const originalAccess = await this.accessService.access({ |
|||
id, |
|||
userId: this.request.user.id |
|||
}); |
|||
|
|||
if (!originalAccess) { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.FORBIDDEN), |
|||
StatusCodes.FORBIDDEN |
|||
); |
|||
} |
|||
|
|||
if ( |
|||
!isValidGranteeOfAccess({ |
|||
granteeUserId: data.granteeUserId, |
|||
type: originalAccess.type |
|||
}) |
|||
) { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.BAD_REQUEST), |
|||
StatusCodes.BAD_REQUEST |
|||
); |
|||
} |
|||
|
|||
if ( |
|||
data.filters?.length && |
|||
!canApplyFiltersToAccess({ type: originalAccess.type }) |
|||
) { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.BAD_REQUEST), |
|||
StatusCodes.BAD_REQUEST |
|||
); |
|||
} |
|||
|
|||
try { |
|||
const access = await this.accessService.updateAccess({ |
|||
data: { |
|||
alias: data.alias, |
|||
expiresAt: new Date(data.expiresAt), |
|||
granteeUser: data.granteeUserId |
|||
? { connect: { id: data.granteeUserId } } |
|||
: { disconnect: true }, |
|||
scopes: getScopesOfAccess({ |
|||
scopes: data.scopes ?? originalAccess.scopes, |
|||
type: originalAccess.type |
|||
}), |
|||
settings: this.accessService.buildSettings(data.filters) |
|||
}, |
|||
where: { id } |
|||
}); |
|||
|
|||
return this.getAccessResponse(access); |
|||
} catch { |
|||
throw new HttpException( |
|||
getReasonPhrase(StatusCodes.BAD_REQUEST), |
|||
StatusCodes.BAD_REQUEST |
|||
); |
|||
} |
|||
} |
|||
|
|||
private getAccessResponse(access: AccessModel): AccessResponse { |
|||
const { alias, expiresAt, granteeUserId, id, lastUsedAt, settings, type } = |
|||
access; |
|||
|
|||
const { filters } = (settings ?? {}) as AccessSettings; |
|||
|
|||
return { |
|||
alias, |
|||
expiresAt, |
|||
id, |
|||
lastUsedAt, |
|||
type, |
|||
grantee: granteeUserId ?? undefined, |
|||
scopes: getScopesOfAccess(access), |
|||
settings: canApplyFiltersToAccess({ type }) ? { filters } : {} |
|||
}; |
|||
} |
|||
} |
|||
@ -0,0 +1,13 @@ |
|||
import { AccessModule } from '@ghostfolio/api/services/access/access.module'; |
|||
import { ConfigurationModule } from '@ghostfolio/api/services/configuration/configuration.module'; |
|||
|
|||
import { Module } from '@nestjs/common'; |
|||
|
|||
import { AccessController } from './access.controller'; |
|||
import { AccessesController } from './accesses.controller'; |
|||
|
|||
@Module({ |
|||
controllers: [AccessController, AccessesController], |
|||
imports: [AccessModule, ConfigurationModule] |
|||
}) |
|||
export class AccessesModule {} |
|||
@ -1,15 +1,12 @@ |
|||
import { ConfigurationModule } from '@ghostfolio/api/services/configuration/configuration.module'; |
|||
import { PrismaModule } from '@ghostfolio/api/services/prisma/prisma.module'; |
|||
|
|||
import { Module } from '@nestjs/common'; |
|||
|
|||
import { AccessController } from './access.controller'; |
|||
import { AccessService } from './access.service'; |
|||
|
|||
@Module({ |
|||
controllers: [AccessController], |
|||
exports: [AccessService], |
|||
imports: [ConfigurationModule, PrismaModule], |
|||
imports: [PrismaModule], |
|||
providers: [AccessService] |
|||
}) |
|||
export class AccessModule {} |
|||
@ -0,0 +1,3 @@ |
|||
import type { Access } from '../access.interface'; |
|||
|
|||
export interface AccessResponse extends Access {} |
|||
@ -0,0 +1,5 @@ |
|||
import type { AccessResponse } from './access-response.interface'; |
|||
|
|||
export interface AccessesResponse { |
|||
accesses: AccessResponse[]; |
|||
} |
|||
Loading…
Reference in new issue