Add LibrarySettings and update edit library modal to include settings tab

2025-07-06 15:35:03 +02:00 · 2022-04-14 17:15:52 -05:00 · 2022-04-14 17:15:52 -05:00 · 5a26b01ffb
commit 5a26b01ffb
parent cbde451120
12 changed files with 356 additions and 162 deletions
--- a/server/objects/settings/ServerSettings.js
+++ b/server/objects/settings/ServerSettings.js
@ -0,0 +1,150 @@
+const { BookCoverAspectRatio, BookshelfView } = require('../../utils/constants')
+const Logger = require('../../Logger')
+
+class ServerSettings {
+  constructor(settings) {
+    this.id = 'server-settings'
+
+    // Misc/Unused
+    this.autoTagNew = false
+    this.newTagExpireDays = 15
+
+    // Scanner
+    this.scannerParseSubtitle = false
+    this.scannerFindCovers = false
+    this.scannerCoverProvider = 'google'
+    this.scannerPreferAudioMetadata = false
+    this.scannerPreferOpfMetadata = false
+    this.scannerDisableWatcher = false
+
+    // Metadata - choose to store inside users library item folder
+    this.storeCoverWithItem = false
+    this.storeMetadataWithItem = false
+
+    // Security/Rate limits
+    this.rateLimitLoginRequests = 10
+    this.rateLimitLoginWindow = 10 * 60 * 1000 // 10 Minutes
+
+    // Backups
+    // this.backupSchedule = '0 1 * * *' // If false then auto-backups are disabled (default every day at 1am)
+    this.backupSchedule = false
+    this.backupsToKeep = 2
+    this.backupMetadataCovers = true
+
+    // Logger
+    this.loggerDailyLogsToKeep = 7
+    this.loggerScannerLogsToKeep = 2
+
+    // Cover
+    this.coverAspectRatio = BookCoverAspectRatio.SQUARE
+    this.bookshelfView = BookshelfView.STANDARD
+
+    // Podcasts
+    this.podcastEpisodeSchedule = '0 * * * *' // Every hour
+
+    this.sortingIgnorePrefix = false
+    this.sortingPrefixes = ['the', 'a']
+
+    this.chromecastEnabled = false
+    this.logLevel = Logger.logLevel
+    this.version = null
+
+    if (settings) {
+      this.construct(settings)
+    }
+  }
+
+  construct(settings) {
+    this.autoTagNew = settings.autoTagNew
+    this.newTagExpireDays = settings.newTagExpireDays
+    this.scannerFindCovers = !!settings.scannerFindCovers
+    this.scannerCoverProvider = settings.scannerCoverProvider || 'google'
+    this.scannerParseSubtitle = settings.scannerParseSubtitle
+    this.scannerPreferAudioMetadata = !!settings.scannerPreferAudioMetadata
+    this.scannerPreferOpfMetadata = !!settings.scannerPreferOpfMetadata
+    this.scannerDisableWatcher = !!settings.scannerDisableWatcher
+
+    this.storeCoverWithItem = !!settings.storeCoverWithItem
+    if (settings.storeCoverWithBook != undefined) { // storeCoverWithBook was old name of setting < v2
+      this.storeCoverWithItem = !!settings.storeCoverWithBook
+    }
+    this.storeMetadataWithItem = !!settings.storeMetadataWithItem
+    if (settings.storeMetadataWithBook != undefined) { // storeMetadataWithBook was old name of setting < v2
+      this.storeMetadataWithItem = !!settings.storeMetadataWithBook
+    }
+
+    this.rateLimitLoginRequests = !isNaN(settings.rateLimitLoginRequests) ? Number(settings.rateLimitLoginRequests) : 10
+    this.rateLimitLoginWindow = !isNaN(settings.rateLimitLoginWindow) ? Number(settings.rateLimitLoginWindow) : 10 * 60 * 1000 // 10 Minutes
+
+    this.backupSchedule = settings.backupSchedule || false
+    this.backupsToKeep = settings.backupsToKeep || 2
+    this.backupMetadataCovers = settings.backupMetadataCovers !== false
+
+    this.loggerDailyLogsToKeep = settings.loggerDailyLogsToKeep || 7
+    this.loggerScannerLogsToKeep = settings.loggerScannerLogsToKeep || 2
+
+    this.coverAspectRatio = !isNaN(settings.coverAspectRatio) ? settings.coverAspectRatio : BookCoverAspectRatio.SQUARE
+    this.bookshelfView = settings.bookshelfView || BookshelfView.STANDARD
+
+    this.sortingIgnorePrefix = !!settings.sortingIgnorePrefix
+    this.sortingPrefixes = settings.sortingPrefixes || ['the', 'a']
+    this.chromecastEnabled = !!settings.chromecastEnabled
+    this.logLevel = settings.logLevel || Logger.logLevel
+    this.version = settings.version || null
+
+    if (this.logLevel !== Logger.logLevel) {
+      Logger.setLogLevel(this.logLevel)
+    }
+  }
+
+  toJSON() {
+    return {
+      id: this.id,
+      autoTagNew: this.autoTagNew,
+      newTagExpireDays: this.newTagExpireDays,
+      scannerFindCovers: this.scannerFindCovers,
+      scannerCoverProvider: this.scannerCoverProvider,
+      scannerParseSubtitle: this.scannerParseSubtitle,
+      scannerPreferAudioMetadata: this.scannerPreferAudioMetadata,
+      scannerPreferOpfMetadata: this.scannerPreferOpfMetadata,
+      scannerDisableWatcher: this.scannerDisableWatcher,
+      storeCoverWithItem: this.storeCoverWithItem,
+      storeMetadataWithItem: this.storeMetadataWithItem,
+      rateLimitLoginRequests: this.rateLimitLoginRequests,
+      rateLimitLoginWindow: this.rateLimitLoginWindow,
+      backupSchedule: this.backupSchedule,
+      backupsToKeep: this.backupsToKeep,
+      backupMetadataCovers: this.backupMetadataCovers,
+      loggerDailyLogsToKeep: this.loggerDailyLogsToKeep,
+      loggerScannerLogsToKeep: this.loggerScannerLogsToKeep,
+      coverAspectRatio: this.coverAspectRatio,
+      bookshelfView: this.bookshelfView,
+      sortingIgnorePrefix: this.sortingIgnorePrefix,
+      sortingPrefixes: [...this.sortingPrefixes],
+      chromecastEnabled: this.chromecastEnabled,
+      logLevel: this.logLevel,
+      version: this.version
+    }
+  }
+
+  update(payload) {
+    var hasUpdates = false
+    for (const key in payload) {
+      if (key === 'sortingPrefixes' && payload[key] && payload[key].length) {
+        var prefixesCleaned = payload[key].filter(prefix => !!prefix).map(prefix => prefix.toLowerCase())
+        if (prefixesCleaned.join(',') !== this[key].join(',')) {
+          this[key] = [...prefixesCleaned]
+          hasUpdates = true
+        }
+      } else if (this[key] !== payload[key]) {
+        if (key === 'logLevel') {
+          Logger.setLogLevel(payload[key])
+        }
+        this[key] = payload[key]
+        hasUpdates = true
+      }
+    }
+    return hasUpdates
+  }
+}
+module.exports = ServerSettings