+import { remove } from 'fs-extra'
import { join } from 'path'
-import { AfterDestroy, AllowNull, BelongsTo, Column, CreatedAt, Default, ForeignKey, Model, Table, UpdatedAt } from 'sequelize-typescript'
-import { STATIC_PATHS, WEBSERVER } from '../../initializers/constants'
+import {
+ AfterDestroy,
+ AllowNull,
+ BeforeCreate,
+ BeforeUpdate,
+ BelongsTo,
+ Column,
+ CreatedAt,
+ DataType,
+ Default,
+ ForeignKey,
+ Model,
+ Table,
+ UpdatedAt
+} from 'sequelize-typescript'
+import { afterCommitIfTransaction } from '@server/helpers/database-utils'
+import { MThumbnail, MThumbnailVideo, MVideo } from '@server/types/models'
+import { AttributesOnly } from '@shared/typescript-utils'
+import { ThumbnailType } from '../../../shared/models/videos/thumbnail.type'
import { logger } from '../../helpers/logger'
-import { remove } from 'fs-extra'
import { CONFIG } from '../../initializers/config'
+import { CONSTRAINTS_FIELDS, LAZY_STATIC_PATHS, STATIC_PATHS, WEBSERVER } from '../../initializers/constants'
import { VideoModel } from './video'
import { VideoPlaylistModel } from './video-playlist'
-import { ThumbnailType } from '../../../shared/models/videos/thumbnail.type'
@Table({
tableName: 'thumbnail',
{
fields: [ 'videoPlaylistId' ],
unique: true
+ },
+ {
+ fields: [ 'filename', 'type' ],
+ unique: true
}
]
})
-export class ThumbnailModel extends Model<ThumbnailModel> {
+export class ThumbnailModel extends Model<Partial<AttributesOnly<ThumbnailModel>>> {
@AllowNull(false)
@Column
@Column
type: ThumbnailType
+ @AllowNull(true)
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.COMMONS.URL.max))
+ fileUrl: string
+
@AllowNull(true)
@Column
- url: string
+ automaticallyGenerated: boolean
@ForeignKey(() => VideoModel)
@Column
@UpdatedAt
updatedAt: Date
- private static types: { [ id in ThumbnailType ]: { label: string, directory: string, staticPath: string } } = {
- [ThumbnailType.THUMBNAIL]: {
- label: 'thumbnail',
+ // If this thumbnail replaced existing one, track the old name
+ previousThumbnailFilename: string
+
+ private static readonly types: { [ id in ThumbnailType ]: { label: string, directory: string, staticPath: string } } = {
+ [ThumbnailType.MINIATURE]: {
+ label: 'miniature',
directory: CONFIG.STORAGE.THUMBNAILS_DIR,
staticPath: STATIC_PATHS.THUMBNAILS
},
[ThumbnailType.PREVIEW]: {
label: 'preview',
directory: CONFIG.STORAGE.PREVIEWS_DIR,
- staticPath: STATIC_PATHS.PREVIEWS
+ staticPath: LAZY_STATIC_PATHS.PREVIEWS
}
}
+ @BeforeCreate
+ @BeforeUpdate
+ static removeOldFile (instance: ThumbnailModel, options) {
+ return afterCommitIfTransaction(options.transaction, () => instance.removePreviousFilenameIfNeeded())
+ }
+
@AfterDestroy
- static removeFilesAndSendDelete (instance: ThumbnailModel) {
+ static removeFiles (instance: ThumbnailModel) {
logger.info('Removing %s file %s.', ThumbnailModel.types[instance.type].label, instance.filename)
// Don't block the transaction
.catch(err => logger.error('Cannot remove thumbnail file %s.', instance.filename, err))
}
- static generateDefaultPreviewName (videoUUID: string) {
- return videoUUID + '.jpg'
+ static loadByFilename (filename: string, thumbnailType: ThumbnailType): Promise<MThumbnail> {
+ const query = {
+ where: {
+ filename,
+ type: thumbnailType
+ }
+ }
+
+ return ThumbnailModel.findOne(query)
}
- getUrl () {
- if (this.url) return this.url
+ static loadWithVideoByFilename (filename: string, thumbnailType: ThumbnailType): Promise<MThumbnailVideo> {
+ const query = {
+ where: {
+ filename,
+ type: thumbnailType
+ },
+ include: [
+ {
+ model: VideoModel.unscoped(),
+ required: true
+ }
+ ]
+ }
- const staticPath = ThumbnailModel.types[this.type].staticPath
- return WEBSERVER.URL + staticPath + this.filename
+ return ThumbnailModel.findOne(query)
+ }
+
+ static buildPath (type: ThumbnailType, filename: string) {
+ const directory = ThumbnailModel.types[type].directory
+
+ return join(directory, filename)
+ }
+
+ getFileUrl (video: MVideo) {
+ const staticPath = ThumbnailModel.types[this.type].staticPath + this.filename
+
+ if (video.isOwned()) return WEBSERVER.URL + staticPath
+
+ return this.fileUrl
+ }
+
+ getPath () {
+ return ThumbnailModel.buildPath(this.type, this.filename)
+ }
+
+ getPreviousPath () {
+ return ThumbnailModel.buildPath(this.type, this.previousThumbnailFilename)
}
removeThumbnail () {
- const directory = ThumbnailModel.types[this.type].directory
- const thumbnailPath = join(directory, this.filename)
+ return remove(this.getPath())
+ }
+
+ removePreviousFilenameIfNeeded () {
+ if (!this.previousThumbnailFilename) return
+
+ const previousPath = this.getPreviousPath()
+ remove(previousPath)
+ .catch(err => logger.error('Cannot remove previous thumbnail file %s.', previousPath, { err }))
- return remove(thumbnailPath)
+ this.previousThumbnailFilename = undefined
}
}