Merge pull request #30 from js3692/custom-filenames

Custom file names

Author: bhstahl

lib/handlers/HeadHandler.js

@@ -11,7 +11,7 @@ class HeadHandler extends BaseHandler {
      * @return {function}
      */
     send(req, res) {
-        const re = new RegExp('\\' + this.store.path + '\\/(\\w+)\/?'); // eslint-disable-line prefer-template
+        const re = new RegExp('\\' + this.store.path + '\\/(\\S+)\/?'); // eslint-disable-line prefer-template
         const match = req.url.match(re);
         if (!match) {
             return super.send(res, 404);

lib/handlers/PatchHandler.js

@@ -11,7 +11,7 @@ class PatchHandler extends BaseHandler {
      * @return {function}
      */
     send(req, res) {
-        const re = new RegExp('\\' + this.store.path + '\\/(\\w+)\/?'); // eslint-disable-line prefer-template
+        const re = new RegExp('\\' + this.store.path + '\\/(\\S+)\/?'); // eslint-disable-line prefer-template
         const match = req.url.match(re);
         if (!match) {
             return super.send(res, 404);

lib/handlers/PostHandler.js

@@ -1,6 +1,5 @@
 'use strict';
 
-const File = require('../models/File');
 const BaseHandler = require('./BaseHandler');
 
 class PostHandler extends BaseHandler {
@@ -12,24 +11,17 @@ class PostHandler extends BaseHandler {
      * @return {function}
      */
     send(req, res) {
-
-        const upload_length = req.headers['upload-length'];
-        const upload_defer_length = req.headers['upload-defer-length'];
-        const upload_metadata = req.headers['upload-metadata'];
-
-        // The request MUST include a Upload-Length or Upload-Defer-Length header
-        if (upload_length === undefined && upload_defer_length === undefined) {
-            return super.send(res, 412, {}, 'Upload-Length or Upload-Defer-Length Required\n');
-        }
-
-        const file = new File(upload_length, upload_defer_length, upload_metadata);
-        return this.store.create(file)
-            .then((location) => {
-                const url = `http://${req.headers.host}${this.store.path}/${file.id}`;
+        return this.store.create(req)
+            .then((File) => {
+                const url = `http://${req.headers.host}${this.store.path}/${File.id}`;
                 return super.send(res, 201, { Location: url });
             })
             .catch((error) => {
                 if (Number.isInteger(error)) {
+                    if (error === 412) {
+                        return super.send(res, error, {}, 'Upload-Length or Upload-Defer-Length Required\n');
+                    }
+
                     return super.send(res, error);
                 }
 

lib/models/File.js

@@ -1,5 +1,4 @@
 'use strict';
-const Uid = require('./Uid');
 
 /**
  * @fileOverview
@@ -9,15 +8,19 @@ const Uid = require('./Uid');
  */
 
 class File {
-    constructor(upload_length, upload_defer_length, upload_metadata) {
+    constructor(file_id, upload_length, upload_defer_length, upload_metadata) {
+        if (!file_id) {
+            throw new Error('[File] constructor must be given a file_id');
+        }
+
         if (upload_length === undefined && upload_defer_length === undefined) {
             throw new Error('[File] constructor must be given either a upload_length or upload_defer_length');
         }
 
+        this.id = `${file_id}`;
         this.upload_length = upload_length;
         this.upload_defer_length = upload_defer_length;
         this.upload_metadata = upload_metadata;
-        this.id = Uid.rand();
     }
 }
 

lib/stores/DataStore.js

@@ -7,14 +7,19 @@
  * @author Ben Stahl <[email protected]>
  */
 
+const Uid = require('../models/Uid');
 const File = require('../models/File');
 
 class DataStore {
     constructor(options) {
         if (!options || !options.path) {
             throw new Error('Store must have a path');
         }
+        if (options.namingFunction && typeof options.namingFunction !== 'function') {
+            throw new Error('namingFunction must be a function');
+        }
         this.path = options.path;
+        this.generateFileName = options.namingFunction || Uid.rand;
     }
 
     get extensions() {
@@ -37,13 +42,26 @@ class DataStore {
      *
      * http://tus.io/protocols/resumable-upload.html#creation
      *
-     * @param  {object} file File model.
+     * @param  {object} req http.incomingMessage
+     * @return {Promise}
      */
-    create(file) {
-        if (!(file instanceof File)) {
-            throw new Error(`${file} is not a File`);
-        }
-        console.log(`[DataStore] create: ${file.id}`);
+    create(req) {
+        console.log('[DataStore] create');
+
+        return new Promise((resolve, reject) => {
+            const upload_length = req.headers['upload-length'];
+            const upload_defer_length = req.headers['upload-defer-length'];
+            const upload_metadata = req.headers['upload-metadata'];
+
+            if (upload_length === undefined && upload_defer_length === undefined) {
+                return reject(412);
+            }
+
+            const file_id = this.generateFileName(req);
+            const file = new File(file_id, upload_length, upload_defer_length, upload_metadata);
+
+            return resolve(file);
+        });
     }
 
     /**

lib/stores/FileStore.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const DataStore = require('./DataStore');
+const File = require('../models/File');
 const fs = require('fs');
 const Configstore = require('configstore');
 const pkg = require('../../package.json');
@@ -41,13 +42,32 @@ class FileStore extends DataStore {
     /**
      * Create an empty file.
      *
+     * @param  {object} req http.incomingMessage
      * @param  {File} file
      * @return {Promise}
      */
-    create(file) {
-        super.create(file);
+    create(req) {
         return new Promise((resolve, reject) => {
-            fs.open(`${this.directory}/${file.id}`, 'w', (err, fd) => {
+            const upload_length = req.headers['upload-length'];
+            const upload_defer_length = req.headers['upload-defer-length'];
+            const upload_metadata = req.headers['upload-metadata'];
+
+            if (upload_length === undefined && upload_defer_length === undefined) {
+                return reject(412);
+            }
+
+            let file_id;
+            try {
+                file_id = this.generateFileName(req);
+            }
+            catch (generateError) {
+                console.warn('[FileStore] create: check your namingFunction. Error', generateError);
+                return reject(500);
+            }
+
+            const file = new File(file_id, upload_length, upload_defer_length, upload_metadata);
+
+            return fs.open(`${this.directory}/${file.id}`, 'w', (err, fd) => {
                 if (err) {
                     console.warn('[FileStore] create: Error', err);
                     return reject(err);
@@ -61,7 +81,7 @@ class FileStore extends DataStore {
                         return reject(exception);
                     }
 
-                    return resolve();
+                    return resolve(file);
                 });
             });
         });

test/Test-DataStore.js

@@ -1,3 +1,6 @@
+/* eslint-env node, mocha */
+/* eslint no-unused-vars: ["error", { "vars": "none" }] */
+
 'use strict';
 const assert = require('assert');
 const should = require('should');
@@ -12,6 +15,11 @@ describe('DataStore', () => {
         done();
     });
 
+    it('constructor must require the namingFunction to be a function, if it is provided', (done) => {
+        assert.throws(() => { new DataStore({ path: '/files', namingFunction: {} }) }, Error);
+        done();
+    });
+
     it('should provide extensions', (done) => {
         datastore.should.have.property('extensions');
         assert.equal(datastore.extensions, null);
@@ -30,14 +38,7 @@ describe('DataStore', () => {
 
     it('must have a create method', (done) => {
         datastore.should.have.property('create');
-        datastore.create(new File(1));
-        done();
-    });
-
-    it('create() must require a File', (done) => {
-        assert.throws(() => {
-            datastore.create();
-        }, Error);
+        datastore.create();
         done();
     });
 
@@ -46,6 +47,7 @@ describe('DataStore', () => {
         datastore.write();
         done();
     });
+
     it('must have a getOffset method', (done) => {
         datastore.should.have.property('getOffset');
         datastore.getOffset();

test/Test-File.js

@@ -1,34 +1,33 @@
 /* eslint-env node, mocha */
+
 'use strict';
 
 const assert = require('assert');
 const should = require('should');
 const File = require('../lib/models/File');
+const Uid = require('../lib/models/Uid');
 
 describe('File', () => {
 
     describe('constructor', () => {
-        it('must be given either a upload_length or upload_defer_length', (done) => {
+        it('must require a file_name', () => {
             assert.throws(() => { new File(); }, Error);
-            done();
         });
 
-        it('should generate an the ID for the file', (done) => {
-            const file = new File(1);
-            file.should.have.property('id');
-            assert.equal(typeof file.id, 'string');
-            done();
+        it('must be given either a upload_length or upload_defer_length', () => {
+            assert.throws(() => { new File(Uid.rand()); }, Error);
         });
 
-        it('should set properties given', (done) => {
+        it('should set properties given', () => {
+            const file_id = Uid.rand();
             const upload_length = 1234;
             const upload_defer_length = 1;
             const upload_metadata = 'metadata';
-            const file = new File(upload_length, upload_defer_length, upload_metadata);
+            const file = new File(file_id, upload_length, upload_defer_length, upload_metadata);
+            assert.equal(file.id, file_id);
             assert.equal(file.upload_length, upload_length);
             assert.equal(file.upload_defer_length, upload_defer_length);
             assert.equal(file.upload_metadata, upload_metadata);
-            done();
         });
     });
 });