PeerTube/server/scripts/prune-storage.ts

188 lines
5.8 KiB
TypeScript
Raw Normal View History

import Bluebird from 'bluebird'
import { remove } from 'fs-extra/esm'
import { readdir, stat } from 'fs/promises'
import { basename, join } from 'path'
import prompt from 'prompt'
import { uniqify } from '@peertube/peertube-core-utils'
import { ThumbnailType, ThumbnailType_Type } from '@peertube/peertube-models'
import { DIRECTORIES } from '@server/initializers/constants.js'
import { VideoFileModel } from '@server/models/video/video-file.js'
import { VideoStreamingPlaylistModel } from '@server/models/video/video-streaming-playlist.js'
import { getUUIDFromFilename } from '../server/helpers/utils.js'
import { CONFIG } from '../server/initializers/config.js'
import { initDatabaseModels } from '../server/initializers/database.js'
import { ActorImageModel } from '../server/models/actor/actor-image.js'
import { VideoRedundancyModel } from '../server/models/redundancy/video-redundancy.js'
import { ThumbnailModel } from '../server/models/video/thumbnail.js'
import { VideoModel } from '../server/models/video/video.js'
2018-05-29 11:11:52 +02:00
run()
.then(() => process.exit(0))
.catch(err => {
console.error(err)
process.exit(-1)
})
async function run () {
2022-08-17 15:36:03 +02:00
const dirs = Object.values(CONFIG.STORAGE)
2022-08-17 15:36:03 +02:00
if (uniqify(dirs).length !== dirs.length) {
console.error('Cannot prune storage because you put multiple storage keys in the same directory.')
process.exit(0)
}
2018-05-29 11:11:52 +02:00
await initDatabaseModels(true)
2019-08-09 15:04:36 +02:00
let toDelete: string[] = []
2018-05-29 11:11:52 +02:00
2021-04-28 08:56:08 +02:00
console.log('Detecting files to remove, it could take a while...')
2019-08-09 15:04:36 +02:00
toDelete = toDelete.concat(
await pruneDirectory(DIRECTORIES.VIDEOS.PUBLIC, doesWebVideoFileExist()),
await pruneDirectory(DIRECTORIES.VIDEOS.PRIVATE, doesWebVideoFileExist()),
2021-12-10 10:28:46 +01:00
await pruneDirectory(DIRECTORIES.HLS_STREAMING_PLAYLIST.PRIVATE, doesHLSPlaylistExist()),
await pruneDirectory(DIRECTORIES.HLS_STREAMING_PLAYLIST.PUBLIC, doesHLSPlaylistExist()),
2021-12-10 10:28:46 +01:00
2021-07-23 11:20:00 +02:00
await pruneDirectory(CONFIG.STORAGE.TORRENTS_DIR, doesTorrentFileExist()),
2018-09-28 10:56:13 +02:00
2019-08-09 15:04:36 +02:00
await pruneDirectory(CONFIG.STORAGE.REDUNDANCY_DIR, doesRedundancyExist),
2018-09-28 10:56:13 +02:00
await pruneDirectory(CONFIG.STORAGE.PREVIEWS_DIR, doesThumbnailExist(true, ThumbnailType.PREVIEW)),
await pruneDirectory(CONFIG.STORAGE.THUMBNAILS_DIR, doesThumbnailExist(false, ThumbnailType.MINIATURE)),
2019-08-09 15:04:36 +02:00
2023-07-11 11:23:51 +02:00
await pruneDirectory(CONFIG.STORAGE.ACTOR_IMAGES_DIR, doesActorImageExist)
2019-08-09 15:04:36 +02:00
)
2018-05-29 11:11:52 +02:00
2018-12-06 09:46:22 +01:00
const tmpFiles = await readdir(CONFIG.STORAGE.TMP_DIR)
toDelete = toDelete.concat(tmpFiles.map(t => join(CONFIG.STORAGE.TMP_DIR, t)))
2018-05-29 11:11:52 +02:00
if (toDelete.length === 0) {
console.log('No files to delete.')
return
}
console.log('Will delete %d files:\n\n%s\n\n', toDelete.length, toDelete.join('\n'))
const res = await askConfirmation()
if (res === true) {
console.log('Processing delete...\n')
for (const path of toDelete) {
2018-08-27 16:23:34 +02:00
await remove(path)
2018-05-29 11:11:52 +02:00
}
console.log('Done!')
} else {
console.log('Exiting without deleting files.')
}
}
type ExistFun = (file: string) => Promise<boolean> | boolean
2019-08-09 15:04:36 +02:00
async function pruneDirectory (directory: string, existFun: ExistFun) {
2018-08-27 16:23:34 +02:00
const files = await readdir(directory)
2018-05-29 11:11:52 +02:00
const toDelete: string[] = []
await Bluebird.map(files, async file => {
2021-07-23 11:20:00 +02:00
const filePath = join(directory, file)
if (await existFun(filePath) !== true) {
toDelete.push(filePath)
2019-08-09 15:04:36 +02:00
}
}, { concurrency: 20 })
return toDelete
}
function doesWebVideoFileExist () {
return (filePath: string) => {
// Don't delete private directory
if (filePath === DIRECTORIES.VIDEOS.PRIVATE) return true
return VideoFileModel.doesOwnedWebVideoFileExist(basename(filePath))
}
2021-07-23 11:20:00 +02:00
}
2018-05-29 11:11:52 +02:00
2021-12-10 10:28:46 +01:00
function doesHLSPlaylistExist () {
return (hlsPath: string) => {
// Don't delete private directory
if (hlsPath === DIRECTORIES.HLS_STREAMING_PLAYLIST.PRIVATE) return true
return VideoStreamingPlaylistModel.doesOwnedHLSPlaylistExist(basename(hlsPath))
}
2021-12-10 10:28:46 +01:00
}
2021-07-23 11:20:00 +02:00
function doesTorrentFileExist () {
return (filePath: string) => VideoFileModel.doesOwnedTorrentFileExist(basename(filePath))
2019-08-09 15:04:36 +02:00
}
2018-05-29 11:11:52 +02:00
function doesThumbnailExist (keepOnlyOwned: boolean, type: ThumbnailType_Type) {
2021-07-23 11:20:00 +02:00
return async (filePath: string) => {
const thumbnail = await ThumbnailModel.loadByFilename(basename(filePath), type)
2019-08-09 15:04:36 +02:00
if (!thumbnail) return false
if (keepOnlyOwned) {
const video = await VideoModel.load(thumbnail.videoId)
if (video.isOwned() === false) return false
2018-09-28 10:56:13 +02:00
}
2019-08-09 15:04:36 +02:00
return true
2018-05-29 11:11:52 +02:00
}
2019-08-09 15:04:36 +02:00
}
2018-05-29 11:11:52 +02:00
2021-07-23 11:20:00 +02:00
async function doesActorImageExist (filePath: string) {
const image = await ActorImageModel.loadByName(basename(filePath))
2019-08-09 15:04:36 +02:00
2021-04-06 11:35:56 +02:00
return !!image
2019-08-09 15:04:36 +02:00
}
2021-07-23 11:20:00 +02:00
async function doesRedundancyExist (filePath: string) {
const isPlaylist = (await stat(filePath)).isDirectory()
2019-08-09 15:04:36 +02:00
if (isPlaylist) {
// Don't delete HLS redundancy directory
if (filePath === DIRECTORIES.HLS_REDUNDANCY) return true
2021-09-02 15:10:30 +02:00
2021-07-23 11:20:00 +02:00
const uuid = getUUIDFromFilename(filePath)
const video = await VideoModel.loadWithFiles(uuid)
if (!video) return false
2019-08-09 15:04:36 +02:00
const p = video.getHLSPlaylist()
if (!p) return false
const redundancy = await VideoRedundancyModel.loadLocalByStreamingPlaylistId(p.id)
return !!redundancy
}
2021-07-23 11:20:00 +02:00
const file = await VideoFileModel.loadByFilename(basename(filePath))
if (!file) return false
2019-08-09 15:04:36 +02:00
2021-07-23 11:20:00 +02:00
const redundancy = await VideoRedundancyModel.loadLocalByFileId(file.id)
2019-08-09 15:04:36 +02:00
return !!redundancy
2018-05-29 11:11:52 +02:00
}
async function askConfirmation () {
return new Promise((res, rej) => {
prompt.start()
2018-05-29 11:11:52 +02:00
const schema = {
properties: {
confirm: {
type: 'string',
2018-09-28 10:56:13 +02:00
description: 'These following unused files can be deleted, but please check your backups first (bugs happen).' +
' Notice PeerTube must have been stopped when your ran this script.' +
2018-09-28 10:56:13 +02:00
' Can we delete these files?',
2018-05-29 11:11:52 +02:00
default: 'n',
required: true
}
}
}
prompt.get(schema, function (err, result) {
2018-05-29 11:11:52 +02:00
if (err) return rej(err)
2020-07-30 14:54:31 +02:00
return res(result.confirm?.match(/y/) !== null)
2018-05-29 11:11:52 +02:00
})
})
}