major refactoring

Author: aguidrevitch

History.md

@@ -1,3 +1,13 @@
+0.0.4 / 2012-12-02
+==================
+
+  * Syntax changed
+  * middleware now provides 'begin','end','abort' events
+  * if file was renamed during upload to avoid conflict,
+    new field 'originalName' keeps original name
+  * dynamic uploadDir and uploadUrl
+  * upload.getFiles() added, see README.md for example
+
 0.0.3 / 2012-11-25
 ==================
 

README.md

@@ -18,9 +18,9 @@ Usage:
     var app = express();
     app.configure(function () {
         ...
-        app.use('/upload', upload({
+        app.use('/upload', upload.fileHandler({
             uploadDir: __dirname + '/public/uploads',
-            uploadUrl: '/uploads/'
+            uploadUrl: '/uploads'
         }));
         app.use(express.bodyParser());
         ...
@@ -34,17 +34,99 @@ On the frontend:
    <script>$('#fileupload').fileupload({ dataType: 'json' })</script>
 ```
 
+More sophisticated example - Events
+
+```javascript
+        app.use('/upload', upload.fileHandler({
+            uploadDir: __dirname + '/public/uploads',
+            uploadUrl: '/uploads'
+        }));
+
+        // events
+        upload.on('begin', function (fileInfo) { ... });
+        upload.on('abort', function (fileInfo) { ... });
+        upload.on('end', function (fileInfo) {
+            // fileInfo structure is the same as returned to browser
+            // { 
+            //     name: '3 (3).jpg',
+            //     originalName: '3.jpg',
+            //     size: 79262,
+            //     type: 'image/jpeg',
+            //     delete_type: 'DELETE',
+            //     delete_url: 'http://yourhost/upload/3%20(3).jpg',
+            //     url: 'http://yourhost/uploads/3%20(3).jpg',
+            //     thumbnail_url: 'http://youhost/uploads/thumbnail/3%20(3).jpg' 
+            // }
+        });
+        upload.on('error', function (e) {
+            console.log(e.message);
+        });
+```
+
+Dynamic upload directory and url, isolating user files:
+
+```javascript
+        app.use('/upload', function (req, res, next) {
+            upload.fileHandler({
+                uploadDir: function () {
+                    return __dirname + '/public/uploads/' + req.sessionID
+                },
+                uploadUrl: function () {
+                    return '/uploads/' + req.sessionID
+                },
+                imageVersions: {
+                    thumbnail: {
+                        width: 80,
+                        height: 80
+                    }
+                }
+            })(req, res, next);
+        });
+```
+
+Getting uploaded files mapped to their fs locations:
+
+```javascript
+        app.use('/list', function (req, res, next) {
+            upload.getFiles({
+                uploadDir: function () {
+                    return __dirname + '/public/uploads/' + req.sessionID
+                },
+                uploadUrl: function () {
+                    return '/uploads/' + req.sessionID
+                },
+                imageVersions: {
+                    thumbnail: {
+                        width: 80,
+                        height: 80
+                    }
+                }
+            }, function (files) {
+                //  {
+                //      "00001.MTS": {
+                //          "path": "/home/.../public/uploads/ekE6k4j9PyrGtcg+SA6a5za3/00001.MTS"
+                //      },
+                //      "DSC00030.JPG": {
+                //          "path": "/home/.../public/uploads/ekE6k4j9PyrGtcg+SA6a5za3/DSC00030.JPG",
+                //          "thumbnail": "/home/.../public/uploads/ekE6k4j9PyrGtcg+SA6a5za3/thumbnail/DSC00030.JPG"
+                //      }
+                //  }
+                res.json(files);
+            });
+        });
+```
+
 Other options and their default values:
+
 ```javascript
 {
     tmpDir: '/tmp',
+    uploadDir: __dirname + '/public/uploads',
+    uploadUrl: '/uploads',
     maxPostSize: 11000000000, // 11 GB
     minFileSize: 1,
     maxFileSize: 10000000000, // 10 GB
     acceptFileTypes: /.+/i,
-    // Files not matched by this regular expression force a download dialog,
-    // to prevent executing any scripts in the context of the service domain:
-    safeFileTypes: /\.(gif|jpe?g|png)$/i,
     imageTypes: /\.(gif|jpe?g|png)$/i,
     imageVersions: {
         thumbnail: {