diff --git a/README.md b/README.md index c6fa1d05b6..3c5a81bea3 100644 --- a/README.md +++ b/README.md @@ -232,6 +232,7 @@ The client keys used with Parse are no longer necessary with Parse Server. If yo #### Advanced options * `fileKey` - For migrated apps, this is necessary to provide access to files already hosted on Parse. +* `preserveFileName` - Set to true to remove the unique hash added to the file names. Defaults to false. * `allowClientClassCreation` - Set to false to disable client class creation. Defaults to true. * `enableAnonymousUsers` - Set to false to disable anonymous users. Defaults to true. * `auth` - Used to configure support for [3rd party authentication](http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication). diff --git a/spec/FilesController.spec.js b/spec/FilesController.spec.js index d4aa85b510..18c685fb98 100644 --- a/spec/FilesController.spec.js +++ b/spec/FilesController.spec.js @@ -14,13 +14,13 @@ const mockAdapter = { } // Small additional tests to improve overall coverage -describe("FilesController",() =>{ +describe("FilesController", () => { it("should properly expand objects", (done) => { const config = Config.get(Parse.applicationId); const gridStoreAdapter = new GridStoreAdapter('mongodb://localhost:27017/parse'); const filesController = new FilesController(gridStoreAdapter) - const result = filesController.expandFilesInObject(config, function(){}); + const result = filesController.expandFilesInObject(config, function () { }); expect(result).toBeUndefined(); @@ -43,7 +43,7 @@ describe("FilesController",() =>{ reconfigureServer({ filesAdapter: mockAdapter }) .then(() => new Promise(resolve => setTimeout(resolve, 1000))) - .then(() => new Parse.File("yolo.txt", [1,2,3], "text/plain").save()) + .then(() => new Parse.File("yolo.txt", [1, 2, 3], "text/plain").save()) .then( () => done.fail('should not succeed'), () => setImmediate(() => Parse.Promise.as('done')) @@ -62,4 +62,40 @@ describe("FilesController",() =>{ done(); }); }); + + it("should add a unique hash to the file name when the preserveFileName option is false", (done) => { + + const config = Config.get(Parse.applicationId) + const gridStoreAdapter = new GridStoreAdapter('mongodb://localhost:27017/parse') + spyOn(gridStoreAdapter, 'createFile') + gridStoreAdapter.createFile.and.returnValue(Promise.resolve()) + const fileName = 'randomFileName.pdf' + const regexEscapedFileName = fileName.replace(/\./g, "\\$&") + const filesController = new FilesController(gridStoreAdapter, null, { preserveFileName: false }) + + filesController.createFile(config, fileName) + + expect(gridStoreAdapter.createFile).toHaveBeenCalledTimes(1) + expect(gridStoreAdapter.createFile.calls.mostRecent().args[0]).toMatch(`^.{32}_${regexEscapedFileName}$`) + + done(); + }); + + it("should not add a unique hash to the file name when the preserveFileName option is false", (done) => { + + const config = Config.get(Parse.applicationId) + const gridStoreAdapter = new GridStoreAdapter('mongodb://localhost:27017/parse') + spyOn(gridStoreAdapter, 'createFile') + gridStoreAdapter.createFile.and.returnValue(Promise.resolve()) + const fileName = 'randomFileName.pdf' + const filesController = new FilesController(gridStoreAdapter, null, { preserveFileName: true }) + + filesController.createFile(config, fileName) + + expect(gridStoreAdapter.createFile).toHaveBeenCalledTimes(1) + expect(gridStoreAdapter.createFile.calls.mostRecent().args[0]).toEqual(fileName) + + done(); + }); + }); diff --git a/src/Controllers/FilesController.js b/src/Controllers/FilesController.js index 2ea83412db..16cd2ac79c 100644 --- a/src/Controllers/FilesController.js +++ b/src/Controllers/FilesController.js @@ -2,7 +2,7 @@ import { randomHexString } from '../cryptoUtils'; import AdaptableController from './AdaptableController'; import { FilesAdapter } from '../Adapters/Files/FilesAdapter'; -import path from 'path'; +import path from 'path'; import mime from 'mime'; const legacyFilesRegex = new RegExp("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}-.*"); @@ -25,9 +25,11 @@ export class FilesController extends AdaptableController { contentType = mime.getType(filename); } - filename = randomHexString(32) + '_' + filename; + if (!this.options.preserveFileName) { + filename = randomHexString(32) + '_' + filename; + } - var location = this.adapter.getFileLocation(config, filename); + const location = this.adapter.getFileLocation(config, filename); return this.adapter.createFile(filename, data, contentType).then(() => { return Promise.resolve({ url: location, diff --git a/src/Controllers/index.js b/src/Controllers/index.js index 6bbcc7f299..a1958cc983 100644 --- a/src/Controllers/index.js +++ b/src/Controllers/index.js @@ -82,6 +82,7 @@ export function getFilesController(options: ParseServerOptions): FilesController databaseURI, filesAdapter, databaseAdapter, + preserveFileName, } = options; if (!filesAdapter && databaseAdapter) { throw 'When using an explicit database adapter, you must also use an explicit filesAdapter.'; @@ -89,7 +90,7 @@ export function getFilesController(options: ParseServerOptions): FilesController const filesControllerAdapter = loadAdapter(filesAdapter, () => { return new GridStoreAdapter(databaseURI); }); - return new FilesController(filesControllerAdapter, appId); + return new FilesController(filesControllerAdapter, appId, { preserveFileName }); } export function getUserController(options: ParseServerOptions): UserController { diff --git a/src/Options/Definitions.js b/src/Options/Definitions.js index 6747fd59cc..dec6284841 100644 --- a/src/Options/Definitions.js +++ b/src/Options/Definitions.js @@ -135,6 +135,12 @@ module.exports.ParseServerOptions = { "env": "PARSE_SERVER_FILE_KEY", "help": "Key for your files" }, + "preserveFileName": { + "env": "PARSE_SERVER_PRESERVE_FILE_NAME", + "help": "Enable (or disable) the addition of a unique hash to the file names", + "action": parsers.booleanParser, + "default": false + }, "userSensitiveFields": { "env": "PARSE_SERVER_USER_SENSITIVE_FIELDS", "help": "Personally identifiable information fields in the user table the should be removed for non-authorized users.", diff --git a/src/Options/index.js b/src/Options/index.js index 247e008a06..07f0c06ba1 100644 --- a/src/Options/index.js +++ b/src/Options/index.js @@ -64,6 +64,9 @@ export interface ParseServerOptions { webhookKey: ?string; /* Key for your files */ fileKey: ?string; + /* Enable (or disable) the addition of a unique hash to the file names + :ENV: PARSE_SERVER_PRESERVE_FILE_NAME */ + preserveFileName: ?boolean; // = false /* Personally identifiable information fields in the user table the should be removed for non-authorized users. */ userSensitiveFields: ?string[]; // = ["email"] /* Enable (or disable) anon users, defaults to true