outputs field support for new tasks

index.js

@@ -80,6 +80,12 @@ let server;
  *          required: false
  *          type: string
  *        -
+ *          name: outputs
+ *          in: formData
+ *          description: 'An optional serialized JSON string of paths relative to the project directory that should be included in the all.zip result file, overriding the default behavior.'
+ *          required: false
+ *          type: string
+ *        -
  *          name: token
  *          in: query
  *          description: 'Token required for authentication (when authentication is required).'
@@ -226,6 +232,12 @@ app.post('/task/new/commit/:uuid', authCheck, taskNew.getUUID, taskNew.handleCom
  *          required: false
  *          type: string
  *        -
+ *          name: outputs
+ *          in: formData
+ *          description: 'An optional serialized JSON string of paths relative to the project directory that should be included in the all.zip result file, overriding the default behavior.'
+ *          required: false
+ *          type: string
+ *        -
  *          name: token
  *          in: query
  *          description: 'Token required for authentication (when authentication is required).'

libs/Task.js

@@ -32,11 +32,12 @@ const Directories = require('./Directories');
 const kill = require('tree-kill');
 const S3 = require('./S3');
 const request = require('request');
+const utils = require('./utils');
 
 const statusCodes = require('./statusCodes');
 
 module.exports = class Task{
-    constructor(uuid, name, done, options = [], webhook = null, skipPostProcessing = false){
+    constructor(uuid, name, options = [], webhook = null, skipPostProcessing = false, outputs = [], done = () => {}){
         assert(uuid !== undefined, "uuid must be set");
         assert(done !== undefined, "ready must be set");
 
@@ -51,6 +52,7 @@ module.exports = class Task{
         this.runningProcesses = [];
         this.webhook = webhook;
         this.skipPostProcessing = skipPostProcessing;
+        this.outputs = utils.parseUnsafePathsList(outputs);
 
         async.series([
             // Read images info
@@ -86,22 +88,28 @@ module.exports = class Task{
     }
 
     static CreateFromSerialized(taskJson, done){
-        new Task(taskJson.uuid, taskJson.name, (err, task) => {
-            if (err) done(err);
-            else{
-                // Override default values with those
-                // provided in the taskJson
-                for (let k in taskJson){
-                    task[k] = taskJson[k];
+        new Task(taskJson.uuid, 
+            taskJson.name, 
+            taskJson.options, 
+            taskJson.webhook, 
+            taskJson.skipPostProcessing,
+            taskJson.outputs,
+            (err, task) => {
+                if (err) done(err);
+                else{
+                    // Override default values with those
+                    // provided in the taskJson
+                    for (let k in taskJson){
+                        task[k] = taskJson[k];
+                    }
+    
+                    // Tasks that were running should be put back to QUEUED state
+                    if (task.status.code === statusCodes.RUNNING){
+                        task.status.code = statusCodes.QUEUED;
+                    }
+                    done(null, task);
                 }
-
-                // Tasks that were running should be put back to QUEUED state
-                if (task.status.code === statusCodes.RUNNING){
-                    task.status.code = statusCodes.QUEUED;
-                }
-                done(null, task);
-            }
-        }, taskJson.options, taskJson.webhook, taskJson.skipPostProcessing);
+            });
     }
 
     // Get path where images are stored for this task
@@ -317,6 +325,12 @@ module.exports = class Task{
                               'odm_georeferencing', 'odm_texturing',
                               'odm_dem/dsm.tif', 'odm_dem/dtm.tif', 'dsm_tiles', 'dtm_tiles',
                               'orthophoto_tiles', 'potree_pointcloud', 'images.json'];
+            
+            // Did the user request different outputs than the default?
+            if (this.outputs.length > 0) allPaths = this.outputs;
+
+            console.log(allPaths);
+
             let tasks = [];
             
             if (config.test){
@@ -528,7 +542,8 @@ module.exports = class Task{
             status: this.status,
             options: this.options,
             webhook: this.webhook,
-            skipPostProcessing: !!this.skipPostProcessing
+            skipPostProcessing: !!this.skipPostProcessing,
+            outputs: this.outputs || []
         };
     }
 };

libs/odmInfo.js

@@ -57,7 +57,7 @@ module.exports = {
                     // (num cores can be set programmatically, so can gcpFile, etc.)
                     if (["-h", "--project-path", "--cmvs-maxImages", "--time",
                         "--zip-results", "--pmvs-num-cores",
-                        "--start-with", "--gcp", "--end-with", "--images",
+                        "--start-with", "--gcp", "--images",
                         "--rerun-all", "--rerun",
                         "--slam-config", "--video", "--version", "name"].indexOf(option) !== -1) continue;
 

libs/taskNew.js

@@ -318,16 +318,18 @@ module.exports = {
 
                 // Create task
                 cb => {
-                    new Task(req.id, req.body.name, (err, task) => {
+                    new Task(req.id, req.body.name, req.body.options,
+                    req.body.webhook,
+                    req.body.skipPostProcessing === 'true',
+                    req.body.outputs,
+                    (err, task) => {
                         if (err) cb(err);
                         else {
                             TaskManager.singleton().addNew(task);
                             res.json({ uuid: req.id });
                             cb();
                         }
-                    }, req.body.options,
-                    req.body.webhook,
-                    req.body.skipPostProcessing === 'true');
+                    });
                 }
             ], err => {
                 if (err) die(err.message);

libs/utils.js

@@ -1,4 +1,7 @@
 "use strict";
+
+const path = require('path');
+
 module.exports = {
     get: function(scope, prop, defaultValue){
         let parts = prop.split(".");
@@ -18,5 +21,28 @@ module.exports = {
     sanitize: function(filePath){
         filePath = filePath.replace(/[^\w.-]/g, "_");
         return filePath;
+    },
+
+    parseUnsafePathsList: function(paths){
+        // Parse a list (or a JSON encoded string representing a list)
+        // of paths and remove all traversals (., ..) and guarantee
+        // that the paths are relative
+
+        if (typeof paths === "string"){
+            try{
+                paths = JSON.parse(paths);
+            }catch(e){
+                return [];
+            }
+        }
+        
+        if (!Array.isArray(paths)){
+            return [];
+        }
+        
+        return paths.map(p => {
+            const safeSuffix = path.normalize(p).replace(/^(\.\.(\/|\\|$))+/, '');
+            return path.join('./', safeSuffix);
+        });
     }
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-opendronemap",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "REST API to access ODM",
   "main": "index.js",
   "scripts": {

public/js/main.js

@@ -69,6 +69,7 @@ $(function() {
         formData.append("webhook", $("#webhook").val());
         formData.append("skipPostProcessing", !$("#doPostProcessing").prop('checked'));
         formData.append("options", JSON.stringify(optionsModel.getUserOptions()));
+        // formData.append("outputs", JSON.stringify(['odm_orthophoto/odm_orthophoto.tif']));
 
         if (this.mode() === 'file'){
             if (this.filesCount() > 0){