filesafe/controllers/uploadController.js

const blake3 = require('blake3')
const contentDisposition = require('content-disposition')
const jetpack = require('fs-jetpack')
const parseDuration = require('parse-duration')
const path = require('path')
const randomstring = require('randomstring')
const searchQuery = require('search-query-parser')
const auth = require('./authController')
const paths = require('./pathsController')
const perms = require('./permissionController')
const utils = require('./utilsController')
const ClientError = require('./utils/ClientError')
const Constants = require('./utils/Constants')
const ScannerManager = require('./utils/ScannerManager')
const ServerError = require('./utils/ServerError')
const config = require('./utils/ConfigManager')
const logger = require('./../logger')

/** Deprecated config options */

if (config.uploads.cacheFileIdentifiers) {
  logger.error('Config option "uploads.cacheFileIdentifiers" is DEPRECATED.')
  logger.error('There is now only "uploads.queryDatabaseForIdentifierMatch" for a similar behavior.')
}

const self = {
  onHold: new Set() // temporarily held random upload identifiers
}

/** Preferences */

const fileIdentifierLengthFallback = 32
const fileIdentifierLengthChangeable = !config.uploads.fileIdentifierLength.force &&
  typeof config.uploads.fileIdentifierLength.min === 'number' &&
  typeof config.uploads.fileIdentifierLength.max === 'number'

// Regular file uploads
const maxSize = parseInt(config.uploads.maxSize)
const maxSizeBytes = maxSize * 1e6

// Max files (or URLs for URL uploads) per POST request
const maxFilesPerUpload = 20

// https://github.com/mscdex/busboy/tree/v1.6.0#exports
const busboyOptions = {
  // This would otherwise defaults to latin1
  defParamCharset: 'utf8',
  limits: {
    fileSize: maxSizeBytes,
    // Maximum number of non-file fields.
    // Dropzone.js will add 6 extra fields for chunked uploads.
    // We don't use them for anything else.
    fields: 6,
    // Maximum number of file fields.
    // Chunked uploads still need to provide ONLY 1 file field.
    // Otherwise, only one of the files will end up being properly stored,
    // and that will also be as a chunk.
    files: maxFilesPerUpload
  }
}

// URL uploads
const urlMaxSize = parseInt(config.uploads.urlMaxSize)
const urlMaxSizeBytes = urlMaxSize * 1e6

// URL uploads timeout for fetch() instances
// Please be aware that uWebSockets.js has a hard-coded timeout of 10s of no activity,
// so letting fetch() run for more than 10s may cause connection to uploaders to drop early,
// thus preventing lolisafe from responding to uploaders about their URL uploads.
const urlFetchTimeout = 10 * 1000 // 10 seconds

const chunkedUploads = config.uploads.chunkSize &&
  typeof config.uploads.chunkSize === 'object' &&
  config.uploads.chunkSize.default
const chunkedUploadsTimeout = config.uploads.chunkSize.timeout || 1800000
const chunksData = {}
// Hard-coded min chunk size of 1 MB (e.g. 50 MB = max 50 chunks)
const maxChunksCount = maxSize

const extensionsFilter = Array.isArray(config.extensionsFilter) &&
  config.extensionsFilter.length
const urlExtensionsFilter = Array.isArray(config.uploads.urlExtensionsFilter) &&
  config.uploads.urlExtensionsFilter.length

// Only disable hashing if explicitly disabled in config file
const enableHashing = config.uploads.hash === undefined
  ? true
  : Boolean(config.uploads.hash)

const queryDatabaseForIdentifierMatch = config.uploads.queryDatabaseForIdentifierMatch ||
  config.uploads.queryDbForFileCollisions // old config name for identical behavior

const uploadsPerPage = config.dashboard
  ? Math.max(Math.min(config.dashboard.uploadsPerPage || 0, 100), 1)
  : 25

/** Chunks helper class & function **/

class ChunksData {
  constructor (uuid) {
    this.uuid = uuid
    this.root = path.join(paths.chunks, this.uuid)
    this.filename = 'tmp'
    this.path = path.join(this.root, this.filename)
    this.chunks = 0
    this.writeStream = null
    this.hashStream = null
    // Immediately mark this chunked upload as currently processing
    this.processing = true
  }

  onTimeout () {
    self.cleanUpChunks(this.uuid)
  }

  setTimeout (delay) {
    this.clearTimeout()
    this._timeout = setTimeout(this.onTimeout.bind(this), delay)
  }

  clearTimeout () {
    if (this._timeout) {
      clearTimeout(this._timeout)
    }
  }
}

const initChunks = async uuid => {
  if (chunksData[uuid] === undefined) {
    chunksData[uuid] = new ChunksData(uuid)
    await jetpack.dirAsync(chunksData[uuid].root, { empty: true })

    // Init write & hasher streams
    chunksData[uuid].writeStream = jetpack.createWriteStream(chunksData[uuid].path, { flags: 'a' })
    chunksData[uuid].hashStream = enableHashing && blake3.createHash()
  } else if (chunksData[uuid].processing) {
    // Wait for the first spawned init tasks
    throw new ClientError('Previous chunk upload is still being processed. Parallel chunked uploads is not supported.')
  }

  // Reset timeout
  chunksData[uuid].setTimeout(chunkedUploadsTimeout)
  return chunksData[uuid]
}

/** Helper functions */

self.isExtensionFiltered = extname => {
  // If empty extension needs to be filtered
  if (!extname && config.filterNoExtension) return true

  // If there are extensions that have to be filtered
  if (extname && extensionsFilter) {
    const match = config.extensionsFilter.includes(extname.toLowerCase())
    const whitelist = config.extensionsFilterMode === 'whitelist'
    if ((!whitelist && match) || (whitelist && !match)) return true
  }

  return false
}

self.parseFileIdentifierLength = fileLength => {
  if (!config.uploads.fileIdentifierLength) return fileIdentifierLengthFallback

  const parsed = parseInt(fileLength)
  if (isNaN(parsed) ||
    !fileIdentifierLengthChangeable ||
    parsed < config.uploads.fileIdentifierLength.min ||
    parsed > config.uploads.fileIdentifierLength.max) {
    return config.uploads.fileIdentifierLength.default || fileIdentifierLengthFallback
  } else {
    return parsed
  }
}

self.getUniqueUploadIdentifier = async (length, extension = '', res) => {
  for (let i = 0; i < utils.idMaxTries; i++) {
    const identifier = randomstring.generate(length)

    if (queryDatabaseForIdentifierMatch) {
      // If must query database for identifiers matches
      if (self.onHold.has(identifier)) {
        logger.debug(`Identifier ${identifier} is currently held by another upload (${i + 1}/${utils.idMaxTries}).`)
        continue
      }

      // Put token on-hold (wait for it to be inserted to DB)
      self.onHold.add(identifier)

      const file = await utils.db.table('files')
        .whereRaw('?? like ?', ['name', `${identifier}.%`])
        .select('id')
        .first()
      if (file) {
        self.onHold.delete(identifier)
        logger.debug(`Identifier ${identifier} is already in use (${i + 1}/${utils.idMaxTries}).`)
        continue
      }

      /*
      if (utils.devmode) {
        logger.debug(`upload.onHold: ${utils.inspect(self.onHold)}`)
      }
      */

      // Unhold identifier once the Response has been sent
      if (res) {
        if (!res.locals.identifiers) {
          res.locals.identifiers = []
          res.once('finish', () => { self.unholdUploadIdentifiers(res) })
        }
        res.locals.identifiers.push(identifier)
      }
    } else {
      // Otherwise, check for physical files' full name matches
      const name = identifier + extension
      const exists = jetpack.existsAsync(path.join(paths.uploads, name))
      if (exists) {
        logger.debug(`${name} is already in use (${i + 1}/${utils.idMaxTries}).`)
        continue
      }
    }

    // Return the random identifier only
    return identifier
  }

  throw new ServerError('Failed to allocate a unique name for the upload. Try again?')
}

