Add afterScan hook for user defined code

#483

packages/server/config/config.default.js

@@ -110,5 +110,16 @@ module.exports = {
     //   device.features['-x'].default = 215;
     //   device.features['-y'].default = 297;
     // }
+  },
+
+  /**
+   * This method is called after a scan has completed with the resultant
+   * FileInfo.
+   * @param {FileInfo} fileInfo 
+   * @returns {Promise.<any>}
+   */
+  async afterScan(fileInfo) {
+    // Copy the file to the home directory
+    // return await Process.spawn(`cp '${fileInfo.fullname}' ~/`);
   }
 };

packages/server/src/config.js

@@ -8,7 +8,7 @@ class Config {
   constructor() {
     this.init();
     this.addEnvironment();
-    userOptions.applyToConfig(this);
+    userOptions.afterConfig(this);
   }
 
   init() {

packages/server/src/configure.js

@@ -59,6 +59,7 @@ function logRequest(req) {
  */
 function initialize(rootPath) {
   if (rootPath) {
+    log.warn(`Running with altered rootPath: ${rootPath}`);
     // Only required for running in development
     Object.assign(Config, {
       devicesPath: rootPath + Config.devicesPath,

packages/server/src/devices.js

@@ -78,7 +78,7 @@ class Devices {
       file.save(JSON.stringify(devices.map(d => d.string), null, 2));
     }
 
-    userOptions.applyToDevices(devices);
+    userOptions.afterDevices(devices);
     return devices;
   }
 

packages/server/src/scan-controller.js

@@ -8,6 +8,7 @@ const Filters = require('./filters');
 const Process = require('./process');
 const Request = require('./request');
 const Scanimage = require('./scanimage');
+const userOptions = require('./user-options');
 const Util = require('./util');
 
 class ScanController {
@@ -170,6 +171,7 @@ class ScanController {
 
     if (this.finishUp) {
       const file = await this.finish();
+      await userOptions.afterScan(file);
       return {
         file
       };

packages/server/src/user-options.js

@@ -10,24 +10,35 @@ class UserOptions {
   }
 
   /**
-   * Applies user overrides from config.local.js to the configuration
+   * Passes a config reference to config.local.js for customisation
    * @param {Configuration} config 
    */
-  applyToConfig(config) {
+  afterConfig(config) {
     if (this.local && this.local.afterConfig) {
       this.local.afterConfig(config);
     }
   }
 
   /**
-   * Applies user overrides from config.local.js to the devices
+   * Passes a devices reference to config.local.js for customisation
    * @param {ScanDevice[]} devices 
    */
-  applyToDevices(devices) {
+  afterDevices(devices) {
     if (this.local && this.local.afterDevices) {
       this.local.afterDevices(devices);
     }
   }
+
+  /**
+   * Passes a fileInfo of the scan result to config.local.js
+   * @param {FileInfo} fileInfo 
+   * @returns {Promise.<any>}
+   */
+  async afterScan(fileInfo) {
+    if (this.local && this.local.afterScan) {
+      return await this.local.afterScan(fileInfo);
+    }
+  }
 }
 
 const userOptions = new UserOptions();