biggora/express-uploader

Uploading files middleware for NodeJS, Express, TrinteJS, Connect

File uploader

Uploading files middleware for NodeJS, Express, TrinteJS, Connect.

Installation

Installation is done using the Node Package Manager (npm). If you don't have npm installed on your system you can download it from npmjs.org To install express-uploader:

$ npm install -g express-uploader

Usage overview

for TrinteJS

manual setup in project config/routes.js

var Uploader = require('express-uploader');

module.exports = function routes(map) {
    ...
    map.all('/upload', function(req, res, next) {
        var uploader = new Uploader({
            debug: true,
            validate: true,
            thumbnails: true,
            thumbToSubDir: true,
            tmpDir: __dirname + '/tmp',
            publicDir: __dirname + '/public',
            uploadDir: __dirname + '/public/files',
            uploadUrl: '/files/',
            thumbSizes: [140, [100, 100]]
        });
        uploader.uploadFile(req, function(data) {
            res.send(JSON.stringify(data), {'Content-Type': 'text/plain'}, 200);
        });
    });
};

for ExpressJS

var Uploader = require('express-uploader');

app.all('/upload', function(req, res, next) {
    var uploader = new Uploader({
        debug: true,
        validate: true,
        thumbnails: true,
        thumbToSubDir: true,
        tmpDir: __dirname + '/tmp',
        publicDir: __dirname + '/public',
        uploadDir: __dirname + '/public/files',
        uploadUrl: '/files/',
        thumbSizes: [140,[100, 100]]
    });
    uploader.uploadFile(req, function(data) {
        res.send(JSON.stringify(data), {'Content-Type': 'text/plain'}, 200);
    });
});

Options

Name	Type	Default	Description
debug	boolean	false
safeName	boolean	true
validate	boolean	false
quality	number	80
thumbnails	boolean	false
thumbToSubDir	boolean	false
tmpDir	string	/tmp
publicDir	string	/public
uploadDir	string	/public/files
uploadUrl	string	/files/
maxPostSize	integer	11000000
minFileSize	integer	1
maxFileSize	integer	10000000
acceptFileTypes	regexp	/.+/i
thumbSizes	array	[[100, 100]]	[width, neight]
imageTypes	regexp	`/.(gif	jpe?g
resize	boolean	false	if need resize image
newSize	mixed	[800, 600]	new size for image [width, height]
crop	boolean	false	if need crop image
coordinates	object	{width:800,height:600,x:0,y:0}	coordinates for crop image { width:1200, height:800, x:0, y:0 }

In the Wild

The following projects use express-uploader.

If you are using express-uploader in a project, app, or module, get on the list below by getting in touch or submitting a pull request with changes to the README.

Recommend extensions

• Bootstrap Fancy File Plugin
• Bootstrap Ajax Typeahead Plugin
• TrinteJS - Javascrpt MVC Framework for Node.JS
• CaminteJS - Cross-db ORM for NodeJS
• MongoDB Session Storage for ExpressJS
• 2CO NodeJS adapter for 2checkout API payment gateway

Author

Aleksej Gordejev ([email protected]).

License

(The MIT License)

Copyright (c) 2012 Aleksej Gordejev [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.

Resources

• Visit the author website.
• Follow @biggora on Twitter for updates.
• Report issues on the github issues page.

express-uploader's Issues

Missing settings nameCountRegexp and nameCountFunc

Hi,

I noticed there two missing settings :

self.settings.nameCountRegexp
self.settings.nameCountFunc

Thank you,

safeCreateDirectory nees perms 0755

Permissions on fs.mkdirSync are set at 755, needs to be 0755 to avoid creating improper permissions when creating new directories.

safeName issue when set to false

Hi,

Thanks for this great module.

I noticed that when safeName is set to false, there's an issue as the returned name is empty. to fix that, I just surrounded the while statement with an if that checks if actually there are identical file names. If no file is detected we return the original filename. The code is below:

    safeName: function(name) {
        var self = this, nname = '';
        // Prevent directory traversal and creating hidden system files:
        name = path.basename( name ).replace( /^\.+/, '' );

        // Prevent overwriting existing files:
        if(self._existsSync( self.settings.uploadDir + name ) ) // <----- Here is the check
        {
            while( self._existsSync( self.settings.uploadDir + name ) ) {
                nname = name.replace( self.settings.nameCountRegexp, self.settings.nameCountFunc );
            }

            self.logging( '  Make SafeName!' );

        }
        else 
            nname = name;  // <----- Else, we return the name

        return nname;
    }

relative directory is being created

When specifying a fully qualified directory, directories are being created relative to directory process is started in:

        ,tmpDir: path.join(config.baseDir,'/tmp')
        ,publicDir: path.join(config.baseDir,'/public')
        ,uploadDir: path.join(config.baseDir, '/public/files')

this is creating directories wherever the process is started.
If I:

cd /tmp
node ~/project/server.js

this is creating new directories in ./tmp, versus the full path passed.

One solution is to include self.settings.osSep when normalizing path:

express-uploader.js: 306: fullPath = path.normalize( path.join( self.settings.osSep, fullPath, part ) );

Thanks!