mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2024-12-20 19:06:06 +01:00
340 lines
14 KiB
JavaScript
340 lines
14 KiB
JavaScript
const Path = require('path')
|
|
const packageJson = require('../../../package.json')
|
|
const { BookshelfView } = require('../../utils/constants')
|
|
const Logger = require('../../Logger')
|
|
const User = require('../user/User')
|
|
|
|
class ServerSettings {
|
|
constructor(settings) {
|
|
this.id = 'server-settings'
|
|
this.tokenSecret = null
|
|
|
|
// Scanner
|
|
this.scannerParseSubtitle = false
|
|
this.scannerFindCovers = false
|
|
this.scannerCoverProvider = 'google'
|
|
this.scannerPreferMatchedMetadata = false
|
|
this.scannerDisableWatcher = false
|
|
|
|
// Metadata - choose to store inside users library item folder
|
|
this.storeCoverWithItem = false
|
|
this.storeMetadataWithItem = false
|
|
this.metadataFileFormat = 'json'
|
|
|
|
// Security/Rate limits
|
|
this.rateLimitLoginRequests = 10
|
|
this.rateLimitLoginWindow = 10 * 60 * 1000 // 10 Minutes
|
|
|
|
// Backups
|
|
this.backupPath = Path.join(global.MetadataPath, 'backups')
|
|
this.backupSchedule = false // If false then auto-backups are disabled
|
|
this.backupsToKeep = 2
|
|
this.maxBackupSize = 1
|
|
|
|
// Logger
|
|
this.loggerDailyLogsToKeep = 7
|
|
this.loggerScannerLogsToKeep = 2
|
|
|
|
// Bookshelf Display
|
|
this.homeBookshelfView = BookshelfView.DETAIL
|
|
this.bookshelfView = BookshelfView.DETAIL
|
|
|
|
// Podcasts
|
|
this.podcastEpisodeSchedule = '0 * * * *' // Every hour
|
|
|
|
// Sorting
|
|
this.sortingIgnorePrefix = false
|
|
this.sortingPrefixes = ['the', 'a']
|
|
|
|
// Misc Flags
|
|
this.chromecastEnabled = false
|
|
this.dateFormat = 'MM/dd/yyyy'
|
|
this.timeFormat = 'HH:mm'
|
|
this.language = 'en-us'
|
|
|
|
this.logLevel = Logger.logLevel
|
|
|
|
this.version = packageJson.version
|
|
this.buildNumber = packageJson.buildNumber
|
|
|
|
// Auth settings
|
|
this.authLoginCustomMessage = null
|
|
this.authActiveAuthMethods = ['local']
|
|
|
|
// openid settings
|
|
this.authOpenIDIssuerURL = null
|
|
this.authOpenIDAuthorizationURL = null
|
|
this.authOpenIDTokenURL = null
|
|
this.authOpenIDUserInfoURL = null
|
|
this.authOpenIDJwksURL = null
|
|
this.authOpenIDLogoutURL = null
|
|
this.authOpenIDClientID = null
|
|
this.authOpenIDClientSecret = null
|
|
this.authOpenIDTokenSigningAlgorithm = 'RS256'
|
|
this.authOpenIDButtonText = 'Login with OpenId'
|
|
this.authOpenIDAutoLaunch = false
|
|
this.authOpenIDAutoRegister = false
|
|
this.authOpenIDMatchExistingBy = null
|
|
this.authOpenIDMobileRedirectURIs = ['audiobookshelf://oauth']
|
|
this.authOpenIDGroupClaim = ''
|
|
this.authOpenIDAdvancedPermsClaim = ''
|
|
|
|
if (settings) {
|
|
this.construct(settings)
|
|
}
|
|
}
|
|
|
|
construct(settings) {
|
|
this.tokenSecret = settings.tokenSecret
|
|
this.scannerFindCovers = !!settings.scannerFindCovers
|
|
this.scannerCoverProvider = settings.scannerCoverProvider || 'google'
|
|
this.scannerParseSubtitle = settings.scannerParseSubtitle
|
|
this.scannerPreferMatchedMetadata = !!settings.scannerPreferMatchedMetadata
|
|
this.scannerDisableWatcher = !!settings.scannerDisableWatcher
|
|
|
|
this.storeCoverWithItem = !!settings.storeCoverWithItem
|
|
this.storeMetadataWithItem = !!settings.storeMetadataWithItem
|
|
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
|
|
|
|
this.backupPath = settings.backupPath || Path.join(global.MetadataPath, 'backups')
|
|
this.backupSchedule = settings.backupSchedule || false
|
|
this.backupsToKeep = settings.backupsToKeep || 2
|
|
this.maxBackupSize = settings.maxBackupSize === 0 ? 0 : settings.maxBackupSize || 1
|
|
|
|
this.loggerDailyLogsToKeep = settings.loggerDailyLogsToKeep || 7
|
|
this.loggerScannerLogsToKeep = settings.loggerScannerLogsToKeep || 2
|
|
|
|
this.homeBookshelfView = settings.homeBookshelfView || BookshelfView.STANDARD
|
|
this.bookshelfView = settings.bookshelfView || BookshelfView.STANDARD
|
|
|
|
this.sortingIgnorePrefix = !!settings.sortingIgnorePrefix
|
|
this.sortingPrefixes = settings.sortingPrefixes || ['the']
|
|
this.chromecastEnabled = !!settings.chromecastEnabled
|
|
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
|
|
this.buildNumber = settings.buildNumber || 0 // Added v2.4.5
|
|
|
|
this.authLoginCustomMessage = settings.authLoginCustomMessage || null // Added v2.8.0
|
|
this.authActiveAuthMethods = settings.authActiveAuthMethods || ['local']
|
|
|
|
this.authOpenIDIssuerURL = settings.authOpenIDIssuerURL || null
|
|
this.authOpenIDAuthorizationURL = settings.authOpenIDAuthorizationURL || null
|
|
this.authOpenIDTokenURL = settings.authOpenIDTokenURL || null
|
|
this.authOpenIDUserInfoURL = settings.authOpenIDUserInfoURL || null
|
|
this.authOpenIDJwksURL = settings.authOpenIDJwksURL || null
|
|
this.authOpenIDLogoutURL = settings.authOpenIDLogoutURL || null
|
|
this.authOpenIDClientID = settings.authOpenIDClientID || null
|
|
this.authOpenIDClientSecret = settings.authOpenIDClientSecret || null
|
|
this.authOpenIDTokenSigningAlgorithm = settings.authOpenIDTokenSigningAlgorithm || 'RS256'
|
|
this.authOpenIDButtonText = settings.authOpenIDButtonText || 'Login with OpenId'
|
|
this.authOpenIDAutoLaunch = !!settings.authOpenIDAutoLaunch
|
|
this.authOpenIDAutoRegister = !!settings.authOpenIDAutoRegister
|
|
this.authOpenIDMatchExistingBy = settings.authOpenIDMatchExistingBy || null
|
|
this.authOpenIDMobileRedirectURIs = settings.authOpenIDMobileRedirectURIs || ['audiobookshelf://oauth']
|
|
this.authOpenIDGroupClaim = settings.authOpenIDGroupClaim || ''
|
|
this.authOpenIDAdvancedPermsClaim = settings.authOpenIDAdvancedPermsClaim || ''
|
|
|
|
if (!Array.isArray(this.authActiveAuthMethods)) {
|
|
this.authActiveAuthMethods = ['local']
|
|
}
|
|
|
|
// remove uninitialized methods
|
|
// OpenID
|
|
if (this.authActiveAuthMethods.includes('openid') && !this.isOpenIDAuthSettingsValid) {
|
|
this.authActiveAuthMethods.splice(this.authActiveAuthMethods.indexOf('openid', 0), 1)
|
|
}
|
|
|
|
// fallback to local
|
|
if (!Array.isArray(this.authActiveAuthMethods) || this.authActiveAuthMethods.length == 0) {
|
|
this.authActiveAuthMethods = ['local']
|
|
}
|
|
|
|
// Migrations
|
|
if (settings.storeCoverWithBook != undefined) {
|
|
// storeCoverWithBook was renamed to storeCoverWithItem in 2.0.0
|
|
this.storeCoverWithItem = !!settings.storeCoverWithBook
|
|
}
|
|
if (settings.storeMetadataWithBook != undefined) {
|
|
// storeMetadataWithBook was renamed to storeMetadataWithItem in 2.0.0
|
|
this.storeMetadataWithItem = !!settings.storeMetadataWithBook
|
|
}
|
|
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'
|
|
}
|
|
|
|
// As of v2.4.5 only json is supported
|
|
if (this.metadataFileFormat !== 'json') {
|
|
Logger.warn(`[ServerSettings] Invalid metadataFileFormat ${this.metadataFileFormat} (as of v2.4.5 only json is supported)`)
|
|
this.metadataFileFormat = 'json'
|
|
}
|
|
|
|
if (this.logLevel !== Logger.logLevel) {
|
|
Logger.setLogLevel(this.logLevel)
|
|
}
|
|
|
|
if (process.env.BACKUP_PATH && this.backupPath !== process.env.BACKUP_PATH) {
|
|
Logger.info(`[ServerSettings] Using backup path from environment variable ${process.env.BACKUP_PATH}`)
|
|
this.backupPath = process.env.BACKUP_PATH
|
|
}
|
|
}
|
|
|
|
toJSON() {
|
|
// Use toJSONForBrowser if sending to client
|
|
return {
|
|
id: this.id,
|
|
tokenSecret: this.tokenSecret, // Do not return to client
|
|
scannerFindCovers: this.scannerFindCovers,
|
|
scannerCoverProvider: this.scannerCoverProvider,
|
|
scannerParseSubtitle: this.scannerParseSubtitle,
|
|
scannerPreferMatchedMetadata: this.scannerPreferMatchedMetadata,
|
|
scannerDisableWatcher: this.scannerDisableWatcher,
|
|
storeCoverWithItem: this.storeCoverWithItem,
|
|
storeMetadataWithItem: this.storeMetadataWithItem,
|
|
metadataFileFormat: this.metadataFileFormat,
|
|
rateLimitLoginRequests: this.rateLimitLoginRequests,
|
|
rateLimitLoginWindow: this.rateLimitLoginWindow,
|
|
backupPath: this.backupPath,
|
|
backupSchedule: this.backupSchedule,
|
|
backupsToKeep: this.backupsToKeep,
|
|
maxBackupSize: this.maxBackupSize,
|
|
loggerDailyLogsToKeep: this.loggerDailyLogsToKeep,
|
|
loggerScannerLogsToKeep: this.loggerScannerLogsToKeep,
|
|
homeBookshelfView: this.homeBookshelfView,
|
|
bookshelfView: this.bookshelfView,
|
|
podcastEpisodeSchedule: this.podcastEpisodeSchedule,
|
|
sortingIgnorePrefix: this.sortingIgnorePrefix,
|
|
sortingPrefixes: [...this.sortingPrefixes],
|
|
chromecastEnabled: this.chromecastEnabled,
|
|
dateFormat: this.dateFormat,
|
|
timeFormat: this.timeFormat,
|
|
language: this.language,
|
|
logLevel: this.logLevel,
|
|
version: this.version,
|
|
buildNumber: this.buildNumber,
|
|
authLoginCustomMessage: this.authLoginCustomMessage,
|
|
authActiveAuthMethods: this.authActiveAuthMethods,
|
|
authOpenIDIssuerURL: this.authOpenIDIssuerURL,
|
|
authOpenIDAuthorizationURL: this.authOpenIDAuthorizationURL,
|
|
authOpenIDTokenURL: this.authOpenIDTokenURL,
|
|
authOpenIDUserInfoURL: this.authOpenIDUserInfoURL,
|
|
authOpenIDJwksURL: this.authOpenIDJwksURL,
|
|
authOpenIDLogoutURL: this.authOpenIDLogoutURL,
|
|
authOpenIDClientID: this.authOpenIDClientID, // Do not return to client
|
|
authOpenIDClientSecret: this.authOpenIDClientSecret, // Do not return to client
|
|
authOpenIDTokenSigningAlgorithm: this.authOpenIDTokenSigningAlgorithm,
|
|
authOpenIDButtonText: this.authOpenIDButtonText,
|
|
authOpenIDAutoLaunch: this.authOpenIDAutoLaunch,
|
|
authOpenIDAutoRegister: this.authOpenIDAutoRegister,
|
|
authOpenIDMatchExistingBy: this.authOpenIDMatchExistingBy,
|
|
authOpenIDMobileRedirectURIs: this.authOpenIDMobileRedirectURIs, // Do not return to client
|
|
authOpenIDGroupClaim: this.authOpenIDGroupClaim, // Do not return to client
|
|
authOpenIDAdvancedPermsClaim: this.authOpenIDAdvancedPermsClaim // Do not return to client
|
|
}
|
|
}
|
|
|
|
toJSONForBrowser() {
|
|
const json = this.toJSON()
|
|
delete json.tokenSecret
|
|
delete json.authOpenIDClientID
|
|
delete json.authOpenIDClientSecret
|
|
delete json.authOpenIDMobileRedirectURIs
|
|
delete json.authOpenIDGroupClaim
|
|
delete json.authOpenIDAdvancedPermsClaim
|
|
return json
|
|
}
|
|
|
|
get supportedAuthMethods() {
|
|
return ['local', 'openid']
|
|
}
|
|
|
|
/**
|
|
* Auth settings required for openid to be valid
|
|
*/
|
|
get isOpenIDAuthSettingsValid() {
|
|
return this.authOpenIDIssuerURL && this.authOpenIDAuthorizationURL && this.authOpenIDTokenURL && this.authOpenIDUserInfoURL && this.authOpenIDJwksURL && this.authOpenIDClientID && this.authOpenIDClientSecret && this.authOpenIDTokenSigningAlgorithm
|
|
}
|
|
|
|
get authenticationSettings() {
|
|
return {
|
|
authLoginCustomMessage: this.authLoginCustomMessage,
|
|
authActiveAuthMethods: this.authActiveAuthMethods,
|
|
authOpenIDIssuerURL: this.authOpenIDIssuerURL,
|
|
authOpenIDAuthorizationURL: this.authOpenIDAuthorizationURL,
|
|
authOpenIDTokenURL: this.authOpenIDTokenURL,
|
|
authOpenIDUserInfoURL: this.authOpenIDUserInfoURL,
|
|
authOpenIDJwksURL: this.authOpenIDJwksURL,
|
|
authOpenIDLogoutURL: this.authOpenIDLogoutURL,
|
|
authOpenIDClientID: this.authOpenIDClientID, // Do not return to client
|
|
authOpenIDClientSecret: this.authOpenIDClientSecret, // Do not return to client
|
|
authOpenIDTokenSigningAlgorithm: this.authOpenIDTokenSigningAlgorithm,
|
|
authOpenIDButtonText: this.authOpenIDButtonText,
|
|
authOpenIDAutoLaunch: this.authOpenIDAutoLaunch,
|
|
authOpenIDAutoRegister: this.authOpenIDAutoRegister,
|
|
authOpenIDMatchExistingBy: this.authOpenIDMatchExistingBy,
|
|
authOpenIDMobileRedirectURIs: this.authOpenIDMobileRedirectURIs, // Do not return to client
|
|
authOpenIDGroupClaim: this.authOpenIDGroupClaim, // Do not return to client
|
|
authOpenIDAdvancedPermsClaim: this.authOpenIDAdvancedPermsClaim, // Do not return to client
|
|
|
|
authOpenIDSamplePermissions: User.getSampleAbsPermissions()
|
|
}
|
|
}
|
|
|
|
get authFormData() {
|
|
const clientFormData = {
|
|
authLoginCustomMessage: this.authLoginCustomMessage
|
|
}
|
|
if (this.authActiveAuthMethods.includes('openid')) {
|
|
clientFormData.authOpenIDButtonText = this.authOpenIDButtonText
|
|
clientFormData.authOpenIDAutoLaunch = this.authOpenIDAutoLaunch
|
|
}
|
|
return clientFormData
|
|
}
|
|
|
|
/**
|
|
* Update server settings
|
|
*
|
|
* @param {Object} payload
|
|
* @returns {boolean} true if updates were made
|
|
*/
|
|
update(payload) {
|
|
let hasUpdates = false
|
|
for (const key in payload) {
|
|
if (key === 'sortingPrefixes') {
|
|
// Sorting prefixes are updated with the /api/sorting-prefixes endpoint
|
|
continue
|
|
} else if (key === 'authActiveAuthMethods') {
|
|
if (!payload[key]?.length) {
|
|
Logger.error(`[ServerSettings] Invalid authActiveAuthMethods`, payload[key])
|
|
continue
|
|
}
|
|
this.authActiveAuthMethods.sort()
|
|
payload[key].sort()
|
|
if (payload[key].join() !== this.authActiveAuthMethods.join()) {
|
|
this.authActiveAuthMethods = payload[key]
|
|
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
|