Blueimp file upload for Express js


A simple express module for integrating the jQuery File Upload frontend plugin.

Fullstack Demo | Tutorial on my blog

History

The code was forked from a sample backend code from the plugin's repo. Adaptations were made to show how to use this plugin with the popular Express Node.js framework.

Although this code was initially meant for educational purposes, enhancements were made. Users can additionally:

• choose the destination filesystem, local or cloud-based Amazon S3,
• create thumbnail without heavy external dependencies using lwip,
• setup server-side rules by configuration,
• modify the code against a test harness.

Installation

Setup an Express project and install the package.

1$ npm install blueimp-file-upload-expressjs

Beginners can follow the tutorial for detailed instructions.

Tests

Unit tests can be run with Jasmine using npm test or this command:

1$ jasmine-node specs/

Manual end to end tests can be done with this full project. Change the require() path of uploadManager.js to link it this cloned repository.

Configuration

1options = {
2    tmpDir: __dirname + '/tmp', // tmp dir to upload files to
3    uploadDir: __dirname + '/public/files', // actual location of the file
4    uploadUrl: '/files/', // end point for delete route 
5    maxPostSize: 11000000000, // 11 GB
6    minFileSize: 1,
7    maxFileSize: 10000000000, // 10 GB
8    acceptFileTypes: /.+/i,
9    inlineFileTypes: /\.(gif|jpe?g|png)/i,
10    imageTypes:  /\.(gif|jpe?g|png)/i,
11    copyImgAsThumb : true, // required
12    imageVersions :{
13        maxWidth : 200,
14        maxHeight : 200
15    },
16    accessControl: {
17        allowOrigin: '*',
18        allowMethods: 'OPTIONS, HEAD, GET, POST, PUT, DELETE',
19        allowHeaders: 'Content-Type, Content-Range, Content-Disposition'
20    },
21    storage : {
22        type : 'local', // local or aws
23        aws : {
24            accessKeyId :  'xxxxxxxxxxxxxxxxx', // required if aws
25            secretAccessKey : 'xxxxxxxxxxxxxxxxxxxxxxx', // required if aws
26            region : 'us-west-2', //make sure you know the region, else leave this option out
27            bucketName : 'xxxxxxxxx' // required if aws
28        }
29    }
30};
31

Usage with options

(refer tutorial)

1// config the uploader
2var options = {
3    tmpDir:  __dirname + '/../public/uploaded/tmp',
4    uploadDir: __dirname + '/../public/uploaded/files',
5    uploadUrl:  '/uploaded/files/',
6    maxPostSize: 11000000000, // 11 GB
7    minFileSize:  1,
8    maxFileSize:  10000000000, // 10 GB
9    acceptFileTypes:  /.+/i,
10    // Files not matched by this regular expression force a download dialog,
11    // to prevent executing any scripts in the context of the service domain:
12    inlineFileTypes:  /\.(gif|jpe?g|png)/i,
13    imageTypes:  /\.(gif|jpe?g|png)/i,
14    copyImgAsThumb : true, // required
15    imageVersions :{
16        maxWidth : 200,
17        maxHeight : 200
18    },
19    accessControl: {
20        allowOrigin: '*',
21        allowMethods: 'OPTIONS, HEAD, GET, POST, PUT, DELETE',
22        allowHeaders: 'Content-Type, Content-Range, Content-Disposition'
23    },
24    storage : {
25        type : 'aws',
26        aws : {
27            accessKeyId :  'xxxxxxxxxxxxxxxxx',
28            secretAccessKey : 'xxxxxxxxxxxxxxxxx',
29            region : 'us-east-1',//make sure you know the region, else leave this option out
30            bucketName : 'xxxxxxxxxxxxxxxxx'
31        }
32    }
33};
34
35// init the uploader
36var uploader = require('blueimp-file-upload-expressjs')(options);
37
38
39module.exports = function (router) {
40    router.get('/upload', function(req, res) {
41      uploader.get(req, res, function (err,obj) {
42            if(!err){
43                res.send(JSON.stringify(obj));
44            }
45      });
46      
47    });
48
49    router.post('/upload', function(req, res) {
50      uploader.post(req, res, function (error,obj, redirect) {
51          if(!error)
52          {
53            res.send(JSON.stringify(obj)); 
54          }
55      });
56      
57    });
58    
59    // the path SHOULD match options.uploadUrl
60    router.delete('/uploaded/files/:name', function(req, res) {
61      uploader.delete(req, res, function (err,obj) {
62            res.Json({error:err}); 
63      });
64      
65    });
66    return router;
67}

SSL Support

Set the useSSL option to true to use the package with an HTTPS server.

1var express = require('express')
2var fs = require('fs')
3var https = require('https');
4
5var app = express()
6
7// config the uploader
8var options = {
9    ...
10    useSSL: true
11    ...
12};
13
14// init the uploader
15var uploader = require('blueimp-file-upload-expressjs')(options);
16
17app.get('/upload', function(req, res) {
18    uploader.get(req, res, function (err,obj) {
19    if(!err)
20        res.send(JSON.stringify(obj)); 
21})
22    .post('/upload', // ...
23    .delete('/uploaded/files/:name', // ...
24
25// create the HTTPS server
26var app_key = fs.readFileSync('key.pem');
27var app_cert = fs.readFileSync('cert.pem');
28
29https.createServer({key: app_key, cert: app_cert}, app).listen(443);
30

Multiple thumbnails

To generate multiple thumbnails while uploading

1var options = {
2  tmpDir: __dirname + '/../public/uploaded/tmp',
3  uploadDir: __dirname + '/../public/uploaded/files',
4  uploadUrl: '/uploaded/files/',
5  copyImgAsThumb: true, // required
6  imageVersions: {
7    maxWidth: 200,
8    maxHeight: 200
9  },
10  storage: {
11    type: 'local'
12  }
13};

copyImgAsThumb needs to be set to true. imageVersions, maxWidth and maxHeight will by default create a thumbnail folder and place the specified width/height thumbnail in it.

Optionally, you can omit the maxHeight. In this case, it will be resize proportionally to the specified width.

1imageVersions: {
2    maxWidth: 200
3  },

also

1imageVersions: {
2    maxWidth: 200,
3    maxHeight : 'auto'
4  },

PS : auto value works only with height.

You can also specify multiple thumbnail generations like

1var options = {
2  tmpDir: __dirname + '/../public/uploaded/tmp',
3  uploadDir: __dirname + '/../public/uploaded/files',
4  uploadUrl: '/uploaded/files/',
5  copyImgAsThumb: true,
6  imageVersions: {
7    maxWidth: 200,
8    maxHeight: 'auto',
9    "large" : {
10        width : 600,
11        height : 600
12    },
13    "medium" : {
14        width : 300,
15        height : 300
16    },
17    "small" : {
18        width : 150,
19        height : 150
20    }
21  },
22  storage: {
23    type: 'local'
24  }
25};

Contributions

Changes and improvements are welcome! Feel free to fork and open a pull request.

To Do

• Make Configuration documentation clearer and shorter,
• Refactor code to build tests and provide generic transports as in winston,
• Write end to end tests with WebdriverIO,
• Provide a basic image processing pipeline (resizing, croping, filter effects),
• Provide access to other cloud-based services like Microsoft Azure.

Done

• Fix Thumbnail creation when uploading images with a more 'feasible' approach,
• Amazon S3 integration,
• SSL Support.

---

License

blueimp-file-upload-expressjs is licensed under the MIT licence.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.