Fix ebook url #75, download other files #75, fix book icon disappearing #88, backups #87

server/BackupManager.js

@@ -0,0 +1,277 @@
+const Path = require('path')
+
+const cron = require('node-cron')
+const fs = require('fs-extra')
+const archiver = require('archiver')
+const StreamZip = require('node-stream-zip')
+
+// Utils
+const { getFileSize } = require('./utils/fileUtils')
+const filePerms = require('./utils/filePerms')
+const Logger = require('./Logger')
+
+const Backup = require('./objects/Backup')
+
+class BackupManager {
+  constructor(MetadataPath, Uid, Gid, db) {
+    this.MetadataPath = MetadataPath
+    this.BackupPath = Path.join(this.MetadataPath, 'backups')
+
+    this.Uid = Uid
+    this.Gid = Gid
+    this.db = db
+
+    this.backups = []
+  }
+
+  get serverSettings() {
+    return this.db.serverSettings || {}
+  }
+
+  async init(overrideCron = null) {
+    var backupsDirExists = await fs.pathExists(this.BackupPath)
+    if (!backupsDirExists) {
+      await fs.ensureDir(this.BackupPath)
+      await filePerms(this.BackupPath, 0o774, this.Uid, this.Gid)
+    }
+
+    await this.loadBackups()
+
+    if (!this.serverSettings.backupSchedule) {
+      Logger.info(`[BackupManager] Auto Backups are disabled`)
+      return
+    }
+    try {
+      var cronSchedule = overrideCron || this.serverSettings.backupSchedule
+      cron.schedule(cronSchedule, this.runBackup.bind(this))
+    } catch (error) {
+      Logger.error(`[BackupManager] Failed to schedule backup cron ${this.serverSettings.backupSchedule}`)
+    }
+  }
+
+  async uploadBackup(req, res) {
+    var backupFile = req.files.file
+    if (Path.extname(backupFile.name) !== '.audiobookshelf') {
+      Logger.error(`[BackupManager] Invalid backup file uploaded "${backupFile.name}"`)
+      return res.status(500).send('Invalid backup file')
+    }
+
+    var tempPath = Path.join(this.BackupPath, backupFile.name)
+    var success = await backupFile.mv(tempPath).then(() => true).catch((error) => {
+      Logger.error('[BackupManager] Failed to move backup file', path, error)
+      return false
+    })
+    if (!success) {
+      return res.status(500).send('Failed to move backup file into backups directory')
+    }
+
+    const zip = new StreamZip.async({ file: tempPath })
+    const data = await zip.entryData('details')
+    var details = data.toString('utf8').split('\n')
+
+    var backup = new Backup({ details, fullPath: tempPath })
+    backup.fileSize = await getFileSize(backup.fullPath)
+
+    var existingBackupIndex = this.backups.findIndex(b => b.id === backup.id)
+    if (existingBackupIndex >= 0) {
+      Logger.warn(`[BackupManager] Backup already exists with id ${backup.id} - overwriting`)
+      this.backups.splice(existingBackupIndex, 1, backup)
+    } else {
+      this.backups.push(backup)
+    }
+
+    return res.json(this.backups.map(b => b.toJSON()))
+  }
+
+  async requestCreateBackup(socket) {
+    // Only Root User allowed
+    var client = socket.sheepClient
+    if (!client || !client.user) {
+      Logger.error(`[BackupManager] Invalid user attempting to create backup`)
+      socket.emit('backup_complete', false)
+      return
+    } else if (!client.user.isRoot) {
+      Logger.error(`[BackupManager] Non-Root user attempting to create backup`)
+      socket.emit('backup_complete', false)
+      return
+    }
+
+    var backupSuccess = await this.runBackup()
+    socket.emit('backup_complete', backupSuccess ? this.backups.map(b => b.toJSON()) : false)
+  }
+
+  async requestApplyBackup(socket, id) {
+    // Only Root User allowed
+    var client = socket.sheepClient
+    if (!client || !client.user) {
+      Logger.error(`[BackupManager] Invalid user attempting to create backup`)
+      socket.emit('apply_backup_complete', false)
+      return
+    } else if (!client.user.isRoot) {
+      Logger.error(`[BackupManager] Non-Root user attempting to create backup`)
+      socket.emit('apply_backup_complete', false)
+      return
+    }
+
+    var backup = this.backups.find(b => b.id === id)
+    if (!backup) {
+      socket.emit('apply_backup_complete', false)
+      return
+    }
+    const zip = new StreamZip.async({ file: backup.fullPath })
+    await zip.extract('config/', this.db.ConfigPath)
+    if (backup.backupMetadataCovers) {
+      var metadataBooksPath = Path.join(this.MetadataPath, 'books')
+      await zip.extract('metadata-books/', metadataBooksPath)
+    }
+    await this.db.reinit()
+    socket.emit('apply_backup_complete', true)
+    socket.broadcast.emit('backup_applied')
+  }
+
+  async setLastBackup() {
+    this.backups.sort((a, b) => b.createdAt - a.createdAt)
+    var lastBackup = this.backups.shift()
+
+    const zip = new StreamZip.async({ file: lastBackup.fullPath })
+    await zip.extract('config/', this.db.ConfigPath)
+    console.log('Set Last Backup')
+    await this.db.reinit()
+  }
+
+  async loadBackups() {
+    try {
+      var filesInDir = await fs.readdir(this.BackupPath)
+      for (let i = 0; i < filesInDir.length; i++) {
+        var filename = filesInDir[i]
+        if (filename.endsWith('.audiobookshelf')) {
+          var fullFilePath = Path.join(this.BackupPath, filename)
+          const zip = new StreamZip.async({ file: fullFilePath })
+          const data = await zip.entryData('details')
+          var details = data.toString('utf8').split('\n')
+
+          var backup = new Backup({ details, fullPath: fullFilePath })
+          backup.fileSize = await getFileSize(backup.fullPath)
+          var existingBackupWithId = this.backups.find(b => b.id === backup.id)
+          if (existingBackupWithId) {
+            Logger.warn(`[BackupManager] Backup already loaded with id ${backup.id} - ignoring`)
+          } else {
+            this.backups.push(backup)
+          }
+
+
+          Logger.debug(`[BackupManager] Backup found "${backup.id}"`)
+          zip.close()
+        }
+      }
+      Logger.info(`[BackupManager] ${this.backups.length} Backups Found`)
+    } catch (error) {
+      Logger.error('[BackupManager] Failed to load backups', error)
+    }
+  }
+
+  async runBackup() {
+    Logger.info(`[BackupManager] Running Backup`)
+    var metadataBooksPath = this.serverSettings.backupMetadataCovers ? Path.join(this.MetadataPath, 'books') : null
+
+    var newBackup = new Backup()
+
+    const newBackData = {
+      backupMetadataCovers: this.serverSettings.backupMetadataCovers,
+      backupDirPath: this.BackupPath
+    }
+    newBackup.setData(newBackData)
+
+    var zipResult = await this.zipBackup(this.db.ConfigPath, metadataBooksPath, newBackup).then(() => true).catch((error) => {
+      Logger.error(`[BackupManager] Backup Failed ${error}`)
+      return false
+    })
+    if (zipResult) {
+      Logger.info(`[BackupManager] Backup successful ${newBackup.id}`)
+      await filePerms(newBackup.fullPath, 0o774, this.Uid, this.Gid)
+      newBackup.fileSize = await getFileSize(newBackup.fullPath)
+      var existingIndex = this.backups.findIndex(b => b.id === newBackup.id)
+      if (existingIndex >= 0) {
+        this.backups.splice(existingIndex, 1, newBackup)
+      } else {
+        this.backups.push(newBackup)
+      }
+
+      // Check remove oldest backup
+      if (this.backups.length > this.serverSettings.backupsToKeep) {
+        this.backups.sort((a, b) => a.createdAt - b.createdAt)
+
+        var oldBackup = this.backups.shift()
+        Logger.debug(`[BackupManager] Removing old backup ${oldBackup.id}`)
+        this.removeBackup(oldBackup)
+      }
+      return true
+    } else {
+      return false
+    }
+  }
+
+  async removeBackup(backup) {
+    try {
+      await fs.remove(backup.fullPath)
+      this.backups = this.backups.filter(b => b.id !== backup.id)
+      Logger.info(`[BackupManager] Backup "${backup.id}" Removed`)
+    } catch (error) {
+      Logger.error(`[BackupManager] Failed to remove backup`, error)
+    }
+  }
+
+  zipBackup(configPath, metadataBooksPath, backup) {
+    return new Promise((resolve, reject) => {
+      // create a file to stream archive data to
+      const output = fs.createWriteStream(backup.fullPath)
+      const archive = archiver('zip', {
+        zlib: { level: 9 } // Sets the compression level.
+      })
+
+      // listen for all archive data to be written
+      // 'close' event is fired only when a file descriptor is involved
+      output.on('close', () => {
+        Logger.info('[BackupManager]', archive.pointer() + ' total bytes')
+        resolve()
+      })
+
+      // This event is fired when the data source is drained no matter what was the data source.
+      // It is not part of this library but rather from the NodeJS Stream API.
+      // @see: https://nodejs.org/api/stream.html#stream_event_end
+      output.on('end', () => {
+        Logger.debug('Data has been drained')
+      })
+
+      // good practice to catch warnings (ie stat failures and other non-blocking errors)
+      archive.on('warning', function (err) {
+        if (err.code === 'ENOENT') {
+          // log warning
+          Logger.warn(`[BackupManager] Archiver warning: ${err.message}`)
+        } else {
+          // throw error
+          Logger.error(`[BackupManager] Archiver error: ${err.message}`)
+          // throw err
+          reject(err)
+        }
+      })
+      archive.on('error', function (err) {
+        Logger.error(`[BackupManager] Archiver error: ${err.message}`)
+        reject(err)
+      })
+
+      // pipe archive data to the file
+      archive.pipe(output)
+
+      archive.directory(configPath, 'config')
+      if (metadataBooksPath) {
+        Logger.debug(`[BackupManager] Backing up Metadata Books "${metadataBooksPath}"`)
+        archive.directory(metadataBooksPath, 'metadata-books')
+      }
+      archive.append(backup.detailsString, { name: 'details' })
+
+      archive.finalize()
+    })
+  }
+}
+module.exports = BackupManager