Add:New scanner and scanner server settings

server/scanner/LibraryScan.js

@@ -1,6 +1,10 @@
-const Folder = require('../objects/Folder')
-const Constants = require('../utils/constants')
+const Path = require('path')
+const fs = require('fs-extra')
+const date = require('date-and-time')
 
+const Logger = require('../Logger')
+const Folder = require('../objects/Folder')
+const { LogLevel } = require('../utils/constants')
 const { getId, secondsToTimestamp } = require('../utils/index')
 
 class LibraryScan {
@@ -9,6 +13,7 @@ class LibraryScan {
     this.libraryId = null
     this.libraryName = null
     this.folders = null
+    this.verbose = false
 
     this.scanOptions = null
 
@@ -16,14 +21,21 @@ class LibraryScan {
     this.finishedAt = null
     this.elapsed = null
 
-    this.status = Constants.ScanStatus.NOTHING
     this.resultsMissing = 0
     this.resultsAdded = 0
     this.resultsUpdated = 0
+
+    this.logs = []
   }
 
   get _scanOptions() { return this.scanOptions || {} }
   get forceRescan() { return !!this._scanOptions.forceRescan }
+  get preferAudioMetadata() { return !!this._scanOptions.preferAudioMetadata }
+  get preferOpfMetadata() { return !!this._scanOptions.preferOpfMetadata }
+  get findCovers() { return !!this._scanOptions.findCovers }
+  get timestamp() {
+    return (new Date()).toISOString()
+  }
 
   get resultStats() {
     return `${this.resultsAdded} Added | ${this.resultsUpdated} Updated | ${this.resultsMissing} Missing`
@@ -42,6 +54,28 @@ class LibraryScan {
       }
     }
   }
+  get totalResults() {
+    return this.resultsAdded + this.resultsUpdated + this.resultsMissing
+  }
+  get getLogFilename() {
+    return date.format(new Date(), 'YYYY-MM-DD') + '_' + this.id + '.txt'
+  }
+
+  toJSON() {
+    return {
+      id: this.id,
+      libraryId: this.libraryId,
+      libraryName: this.libraryName,
+      folders: this.folders.map(f => f.toJSON()),
+      scanOptions: this.scanOptions.toJSON(),
+      startedAt: this.startedAt,
+      finishedAt: this.finishedAt,
+      elapsed: this.elapsed,
+      resultsAdded: this.resultsAdded,
+      resultsUpdated: this.resultsUpdated,
+      resultsMissing: this.resultsMissing
+    }
+  }
 
   setData(library, scanOptions) {
     this.id = getId('lscan')
@@ -58,5 +92,39 @@ class LibraryScan {
     this.finishedAt = Date.now()
     this.elapsed = this.finishedAt - this.startedAt
   }
+
+  getLogLevelString(level) {
+    for (const key in LogLevel) {
+      if (LogLevel[key] === level) {
+        return key
+      }
+    }
+    return 'UNKNOWN'
+  }
+
+  addLog(level, ...args) {
+    const logObj = {
+      timestamp: this.timestamp,
+      message: args.join(' '),
+      levelName: this.getLogLevelString(level),
+      level
+    }
+
+    if (this.verbose) {
+      Logger.debug(`[LibraryScan] "${this.libraryName}":`, args)
+    }
+    this.logs.push(logObj)
+  }
+
+  async saveLog(logDir) {
+    await fs.ensureDir(logDir)
+    var outputPath = Path.join(logDir, this.getLogFilename)
+    var logLines = [JSON.stringify(this.toJSON())]
+    this.logs.forEach(l => {
+      logLines.push(JSON.stringify(l))
+    })
+    await fs.writeFile(outputPath, logLines.join('\n') + '\n')
+    Logger.info(`[LibraryScan] Scan log saved "${outputPath}"`)
+  }
 }
 module.exports = LibraryScan