Merge remote-tracking branch 'upstream/master'

server/objects/settings/EmailSettings.js

@@ -0,0 +1,101 @@
+const Logger = require('../../Logger')
+const { areEquivalent, copyValue, isNullOrNaN } = require('../../utils')
+
+// REF: https://nodemailer.com/smtp/
+class EmailSettings {
+  constructor(settings = null) {
+    this.id = 'email-settings'
+    this.host = null
+    this.port = 465
+    this.secure = true
+    this.user = null
+    this.pass = null
+    this.fromAddress = null
+
+    // Array of { name:String, email:String }
+    this.ereaderDevices = []
+
+    if (settings) {
+      this.construct(settings)
+    }
+  }
+
+  construct(settings) {
+    this.host = settings.host
+    this.port = settings.port
+    this.secure = !!settings.secure
+    this.user = settings.user
+    this.pass = settings.pass
+    this.fromAddress = settings.fromAddress
+    this.ereaderDevices = settings.ereaderDevices?.map(d => ({ ...d })) || []
+  }
+
+  toJSON() {
+    return {
+      id: this.id,
+      host: this.host,
+      port: this.port,
+      secure: this.secure,
+      user: this.user,
+      pass: this.pass,
+      fromAddress: this.fromAddress,
+      ereaderDevices: this.ereaderDevices.map(d => ({ ...d }))
+    }
+  }
+
+  update(payload) {
+    if (!payload) return false
+
+    if (payload.port !== undefined) {
+      if (isNullOrNaN(payload.port)) payload.port = 465
+      else payload.port = Number(payload.port)
+    }
+    if (payload.secure !== undefined) payload.secure = !!payload.secure
+
+    if (payload.ereaderDevices !== undefined && !Array.isArray(payload.ereaderDevices)) payload.ereaderDevices = undefined
+
+    let hasUpdates = false
+
+    const json = this.toJSON()
+    for (const key in json) {
+      if (key === 'id') continue
+
+      if (payload[key] !== undefined && !areEquivalent(payload[key], json[key])) {
+        this[key] = copyValue(payload[key])
+        hasUpdates = true
+      }
+    }
+
+    return hasUpdates
+  }
+
+  getTransportObject() {
+    const payload = {
+      host: this.host,
+      secure: this.secure
+    }
+    if (this.port) payload.port = this.port
+    if (this.user && this.pass !== undefined) {
+      payload.auth = {
+        user: this.user,
+        pass: this.pass
+      }
+    }
+
+    return payload
+  }
+
+  getEReaderDevices(user) {
+    // Only accessible to admin or up
+    if (!user.isAdminOrUp) {
+      return []
+    }
+
+    return this.ereaderDevices.map(d => ({ ...d }))
+  }
+
+  getEReaderDevice(deviceName) {
+    return this.ereaderDevices.find(d => d.name === deviceName)
+  }
+}
+module.exports = EmailSettings

server/objects/settings/ServerSettings.js

@@ -1,5 +1,4 @@
 const { BookshelfView } = require('../../utils/constants')
-const { isNullOrNaN } = require('../../utils')
 const Logger = require('../../Logger')
 
 class ServerSettings {
@@ -22,6 +21,7 @@ class ServerSettings {
     this.storeCoverWithItem = false
     this.storeMetadataWithItem = false
     this.defaultRenameString = "$bookAuthor/$bookTitle"
+    this.metadataFileFormat = 'json'
 
     // Security/Rate limits
     this.rateLimitLoginRequests = 10
@@ -52,6 +52,7 @@ class ServerSettings {
     this.chromecastEnabled = false
     this.enableEReader = false
     this.dateFormat = 'MM/dd/yyyy'
+    this.timeFormat = 'HH:mm'
     this.language = 'en-us'
 
     this.logLevel = Logger.logLevel
@@ -78,6 +79,7 @@ class ServerSettings {
     this.storeCoverWithItem = !!settings.storeCoverWithItem
     this.storeMetadataWithItem = !!settings.storeMetadataWithItem
     this.defaultRenameString = settings.defaultRenameString || "$bookAuthor/$bookTitle"
+    this.metadataFileFormat = settings.metadataFileFormat || 'json'
 
     this.rateLimitLoginRequests = !isNaN(settings.rateLimitLoginRequests) ? Number(settings.rateLimitLoginRequests) : 10
     this.rateLimitLoginWindow = !isNaN(settings.rateLimitLoginWindow) ? Number(settings.rateLimitLoginWindow) : 10 * 60 * 1000 // 10 Minutes
@@ -98,6 +100,7 @@ class ServerSettings {
     this.chromecastEnabled = !!settings.chromecastEnabled
     this.enableEReader = !!settings.enableEReader
     this.dateFormat = settings.dateFormat || 'MM/dd/yyyy'
+    this.timeFormat = settings.timeFormat || 'HH:mm'
     this.language = settings.language || 'en-us'
     this.logLevel = settings.logLevel || Logger.logLevel
     this.version = settings.version || null
@@ -112,6 +115,16 @@ class ServerSettings {
     if (settings.homeBookshelfView == undefined) { // homeBookshelfView was added in 2.1.3
       this.homeBookshelfView = settings.bookshelfView
     }
+    if (settings.metadataFileFormat == undefined) { // metadataFileFormat was added in 2.2.21
+      // All users using old settings will stay abs until changed
+      this.metadataFileFormat = 'abs'
+    }
+
+    // Validation
+    if (!['abs', 'json'].includes(this.metadataFileFormat)) {
+      Logger.error(`[ServerSettings] construct: Invalid metadataFileFormat ${this.metadataFileFormat}`)
+      this.metadataFileFormat = 'json'
+    }
 
     if (this.logLevel !== Logger.logLevel) {
       Logger.setLogLevel(this.logLevel)
@@ -134,6 +147,7 @@ class ServerSettings {
       storeCoverWithItem: this.storeCoverWithItem,
       storeMetadataWithItem: this.storeMetadataWithItem,
       defaultRenameString: this.defaultRenameString,
+      metadataFileFormat: this.metadataFileFormat,
       rateLimitLoginRequests: this.rateLimitLoginRequests,
       rateLimitLoginWindow: this.rateLimitLoginWindow,
       backupSchedule: this.backupSchedule,
@@ -149,6 +163,7 @@ class ServerSettings {
       chromecastEnabled: this.chromecastEnabled,
       enableEReader: this.enableEReader,
       dateFormat: this.dateFormat,
+      timeFormat: this.timeFormat,
       language: this.language,
       logLevel: this.logLevel,
       version: this.version
@@ -181,4 +196,4 @@ class ServerSettings {
     return hasUpdates
   }
 }
-module.exports = ServerSettings
+module.exports = ServerSettings