self.unholdUploadIdentifiers = res => {
  if (!res.locals.identifiers) return

  for (const identifier of res.locals.identifiers) {
    self.onHold.delete(identifier)

    /*
    if (utils.devmode) {
      logger.debug(`upload.onHold: ${utils.inspect(self.onHold)} -> ${utils.inspect(identifier)}`)
    }
    */
  }

  delete res.locals.identifiers
}

self.assertRetentionPeriod = (user, age) => {
  if (!utils.retentions.enabled) {
    return null
  }

  // _ is special key for non-registered users (no auth requests)
  const group = user ? perms.group(user) : '_'
  if (!group || !utils.retentions.periods[group]) {
    throw new ClientError('You are not eligible for any file retention periods.', { statusCode: 403 })
  }

  let parsed = parseFloat(age)
  if (Number.isNaN(parsed) || age < 0) {
    parsed = utils.retentions.default[group]
  } else if (!utils.retentions.periods[group].includes(parsed)) {
    throw new ClientError('You are not eligible for the specified file retention period.', { statusCode: 403 })
  }

  if (!parsed && !utils.retentions.periods[group].includes(0)) {
    throw new ClientError('Permanent uploads are not permitted.', { statusCode: 403 })
  }

  return parsed
}

self.parseStripTags = stripTags => {
  if (!config.uploads.stripTags) return false

  if (config.uploads.stripTags.force || stripTags === undefined) {
    return config.uploads.stripTags.default
  }

  return Boolean(parseInt(stripTags))
}

/** File uploads */

self.upload = async (req, res) => {
  // Assert Request type (skip for POST /nojs requests)
  let isMultipart = req.locals.nojs
  let isJson
  if (!req.locals.nojs) {
    // Multipart for regular uploads, JSON for URL uploads
    isMultipart = req.is('multipart/form-data')
    isJson = req.is('application/json')
    if (!isMultipart && !isJson) {
      throw new ClientError('Request Content-Type must be either multipart/form-data or application/json.')
    }
  }

  if (config.privateUploadGroup) {
    if (!req.locals.user || !perms.is(req.locals.user, config.privateUploadGroup)) {
      throw new ClientError(config.privateUploadCustomResponse || 'Your usergroup is not permitted to upload new files.', { statusCode: 403 })
    }
  }

  let albumid = parseInt(req.headers.albumid || (req.path_parameters && req.path_parameters.albumid))
  if (isNaN(albumid)) albumid = null

  const age = self.assertRetentionPeriod(req.locals.user, req.headers.age)

  if (isMultipart) {
    return self.actuallyUpload(req, res, { albumid, age })
  } else {
    // Parse POST body
    req.body = await req.json()
    return self.actuallyUploadUrls(req, res, { albumid, age })
  }
}

self.unfreezeChunksData = async (files = [], increase = false) => {
  for (const file of files) {
    if (!file.chunksData) return
    if (increase) file.chunksData.chunks++
    file.chunksData.processing = false
  }
}

self.cleanUpFiles = async (files = []) => {
  // Unlink temp files
  await Promise.all(files.map(async file => {
    if (file.chunksData) {
      return self.cleanUpChunks(file.chunksData.uuid).catch(logger.error)
    } else if (file.filename) {
      return utils.unlinkFile(file.filename).catch(logger.error)
    }
  }))
}

self.actuallyUpload = async (req, res, data = {}) => {
  // Init empty Request.body and Request.files
  req.body = {}
  req.files = []

  await req.multipart(busboyOptions, async field => {
    /*
      Keep non-files fields in body.
      Since fields get processed in sequence, depending on the order at which they were defined,
      chunked uploads data must be set before the "files[]"" field which contain the actual file.
    */
    if (field.truncated) {
      // Re-map Dropzone chunked uploads keys so people can manually use the API without prepending 'dz'
      let name = field.name
      if (name.startsWith('dz')) {
        name = name.replace(/^dz/, '')
      }

      req.body[name] = field.value || ''
      return
    }

    if (!field.file) return

    // Push immediately as we will only be adding props into the file object down the line
    const file = {
      field: field.name,
      albumid: data.albumid,
      age: data.age,
      originalname: field.file.name || '',
      mimetype: field.mime_type || 'application/octet-stream'
    }
    req.files.push(file)

    file.extname = utils.extname(file.originalname)

    const isChunk = typeof req.body.uuid === 'string' && Boolean(req.body.uuid)
    if (isChunk) {
      // Re-map UUID property to IP-specific UUID
      const uuid = `${utils.pathSafeIp(req.ip)}_${req.body.uuid}`
      // Calling initChunks() will also reset the chunked uploads' timeout
      file.chunksData = await initChunks(uuid)
      file.filename = file.chunksData.filename
      file.path = file.chunksData.path
    } else {
      const length = self.parseFileIdentifierLength(req.headers.filelength)
      const identifier = await self.getUniqueUploadIdentifier(length, file.extname, res)
      file.filename = identifier + file.extname
      file.path = path.join(paths.uploads, file.filename)
    }

    const readStream = field.file.stream
    let writeStream
    let hashStream
    let _reject

    // Write the file into disk, and supply required props into file object
    await new Promise((resolve, reject) => {
      // Keep reference to Promise's reject function to allow unlistening events from Promise.finally() block
      _reject = reject

      if (file.chunksData) {
        writeStream = file.chunksData.writeStream
        hashStream = file.chunksData.hashStream
      } else {
        writeStream = jetpack.createWriteStream(file.path)
        hashStream = enableHashing && blake3.createHash()
      }

      readStream.once('error', _reject)

      // Re-init stream errors listeners for this Request
      writeStream.once('error', _reject)

      if (hashStream) {
        hashStream.once('error', _reject)

        // Ensure readStream will only be resumed later down the line by readStream.pipe()
        // TODO: readStream.pause()
        readStream.on('data', data => {
          // .dispose() will destroy this internal component,
          // so use it as an indicator of whether the hashStream has been .dispose()'d
          if (hashStream.hash?.hash) {
            hashStream.update(data)
          }
        })
      }

      if (file.chunksData) {
        // We listen for readStream's end event
        readStream.once('end', () => resolve())
      } else {
        // We immediately listen for writeStream's finish event
        writeStream.once('finish', () => {
          file.size = writeStream.bytesWritten || 0
          if (hashStream?.hash?.hash) {
            const hash = hashStream.digest('hex')
            file.hash = file.size === 0 ? '' : hash
          }
          return resolve()
        })
      }

      // Pipe readStream to writeStream
      // Do not end writeStream when readStream finishes if it's a chunk upload
      readStream.pipe(writeStream, { end: !file.chunksData })
    }).catch(error => {
      // Dispose of unfinished write & hasher streams
      if (writeStream && !writeStream.destroyed) {
        writeStream.destroy()
      }
      if (hashStream?.hash?.hash) {
        hashStream.dispose()
      }

      // Re-throw error
      throw error
    }).finally(() => {
      if (!file.chunksData) return
      // Unlisten streams' error event for this Request if it's a chunk upload
      utils.unlistenEmitters([writeStream, hashStream], 'error', _reject)
    })
  }).catch(error => {
    // Clean up temp files and held identifiers (do not wait)
    self.cleanUpFiles(req.files)
    self.unfreezeChunksData(req.files)

    // Re-throw error
    if (typeof error === 'string') {
      // Response.multipart() itself may throw string errors
      throw new ClientError(error)
    } else {
      throw error
    }
  })

  if (!req.files.length) {
    throw new ClientError('No files.')
  }

  // Validate files
  try {
    for (const file of req.files) {
      if (file.field !== 'files[]') {
        throw new ClientError(`Unexpected file-type field: ${file.field}`)
      }

      if (self.isExtensionFiltered(file.extname)) {
        throw new ClientError(`${file.extname ? `${file.extname.substr(1).toUpperCase()} files` : 'Files with no extension'} are not permitted.`)
      }

      if (config.filterEmptyFile && file.size === 0) {
        throw new ClientError('Empty files are not allowed.')
      }
    }
  } catch (error) {
    // Clean up temp files and held identifiers (do not wait)
    self.cleanUpFiles(req.files)
    self.unfreezeChunksData(req.files)

    // Re-throw error
    throw error
  }

  // If chunked uploads is enabled and the uploaded file is a chunk, then just say that it was a success
  if (req.files.some(file => file.chunksData)) {
    self.unfreezeChunksData(req.files, true)
    return res.json({ success: true })
  }

  // If POST /nojs requests, additionally attempt to parse token from form input
  if (req.locals.nojs) {
    await new Promise((resolve, reject) => {
      auth.optionalUser(req, res, error => {
        if (error) return reject(error)
        return resolve()
      }, {
        token: req.body.token
      })
    })
  }

  const filesData = req.files

  if (ScannerManager.instance) {
    const scanResult = await self.scanFiles(req.locals.user, filesData)
    if (scanResult) {
      throw new ClientError(scanResult)
    }
  }

  // Strip tags, then update their size attribute, if required
  if (self.parseStripTags(req.headers.striptags)) {
    await self.stripTags(filesData)
  }

  const stored = await self.storeFilesToDb(req, res, filesData)
  return self.sendUploadResponse(req, res, stored)
}

