const Path = require('path') const express = require('express') const http = require('http') const SocketIO = require('socket.io') const fs = require('./libs/fsExtra') const fileUpload = require('./libs/expressFileupload') const rateLimit = require('./libs/expressRateLimit') const { version } = require('../package.json') // Utils const dbMigration = require('./utils/dbMigration') const filePerms = require('./utils/filePerms') const Logger = require('./Logger') // Classes const Auth = require('./Auth') const Watcher = require('./Watcher') const Scanner = require('./scanner/Scanner') const Db = require('./Db') const ApiRouter = require('./routers/ApiRouter') const HlsRouter = require('./routers/HlsRouter') const StaticRouter = require('./routers/StaticRouter') const NotificationManager = require('./managers/NotificationManager') const CoverManager = require('./managers/CoverManager') const AbMergeManager = require('./managers/AbMergeManager') const CacheManager = require('./managers/CacheManager') const LogManager = require('./managers/LogManager') const BackupManager = require('./managers/BackupManager') const PlaybackSessionManager = require('./managers/PlaybackSessionManager') const PodcastManager = require('./managers/PodcastManager') const AudioMetadataMangaer = require('./managers/AudioMetadataManager') const RssFeedManager = require('./managers/RssFeedManager') const CronManager = require('./managers/CronManager') const TaskManager = require('./managers/TaskManager') class Server { constructor(SOURCE, PORT, HOST, UID, GID, CONFIG_PATH, METADATA_PATH, ROUTER_BASE_PATH) { this.Port = PORT this.Host = HOST global.Source = SOURCE global.Uid = isNaN(UID) ? 0 : Number(UID) global.Gid = isNaN(GID) ? 0 : Number(GID) global.ConfigPath = Path.normalize(CONFIG_PATH) global.MetadataPath = Path.normalize(METADATA_PATH) global.RouterBasePath = ROUTER_BASE_PATH // Fix backslash if not on Windows if (process.platform !== 'win32') { global.ConfigPath = global.ConfigPath.replace(/\\/g, '/') global.MetadataPath = global.MetadataPath.replace(/\\/g, '/') } if (!fs.pathExistsSync(global.ConfigPath)) { fs.mkdirSync(global.ConfigPath) filePerms.setDefaultDirSync(global.ConfigPath, false) } if (!fs.pathExistsSync(global.MetadataPath)) { fs.mkdirSync(global.MetadataPath) filePerms.setDefaultDirSync(global.MetadataPath, false) } this.db = new Db() this.watcher = new Watcher() this.auth = new Auth(this.db) // Managers this.taskManager = new TaskManager(this.emitter.bind(this)) this.notificationManager = new NotificationManager(this.db, this.emitter.bind(this)) this.backupManager = new BackupManager(this.db, this.emitter.bind(this)) this.logManager = new LogManager(this.db) this.cacheManager = new CacheManager() this.abMergeManager = new AbMergeManager(this.db, this.taskManager, this.clientEmitter.bind(this)) this.playbackSessionManager = new PlaybackSessionManager(this.db, this.emitter.bind(this), this.clientEmitter.bind(this)) this.coverManager = new CoverManager(this.db, this.cacheManager) this.podcastManager = new PodcastManager(this.db, this.watcher, this.emitter.bind(this), this.notificationManager) this.audioMetadataManager = new AudioMetadataMangaer(this.db, this.taskManager, this.emitter.bind(this), this.clientEmitter.bind(this)) this.rssFeedManager = new RssFeedManager(this.db, this.emitter.bind(this)) this.scanner = new Scanner(this.db, this.coverManager, this.emitter.bind(this)) this.cronManager = new CronManager(this.db, this.scanner, this.podcastManager) // Routers this.apiRouter = new ApiRouter(this.db, this.auth, this.scanner, this.playbackSessionManager, this.abMergeManager, this.coverManager, this.backupManager, this.watcher, this.cacheManager, this.podcastManager, this.audioMetadataManager, this.rssFeedManager, this.cronManager, this.notificationManager, this.taskManager, this.getUsersOnline.bind(this), this.emitter.bind(this), this.clientEmitter.bind(this)) this.hlsRouter = new HlsRouter(this.db, this.auth, this.playbackSessionManager, this.emitter.bind(this)) this.staticRouter = new StaticRouter(this.db) Logger.logManager = this.logManager this.server = null this.io = null this.clients = {} } getUsersOnline() { return Object.values(this.clients).filter(c => c.user).map(client => { return client.user.toJSONForPublic(this.playbackSessionManager.sessions, this.db.libraryItems) }) } getClientsForUser(userId) { return Object.values(this.clients).filter(c => c.user && c.user.id === userId) } emitter(ev, data) { // Logger.debug('EMITTER', ev) this.io.emit(ev, data) } clientEmitter(userId, ev, data) { var clients = this.getClientsForUser(userId) if (!clients.length) { return Logger.debug(`[Server] clientEmitter - no clients found for user ${userId}`) } clients.forEach((client) => { if (client.socket) { client.socket.emit(ev, data) } }) } authMiddleware(req, res, next) { this.auth.authMiddleware(req, res, next) } async init() { Logger.info('[Server] Init v' + version) await this.playbackSessionManager.removeOrphanStreams() var previousVersion = await this.db.checkPreviousVersion() // Returns null if same server version if (previousVersion) { Logger.debug(`[Server] Upgraded from previous version ${previousVersion}`) } if (previousVersion && previousVersion.localeCompare('2.0.0') < 0) { // Old version data model migration Logger.debug(`[Server] Previous version was < 2.0.0 - migration required`) await dbMigration.migrate(this.db) } else { await this.db.init() } // Create token secret if does not exist (Added v2.1.0) if (!this.db.serverSettings.tokenSecret) { await this.auth.initTokenSecret() } await this.cleanUserData() // Remove invalid user item progress await this.purgeMetadata() // Remove metadata folders without library item await this.playbackSessionManager.removeInvalidSessions() await this.cacheManager.ensureCachePaths() await this.abMergeManager.ensureDownloadDirPath() await this.backupManager.init() await this.logManager.init() await this.rssFeedManager.init() this.cronManager.init() if (this.db.serverSettings.scannerDisableWatcher) { Logger.info(`[Server] Watcher is disabled`) this.watcher.disabled = true } else { this.watcher.initWatcher(this.db.libraries) this.watcher.on('files', this.filesChanged.bind(this)) } } async start() { Logger.info('=== Starting Server ===') await this.init() const app = express() const router = express.Router() app.use(global.RouterBasePath, router) this.server = http.createServer(app) router.use(this.auth.cors) router.use(fileUpload()) router.use(express.urlencoded({ extended: true, limit: "5mb" })); router.use(express.json({ limit: "5mb" })) // Static path to generated nuxt const distPath = Path.join(global.appRoot, '/client/dist') router.use(express.static(distPath)) // Metadata folder static path router.use('/metadata', this.authMiddleware.bind(this), express.static(global.MetadataPath)) // Static folder router.use(express.static(Path.join(global.appRoot, 'static'))) router.use('/api', this.authMiddleware.bind(this), this.apiRouter.router) router.use('/hls', this.authMiddleware.bind(this), this.hlsRouter.router) router.use('/s', this.authMiddleware.bind(this), this.staticRouter.router) // EBook static file routes router.get('/ebook/:library/:folder/*', (req, res) => { var library = this.db.libraries.find(lib => lib.id === req.params.library) if (!library) return res.sendStatus(404) var folder = library.folders.find(fol => fol.id === req.params.folder) if (!folder) return res.status(404).send('Folder not found') var remainingPath = req.params['0'] var fullPath = Path.join(folder.fullPath, remainingPath) res.sendFile(fullPath) }) // RSS Feed temp route router.get('/feed/:id', (req, res) => { Logger.info(`[Server] Requesting rss feed ${req.params.id}`) this.rssFeedManager.getFeed(req, res) }) router.get('/feed/:id/cover', (req, res) => { this.rssFeedManager.getFeedCover(req, res) }) router.get('/feed/:id/item/:episodeId/*', (req, res) => { Logger.debug(`[Server] Requesting rss feed episode ${req.params.id}/${req.params.episodeId}`) this.rssFeedManager.getFeedItem(req, res) }) // Client dynamic routes const dyanimicRoutes = [ '/item/:id', '/author/:id', '/audiobook/:id/chapters', '/audiobook/:id/edit', '/audiobook/:id/manage', '/library/:library', '/library/:library/search', '/library/:library/bookshelf/:id?', '/library/:library/authors', '/library/:library/series/:id?', '/library/:library/podcast/search', '/library/:library/podcast/latest', '/config/users/:id', '/config/users/:id/sessions', '/collection/:id' ] dyanimicRoutes.forEach((route) => router.get(route, (req, res) => res.sendFile(Path.join(distPath, 'index.html')))) router.post('/login', this.getLoginRateLimiter(), (req, res) => this.auth.login(req, res, this.rssFeedManager.feedsArray)) router.post('/logout', this.authMiddleware.bind(this), this.logout.bind(this)) router.post('/init', (req, res) => { if (this.db.hasRootUser) { Logger.error(`[Server] attempt to init server when server already has a root user`) return res.sendStatus(500) } this.initializeServer(req, res) }) router.get('/status', (req, res) => { // status check for client to see if server has been initialized // server has been initialized if a root user exists const payload = { isInit: this.db.hasRootUser, language: this.db.serverSettings.language } if (!payload.isInit) { payload.ConfigPath = global.ConfigPath payload.MetadataPath = global.MetadataPath } res.json(payload) }) router.get('/ping', (req, res) => { Logger.info('Received ping') res.json({ success: true }) }) app.get('/healthcheck', (req, res) => res.sendStatus(200)) this.server.listen(this.Port, this.Host, () => { Logger.info(`Listening on http://${this.Host}:${this.Port}`) }) this.io = new SocketIO.Server(this.server, { cors: { origin: '*', methods: ["GET", "POST"] } }) this.io.on('connection', (socket) => { this.clients[socket.id] = { id: socket.id, socket, connected_at: Date.now() } socket.sheepClient = this.clients[socket.id] Logger.info('[Server] Socket Connected', socket.id) socket.on('auth', (token) => this.authenticateSocket(socket, token)) // Scanning socket.on('cancel_scan', this.cancelScan.bind(this)) // Logs socket.on('set_log_listener', (level) => Logger.addSocketListener(socket, level)) socket.on('remove_log_listener', () => Logger.removeSocketListener(socket.id)) socket.on('fetch_daily_logs', () => this.logManager.socketRequestDailyLogs(socket)) socket.on('ping', () => { var client = this.clients[socket.id] || {} var user = client.user || {} Logger.debug(`[Server] Received ping from socket ${user.username || 'No User'}`) socket.emit('pong') }) socket.on('disconnect', (reason) => { Logger.removeSocketListener(socket.id) var _client = this.clients[socket.id] if (!_client) { Logger.warn(`[Server] Socket ${socket.id} disconnect, no client (Reason: ${reason})`) } else if (!_client.user) { Logger.info(`[Server] Unauth socket ${socket.id} disconnected (Reason: ${reason})`) delete this.clients[socket.id] } else { Logger.debug('[Server] User Offline ' + _client.user.username) this.io.emit('user_offline', _client.user.toJSONForPublic(this.playbackSessionManager.sessions, this.db.libraryItems)) const disconnectTime = Date.now() - _client.connected_at Logger.info(`[Server] Socket ${socket.id} disconnected from client "${_client.user.username}" after ${disconnectTime}ms (Reason: ${reason})`) delete this.clients[socket.id] } }) }) } async initializeServer(req, res) { Logger.info(`[Server] Initializing new server`) const newRoot = req.body.newRoot let rootPash = newRoot.password ? await this.auth.hashPass(newRoot.password) : '' if (!rootPash) Logger.warn(`[Server] Creating root user with no password`) let rootToken = await this.auth.generateAccessToken({ userId: 'root', username: newRoot.username }) await this.db.createRootUser(newRoot.username, rootPash, rootToken) res.sendStatus(200) } async filesChanged(fileUpdates) { Logger.info('[Server]', fileUpdates.length, 'Files Changed') await this.scanner.scanFilesChanged(fileUpdates) } cancelScan(id) { Logger.debug('[Server] Cancel scan', id) this.scanner.setCancelLibraryScan(id) } // Remove unused /metadata/items/{id} folders async purgeMetadata() { var itemsMetadata = Path.join(global.MetadataPath, 'items') if (!(await fs.pathExists(itemsMetadata))) return var foldersInItemsMetadata = await fs.readdir(itemsMetadata) var purged = 0 await Promise.all(foldersInItemsMetadata.map(async foldername => { var hasMatchingItem = this.db.libraryItems.find(ab => ab.id === foldername) if (!hasMatchingItem) { var folderPath = Path.join(itemsMetadata, foldername) Logger.debug(`[Server] Purging unused metadata ${folderPath}`) await fs.remove(folderPath).then(() => { purged++ }).catch((err) => { Logger.error(`[Server] Failed to delete folder path ${folderPath}`, err) }) } })) if (purged > 0) { Logger.info(`[Server] Purged ${purged} unused library item metadata`) } return purged } // Remove user media progress with items that no longer exist & remove seriesHideFrom that no longer exist async cleanUserData() { for (let i = 0; i < this.db.users.length; i++) { var _user = this.db.users[i] var hasUpdated = false if (_user.mediaProgress.length) { const lengthBefore = _user.mediaProgress.length _user.mediaProgress = _user.mediaProgress.filter(mp => { const libraryItem = this.db.libraryItems.find(li => li.id === mp.libraryItemId) if (!libraryItem) return false if (mp.episodeId && (libraryItem.mediaType !== 'podcast' || !libraryItem.media.checkHasEpisode(mp.episodeId))) return false // Episode not found return true }) if (lengthBefore > _user.mediaProgress.length) { Logger.debug(`[Server] Removing ${_user.mediaProgress.length - lengthBefore} media progress data from user ${_user.username}`) hasUpdated = true } } if (_user.seriesHideFromContinueListening.length) { _user.seriesHideFromContinueListening = _user.seriesHideFromContinueListening.filter(seriesId => { if (!this.db.series.some(se => se.id === seriesId)) { // Series removed hasUpdated = true return false } return true }) } if (hasUpdated) { await this.db.updateEntity('user', _user) } } } // First time login rate limit is hit loginLimitReached(req, res, options) { Logger.error(`[Server] Login rate limit (${options.max}) was hit for ip ${req.ip}`) options.message = 'Too many attempts. Login temporarily locked.' } getLoginRateLimiter() { return rateLimit({ windowMs: this.db.serverSettings.rateLimitLoginWindow, // 5 minutes max: this.db.serverSettings.rateLimitLoginRequests, skipSuccessfulRequests: true, onLimitReached: this.loginLimitReached }) } logout(req, res) { var { socketId } = req.body Logger.info(`[Server] User ${req.user ? req.user.username : 'Unknown'} is logging out with socket ${socketId}`) // Strip user and client from client and client socket if (socketId && this.clients[socketId]) { var client = this.clients[socketId] var clientSocket = client.socket Logger.debug(`[Server] Found user client ${clientSocket.id}, Has user: ${!!client.user}, Socket has client: ${!!clientSocket.sheepClient}`) if (client.user) { Logger.debug('[Server] User Offline ' + client.user.username) this.io.emit('user_offline', client.user.toJSONForPublic(null, this.db.libraryItems)) } delete this.clients[socketId].user if (clientSocket && clientSocket.sheepClient) delete this.clients[socketId].socket.sheepClient } else if (socketId) { Logger.warn(`[Server] No client for socket ${socketId}`) } res.sendStatus(200) } async authenticateSocket(socket, token) { var user = await this.auth.authenticateUser(token) if (!user) { Logger.error('Cannot validate socket - invalid token') return socket.emit('invalid_token') } var client = this.clients[socket.id] if (client.user !== undefined) { Logger.debug(`[Server] Authenticating socket client already has user`, client.user.username) } client.user = user if (!client.user.toJSONForBrowser) { Logger.error('Invalid user...', client.user) return } Logger.debug(`[Server] User Online ${client.user.username}`) this.io.emit('user_online', client.user.toJSONForPublic(this.playbackSessionManager.sessions, this.db.libraryItems)) user.lastSeen = Date.now() await this.db.updateEntity('user', user) const initialPayload = { metadataPath: global.MetadataPath, configPath: global.ConfigPath, user: client.user.toJSONForBrowser(), librariesScanning: this.scanner.librariesScanning, backups: (this.backupManager.backups || []).map(b => b.toJSON()) } if (user.type === 'root') { initialPayload.usersOnline = this.getUsersOnline() } client.socket.emit('init', initialPayload) } async stop() { await this.watcher.close() Logger.info('Watcher Closed') return new Promise((resolve) => { this.server.close((err) => { if (err) { Logger.error('Failed to close server', err) } else { Logger.info('Server successfully closed') } resolve() }) }) } } module.exports = Server