File size: 17,307 Bytes
b0984a9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e6677f0
b0984a9
 
e6677f0
b0984a9
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
e6677f0
b0984a9
 
 
 
 
 
 
 
 
 
 
 
 
 
0d75d39
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
e6677f0
b0984a9
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
0d75d39
b0984a9
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
0d75d39
b0984a9
 
 
 
 
e6677f0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b0984a9
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
import {
  Controller,
  Get,
  Post,
  Put,
  Delete,
  Param,
  Body,
  Query,
  UseGuards,
  UseInterceptors,
  UploadedFile,
  HttpCode,
  HttpStatus,
  ParseIntPipe,
  Res,
  StreamableFile,
} from '@nestjs/common';
import {
  ApiTags,
  ApiOperation,
  ApiResponse,
  ApiBearerAuth,
  ApiParam,
  ApiQuery,
  ApiBody,
  ApiConsumes,
} from '@nestjs/swagger';
import { FileInterceptor } from '@nestjs/platform-express';
import type { Response } from 'express';
import { FilesService } from './files.service';
import { FilePermissionService } from './file-permission.service';
import { PermissionType } from './entities/file-permission.entity';
import { UploadFileDto } from './dto/upload-file.dto';
import { FileResponseDto } from './dto/file-response.dto';
import { FileVersionResponseDto } from './dto/file-version-response.dto';
import { FilePermissionDto } from './dto/file-permission.dto';
import { GrantPermissionDto } from './dto/grant-permission.dto';
import { FileSearchDto } from './dto/file-search.dto';
import { JwtAuthGuard } from '../auth/guards/jwt-auth.guard';
import { CurrentUser } from '../../common/decorators/current-user.decorator';
import { User } from '../auth/entities/user.entity';
import { createReadStream } from 'fs';

@ApiTags('πŸ“ Files')
@Controller('api/files')
@UseGuards(JwtAuthGuard)
@ApiBearerAuth('JWT-auth')
export class FilesController {
  constructor(
    private readonly filesService: FilesService,
    private readonly filePermissionService: FilePermissionService,
  ) {}

  @Post('upload')
  @UseInterceptors(FileInterceptor('file'))
  @HttpCode(HttpStatus.CREATED)
  @ApiOperation({
    summary: 'Upload a file',
    description: `
## Upload File

Uploads a file to the system.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: Any authenticated user

### Supported File Types
Most common file types are supported including documents, images, videos, and archives.

### Notes
- Maximum file size: 50MB (configurable)
- Files are associated with the uploading user
- Optional folder and course association
    `,
  })
  @ApiConsumes('multipart/form-data')
  @ApiBody({
    schema: {
      type: 'object',
      properties: {
        file: { type: 'string', format: 'binary', description: 'File to upload' },
        folderId: { type: 'number', description: 'Optional folder ID' },
        courseId: { type: 'number', description: 'Optional course ID' },
      },
      required: ['file'],
    },
  })
  @ApiResponse({ status: 201, description: 'File uploaded successfully' })
  @ApiResponse({ status: 400, description: 'No file provided or invalid file type' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 413, description: 'File too large' })
  async uploadFile(
    @UploadedFile() file: Express.Multer.File,
    @Body() uploadDto: UploadFileDto,
    @CurrentUser() user: User,
  ): Promise<FileResponseDto> {
    if (!file) {
      throw new Error('No file uploaded');
    }

    return this.filesService.uploadFile(
      file,
      user.userId,
      uploadDto.folderId,
    );
  }

