401 lines
14 KiB
JavaScript
401 lines
14 KiB
JavaScript
const Path = require('path')
|
|
const fs = require('../libs/fsExtra')
|
|
const Logger = require('../Logger')
|
|
const { recurseFiles, getFileTimestampsWithIno } = require('./fileUtils')
|
|
const globals = require('./globals')
|
|
const LibraryFile = require('../objects/files/LibraryFile')
|
|
|
|
function isMediaFile(mediaType, ext) {
|
|
if (!ext) return false
|
|
var extclean = ext.slice(1).toLowerCase()
|
|
if (mediaType === 'podcast') return globals.SupportedAudioTypes.includes(extclean)
|
|
else if (mediaType === 'video') return globals.SupportedVideoTypes.includes(extclean)
|
|
return globals.SupportedAudioTypes.includes(extclean) || globals.SupportedEbookTypes.includes(extclean)
|
|
}
|
|
|
|
// TODO: Function needs to be re-done
|
|
// Input: array of relative file paths
|
|
// Output: map of files grouped into potential item dirs
|
|
function groupFilesIntoLibraryItemPaths(mediaType, paths) {
|
|
// Step 1: Clean path, Remove leading "/", Filter out non-media files in root dir
|
|
var nonMediaFilePaths = []
|
|
var pathsFiltered = paths.map(path => {
|
|
return path.startsWith('/') ? path.slice(1) : path
|
|
}).filter(path => {
|
|
let parsedPath = Path.parse(path)
|
|
// Is not in root dir OR is a book media file
|
|
if (parsedPath.dir) {
|
|
if (!isMediaFile(mediaType, parsedPath.ext)) { // Seperate out non-media files
|
|
nonMediaFilePaths.push(path)
|
|
return false
|
|
}
|
|
return true
|
|
} else if (mediaType === 'book' && isMediaFile(mediaType, parsedPath.ext)) { // (book media type supports single file audiobooks/ebooks in root dir)
|
|
return true
|
|
}
|
|
return false
|
|
})
|
|
|
|
// Step 2: Sort by least number of directories
|
|
pathsFiltered.sort((a, b) => {
|
|
var pathsA = Path.dirname(a).split('/').length
|
|
var pathsB = Path.dirname(b).split('/').length
|
|
return pathsA - pathsB
|
|
})
|
|
|
|
// Step 3: Group files in dirs
|
|
var itemGroup = {}
|
|
pathsFiltered.forEach((path) => {
|
|
var dirparts = Path.dirname(path).split('/').filter(p => !!p && p !== '.') // dirname returns . if no directory
|
|
var numparts = dirparts.length
|
|
var _path = ''
|
|
|
|
if (!numparts) {
|
|
// Media file in root
|
|
itemGroup[path] = path
|
|
} else {
|
|
// Iterate over directories in path
|
|
for (let i = 0; i < numparts; i++) {
|
|
var dirpart = dirparts.shift()
|
|
_path = Path.posix.join(_path, dirpart)
|
|
|
|
if (itemGroup[_path]) { // Directory already has files, add file
|
|
var relpath = Path.posix.join(dirparts.join('/'), Path.basename(path))
|
|
itemGroup[_path].push(relpath)
|
|
return
|
|
} else if (!dirparts.length) { // This is the last directory, create group
|
|
itemGroup[_path] = [Path.basename(path)]
|
|
return
|
|
} else if (dirparts.length === 1 && /^cd\d{1,3}$/i.test(dirparts[0])) { // Next directory is the last and is a CD dir, create group
|
|
itemGroup[_path] = [Path.posix.join(dirparts[0], Path.basename(path))]
|
|
return
|
|
}
|
|
}
|
|
}
|
|
})
|
|
|
|
// Step 4: Add in non-media files if they fit into item group
|
|
if (nonMediaFilePaths.length) {
|
|
for (const nonMediaFilePath of nonMediaFilePaths) {
|
|
const pathDir = Path.dirname(nonMediaFilePath)
|
|
if (itemGroup[pathDir]) {
|
|
itemGroup[pathDir].push(nonMediaFilePath)
|
|
}
|
|
}
|
|
}
|
|
|
|
return itemGroup
|
|
}
|
|
module.exports.groupFilesIntoLibraryItemPaths = groupFilesIntoLibraryItemPaths
|
|
|
|
// Input: array of relative file items (see recurseFiles)
|
|
// Output: map of files grouped into potential libarary item dirs
|
|
function groupFileItemsIntoLibraryItemDirs(mediaType, fileItems) {
|
|
// Step 1: Filter out non-book-media files in root dir (with depth of 0)
|
|
var itemsFiltered = fileItems.filter(i => {
|
|
return i.deep > 0 || ((mediaType === 'book' || mediaType === 'video') && isMediaFile(mediaType, i.extension))
|
|
})
|
|
|
|
// Step 2: Seperate media files and other files
|
|
// - Directories without a media file will not be included
|
|
var mediaFileItems = []
|
|
var otherFileItems = []
|
|
itemsFiltered.forEach(item => {
|
|
if (isMediaFile(mediaType, item.extension)) mediaFileItems.push(item)
|
|
else otherFileItems.push(item)
|
|
})
|
|
|
|
// Step 3: Group audio files in library items
|
|
var libraryItemGroup = {}
|
|
mediaFileItems.forEach((item) => {
|
|
var dirparts = item.reldirpath.split('/').filter(p => !!p)
|
|
var numparts = dirparts.length
|
|
var _path = ''
|
|
|
|
if (!dirparts.length) {
|
|
// Media file in root
|
|
libraryItemGroup[item.name] = item.name
|
|
} else {
|
|
// Iterate over directories in path
|
|
for (let i = 0; i < numparts; i++) {
|
|
var dirpart = dirparts.shift()
|
|
_path = Path.posix.join(_path, dirpart)
|
|
|
|
if (libraryItemGroup[_path]) { // Directory already has files, add file
|
|
var relpath = Path.posix.join(dirparts.join('/'), item.name)
|
|
libraryItemGroup[_path].push(relpath)
|
|
return
|
|
} else if (!dirparts.length) { // This is the last directory, create group
|
|
libraryItemGroup[_path] = [item.name]
|
|
return
|
|
} else if (dirparts.length === 1 && /^cd\d{1,3}$/i.test(dirparts[0])) { // Next directory is the last and is a CD dir, create group
|
|
libraryItemGroup[_path] = [Path.posix.join(dirparts[0], item.name)]
|
|
return
|
|
}
|
|
}
|
|
}
|
|
})
|
|
|
|
// Step 4: Add other files into library item groups
|
|
otherFileItems.forEach((item) => {
|
|
var dirparts = item.reldirpath.split('/')
|
|
var numparts = dirparts.length
|
|
var _path = ''
|
|
|
|
// Iterate over directories in path
|
|
for (let i = 0; i < numparts; i++) {
|
|
var dirpart = dirparts.shift()
|
|
_path = Path.posix.join(_path, dirpart)
|
|
if (libraryItemGroup[_path]) { // Directory is audiobook group
|
|
var relpath = Path.posix.join(dirparts.join('/'), item.name)
|
|
libraryItemGroup[_path].push(relpath)
|
|
return
|
|
}
|
|
}
|
|
})
|
|
return libraryItemGroup
|
|
}
|
|
|
|
function cleanFileObjects(libraryItemPath, files) {
|
|
return Promise.all(files.map(async (file) => {
|
|
var filePath = Path.posix.join(libraryItemPath, file)
|
|
var newLibraryFile = new LibraryFile()
|
|
await newLibraryFile.setDataFromPath(filePath, file)
|
|
return newLibraryFile
|
|
}))
|
|
}
|
|
|
|
// Scan folder
|
|
async function scanFolder(libraryMediaType, folder, serverSettings = {}) {
|
|
var folderPath = folder.fullPath.replace(/\\/g, '/')
|
|
|
|
var pathExists = await fs.pathExists(folderPath)
|
|
if (!pathExists) {
|
|
Logger.error(`[scandir] Invalid folder path does not exist "${folderPath}"`)
|
|
return []
|
|
}
|
|
|
|
var fileItems = await recurseFiles(folderPath)
|
|
var libraryItemGrouping = groupFileItemsIntoLibraryItemDirs(libraryMediaType, fileItems)
|
|
|
|
if (!Object.keys(libraryItemGrouping).length) {
|
|
Logger.error(`Root path has no media folders: ${folderPath}`)
|
|
return []
|
|
}
|
|
|
|
var items = []
|
|
for (const libraryItemPath in libraryItemGrouping) {
|
|
var isFile = false // item is not in a folder
|
|
var libraryItemData = null
|
|
var fileObjs = []
|
|
if (libraryItemPath === libraryItemGrouping[libraryItemPath]) {
|
|
// Media file in root only get title
|
|
libraryItemData = {
|
|
mediaMetadata: {
|
|
title: Path.basename(libraryItemPath, Path.extname(libraryItemPath))
|
|
},
|
|
path: Path.posix.join(folderPath, libraryItemPath),
|
|
relPath: libraryItemPath
|
|
}
|
|
fileObjs = await cleanFileObjects(folderPath, [libraryItemPath])
|
|
isFile = true
|
|
} else {
|
|
libraryItemData = getDataFromMediaDir(libraryMediaType, folderPath, libraryItemPath, serverSettings)
|
|
fileObjs = await cleanFileObjects(libraryItemData.path, libraryItemGrouping[libraryItemPath])
|
|
}
|
|
|
|
var libraryItemFolderStats = await getFileTimestampsWithIno(libraryItemData.path)
|
|
items.push({
|
|
folderId: folder.id,
|
|
libraryId: folder.libraryId,
|
|
ino: libraryItemFolderStats.ino,
|
|
mtimeMs: libraryItemFolderStats.mtimeMs || 0,
|
|
ctimeMs: libraryItemFolderStats.ctimeMs || 0,
|
|
birthtimeMs: libraryItemFolderStats.birthtimeMs || 0,
|
|
path: libraryItemData.path,
|
|
relPath: libraryItemData.relPath,
|
|
isFile,
|
|
media: {
|
|
metadata: libraryItemData.mediaMetadata || null
|
|
},
|
|
libraryFiles: fileObjs
|
|
})
|
|
}
|
|
return items
|
|
}
|
|
module.exports.scanFolder = scanFolder
|
|
|
|
// Input relative filepath, output all details that can be parsed
|
|
function getBookDataFromDir(folderPath, relPath, parseSubtitle = false) {
|
|
relPath = relPath.replace(/\\/g, '/')
|
|
var splitDir = relPath.split('/')
|
|
|
|
var folder = splitDir.pop() // Audio files will always be in the directory named for the title
|
|
series = (splitDir.length > 1) ? splitDir.pop() : null // If there are at least 2 more directories, next furthest will be the series
|
|
author = (splitDir.length > 0) ? splitDir.pop() : null // There could be many more directories, but only the top 3 are used for naming /author/series/title/
|
|
|
|
// The may contain various other pieces of metadata, these functions extract it.
|
|
var [folder, narrators] = getNarrator(folder)
|
|
var [folder, sequence] = series ? getSequence(folder) : [folder, null]
|
|
var [folder, publishedYear] = getPublishedYear(folder)
|
|
var [title, subtitle] = parseSubtitle ? getSubtitle(folder) : [folder, null]
|
|
|
|
return {
|
|
mediaMetadata: {
|
|
author,
|
|
title,
|
|
subtitle,
|
|
series,
|
|
sequence,
|
|
publishedYear,
|
|
narrators,
|
|
},
|
|
relPath: relPath, // relative audiobook path i.e. /Author Name/Book Name/..
|
|
path: Path.posix.join(folderPath, relPath) // i.e. /audiobook/Author Name/Book Name/..
|
|
}
|
|
}
|
|
module.exports.getBookDataFromDir = getBookDataFromDir
|
|
|
|
function getNarrator(folder) {
|
|
let pattern = /^(?<title>.*) \{(?<narrators>.*)\}$/
|
|
let match = folder.match(pattern)
|
|
return match ? [match.groups.title, match.groups.narrators] : [folder, null]
|
|
}
|
|
|
|
function getSequence(folder) {
|
|
// Valid ways of including a volume number:
|
|
// [
|
|
// 'Book 2 - Title - Subtitle',
|
|
// 'Title - Subtitle - Vol 12',
|
|
// 'Title - volume 9 - Subtitle',
|
|
// 'Vol. 3 Title Here - Subtitle',
|
|
// '1980 - Book 2 - Title',
|
|
// 'Volume 12. Title - Subtitle',
|
|
// '100 - Book Title',
|
|
// '2 - Book Title',
|
|
// '6. Title',
|
|
// '0.5 - Book Title'
|
|
// ]
|
|
|
|
// Matches a valid volume string. Also matches a book whose title starts with a 1 to 3 digit number. Will handle that later.
|
|
let pattern = /^(?<volumeLabel>vol\.? |volume |book )?(?<sequence>\d{0,3}(?:\.\d{1,2})?)(?<trailingDot>\.?)(?: (?<suffix>.*))?$/i
|
|
|
|
let volumeNumber = null
|
|
let parts = folder.split(' - ')
|
|
for (let i = 0; i < parts.length; i++) {
|
|
let match = parts[i].match(pattern)
|
|
// This excludes '101 Dalmations' but includes '101. Dalmations'
|
|
if (match && !(match.groups.suffix && !(match.groups.volumeLabel || match.groups.trailingDot))) {
|
|
volumeNumber = isNaN(match.groups.sequence) ? match.groups.sequence : Number(match.groups.sequence).toString()
|
|
parts[i] = match.groups.suffix
|
|
if (!parts[i]) { parts.splice(i, 1) }
|
|
break
|
|
}
|
|
}
|
|
|
|
folder = parts.join(' - ')
|
|
return [folder, volumeNumber]
|
|
}
|
|
|
|
function getPublishedYear(folder) {
|
|
var publishedYear = null
|
|
|
|
pattern = /^ *\(?([0-9]{4})\)? * - *(.+)/ //Matches #### - title or (####) - title
|
|
var match = folder.match(pattern)
|
|
if (match) {
|
|
publishedYear = match[1]
|
|
folder = match[2]
|
|
}
|
|
|
|
return [folder, publishedYear]
|
|
}
|
|
|
|
function getSubtitle(folder) {
|
|
// Subtitle is everything after " - "
|
|
var splitTitle = folder.split(' - ')
|
|
return [splitTitle.shift(), splitTitle.join(' - ')]
|
|
}
|
|
|
|
function getPodcastDataFromDir(folderPath, relPath) {
|
|
relPath = relPath.replace(/\\/g, '/')
|
|
var splitDir = relPath.split('/')
|
|
|
|
// Audio files will always be in the directory named for the title
|
|
var title = splitDir.pop()
|
|
return {
|
|
mediaMetadata: {
|
|
title
|
|
},
|
|
relPath: relPath, // relative audiobook path i.e. /Author Name/Book Name/..
|
|
path: Path.posix.join(folderPath, relPath) // i.e. /audiobook/Author Name/Book Name/..
|
|
}
|
|
}
|
|
|
|
function getDataFromMediaDir(libraryMediaType, folderPath, relPath, serverSettings) {
|
|
if (libraryMediaType === 'podcast') {
|
|
return getPodcastDataFromDir(folderPath, relPath)
|
|
} else if (libraryMediaType === 'book') {
|
|
var parseSubtitle = !!serverSettings.scannerParseSubtitle
|
|
return getBookDataFromDir(folderPath, relPath, parseSubtitle)
|
|
} else {
|
|
return getPodcastDataFromDir(folderPath, relPath)
|
|
}
|
|
}
|
|
|
|
// Called from Scanner.js
|
|
async function getLibraryItemFileData(libraryMediaType, folder, libraryItemPath, isSingleMediaItem, serverSettings = {}) {
|
|
libraryItemPath = libraryItemPath.replace(/\\/g, '/')
|
|
var folderFullPath = folder.fullPath.replace(/\\/g, '/')
|
|
|
|
var libraryItemDir = libraryItemPath.replace(folderFullPath, '').slice(1)
|
|
var libraryItemData = {}
|
|
|
|
var fileItems = []
|
|
|
|
if (isSingleMediaItem) { // Single media item in root of folder
|
|
fileItems = [
|
|
{
|
|
fullpath: libraryItemPath,
|
|
path: libraryItemDir // actually the relPath (only filename here)
|
|
}
|
|
]
|
|
libraryItemData = {
|
|
path: libraryItemPath, // full path
|
|
relPath: libraryItemDir, // only filename
|
|
mediaMetadata: {
|
|
title: Path.basename(libraryItemDir, Path.extname(libraryItemDir))
|
|
}
|
|
}
|
|
} else {
|
|
fileItems = await recurseFiles(libraryItemPath)
|
|
libraryItemData = getDataFromMediaDir(libraryMediaType, folderFullPath, libraryItemDir, serverSettings)
|
|
}
|
|
|
|
var libraryItemDirStats = await getFileTimestampsWithIno(libraryItemData.path)
|
|
var libraryItem = {
|
|
ino: libraryItemDirStats.ino,
|
|
mtimeMs: libraryItemDirStats.mtimeMs || 0,
|
|
ctimeMs: libraryItemDirStats.ctimeMs || 0,
|
|
birthtimeMs: libraryItemDirStats.birthtimeMs || 0,
|
|
folderId: folder.id,
|
|
libraryId: folder.libraryId,
|
|
path: libraryItemData.path,
|
|
relPath: libraryItemData.relPath,
|
|
isFile: isSingleMediaItem,
|
|
media: {
|
|
metadata: libraryItemData.mediaMetadata || null
|
|
},
|
|
libraryFiles: []
|
|
}
|
|
|
|
for (let i = 0; i < fileItems.length; i++) {
|
|
var fileItem = fileItems[i]
|
|
var newLibraryFile = new LibraryFile()
|
|
// fileItem.path is the relative path
|
|
await newLibraryFile.setDataFromPath(fileItem.fullpath, fileItem.path)
|
|
libraryItem.libraryFiles.push(newLibraryFile)
|
|
}
|
|
return libraryItem
|
|
}
|
|
module.exports.getLibraryItemFileData = getLibraryItemFileData
|