const Path = require('path') const serverVersion = require('../../package.json').version const Logger = require('../Logger') const SocketAuthority = require('../SocketAuthority') const date = require('../libs/dateAndTime') const fs = require('../libs/fsExtra') const uaParserJs = require('../libs/uaParser') const requestIp = require('../libs/requestIp') const { PlayMethod } = require('../utils/constants') const PlaybackSession = require('../objects/PlaybackSession') const DeviceInfo = require('../objects/DeviceInfo') const Stream = require('../objects/Stream') class PlaybackSessionManager { constructor(db) { this.db = db this.StreamsPath = Path.join(global.MetadataPath, 'streams') this.sessions = [] } getSession(sessionId) { return this.sessions.find(s => s.id === sessionId) } getUserSession(userId) { return this.sessions.find(s => s.userId === userId) } getStream(sessionId) { const session = this.getSession(sessionId) return session?.stream || null } getDeviceInfo(req) { const ua = uaParserJs(req.headers['user-agent']) const ip = requestIp.getClientIp(req) const clientDeviceInfo = req.body?.deviceInfo || null const deviceInfo = new DeviceInfo() deviceInfo.setData(ip, ua, clientDeviceInfo, serverVersion) return deviceInfo } async startSessionRequest(req, res, episodeId) { const deviceInfo = this.getDeviceInfo(req) Logger.debug(`[PlaybackSessionManager] startSessionRequest for device ${deviceInfo.deviceDescription}`) const { user, libraryItem, body: options } = req const session = await this.startSession(user, deviceInfo, libraryItem, episodeId, options) res.json(session.toJSONForClient(libraryItem)) } async syncSessionRequest(user, session, payload, res) { if (await this.syncSession(user, session, payload)) { res.sendStatus(200) } else { res.sendStatus(500) } } async syncLocalSessionsRequest(req, res) { const user = req.user const sessions = req.body.sessions || [] const syncResults = [] for (const sessionJson of sessions) { Logger.info(`[PlaybackSessionManager] Syncing local session "${sessionJson.displayTitle}" (${sessionJson.id})`) const result = await this.syncLocalSession(user, sessionJson) syncResults.push(result) } res.json({ results: syncResults }) } async syncLocalSession(user, sessionJson) { const libraryItem = this.db.getLibraryItem(sessionJson.libraryItemId) const episode = (sessionJson.episodeId && libraryItem && libraryItem.isPodcast) ? libraryItem.media.getEpisode(sessionJson.episodeId) : null if (!libraryItem || (libraryItem.isPodcast && !episode)) { Logger.error(`[PlaybackSessionManager] syncLocalSession: Media item not found for session "${sessionJson.displayTitle}" (${sessionJson.id})`) return { id: sessionJson.id, success: false, error: 'Media item not found' } } let session = await this.db.getPlaybackSession(sessionJson.id) if (!session) { // New session from local session = new PlaybackSession(sessionJson) Logger.debug(`[PlaybackSessionManager] Inserting new session for "${session.displayTitle}" (${session.id})`) await this.db.insertEntity('session', session) } else { session.currentTime = sessionJson.currentTime session.timeListening = sessionJson.timeListening session.updatedAt = sessionJson.updatedAt session.date = date.format(new Date(), 'YYYY-MM-DD') session.dayOfWeek = date.format(new Date(), 'dddd') Logger.debug(`[PlaybackSessionManager] Updated session for "${session.displayTitle}" (${session.id})`) await this.db.updateEntity('session', session) } const result = { id: session.id, success: true, progressSynced: false } const userProgressForItem = user.getMediaProgress(session.libraryItemId, session.episodeId) if (userProgressForItem) { if (userProgressForItem.lastUpdate > session.updatedAt) { Logger.debug(`[PlaybackSessionManager] Not updating progress for "${session.displayTitle}" because it has been updated more recently`) } else { Logger.debug(`[PlaybackSessionManager] Updating progress for "${session.displayTitle}" with current time ${session.currentTime} (previously ${userProgressForItem.currentTime})`) result.progressSynced = user.createUpdateMediaProgress(libraryItem, session.mediaProgressObject, session.episodeId) } } else { Logger.debug(`[PlaybackSessionManager] Creating new media progress for media item "${session.displayTitle}"`) result.progressSynced = user.createUpdateMediaProgress(libraryItem, session.mediaProgressObject, session.episodeId) } // Update user and emit socket event if (result.progressSynced) { await this.db.updateEntity('user', user) const itemProgress = user.getMediaProgress(session.libraryItemId, session.episodeId) SocketAuthority.clientEmitter(user.id, 'user_item_progress_updated', { id: itemProgress.id, sessionId: session.id, deviceDescription: session.deviceDescription, data: itemProgress.toJSON() }) } return result } async syncLocalSessionRequest(user, sessionJson, res) { const result = await this.syncLocalSession(user, sessionJson) if (result.error) { res.status(500).send(result.error) } else { res.sendStatus(200) } } async closeSessionRequest(user, session, syncData, res) { await this.closeSession(user, session, syncData) res.sendStatus(200) } async startSession(user, deviceInfo, libraryItem, episodeId, options) { // Close any sessions already open for user and device const userSessions = this.sessions.filter(playbackSession => playbackSession.userId === user.id && playbackSession.deviceId === deviceInfo.deviceId) for (const session of userSessions) { Logger.info(`[PlaybackSessionManager] startSession: Closing open session "${session.displayTitle}" for user "${user.username}" (Device: ${session.deviceDescription})`) await this.closeSession(user, session, null) } const shouldDirectPlay = options.forceDirectPlay || (!options.forceTranscode && libraryItem.media.checkCanDirectPlay(options, episodeId)) const mediaPlayer = options.mediaPlayer || 'unknown' const userProgress = libraryItem.isMusic ? null : user.getMediaProgress(libraryItem.id, episodeId) let userStartTime = 0 if (userProgress) { if (userProgress.isFinished) { Logger.info(`[PlaybackSessionManager] Starting session for user "${user.username}" and resetting progress for finished item "${libraryItem.media.metadata.title}"`) // Keep userStartTime as 0 so the client restarts the media } else { userStartTime = Number.parseFloat(userProgress.currentTime) || 0 } } const newPlaybackSession = new PlaybackSession() newPlaybackSession.setData(libraryItem, user, mediaPlayer, deviceInfo, userStartTime, episodeId) if (libraryItem.mediaType === 'video') { if (shouldDirectPlay) { Logger.debug(`[PlaybackSessionManager] "${user.username}" starting direct play session for item "${libraryItem.id}" with id ${newPlaybackSession.id}`) newPlaybackSession.videoTrack = libraryItem.media.getVideoTrack() newPlaybackSession.playMethod = PlayMethod.DIRECTPLAY } else { // HLS not supported for video yet } } else { let audioTracks = [] if (shouldDirectPlay) { Logger.debug(`[PlaybackSessionManager] "${user.username}" starting direct play session for item "${libraryItem.id}" with id ${newPlaybackSession.id} (Device: ${newPlaybackSession.deviceDescription})`) audioTracks = libraryItem.getDirectPlayTracklist(episodeId) newPlaybackSession.playMethod = PlayMethod.DIRECTPLAY } else { Logger.debug(`[PlaybackSessionManager] "${user.username}" starting stream session for item "${libraryItem.id}" (Device: ${newPlaybackSession.deviceDescription})`) const stream = new Stream(newPlaybackSession.id, this.StreamsPath, user, libraryItem, episodeId, userStartTime) await stream.generatePlaylist() stream.start() // Start transcode audioTracks = [stream.getAudioTrack()] newPlaybackSession.stream = stream newPlaybackSession.playMethod = PlayMethod.TRANSCODE stream.on('closed', () => { Logger.debug(`[PlaybackSessionManager] Stream closed for session "${newPlaybackSession.id}" (Device: ${newPlaybackSession.deviceDescription})`) newPlaybackSession.stream = null }) } newPlaybackSession.audioTracks = audioTracks } // Will save on the first sync user.currentSessionId = newPlaybackSession.id this.sessions.push(newPlaybackSession) SocketAuthority.adminEmitter('user_stream_update', user.toJSONForPublic(this.sessions, this.db.libraryItems)) return newPlaybackSession } async syncSession(user, session, syncData) { const libraryItem = this.db.libraryItems.find(li => li.id === session.libraryItemId) if (!libraryItem) { Logger.error(`[PlaybackSessionManager] syncSession Library Item not found "${session.libraryItemId}"`) return null } session.currentTime = syncData.currentTime session.addListeningTime(syncData.timeListened) Logger.debug(`[PlaybackSessionManager] syncSession "${session.id}" (Device: ${session.deviceDescription}) | Total Time Listened: ${session.timeListening}`) const itemProgressUpdate = { duration: syncData.duration, currentTime: syncData.currentTime, progress: session.progress } const wasUpdated = user.createUpdateMediaProgress(libraryItem, itemProgressUpdate, session.episodeId) if (wasUpdated) { await this.db.updateEntity('user', user) const itemProgress = user.getMediaProgress(session.libraryItemId, session.episodeId) SocketAuthority.clientEmitter(user.id, 'user_item_progress_updated', { id: itemProgress.id, sessionId: session.id, deviceDescription: session.deviceDescription, data: itemProgress.toJSON() }) } this.saveSession(session) return { libraryItem } } async closeSession(user, session, syncData = null) { if (syncData) { await this.syncSession(user, session, syncData) } else { await this.saveSession(session) } Logger.debug(`[PlaybackSessionManager] closeSession "${session.id}"`) SocketAuthority.adminEmitter('user_stream_update', user.toJSONForPublic(this.sessions, this.db.libraryItems)) SocketAuthority.clientEmitter(session.userId, 'user_session_closed', session.id) return this.removeSession(session.id) } saveSession(session) { if (!session.timeListening) return // Do not save a session with no listening time if (session.lastSave) { return this.db.updateEntity('session', session) } else { session.lastSave = Date.now() return this.db.insertEntity('session', session) } } async removeSession(sessionId) { const session = this.sessions.find(s => s.id === sessionId) if (!session) return if (session.stream) { await session.stream.close() } this.sessions = this.sessions.filter(s => s.id !== sessionId) Logger.debug(`[PlaybackSessionManager] Removed session "${sessionId}"`) } // Check for streams that are not in memory and remove async removeOrphanStreams() { await fs.ensureDir(this.StreamsPath) try { const streamsInPath = await fs.readdir(this.StreamsPath) for (let i = 0; i < streamsInPath.length; i++) { const streamId = streamsInPath[i] if (streamId.startsWith('play_')) { // Make sure to only remove folders that are a stream const session = this.sessions.find(se => se.id === streamId) if (!session) { const streamPath = Path.join(this.StreamsPath, streamId) Logger.debug(`[PlaybackSessionManager] Removing orphan stream "${streamPath}"`) await fs.remove(streamPath) } } } } catch (error) { Logger.error(`[PlaybackSessionManager] cleanOrphanStreams failed`, error) } } // Android app v0.9.54 and below had a bug where listening time was sending unix timestamp // See https://github.com/advplyr/audiobookshelf/issues/868 // Remove playback sessions with listening time too high async removeInvalidSessions() { const selectFunc = (session) => isNaN(session.timeListening) || Number(session.timeListening) > 36000000 const numSessionsRemoved = await this.db.removeEntities('session', selectFunc, true) if (numSessionsRemoved) { Logger.info(`[PlaybackSessionManager] Removed ${numSessionsRemoved} invalid playback sessions`) } } } module.exports = PlaybackSessionManager