  @Get('search')
  @ApiOperation({
    summary: 'Search files',
    description: `
## Search Files

Searches for files by name, type, or other criteria.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: Any authenticated user

### Search Scope
Only returns files the user has permission to access.
    `,
  })
  @ApiResponse({ status: 200, description: 'Search results' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  async searchFiles(
    @Query() searchDto: FileSearchDto,
    @CurrentUser() user: User,
  ): Promise<FileResponseDto[]> {
    return this.filesService.searchFiles(searchDto, user.userId);
  }

  @Get('recent')
  @ApiOperation({
    summary: 'Get recent files',
    description: `
## Get Recently Accessed Files

Returns files recently uploaded or accessed by the user.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: Any authenticated user
    `,
  })
  @ApiQuery({ name: 'limit', required: false, type: Number, example: 10 })
  @ApiResponse({ status: 200, description: 'Recent files' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  async getRecentFiles(
    @CurrentUser() user: User,
    @Query('limit') limit?: number,
  ): Promise<FileResponseDto[]> {
    return this.filesService.getRecentFiles(user.userId, limit);
  }

  @Get('shared')
  @ApiOperation({
    summary: 'Get shared files',
    description: `
## Get Files Shared with User

Returns files that others have shared with the current user.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: Any authenticated user
    `,
  })
  @ApiResponse({ status: 200, description: 'Shared files' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  async getSharedFiles(
    @CurrentUser() user: User,
  ): Promise<FileResponseDto[]> {
    return this.filesService.getSharedFiles(user.userId);
  }

  @Get(':fileId')
  @ApiOperation({
    summary: 'Get file metadata',
    description: `
## Get File Information

Retrieves metadata about a specific file.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with READ permission on the file

### Response Includes
- File name, type, size
- Upload date and uploader
- Folder location
- Version information
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiResponse({ status: 200, description: 'File metadata' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - No read permission' })
  @ApiResponse({ status: 404, description: 'File not found' })
  async getFile(
    @Param('fileId', ParseIntPipe) fileId: number,
    @CurrentUser() user: User,
  ): Promise<FileResponseDto> {
    return this.filesService.getFile(fileId, user.userId);
  }

  @Get(':fileId/download')
  @ApiOperation({
    summary: 'Download file',
    description: `
## Download File

Downloads the file content.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with READ permission on the file

### Response
Returns the file as a binary stream with appropriate content headers.
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiResponse({ status: 200, description: 'File content' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - No read permission' })
  @ApiResponse({ status: 404, description: 'File not found' })
  async downloadFile(
    @Param('fileId', ParseIntPipe) fileId: number,
    @CurrentUser() user: User,
    @Res({ passthrough: true }) res: Response,
  ): Promise<StreamableFile> {
    const { file, filePath } = await this.filesService.downloadFile(
      fileId,
      user.userId,
    );

    res.set({
      'Content-Type': file.mimeType,
      'Content-Disposition': `attachment; filename="${file.originalFileName}"`,
      'Content-Length': file.fileSize.toString(),
    });

    const fileStream = createReadStream(filePath);

    return new StreamableFile(fileStream);
  }

  @Put(':fileId')
  @ApiOperation({
    summary: 'Update file',
    description: `
## Update File Metadata

Updates file name or folder location.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with WRITE permission on the file
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiBody({
    schema: {
      type: 'object',
      properties: {
        fileName: { type: 'string', description: 'New file name' },
        folderId: { type: 'number', description: 'New folder ID' },
      },
    },
  })
  @ApiResponse({ status: 200, description: 'File updated' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - No write permission' })
  @ApiResponse({ status: 404, description: 'File not found' })
  async updateFile(
    @Param('fileId', ParseIntPipe) fileId: number,
    @Body() updates: { fileName?: string; folderId?: number },
    @CurrentUser() user: User,
  ): Promise<FileResponseDto> {
    return this.filesService.updateFile(fileId, user.userId, updates);
  }

  @Delete(':fileId')
  @HttpCode(HttpStatus.NO_CONTENT)
  @ApiOperation({
    summary: 'Delete file',
    description: `
## Delete File

Permanently deletes a file.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with DELETE permission (usually owner)

### ⚠️ Warning
This action is irreversible. All versions will be deleted.
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiResponse({ status: 204, description: 'File deleted' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - No delete permission' })
  @ApiResponse({ status: 404, description: 'File not found' })
  async deleteFile(
    @Param('fileId', ParseIntPipe) fileId: number,
    @CurrentUser() user: User,
  ): Promise<void> {
    return this.filesService.deleteFile(fileId, user.userId);
  }

  @Post(':fileId/versions')
  @UseInterceptors(FileInterceptor('file'))
  @HttpCode(HttpStatus.CREATED)
  @ApiOperation({
    summary: 'Upload new file version',
    description: `
## Upload New Version

Uploads a new version of an existing file.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with WRITE permission on the file

### Version Management
- Previous versions are preserved
- Version numbers auto-increment
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiConsumes('multipart/form-data')
  @ApiBody({
    schema: {
      type: 'object',
      properties: {
        file: { type: 'string', format: 'binary' },
      },
      required: ['file'],
    },
  })
  @ApiResponse({ status: 201, description: 'Version created' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - No write permission' })
  @ApiResponse({ status: 404, description: 'File not found' })
  async createVersion(
    @Param('fileId', ParseIntPipe) fileId: number,
    @UploadedFile() file: Express.Multer.File,
    @CurrentUser() user: User,
  ): Promise<FileVersionResponseDto> {
    if (!file) {
      throw new Error('No file uploaded');
    }

    return this.filesService.createVersion(fileId, file, user.userId);
  }

  @Get(':fileId/versions')
  @ApiOperation({
    summary: 'List file versions',
    description: `
## List File Versions

Retrieves all versions of a file.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with READ permission on the file
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiResponse({ status: 200, description: 'List of versions' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - No read permission' })
  @ApiResponse({ status: 404, description: 'File not found' })
  async getFileVersions(
    @Param('fileId', ParseIntPipe) fileId: number,
    @CurrentUser() user: User,
  ): Promise<FileVersionResponseDto[]> {
    return this.filesService.getFileVersions(fileId, user.userId);
  }

  @Get(':fileId/versions/:versionId/download')
  @ApiOperation({
    summary: 'Download specific version',
    description: `
## Download File Version

Downloads a specific version of a file.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with READ permission on the file
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiParam({ name: 'versionId', description: 'Version ID', type: Number })
  @ApiResponse({ status: 200, description: 'Version content' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - No read permission' })
  @ApiResponse({ status: 404, description: 'File or version not found' })
  async downloadVersion(
    @Param('fileId', ParseIntPipe) fileId: number,
    @Param('versionId', ParseIntPipe) versionId: number,
    @CurrentUser() user: User,
    @Res({ passthrough: true }) res: Response,
  ): Promise<StreamableFile> {
    const { version, filePath } = await this.filesService.downloadVersion(
      fileId,
      versionId,
      user.userId,
    );

    res.set({
      'Content-Type': 'application/octet-stream',
      'Content-Disposition': `attachment; filename="version-${version.versionNumber}"`,
      'Content-Length': version.fileSize.toString(),
    });

    const fileStream = createReadStream(filePath);

    return new StreamableFile(fileStream);
  }

  @Get(':fileId/permissions')
  @ApiOperation({
    summary: 'Get file permissions',
    description: `
## Get File Permissions

Retrieves all permissions set on a file.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with READ permission on the file
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiResponse({ status: 200, description: 'List of permissions' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden' })
  @ApiResponse({ status: 404, description: 'File not found' })
  async getFilePermissions(
    @Param('fileId', ParseIntPipe) fileId: number,
    @CurrentUser() user: User,
  ): Promise<FilePermissionDto[]> {
    // Check if user has permission to view permissions
    await this.filePermissionService.requirePermission(
      fileId,
      user.userId,
      PermissionType.READ,
    );

    const permissions = await this.filePermissionService.getFilePermissions(
      fileId,
    );

    return permissions.map((p) => ({
      permissionId: p.permissionId,
      fileId: p.fileId,
      userId: p.userId,
      userName: p.user
        ? `${p.user.firstName} ${p.user.lastName}`
        : undefined,
      roleId: p.roleId,
      roleName: p.role?.roleName,
      permissionType: p.permissionType,
      grantedBy: p.grantedBy,
      granterName: p.granter
        ? `${p.granter.firstName} ${p.granter.lastName}`
        : undefined,
      createdAt: p.grantedAt,
    }));
  }

  @Post(':fileId/permissions')
  @HttpCode(HttpStatus.CREATED)
  @ApiOperation({
    summary: 'Grant file permission',
    description: `
## Grant Permission on File

Grants read, write, or delete permission to a user or role.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with WRITE permission (file owner or admin)

### Permission Types
- READ: View and download file
- WRITE: Edit and create versions
- DELETE: Remove file
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiBody({ type: GrantPermissionDto })
  @ApiResponse({ status: 201, description: 'Permission granted' })
  @ApiResponse({ status: 400, description: 'Invalid permission data' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden - Cannot grant permissions' })
  @ApiResponse({ status: 404, description: 'File not found' })
  async grantPermission(
    @Param('fileId', ParseIntPipe) fileId: number,
    @Body() grantDto: GrantPermissionDto,
    @CurrentUser() user: User,
  ): Promise<FilePermissionDto> {
    const permission = await this.filePermissionService.grantPermission(
      fileId,
      user.userId,
      grantDto.permissionType,
      user.userId,
      grantDto.userId,
      grantDto.roleId,
    );

    return {
      permissionId: permission.permissionId,
      fileId: permission.fileId,
      userId: permission.userId,
      roleId: permission.roleId,
      permissionType: permission.permissionType,
      grantedBy: permission.grantedBy,
      createdAt: permission.grantedAt,
    };
  }

  @Delete(':fileId/permissions/:permissionId')
  @HttpCode(HttpStatus.NO_CONTENT)
  @ApiOperation({
    summary: 'Revoke file permission',
    description: `
## Revoke Permission on File

Removes a permission from a file.

### Access Control
- **Authentication Required**: βœ… Yes (Bearer Token)
- **Roles Required**: User with WRITE permission (file owner or admin)
    `,
  })
  @ApiParam({ name: 'fileId', description: 'File ID', type: Number })
  @ApiParam({ name: 'permissionId', description: 'Permission ID', type: Number })
  @ApiResponse({ status: 204, description: 'Permission revoked' })
  @ApiResponse({ status: 401, description: 'Unauthorized' })
  @ApiResponse({ status: 403, description: 'Forbidden' })
  @ApiResponse({ status: 404, description: 'Permission not found' })
  async revokePermission(
    @Param('fileId', ParseIntPipe) fileId: number,
    @Param('permissionId', ParseIntPipe) permissionId: number,
    @CurrentUser() user: User,
  ): Promise<void> {
    return this.filePermissionService.revokePermission(permissionId, user.userId);
  }
}