Merge pull request #3058 from SeedCompany/file-url-download-or-preview

Author: CarsonF

src/components/file/file-url.controller.ts

@@ -5,6 +5,7 @@ import {
   HttpStatus,
   Inject,
   Param,
+  Query,
   Request,
   Response,
 } from '@nestjs/common';
@@ -29,6 +30,7 @@ export class FileUrlController {
   @Get(':fileId/:fileName?')
   async download(
     @Param('fileId') fileId: ID,
+    @Query('download') download: '' | undefined,
     @Request() request: IRequest,
     @Response() res: unknown,
   ) {
@@ -41,7 +43,7 @@ export class FileUrlController {
 
     // TODO authorization using session
 
-    const url = await this.files.getDownloadUrl(node);
+    const url = await this.files.getDownloadUrl(node, download != null);
     const cacheControl = this.files.determineCacheHeader(node);
 
     const { httpAdapter } = this.httpAdapterHost;

src/components/file/file-url.resolver-util.ts

@@ -0,0 +1,23 @@
+import { Args, ResolveField } from '@nestjs/graphql';
+import { stripIndent } from 'common-tags';
+import { URL } from 'url';
+
+export const Resolver = () =>
+  ResolveField(() => URL, {
+    description: stripIndent`
+      A url to the file.
+
+      This url could require authentication.
+    `,
+  });
+
+export const DownloadArg = () =>
+  Args('download', {
+    description: stripIndent`
+      Whether the browser should download this file if opened directly
+
+      This sets the \`Content-Disposition\` header to \`attachment\` instead of \`inline\`.
+      https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+    `,
+    defaultValue: false,
+  });

src/components/file/file-version.resolver.ts

@@ -2,21 +2,19 @@ import { Parent, ResolveField, Resolver } from '@nestjs/graphql';
 import { stripIndent } from 'common-tags';
 import { URL } from 'url';
 import { FileVersion } from './dto';
+import * as FileUrl from './file-url.resolver-util';
 import { FileService } from './file.service';
 
 @Resolver(FileVersion)
 export class FileVersionResolver {
   constructor(protected readonly service: FileService) {}
 
-  @ResolveField(() => URL, {
-    description: stripIndent`
-      A url to the file version.
-
-      This url could require authentication.
-    `,
-  })
-  async url(@Parent() node: FileVersion) {
-    return await this.service.getUrl(node);
+  @FileUrl.Resolver()
+  async url(
+    @Parent() node: FileVersion,
+    @FileUrl.DownloadArg() download: boolean,
+  ) {
+    return await this.service.getUrl(node, download);
   }
 
   @ResolveField(() => URL, {

src/components/file/file.resolver.ts

@@ -32,6 +32,7 @@ import {
   RequestUploadOutput,
 } from './dto';
 import { FileNodeLoader } from './file-node.loader';
+import * as FileUrl from './file-url.resolver-util';
 import { FileService } from './file.service';
 
 @Resolver(File)
@@ -75,15 +76,9 @@ export class FileResolver {
     return await this.service.listChildren(node, input, session);
   }
 
-  @ResolveField(() => URL, {
-    description: stripIndent`
-      A url to the file.
-
-      This url could require authentication.
-    `,
-  })
-  async url(@Parent() node: File) {
-    return await this.service.getUrl(node);
+  @FileUrl.Resolver()
+  async url(@Parent() node: File, @FileUrl.DownloadArg() download: boolean) {
+    return await this.service.getUrl(node, download);
   }
 
   @ResolveField(() => URL, {

src/components/file/file.service.ts

@@ -145,27 +145,28 @@ export class FileService {
     return data;
   }
 
-  async getUrl(node: FileNode) {
+  async getUrl(node: FileNode, download: boolean) {
     const url = withAddedPath(
       this.config.hostUrl,
       FileUrl.path,
       isFile(node) ? node.latestVersionId : node.id,
       encodeURIComponent(node.name),
     );
-    return url.toString();
+    return url.toString() + (download ? '?download' : '');
   }
 
-  async getDownloadUrl(node: FileNode): Promise<string> {
+  async getDownloadUrl(node: FileNode, download = true): Promise<string> {
     if (isDirectory(node)) {
       throw new InputException('View directories via GraphQL API');
     }
     const id = isFile(node) ? node.latestVersionId : node.id;
+    const disposition = download ? 'attachment' : 'inline';
     try {
       // before sending link, first check if object exists in s3
       await this.bucket.headObject(id);
       return await this.bucket.getSignedUrl(GetObject, {
         Key: id,
-        ResponseContentDisposition: `attachment; filename="${encodeURIComponent(
+        ResponseContentDisposition: `${disposition}; filename="${encodeURIComponent(
           node.name,
         )}"`,
         ResponseContentType: node.mimeType,

src/components/file/media-url.resolver.ts

@@ -1,27 +1,21 @@
-import { Parent, ResolveField, Resolver } from '@nestjs/graphql';
+import { Parent, Resolver } from '@nestjs/graphql';
 import { Loader, LoaderOf } from '@seedcompany/data-loader';
-import { stripIndent } from 'common-tags';
-import { URL } from 'url';
 import { FileNodeLoader } from './file-node.loader';
+import * as FileUrl from './file-url.resolver-util';
 import { FileService } from './file.service';
 import { Media } from './media/media.dto';
 
 @Resolver(() => Media)
 export class MediaUrlResolver {
   constructor(protected readonly service: FileService) {}
 
-  @ResolveField(() => URL, {
-    description: stripIndent`
-      A url to the file version.
-
-      This url could require authentication.
-    `,
-  })
+  @FileUrl.Resolver()
   async url(
     @Parent() media: Media,
+    @FileUrl.DownloadArg() download: boolean,
     @Loader(FileNodeLoader) files: LoaderOf<FileNodeLoader>,
   ) {
     const node = await files.load(media.file);
-    return await this.service.getUrl(node);
+    return await this.service.getUrl(node, download);
   }
 }