/** URL uploads */

self.actuallyUploadUrls = async (req, res, data = {}) => {
  if (!config.uploads.urlMaxSize) {
    throw new ClientError('Upload by URLs is disabled at the moment.', { statusCode: 403 })
  }

  const urls = req.body.urls
  if (!Array.isArray(urls) || !urls.length || urls.some(url => !/^https?:\/\//.test(url))) {
    throw new ClientError('Bad request.')
  }

  if (urls.length > maxFilesPerUpload) {
    throw new ClientError(`Maximum ${maxFilesPerUpload} URLs at a time.`)
  }

  const assertSize = (size, isContentLength = false) => {
    if (config.filterEmptyFile && size === 0) {
      throw new ClientError('Empty files are not allowed.')
    } else if (size > urlMaxSizeBytes) {
      if (isContentLength) {
        throw new ClientError(`File too large. Content-Length header reports file is bigger than ${urlMaxSize} MB.`)
      } else {
        throw new ClientError(`File too large. File is bigger than ${urlMaxSize} MB.`)
      }
    }
  }

  const filesData = []

  await Promise.all(urls.map(async url => {
    // Push immediately as we will only be adding props into the file object down the line
    const file = {
      url,
      albumid: data.albumid,
      age: data.age
    }
    filesData.push(file)

    if (config.uploads.urlProxy) {
      url = config.uploads.urlProxy
        .replace(/{url}/g, encodeURIComponent(url))
        .replace(/{url-noprot}/g, encodeURIComponent(url.replace(/^https?:\/\//, '')))
    }

    // Try to determine size early via Content-Length header,
    // but continue anyway if it isn't a valid number (some servers don't provide them)
    const headStart = Date.now()
    try {
      const head = await utils.fetch(url, {
        method: 'HEAD',
        size: urlMaxSizeBytes, // limit max response body size
        timeout: urlFetchTimeout
      })

      if (head.status === 200) {
        const contentLength = parseInt(head.headers.get('content-length'))
        if (!Number.isNaN(contentLength)) {
          assertSize(contentLength, true)
        }
      }
    } catch (ex) {
      // Re-throw only if ClientError (can be thrown by assertSize()), otherwise ignore
      if (ex instanceof ClientError) {
        throw ex
      }
    }

    const length = self.parseFileIdentifierLength(req.headers.filelength)
    const identifier = await self.getUniqueUploadIdentifier(length, '.tmp', res)

    // Temporarily store to disk as a .tmp file
    file.filename = identifier + '.tmp'
    file.path = path.join(paths.uploads, file.filename)

    let writeStream
    let hashStream

    return Promise.resolve().then(async () => {
      writeStream = jetpack.createWriteStream(file.path)
      hashStream = enableHashing && blake3.createHash()

      // Reduce GET timeout by time already spent for HEAD request
      const _timeout = urlFetchTimeout - (Date.now() - headStart)

      // Skip early if HEAD fetch took too long
      if (_timeout <= 0) {
        throw new ClientError('Fetch timed out. Try again?')
      }

      const fetchFile = await utils.fetch(url, {
        method: 'GET',
        size: urlMaxSizeBytes, // limit max response body size
        timeout: _timeout
      })
        .then(res => new Promise((resolve, reject) => {
          if (res.status !== 200) {
            return resolve(res)
          }

          writeStream.once('error', reject)
          res.body.once('error', reject)

          if (hashStream) {
            hashStream.once('error', reject)
            res.body.pause()
            res.body.on('data', d => hashStream.update(d))
          }

          res.body.pipe(writeStream)
          writeStream.once('finish', () => resolve(res))
        }))
        .catch(ex => {
          // Re-throw node-fetch's errors as regular ClientError
          throw new ClientError(`${ex.code ? `${ex.code}: ` : ''}${ex.message}`)
        })

      if (fetchFile.status !== 200) {
        throw new ServerError(`${fetchFile.status} ${fetchFile.statusText}`)
      }

      // Re-test size via actual bytes written to physical file
      assertSize(writeStream.bytesWritten)

      // Try to determine filename from Content-Disposition header if available
      const contentDispositionHeader = fetchFile.headers.get('content-disposition')
      if (contentDispositionHeader) {
        const parsed = contentDisposition.parse(contentDispositionHeader)
        if (parsed && parsed.parameters) {
          file.originalname = parsed.parameters.filename
        }
      }

      if (!file.originalname) {
        file.originalname = path.basename(url).split(/[?#]/)[0]
      }

      file.extname = utils.extname(file.originalname)

      // Extensions filter
      let filtered = false
      if (urlExtensionsFilter && ['blacklist', 'whitelist'].includes(config.uploads.urlExtensionsFilterMode)) {
        const match = config.uploads.urlExtensionsFilter.includes(file.extname.toLowerCase())
        const whitelist = config.uploads.urlExtensionsFilterMode === 'whitelist'
        filtered = ((!whitelist && match) || (whitelist && !match))
      } else {
        filtered = self.isExtensionFiltered(file.extname)
      }

      if (filtered) {
        throw new ClientError(`${file.extname ? `${file.extname.substr(1).toUpperCase()} files` : 'Files with no extension'} are not permitted.`)
      }

      // Generate a new filename with actual extname
      // Also generate a new random identifier if required
      const _identifier = queryDatabaseForIdentifierMatch
        ? identifier
        : await self.getUniqueUploadIdentifier(length, file.extname, res)
      const _name = _identifier + file.extname

      // Move .tmp file to the new filename
      await jetpack.renameAsync(file.path, _name)

      // Then update the props with renewed information
      file.filename = _name
      file.path = path.join(paths.uploads, _name)

      // Finalize other file props
      const contentType = fetchFile.headers.get('content-type')
      file.mimetype = (contentType && contentType.split(';')[0]) || 'application/octet-stream'
      file.size = writeStream.bytesWritten
      file.hash = hashStream
        ? hashStream.digest('hex')
        : null
    }).catch(err => {
      // Dispose of unfinished write & hasher streams
      if (writeStream && !writeStream.destroyed) {
        writeStream.destroy()
      }
      if (hashStream?.hash?.hash) {
        hashStream.dispose()
      }

      // Re-throw errors
      throw err
    })
  })).catch(async error => {
    // Unlink temp files (do not wait)
    if (filesData.length) {
      Promise.all(filesData.map(async file => {
        if (!file.filename) return
        return utils.unlinkFile(file.filename).catch(logger.error)
      }))
    }

    // Re-throw errors
    throw error
  })

  if (ScannerManager.instance) {
    const scanResult = await self.scanFiles(req.locals.user, filesData)
    if (scanResult) {
      throw new ClientError(scanResult)
    }
  }

  const stored = await self.storeFilesToDb(req, res, filesData)
  return self.sendUploadResponse(req, res, stored)
}

/** Chunk uploads */

self.finishChunks = async (req, res) => {
  if (!chunkedUploads) {
    throw new ClientError('Chunked upload is disabled.', { statusCode: 403 })
  }

  const files = req.body.files
  if (!Array.isArray(files) || !files.length || files.some(file => {
    return typeof file !== 'object' || !file.uuid
  })) {
    throw new ClientError('Bad request.')
  }

  // Re-map UUID property to IP-specific UUID
  files.forEach(file => {
    file.uuid = `${utils.pathSafeIp(req.ip)}_${file.uuid}`
    file.chunksData = chunksData[file.uuid]
  })

  if (files.some(file => !file.chunksData || file.chunksData.processing)) {
    throw new ClientError('Invalid file UUID, chunks data had already timed out, or is still processing. Try again?')
  }

  return self.actuallyFinishChunks(req, res, files)
    .catch(error => {
      // Unlink temp files (do not wait)
      Promise.all(files.map(async file => {
        return self.cleanUpChunks(file.uuid).catch(logger.error)
      }))
      // Re-throw errors
      throw error
    })
}

self.actuallyFinishChunks = async (req, res, files) => {
  const filesData = []
  await Promise.all(files.map(async file => {
    // Suspend timeout
    // If the chunk errors out there, it will be immediately cleaned up anyway
    chunksData[file.uuid].clearTimeout()

    // Conclude write and hasher streams
    chunksData[file.uuid].writeStream.end()
    const bytesWritten = chunksData[file.uuid].writeStream.bytesWritten
    const hash = chunksData[file.uuid].hashStream
      ? chunksData[file.uuid].hashStream.digest('hex')
      : null

    if (chunksData[file.uuid].chunks < 2 || chunksData[file.uuid].chunks > maxChunksCount) {
      throw new ClientError('Invalid chunks count.')
    }

    const extname = typeof file.original === 'string' ? utils.extname(file.original) : ''
    if (self.isExtensionFiltered(extname)) {
      throw new ClientError(`${extname ? `${extname.substr(1).toUpperCase()} files` : 'Files with no extension'} are not permitted.`)
    }

    const age = self.assertRetentionPeriod(req.locals.user, file.age)

    let size = typeof file.size === 'number' ? file.size : undefined
    if (size === undefined) {
      size = bytesWritten
    } else if (size !== bytesWritten) {
      // If client reports actual total size, confirm match
      throw new ClientError(`Written bytes (${bytesWritten}) does not match actual size reported by client (${size}).`)
    }

    if (config.filterEmptyFile && size === 0) {
      throw new ClientError('Empty files are not allowed.')
    } else if (size > maxSizeBytes) {
      throw new ClientError(`File too large. Chunks are bigger than ${maxSize} MB.`)
    }

    const tmpfile = path.join(chunksData[file.uuid].root, chunksData[file.uuid].filename)

    // Double-check file size
    const stat = await jetpack.inspectAsync(tmpfile)
    if (stat.size !== size) {
      throw new ClientError(`Resulting physical file size (${stat.size}) does not match expected size (${size}).`)
    }

    // Generate name
    const length = self.parseFileIdentifierLength(file.filelength)
    const identifier = await self.getUniqueUploadIdentifier(length, extname, res)
    const name = identifier + extname

    // Move tmp file to final destination
    const destination = path.join(paths.uploads, name)
    await jetpack.moveAsync(tmpfile, destination)

    // Continue even when encountering errors
    await self.cleanUpChunks(file.uuid).catch(logger.error)

    let albumid = parseInt(file.albumid)
    if (isNaN(albumid)) {
      albumid = null
    }

    filesData.push({
      filename: name,
      originalname: file.original || '',
      extname,
      mimetype: file.type || 'application/octet-stream',
      path: destination,
      size,
      hash,
      albumid,
      age
    })
  }))

  if (ScannerManager.instance) {
    const scanResult = await self.scanFiles(req.locals.user, filesData)
    if (scanResult) {
      throw new ClientError(scanResult)
    }
  }

  // Strip tags, then update their size attribute, if required
  if (self.parseStripTags(req.headers.striptags)) {
    await self.stripTags(filesData)
  }

  const stored = await self.storeFilesToDb(req, res, filesData)
  return self.sendUploadResponse(req, res, stored)
}

self.cleanUpChunks = async uuid => {
  if (!uuid || !chunksData[uuid]) return

  // Dispose of unfinished write & hasher streams
  if (chunksData[uuid].writeStream && !chunksData[uuid].writeStream.destroyed) {
    chunksData[uuid].writeStream.destroy()
  }
  if (chunksData[uuid].hashStream?.hash?.hash) {
    chunksData[uuid].hashStream.dispose()
  }

  // Remove UUID dir and everything in it
  await jetpack.removeAsync(chunksData[uuid].root)

  // Delete cached chunks data
  delete chunksData[uuid]
}

/** Virus scanning (ClamAV) */

self.assertScanUserBypass = (user, filenames) => {
  if (!user || !ScannerManager.groupBypass) {
    return false
  }

  if (!Array.isArray(filenames)) {
    filenames = [filenames]
  }

  logger.debug(`[ClamAV]: ${filenames.join(', ')}: Skipped, uploaded by ${user.username} (${ScannerManager.groupBypass})`)
  return perms.is(user, ScannerManager.groupBypass)
}

self.assertScanFileBypass = data => {
  if (typeof data !== 'object' || !data.filename) {
    return false
  }

  const extname = data.extname || utils.extname(data.filename)
  if (ScannerManager.whitelistExtensions && ScannerManager.whitelistExtensions.includes(extname)) {
    logger.debug(`[ClamAV]: ${data.filename}: Skipped, extension whitelisted`)
    return true
  }

  if (ScannerManager.maxSize && data.size !== undefined && data.size > ScannerManager.maxSize) {
    logger.debug(`[ClamAV]: ${data.filename}: Skipped, size ${data.size} > ${ScannerManager.maxSize}`)
    return true
  }

  return false
}

self.scanFiles = async (user, filesData) => {
  const filenames = filesData.map(file => file.filename)
  if (self.assertScanUserBypass(user, filenames)) {
    return false
  }

  const foundThreats = []
  const unableToScan = []
  const result = await Promise.all(filesData.map(async file => {
    if (self.assertScanFileBypass(file)) return

    logger.debug(`[ClamAV]: ${file.filename}: Scanning\u2026`)
    const response = await ScannerManager.instance.isInfected(file.path)
    if (response.isInfected) {
      logger.log(`[ClamAV]: ${file.filename}: ${response.viruses.join(', ')}`)
      foundThreats.push(...response.viruses)
    } else if (response.isInfected === null) {
      logger.log(`[ClamAV]: ${file.filename}: Unable to scan`)
      unableToScan.push(file.filename)
    } else {
      logger.debug(`[ClamAV]: ${file.filename}: File is clean`)
    }
  })).then(() => {
    if (foundThreats.length) {
      const more = foundThreats.length > 1
      return `Threat${more ? 's' : ''} detected: ${foundThreats[0]}${more ? ', and more' : ''}.`
    } else if (unableToScan.length) {
      const more = unableToScan.length > 1
      return `Unable to scan: ${unableToScan[0]}${more ? ', and more' : ''}.`
    }
  }).catch(error => {
    logger.error(`[ClamAV]: ${filenames.join(', ')}: ${error.toString()}`)
    return 'An unexpected error occurred with ClamAV, please contact the site owner.'
  })

  if (result) {
    // Unlink temp files (do not wait)
    Promise.all(filesData.map(async file =>
      utils.unlinkFile(file.filename).catch(logger.error)
    ))
  }

  return result
}

/** Strip tags (EXIF, etc.) */

self.stripTags = async filesData => {
  try {
    await Promise.all(filesData.map(async file => {
      // Update size attribute if applicable
      const stat = await utils.stripTags(file.filename, file.extname)
      if (stat) {
        file.size = stat.size
      }
    }))
  } catch (error) {
    // Unlink temp files (do not wait)
    Promise.all(filesData.map(async file =>
      utils.unlinkFile(file.filename).catch(logger.error)
    ))

    // Re-throw error
    throw error
  }
}

/** Database functions */

self.storeFilesToDb = async (req, res, filesData) => {
  const stored = []
  const albumids = []

  // for-loop to prioritize sequential ordering over multiple async sub-tasks
  for (const file of filesData) {
    if (enableHashing) {
      // Check if the file exists by checking its hash and size
      const dbFile = await utils.db.table('files')
        .where(function () {
          if (req.locals.user) {
            this.where('userid', req.locals.user.id)
          } else {
            this.whereNull('userid')
          }
        })
        .where({
          hash: file.hash,
          size: String(file.size)
        })
        .first()

      if (dbFile) {
        // Continue even when encountering errors
        await utils.unlinkFile(file.filename).catch(logger.error)
        logger.debug(`Unlinked ${file.filename} since a duplicate named ${dbFile.name} exists`)

        // If on /nojs route, append original name reported by client,
        // instead of the actual original name from database
        if (req.path === '/nojs') {
          dbFile.original = file.originalname
        }

        stored.push({
          file: dbFile,
          repeated: true
        })
        continue
      }
    }

    const timestamp = Math.floor(Date.now() / 1000)
    const data = {
      name: file.filename,
      original: file.originalname,
      type: file.mimetype,
      size: String(file.size),
      hash: file.hash,
      // Only disable if explicitly set to false in config
      ip: config.uploads.storeIP !== false ? req.ip : null,
      timestamp
    }

    if (req.locals.user) {
      data.userid = req.locals.user.id
      data.albumid = file.albumid
      if (data.albumid !== null && !albumids.includes(data.albumid)) {
        albumids.push(data.albumid)
      }
    }

    if (file.age) {
      data.expirydate = data.timestamp + (file.age * 3600) // Hours to seconds
    }

    stored.push({ file: data })

    // Generate thumbs, but do not wait
    if (utils.mayGenerateThumb(file.extname)) {
      utils.generateThumbs(file.filename, file.extname, true).catch(logger.error)
    }
  }

  const fresh = stored.filter(entry => !entry.repeated)
  if (fresh.length) {
    // albumids should be empty if non-registerd users (no auth requests)
    let authorizedIds = []
    if (albumids.length) {
      authorizedIds = await utils.db.table('albums')
        .where({ userid: req.locals.user.id })
        .whereIn('id', albumids)
        .select('id')
        .then(rows => rows.map(row => row.id))

      // Remove albumid if user do not own the album
      for (const entry of fresh) {
        if (entry.file.albumid !== null && !authorizedIds.includes(entry.file.albumid)) {
          entry.file.albumid = null
        }
      }
    }

    await utils.db.transaction(async trx => {
      // Insert new files to DB
      await trx('files')
        .insert(fresh.map(entry => entry.file))
      utils.invalidateStatsCache('uploads')

      // Update albums' timestamp
      if (authorizedIds.length) {
        await trx('albums')
          .whereIn('id', authorizedIds)
          .update('editedAt', Math.floor(Date.now() / 1000))
        utils.deleteStoredAlbumRenders(authorizedIds)
      }
    })
  }

  return stored
}

/** Final response */

self.sendUploadResponse = async (req, res, stored) => {
  // Send response
  return res.json({
    success: true,
    files: stored.map(entry => {
      const map = {
        name: entry.file.name,
        original: entry.file.original,
        url: `${config.domain ? `${config.domain}/` : ''}${entry.file.name}`,
        hash: entry.file.hash,
        size: Number(entry.file.size)
      }

      // If a temporary upload, add expiry date
      if (entry.file.expirydate) {
        map.expirydate = entry.file.expirydate
      }

      // If on /nojs route, add original name
      if (req.path === '/nojs') {
        map.original = entry.file.original
      }

      // If uploaded by user, add delete URL (intended for ShareX and its derivatives)
      // Homepage uploader will not use this (use dashboard instead)
      if (req.locals.user) {
        map.deleteUrl = `${config.homeDomain || ''}/file/${entry.file.name}?delete`
      }

      if (entry.repeated) {
        map.repeated = true
      }

      return map
    })
  })
}

/** Delete uploads */

self.delete = async (req, res) => {
  // Re-map Request.body for .bulkDelete()
  // This is the legacy API used by lolisafe v3's frontend
  // Meanwhile this fork's frontend uses .bulkDelete() straight away
  const id = parseInt(req.body.id)
  req.body = {
    _legacy: true,
    field: 'id',
    values: isNaN(id) ? undefined : [id]
  }

  return self.bulkDelete(req, res)
}

self.bulkDelete = async (req, res) => {
  const field = req.body.field || 'id'
  const values = req.body.values

  if (!Array.isArray(values) || !values.length) {
    throw new ClientError('No array of files specified.')
  }

  const failed = await utils.bulkDeleteFromDb(field, values, req.locals.user)

  return res.json({ success: true, failed })
}

/** List uploads */

self.list = async (req, res) => {
  const all = req.headers.all === '1'
  const filters = req.headers.filters
  const minoffset = Number(req.headers.minoffset) || 0
  const ismoderator = perms.is(req.locals.user, 'moderator')
  if (all && !ismoderator) {
    return res.status(403).end()
  }

  const albumid = req.path_parameters && Number(req.path_parameters.albumid)
  const basedomain = config.domain

  // Thresholds for regular users (usergroups lower than moderator)
  const MAX_WILDCARDS_IN_KEY = 2
  const MAX_TEXT_QUERIES = 3 // non-keyed keywords
  const MAX_SORT_KEYS = 2
  const MAX_IS_KEYS = 1

  // Timezone offset
  let timezoneOffset = 0
  if (minoffset !== undefined) {
    timezoneOffset = 60000 * (utils.timezoneOffset - minoffset)
  }

  const filterObj = {
    uploaders: [],
    excludeUploaders: [],
    queries: {
      exclude: {}
    },
    typeIs: {
      image: Constants.IMAGE_EXTS,
      video: Constants.VIDEO_EXTS,
      audio: Constants.AUDIO_EXTS
    },
    flags: {}
  }
  const typeIsKeys = Object.keys(filterObj.typeIs)

  const sortObj = {
    // Cast columns to specific type if they are stored differently
    casts: {
      size: 'integer'
    },
    // Columns mapping
    maps: {
      date: 'timestamp',
      expiry: 'expirydate',
      originalname: 'original'
    },
    // Columns with which to use SQLite's NULLS LAST option
    nullsLast: [
      'userid',
      'type',
      'albumid',
      'expirydate',
      'ip'
    ],
    parsed: []
  }

  // Parse glob wildcards into SQL wildcards
  function sqlLikeParser (pattern) {
    // Escape SQL operators
    const escaped = pattern
      .replace(/(?<!\\)%/g, '\\%')
      .replace(/(?<!\\)_/g, '\\_')

    // Look for any glob operators
    const match = pattern.match(/(?<!\\)(\*|\?)/g)
    if (match && match.length) {
      return {
        count: match.length,
        // Replace glob operators with their SQL equivalents
        escaped: escaped
          .replace(/(?<!\\)\*/g, '%')
          .replace(/(?<!\\)\?/g, '_')
      }
    } else {
      return {
        count: 0,
        // Assume partial match
        escaped: `%${escaped}%`
      }
    }
  }

  if (filters) {
    const keywords = ['type']

    // Only allow filtering by 'albumid' when not listing a specific album's uploads
    if (isNaN(albumid)) {
      keywords.push('albumid')
    }

    // Only allow filtering by 'ip' and 'user' keys when listing all uploads
    if (all) {
      keywords.push('ip', 'user')
    }

    const ranges = [
      'date',
      'expiry'
    ]

    keywords.push('is', 'sort', 'orderby')
    filterObj.queries = searchQuery.parse(filters, {
      keywords,
      ranges,
      tokenize: true,
      alwaysArray: true,
      offsets: false
    })

    // Accept orderby as alternative for sort
    if (filterObj.queries.orderby) {
      if (!filterObj.queries.sort) filterObj.queries.sort = []
      filterObj.queries.sort.push(...filterObj.queries.orderby)
      delete filterObj.queries.orderby
    }

    // For some reason, single value won't be in Array even with 'alwaysArray' option
    if (typeof filterObj.queries.exclude.text === 'string') {
      filterObj.queries.exclude.text = [filterObj.queries.exclude.text]
    }

    // Text (non-keyed keywords) queries
    let textQueries = 0
    if (filterObj.queries.text) textQueries += filterObj.queries.text.length
    if (filterObj.queries.exclude.text) textQueries += filterObj.queries.exclude.text.length

    // Regular user threshold check
    if (!ismoderator && textQueries > MAX_TEXT_QUERIES) {
      throw new ClientError(`Users are only allowed to use ${MAX_TEXT_QUERIES} non-keyed keyword${MAX_TEXT_QUERIES === 1 ? '' : 's'} at a time.`)
    }

    if (filterObj.queries.text) {
      for (let i = 0; i < filterObj.queries.text.length; i++) {
        const result = sqlLikeParser(filterObj.queries.text[i])
        if (!ismoderator && result.count > MAX_WILDCARDS_IN_KEY) {
          throw new ClientError(`Users are only allowed to use ${MAX_WILDCARDS_IN_KEY} wildcard${MAX_WILDCARDS_IN_KEY === 1 ? '' : 's'} per key.`)
        }
        filterObj.queries.text[i] = result.escaped
      }
    }

    if (filterObj.queries.exclude.text) {
      for (let i = 0; i < filterObj.queries.exclude.text.length; i++) {
        const result = sqlLikeParser(filterObj.queries.exclude.text[i])
        if (!ismoderator && result.count > MAX_WILDCARDS_IN_KEY) {
          throw new ClientError(`Users are only allowed to use ${MAX_WILDCARDS_IN_KEY} wildcard${MAX_WILDCARDS_IN_KEY === 1 ? '' : 's'} per key.`)
        }
        filterObj.queries.exclude.text[i] = result.escaped
      }
    }

    for (const key of keywords) {
      let queryIndex = -1
      let excludeIndex = -1

      // Make sure keyword arrays only contain unique values
      if (filterObj.queries[key]) {
        filterObj.queries[key] = filterObj.queries[key].filter((v, i, a) => a.indexOf(v) === i)
        queryIndex = filterObj.queries[key].indexOf('-')
      }
      if (filterObj.queries.exclude[key]) {
        filterObj.queries.exclude[key] = filterObj.queries.exclude[key].filter((v, i, a) => a.indexOf(v) === i)
        excludeIndex = filterObj.queries.exclude[key].indexOf('-')
      }

      // Flag to match NULL values
      const inQuery = queryIndex !== -1
      const inExclude = excludeIndex !== -1
      if (inQuery || inExclude) {
        // Prioritize exclude keys when both types found
        filterObj.flags[`${key}Null`] = inExclude ? false : inQuery
        if (inQuery) {
          if (filterObj.queries[key].length === 1) {
            // Delete key to avoid unexpected behavior
            delete filterObj.queries[key]
          } else {
            filterObj.queries[key].splice(queryIndex, 1)
          }
        }
        if (inExclude) {
          if (filterObj.queries.exclude[key].length === 1) {
            // Delete key to avoid unexpected behavior
            delete filterObj.queries.exclude[key]
          } else {
            filterObj.queries.exclude[key].splice(excludeIndex, 1)
          }
        }
      }
    }

    const parseDate = (date, resetMs) => {
      // [YYYY][/MM][/DD] [HH][:MM][:SS]
      // e.g. 2020/01/01 00:00:00, 2018/01/01 06, 2019/11, 12:34:00
      const formattedMatch = date.match(/^(\d{4})?(\/\d{2})?(\/\d{2})?\s?(\d{2})?(:\d{2})?(:\d{2})?$/)
      if (formattedMatch) {
        const dateObj = new Date(Date.now() + timezoneOffset)

        if (formattedMatch[1] !== undefined) {
          dateObj.setFullYear(Number(formattedMatch[1]), // full year
            formattedMatch[2] !== undefined ? (Number(formattedMatch[2].slice(1)) - 1) : 0, // month, zero-based
            formattedMatch[3] !== undefined ? Number(formattedMatch[3].slice(1)) : 1) // date
        }

        if (formattedMatch[4] !== undefined) {
          dateObj.setHours(Number(formattedMatch[4]), // hours
            formattedMatch[5] !== undefined ? Number(formattedMatch[5].slice(1)) : 0, // minutes
            formattedMatch[6] !== undefined ? Number(formattedMatch[6].slice(1)) : 0) // seconds
        }

        if (resetMs) {
          dateObj.setMilliseconds(0)
        }

        // Calculate timezone differences
        return new Date(dateObj.getTime() - timezoneOffset)
      } else if (/^\d+$/.test(date)) {
        // Unix timestamps (always assume seconds resolution)
        return new Date(parseInt(date) * 1000)
      }
      return null
    }

    const parseRelativeDuration = (operator, duration, resetMs, inverse = false) => {
      let milliseconds = parseDuration(duration)
      if (isNaN(milliseconds) || typeof milliseconds !== 'number') {
        return null
      }

      let from = operator === '<'
      if (inverse) {
        // Intended for "expiry" column, as it essentially has to do the opposite
        from = !from
        milliseconds = -milliseconds
      }

      const dateObj = new Date(Date.now() + timezoneOffset - milliseconds)
      if (resetMs) {
        dateObj.setMilliseconds(0)
      }

      const range = { from: null, to: null }
      const offsetDateObj = new Date(dateObj.getTime() - timezoneOffset)
      if (from) {
        range.from = Math.floor(offsetDateObj / 1000)
      } else {
        range.to = Math.ceil(offsetDateObj / 1000)
      }
      return range
    }

    // Parse dates to timestamps
    for (const range of ranges) {
      if (filterObj.queries[range]) {
        if (filterObj.queries[range].from) {
          const relativeMatch = filterObj.queries[range].from.match(/^(<|>)(.*)$/)
          if (relativeMatch && relativeMatch[2]) {
            // Human-readable relative duration
            filterObj.queries[range] = parseRelativeDuration(relativeMatch[1], relativeMatch[2], true, (range === 'expiry'))
            continue
          } else {
            const parsed = parseDate(filterObj.queries[range].from, true)
            filterObj.queries[range].from = parsed ? Math.floor(parsed / 1000) : null
          }
        }
        if (filterObj.queries[range].to) {
          const parsed = parseDate(filterObj.queries[range].to, true)
          filterObj.queries[range].to = parsed ? Math.ceil(parsed / 1000) : null
        }
      }
    }

    // Query users table for user IDs
    if (filterObj.queries.user || filterObj.queries.exclude.user) {
      const usernames = []
      if (filterObj.queries.user) {
        usernames.push(...filterObj.queries.user)
      }
      if (filterObj.queries.exclude.user) {
        usernames.push(...filterObj.queries.exclude.user)
      }

      const uploaders = await utils.db.table('users')
        .whereIn('username', usernames)
        .select('id', 'username')

      // If no matches, or mismatched results
      if (!uploaders || (uploaders.length !== usernames.length)) {
        const notFound = usernames.filter(username => {
          return !uploaders.find(uploader => uploader.username === username)
        })
        if (notFound) {
          throw new ClientError(`User${notFound.length === 1 ? '' : 's'} not found: ${notFound.join(', ')}.`)
        }
      }

      for (const uploader of uploaders) {
        if (filterObj.queries.user && filterObj.queries.user.includes(uploader.username)) {
          filterObj.uploaders.push(uploader)
        } else {
          filterObj.excludeUploaders.push(uploader)
        }
      }

      // Delete keys to avoid unexpected behavior
      delete filterObj.queries.user
      delete filterObj.queries.exclude.user
    }

    // Parse sort keys
    if (filterObj.queries.sort) {
      const allowed = [
        'expirydate',
        'id',
        'name',
        'original',
        'size',
        'timestamp'
      ]

      // Only allow sorting by 'albumid' when not listing a specific album's uploads
      if (isNaN(albumid)) {
        allowed.push('albumid')
      }

      // Only allow sorting by 'ip' and 'userid' columns when listing all uploads
      if (all) {
        allowed.push('ip', 'userid')
      }

      for (const obQuery of filterObj.queries.sort) {
        const tmp = obQuery.toLowerCase().split(':')
        const column = sortObj.maps[tmp[0]] || tmp[0]

        if (!allowed.includes(column)) {
          // Alert users if using disallowed/missing columns
          throw new ClientError(`Column "${column}" cannot be used for sorting.\n\nTry the following instead:\n${allowed.join(', ')}`)
        }

        sortObj.parsed.push({
          column,
          order: (tmp[1] && /^d/i.test(tmp[1])) ? 'desc' : 'asc',
          clause: sortObj.nullsLast.includes(column) ? 'nulls last' : '',
          cast: sortObj.casts[column] || null
        })
      }

      // Regular user threshold check
      if (!ismoderator && sortObj.parsed.length > MAX_SORT_KEYS) {
        throw new ClientError(`Users are only allowed to use ${MAX_SORT_KEYS} sort key${MAX_SORT_KEYS === 1 ? '' : 's'} at a time.`)
      }

      // Delete key to avoid unexpected behavior
      delete filterObj.queries.sort
    }

    // Parse type-is keys
    if (filterObj.queries.is || filterObj.queries.exclude.is) {
      const types = []

      if (filterObj.queries.is) {
        filterObj.queries.is = filterObj.queries.is.map(type => type.toLowerCase())
        types.push(...filterObj.queries.is)
      }
      if (filterObj.queries.exclude.is) {
        filterObj.queries.exclude.is = filterObj.queries.exclude.is.map(type => type.toLowerCase())
        types.push(...filterObj.queries.exclude.is)
      }

      let isKeys = 0
      let isLast

      for (const type of types) {
        if (!typeIsKeys.includes(type)) {
          throw new ClientError(`Found invalid type-is key: ${type}.`)
        }

        if (filterObj.queries.is && filterObj.queries.is.includes(type)) {
          filterObj.flags[`is${type}`] = true
        } else {
          filterObj.flags[`is${type}`] = false
        }

        isKeys++

        if (isLast === undefined) {
          isLast = filterObj.flags[`is${type}`]
        } else if (filterObj.flags[`is${type}`] !== isLast) {
          throw new ClientError('Cannot mix inclusion and exclusion type-is keys.')
        }
      }

      // Regular user threshold check
      if (!ismoderator && isKeys > MAX_IS_KEYS) {
        throw new ClientError(`Users are only allowed to use ${MAX_IS_KEYS} type-is key${MAX_IS_KEYS === 1 ? '' : 's'} at a time.`)
      }

      // Delete keys to avoid unexpected behavior
      delete filterObj.queries.is
      delete filterObj.queries.exclude.is
    }
  }

  function filter () {
    // If listing all uploads
    if (all) {
      this.where(function () {
        // Filter uploads matching any of the supplied 'user' keys and/or NULL flag
        // Prioritze exclude keys when both types found
        this.orWhere(function () {
          if (filterObj.excludeUploaders.length) {
            this.whereNotIn('userid', filterObj.excludeUploaders.map(v => v.id))
          } else if (filterObj.uploaders.length) {
            this.orWhereIn('userid', filterObj.uploaders.map(v => v.id))
          }
          // Such overbearing logic for NULL values, smh...
          if ((filterObj.excludeUploaders.length && filterObj.flags.userNull !== false) ||
            (filterObj.uploaders.length && filterObj.flags.userNull) ||
            (!filterObj.excludeUploaders.length && !filterObj.uploaders.length && filterObj.flags.userNull)) {
            this.orWhereNull('userid')
          } else if (filterObj.flags.userNull === false) {
            this.whereNotNull('userid')
          }
        })

        // Filter uploads matching any of the supplied 'ip' keys and/or NULL flag
        // Same prioritization logic as above
        this.orWhere(function () {
          if (filterObj.queries.exclude.ip) {
            this.whereNotIn('ip', filterObj.queries.exclude.ip)
          } else if (filterObj.queries.ip) {
            this.orWhereIn('ip', filterObj.queries.ip)
          }
          // ...
          if ((filterObj.queries.exclude.ip && filterObj.flags.ipNull !== false) ||
            (filterObj.queries.ip && filterObj.flags.ipNull) ||
            (!filterObj.queries.exclude.ip && !filterObj.queries.ip && filterObj.flags.ipNull)) {
            this.orWhereNull('ip')
          } else if (filterObj.flags.ipNull === false) {
            this.whereNotNull('ip')
          }
        })
      })
    } else {
      // If not listing all uploads, list user's uploads
      this.where('userid', req.locals.user.id)
    }

    // Then, refine using any of the supplied 'albumid' keys and/or NULL flag
    // Same prioritization logic as 'userid' and 'ip' above
    if (isNaN(albumid)) {
      this.andWhere(function () {
        if (filterObj.queries.exclude.albumid) {
          this.whereNotIn('albumid', filterObj.queries.exclude.albumid)
        } else if (filterObj.queries.albumid) {
          this.orWhereIn('albumid', filterObj.queries.albumid)
        }
        // ...
        if ((filterObj.queries.exclude.albumid && filterObj.flags.albumidNull !== false) ||
          (filterObj.queries.albumid && filterObj.flags.albumidNull) ||
          (!filterObj.queries.exclude.albumid && !filterObj.queries.albumid && filterObj.flags.albumidNull)) {
          this.orWhereNull('albumid')
        } else if (filterObj.flags.albumidNull === false) {
          this.whereNotNull('albumid')
        }
      })
    } else if (!all) {
      // If not listing all uploads, list uploads from user's album
      this.andWhere('albumid', req.path_parameters.albumid)
    }

    // Then, refine using the supplied 'date' ranges
    this.andWhere(function () {
      if (!filterObj.queries.date ||
        (!filterObj.queries.date.from && !filterObj.queries.date.to)) {
        return
      }
      if (typeof filterObj.queries.date.from === 'number') {
        if (typeof filterObj.queries.date.to === 'number') {
          this.andWhereBetween('timestamp', [filterObj.queries.date.from, filterObj.queries.date.to])
        } else {
          this.andWhere('timestamp', '>=', filterObj.queries.date.from)
        }
      } else {
        this.andWhere('timestamp', '<=', filterObj.queries.date.to)
      }
    })

    // Then, refine using the supplied 'expiry' ranges
    this.andWhere(function () {
      if (!filterObj.queries.expiry ||
        (!filterObj.queries.expiry.from && !filterObj.queries.expiry.to)) {
        return
      }
      if (typeof filterObj.queries.expiry.from === 'number') {
        if (typeof filterObj.queries.expiry.to === 'number') {
          this.andWhereBetween('expirydate', [filterObj.queries.expiry.from, filterObj.queries.expiry.to])
        } else {
          this.andWhere('expirydate', '>=', filterObj.queries.expiry.from)
        }
      } else {
        this.andWhere('expirydate', '<=', filterObj.queries.expiry.to)
      }
    })

    // Then, refine using type-is flags
    this.andWhere(function () {
      for (const type of typeIsKeys) {
        let func
        let operator
        if (filterObj.flags[`is${type}`] === true) {
          func = 'orWhere'
          operator = 'like'
        } else if (filterObj.flags[`is${type}`] === false) {
          func = 'andWhere'
          operator = 'not like'
        }

        if (func) {
          for (const pattern of filterObj.typeIs[type].map(ext => `%${ext}`)) {
            this[func]('name', operator, pattern)
          }
        }
      }
    })

    // Then, refine using 'type' keys
    this.andWhere(function () {
      if (filterObj.queries.exclude.type) {
        this.whereNotIn('type', filterObj.queries.exclude.type)
      } else if (filterObj.queries.type) {
        this.orWhereIn('type', filterObj.queries.type)
      }
      // ...
      if ((filterObj.queries.exclude.type && filterObj.flags.typeNull !== false) ||
          (filterObj.queries.type && filterObj.flags.typeNull) ||
          (!filterObj.queries.exclude.type && !filterObj.queries.type && filterObj.flags.typeNull)) {
        this.orWhereNull('type')
      } else if (filterObj.flags.typeNull === false) {
        this.whereNotNull('type')
      }
    })

    // Then, refine using the supplied keywords against their file names
    this.andWhere(function () {
      if (!filterObj.queries.text) return
      for (const pattern of filterObj.queries.text) {
        this.orWhereRaw('?? like ? escape ?', ['name', pattern, '\\'])
        this.orWhereRaw('?? like ? escape ?', ['original', pattern, '\\'])
      }
    })

    // Finally, refine using the supplied exclusions against their file names
    this.andWhere(function () {
      if (!filterObj.queries.exclude.text) return
      for (const pattern of filterObj.queries.exclude.text) {
        this.andWhereRaw('?? not like ? escape ?', ['name', pattern, '\\'])
        this.andWhereRaw('?? not like ? escape ?', ['original', pattern, '\\'])
      }
    })
  }

  // Base result object
  const result = { success: true, files: [], uploadsPerPage, count: 0, basedomain }

  // Query uploads count for pagination
  result.count = await utils.db.table('files')
    .where(filter)
    .count('id as count')
    .then(rows => rows[0].count)
  if (!result.count) {
    return res.json(result)
  }

  let offset = req.path_parameters && Number(req.path_parameters.page)
  if (isNaN(offset)) {
    offset = 0
  } else if (offset < 0) {
    offset = Math.max(0, Math.ceil(result.count / uploadsPerPage) + offset)
  }

  // Database columns to query
  const columns = ['id', 'name', 'original', 'userid', 'size', 'timestamp']

  if (utils.retentions.enabled) {
    columns.push('expirydate')
  }

  const filterByAlbums = filterObj.queries.albumid ||
    filterObj.queries.exclude.albumid ||
    filterObj.flags.albumidNull !== undefined

  // If not listing all uploads, OR specifically filtering by album IDs
  if (!all || filterByAlbums) {
    columns.push('albumid')
  }

  // Only select IPs if we are listing all uploads
  if (all) {
    columns.push('ip')
  }

  // Build raw query for order by (sorting) operation
  let orderByRaw
  if (sortObj.parsed.length) {
    orderByRaw = sortObj.parsed.map(sort => {
      // Use Knex.raw() to sanitize user inputs
      if (sort.cast) {
        return utils.db.raw(`cast (?? as ${sort.cast}) ${sort.order} ${sort.clause}`.trim(), sort.column)
      } else {
        return utils.db.raw(`?? ${sort.order} ${sort.clause}`.trim(), sort.column)
      }
    }).join(', ')
  } else {
    orderByRaw = '`id` desc'
  }

  result.files = await utils.db.table('files')
    .where(filter)
    .orderByRaw(orderByRaw)
    .limit(uploadsPerPage)
    .offset(uploadsPerPage * offset)
    .select(columns)

  if (!result.files.length) {
    return res.json(result)
  }

  for (const file of result.files) {
    file.extname = utils.extname(file.name)
    if (utils.mayGenerateThumb(file.extname)) {
      let thumbext = '.png'
      if (file.extname === '.gif' && config.uploads.generateThumbs.animated) {
        thumbext = '.gif'
      }
      file.thumb = `thumbs/${file.name.slice(0, -file.extname.length)}${thumbext}`
    }
  }

  result.albums = {}

  // If not listing all uploads, OR specifically filtering by album IDs
  if (!all || filterByAlbums) {
    const albumids = result.files
      .map(file => file.albumid)
      .filter(utils.filterUniquifySqlArray)

    result.albums = await utils.db.table('albums')
      .where(function () {
        this.whereIn('id', albumids)

        // Only include data of disabled albums if listing all uploads
        // and filtering by album IDs
        if (!all) {
          this.andWhere('enabled', 1)
        }
      })
      .select('id', 'name', 'enabled')
      .then(rows => {
        // Build Object indexed by their IDs
        const obj = {}
        for (const row of rows) {
          obj[row.id] = row.name
        }
        return obj
      })

    // If filtering by album IDs,
    // then filter out uploads with missing albums data (assume disabled/deleted)
    if (filterByAlbums) {
      result.files = result.files.filter(file => result.albums[file.albumid] !== undefined)
    }
  }

  // If we are not listing all uploads, send response
  if (!all) {
    return res.json(result)
  }

  // Otherwise proceed to querying usernames
  let usersTable = filterObj.uploaders
  if (!usersTable.length) {
    const userids = result.files
      .map(file => file.userid)
      .filter(utils.filterUniquifySqlArray)

    // If there are no uploads attached to a registered user, send response
    if (!userids.length) {
      return res.json(result)
    }

    // Query usernames of user IDs from currently selected files
    usersTable = await utils.db.table('users')
      .whereIn('id', userids)
      .select('id', 'username')
  }

  result.users = {}

  for (const user of usersTable) {
    result.users[user.id] = user.username
  }

  return res.json(result)
}

/** Get file info */

self.get = async (req, res) => {
  const ismoderator = perms.is(req.locals.user, 'moderator')

  const identifier = req.path_parameters && req.path_parameters.identifier
  if (identifier === undefined) {
    throw new ClientError('No identifier provided.')
  }

  const file = await utils.db.table('files')
    .where('name', identifier)
    .where(function () {
      // Only allow moderators to get any files' information
      if (!ismoderator) {
        this.where('userid', req.locals.user.id)
      }
    })
    .first()

  if (!file) {
    throw new ClientError('File not found.', { statusCode: 404 })
  }

  return res.json({ success: true, file })
}

module.exports = self