PeerTube/server/models/video/thumbnail.ts

150 lines
3.3 KiB
TypeScript
Raw Normal View History

import { join } from 'path'
import {
AfterDestroy,
AllowNull,
BelongsTo,
Column,
CreatedAt,
DataType,
Default,
ForeignKey,
Model,
Table,
UpdatedAt
} from 'sequelize-typescript'
import { CONSTRAINTS_FIELDS, LAZY_STATIC_PATHS, STATIC_PATHS, WEBSERVER } from '../../initializers/constants'
import { logger } from '../../helpers/logger'
import { remove } from 'fs-extra'
import { CONFIG } from '../../initializers/config'
import { VideoModel } from './video'
import { VideoPlaylistModel } from './video-playlist'
import { ThumbnailType } from '../../../shared/models/videos/thumbnail.type'
import { MVideoAccountLight } from '@server/typings/models'
import { buildRemoteVideoBaseUrl } from '@server/helpers/activitypub'
@Table({
tableName: 'thumbnail',
indexes: [
{
fields: [ 'videoId' ]
},
{
fields: [ 'videoPlaylistId' ],
unique: true
}
]
})
export class ThumbnailModel extends Model<ThumbnailModel> {
@AllowNull(false)
@Column
filename: string
@AllowNull(true)
@Default(null)
@Column
height: number
@AllowNull(true)
@Default(null)
@Column
width: number
@AllowNull(false)
@Column
type: ThumbnailType
@AllowNull(true)
@Column(DataType.STRING(CONSTRAINTS_FIELDS.COMMONS.URL.max))
2019-04-24 10:28:57 +02:00
fileUrl: string
@AllowNull(true)
@Column
automaticallyGenerated: boolean
@ForeignKey(() => VideoModel)
@Column
videoId: number
@BelongsTo(() => VideoModel, {
foreignKey: {
allowNull: true
},
onDelete: 'CASCADE'
})
Video: VideoModel
@ForeignKey(() => VideoPlaylistModel)
@Column
videoPlaylistId: number
@BelongsTo(() => VideoPlaylistModel, {
foreignKey: {
allowNull: true
},
onDelete: 'CASCADE'
})
VideoPlaylist: VideoPlaylistModel
@CreatedAt
createdAt: Date
@UpdatedAt
updatedAt: Date
2020-01-31 16:56:52 +01:00
private static readonly types: { [ id in ThumbnailType ]: { label: string, directory: string, staticPath: string } } = {
2019-04-23 09:50:57 +02:00
[ThumbnailType.MINIATURE]: {
label: 'miniature',
directory: CONFIG.STORAGE.THUMBNAILS_DIR,
staticPath: STATIC_PATHS.THUMBNAILS
},
[ThumbnailType.PREVIEW]: {
label: 'preview',
directory: CONFIG.STORAGE.PREVIEWS_DIR,
2019-08-09 11:32:40 +02:00
staticPath: LAZY_STATIC_PATHS.PREVIEWS
}
}
@AfterDestroy
static removeFiles (instance: ThumbnailModel) {
logger.info('Removing %s file %s.', ThumbnailModel.types[instance.type].label, instance.filename)
// Don't block the transaction
instance.removeThumbnail()
.catch(err => logger.error('Cannot remove thumbnail file %s.', instance.filename, err))
}
2019-08-09 15:04:36 +02:00
static loadByName (filename: string) {
const query = {
where: {
filename
}
}
return ThumbnailModel.findOne(query)
}
static generateDefaultPreviewName (videoUUID: string) {
return videoUUID + '.jpg'
}
getFileUrl (video: MVideoAccountLight) {
const staticPath = ThumbnailModel.types[this.type].staticPath + this.filename
if (video.isOwned()) return WEBSERVER.URL + staticPath
if (this.fileUrl) return this.fileUrl
// Fallback if we don't have a file URL
return buildRemoteVideoBaseUrl(video, staticPath)
}
2019-05-16 16:55:34 +02:00
getPath () {
const directory = ThumbnailModel.types[this.type].directory
2019-05-16 16:55:34 +02:00
return join(directory, this.filename)
}
2019-05-16 16:55:34 +02:00
removeThumbnail () {
return remove(this.getPath())
}
}