PeerTube/server/models/video/video-import.ts

268 lines
6.7 KiB
TypeScript
Raw Normal View History

import { IncludeOptions, Op, WhereOptions } from 'sequelize'
import {
2018-08-02 17:48:50 +02:00
AfterUpdate,
AllowNull,
BelongsTo,
Column,
CreatedAt,
DataType,
Default,
DefaultScope,
ForeignKey,
Is,
Model,
Table,
UpdatedAt
} from 'sequelize-typescript'
2021-05-11 11:15:29 +02:00
import { afterCommitIfTransaction } from '@server/helpers/database-utils'
2020-12-08 14:30:29 +01:00
import { MVideoImportDefault, MVideoImportFormattable } from '@server/types/models/video/video-import'
2021-12-24 10:14:47 +01:00
import { VideoImport, VideoImportState } from '@shared/models'
import { AttributesOnly } from '@shared/typescript-utils'
2020-12-08 14:30:29 +01:00
import { isVideoImportStateValid, isVideoImportTargetUrlValid } from '../../helpers/custom-validators/video-imports'
2018-08-06 17:13:39 +02:00
import { isVideoMagnetUriValid } from '../../helpers/custom-validators/videos'
2020-12-08 14:30:29 +01:00
import { CONSTRAINTS_FIELDS, VIDEO_IMPORT_STATES } from '../../initializers/constants'
2021-05-11 11:15:29 +02:00
import { UserModel } from '../user/user'
2023-01-10 11:09:30 +01:00
import { getSort, searchAttribute, throwIfNotValid } from '../shared'
2020-12-08 14:30:29 +01:00
import { ScopeNames as VideoModelScopeNames, VideoModel } from './video'
import { VideoChannelSyncModel } from './video-channel-sync'
const defaultVideoScope = () => {
return VideoModel.scope([
VideoModelScopeNames.WITH_ACCOUNT_DETAILS,
VideoModelScopeNames.WITH_TAGS,
VideoModelScopeNames.WITH_THUMBNAILS
])
}
2019-04-23 09:50:57 +02:00
@DefaultScope(() => ({
include: [
{
2019-04-23 09:50:57 +02:00
model: UserModel.unscoped(),
2018-08-07 10:07:53 +02:00
required: true
},
{
model: defaultVideoScope(),
required: false
},
{
model: VideoChannelSyncModel.unscoped(),
2018-08-07 10:07:53 +02:00
required: false
}
]
2019-04-23 09:50:57 +02:00
}))
@Table({
tableName: 'videoImport',
indexes: [
{
fields: [ 'videoId' ],
unique: true
2018-08-07 10:07:53 +02:00
},
{
fields: [ 'userId' ]
}
]
})
2021-05-12 14:09:04 +02:00
export class VideoImportModel extends Model<Partial<AttributesOnly<VideoImportModel>>> {
@CreatedAt
createdAt: Date
@UpdatedAt
updatedAt: Date
2018-08-06 17:13:39 +02:00
@AllowNull(true)
@Default(null)
2019-04-18 11:28:17 +02:00
@Is('VideoImportTargetUrl', value => throwIfNotValid(value, isVideoImportTargetUrlValid, 'targetUrl', true))
@Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_IMPORTS.URL.max))
targetUrl: string
2018-08-06 17:13:39 +02:00
@AllowNull(true)
@Default(null)
2019-04-18 11:28:17 +02:00
@Is('VideoImportMagnetUri', value => throwIfNotValid(value, isVideoMagnetUriValid, 'magnetUri', true))
2018-08-06 17:13:39 +02:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_IMPORTS.URL.max)) // Use the same constraints than URLs
magnetUri: string
@AllowNull(true)
@Default(null)
@Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_IMPORTS.TORRENT_NAME.max))
torrentName: string
@AllowNull(false)
@Default(null)
@Is('VideoImportState', value => throwIfNotValid(value, isVideoImportStateValid, 'state'))
@Column
state: VideoImportState
@AllowNull(true)
@Default(null)
@Column(DataType.TEXT)
error: string
2018-08-07 10:07:53 +02:00
@ForeignKey(() => UserModel)
@Column
userId: number
@BelongsTo(() => UserModel, {
foreignKey: {
allowNull: false
},
onDelete: 'cascade'
})
User: UserModel
@ForeignKey(() => VideoModel)
@Column
videoId: number
@BelongsTo(() => VideoModel, {
foreignKey: {
2018-08-02 17:48:50 +02:00
allowNull: true
},
2018-08-02 17:48:50 +02:00
onDelete: 'set null'
})
Video: VideoModel
@ForeignKey(() => VideoChannelSyncModel)
@Column
videoChannelSyncId: number
@BelongsTo(() => VideoChannelSyncModel, {
foreignKey: {
allowNull: true
},
onDelete: 'set null'
})
VideoChannelSync: VideoChannelSyncModel
2018-08-02 17:48:50 +02:00
@AfterUpdate
static deleteVideoIfFailed (instance: VideoImportModel, options) {
if (instance.state === VideoImportState.FAILED) {
2021-02-09 11:22:42 +01:00
return afterCommitIfTransaction(options.transaction, () => instance.Video.destroy())
2018-08-02 17:48:50 +02:00
}
return undefined
}
2020-12-08 14:30:29 +01:00
static loadAndPopulateVideo (id: number): Promise<MVideoImportDefault> {
2019-02-21 14:28:06 +01:00
return VideoImportModel.findByPk(id)
}
static listUserVideoImportsForApi (options: {
userId: number
start: number
count: number
sort: string
search?: string
targetUrl?: string
videoChannelSyncId?: number
}) {
const { userId, start, count, sort, targetUrl, videoChannelSyncId, search } = options
const where: WhereOptions = { userId }
const include: IncludeOptions[] = [
{
attributes: [ 'id' ],
model: UserModel.unscoped(), // FIXME: Without this, sequelize try to COUNT(DISTINCT(*)) which is an invalid SQL query
required: true
},
{
model: VideoChannelSyncModel.unscoped(),
required: false
}
]
if (targetUrl) where['targetUrl'] = targetUrl
if (videoChannelSyncId) where['videoChannelSyncId'] = videoChannelSyncId
if (search) {
include.push({
model: defaultVideoScope(),
required: true,
where: searchAttribute(search, 'name')
})
} else {
include.push({
model: defaultVideoScope(),
required: false
})
}
2018-08-02 17:48:50 +02:00
const query = {
2018-08-03 16:23:45 +02:00
distinct: true,
include,
2018-08-07 10:07:53 +02:00
offset: start,
limit: count,
order: getSort(sort),
where
2018-08-02 17:48:50 +02:00
}
return Promise.all([
VideoImportModel.unscoped().count(query),
VideoImportModel.findAll<MVideoImportDefault>(query)
]).then(([ total, data ]) => ({ total, data }))
2018-08-02 17:48:50 +02:00
}
Channel sync (#5135) * Add external channel URL for channel update / creation (#754) * Disallow synchronisation if user has no video quota (#754) * More constraints serverside (#754) * Disable sync if server configuration does not allow HTTP import (#754) * Working version synchronizing videos with a job (#754) TODO: refactoring, too much code duplication * More logs and try/catch (#754) * Fix eslint error (#754) * WIP: support synchronization time change (#754) * New frontend #754 * WIP: Create sync front (#754) * Enhance UI, sync creation form (#754) * Warning message when HTTP upload is disallowed * More consistent names (#754) * Binding Front with API (#754) * Add a /me API (#754) * Improve list UI (#754) * Implement creation and deletion routes (#754) * Lint (#754) * Lint again (#754) * WIP: UI for triggering import existing videos (#754) * Implement jobs for syncing and importing channels * Don't sync videos before sync creation + avoid concurrency issue (#754) * Cleanup (#754) * Cleanup: OpenAPI + API rework (#754) * Remove dead code (#754) * Eslint (#754) * Revert the mess with whitespaces in constants.ts (#754) * Some fixes after rebase (#754) * Several fixes after PR remarks (#754) * Front + API: Rename video-channels-sync to video-channel-syncs (#754) * Allow enabling channel sync through UI (#754) * getChannelInfo (#754) * Minor fixes: openapi + model + sql (#754) * Simplified API validators (#754) * Rename MChannelSync to MChannelSyncChannel (#754) * Add command for VideoChannelSync (#754) * Use synchronization.enabled config (#754) * Check parameters test + some fixes (#754) * Fix conflict mistake (#754) * Restrict access to video channel sync list API (#754) * Start adding unit test for synchronization (#754) * Continue testing (#754) * Tests finished + convertion of job to scheduler (#754) * Add lastSyncAt field (#754) * Fix externalRemoteUrl sort + creation date not well formatted (#754) * Small fix (#754) * Factorize addYoutubeDLImport and buildVideo (#754) * Check duplicates on channel not on users (#754) * factorize thumbnail generation (#754) * Fetch error should return status 400 (#754) * Separate video-channel-import and video-channel-sync-latest (#754) * Bump DB migration version after rebase (#754) * Prettier states in UI table (#754) * Add DefaultScope in VideoChannelSyncModel (#754) * Fix audit logs (#754) * Ensure user can upload when importing channel + minor fixes (#754) * Mark synchronization as failed on exception + typos (#754) * Change REST API for importing videos into channel (#754) * Add option for fully synchronize a chnanel (#754) * Return a whole sync object on creation to avoid tricks in Front (#754) * Various remarks (#754) * Single quotes by default (#754) * Rename synchronization to video_channel_synchronization * Add check.latest_videos_count and max_per_user options (#754) * Better channel rendering in list #754 * Allow sorting with channel name and state (#754) * Add missing tests for channel imports (#754) * Prefer using a parent job for channel sync * Styling * Client styling Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-08-10 09:53:39 +02:00
static async urlAlreadyImported (channelId: number, targetUrl: string): Promise<boolean> {
const element = await VideoImportModel.unscoped().findOne({
where: {
targetUrl,
state: {
[Op.in]: [ VideoImportState.PENDING, VideoImportState.PROCESSING, VideoImportState.SUCCESS ]
}
},
include: [
{
model: VideoModel,
required: true,
where: {
channelId
}
}
]
})
return !!element
}
getTargetIdentifier () {
return this.targetUrl || this.magnetUri || this.torrentName
}
2019-08-20 19:05:31 +02:00
toFormattedJSON (this: MVideoImportFormattable): VideoImport {
const videoFormatOptions = {
completeDescription: true,
additionalAttributes: { state: true, waitTranscoding: true, scheduledUpdate: true }
}
2018-08-02 17:48:50 +02:00
const video = this.Video
? Object.assign(this.Video.toFormattedJSON(videoFormatOptions), { tags: this.Video.Tags.map(t => t.name) })
2018-08-02 17:48:50 +02:00
: undefined
const videoChannelSync = this.VideoChannelSync
? { id: this.VideoChannelSync.id, externalChannelUrl: this.VideoChannelSync.externalChannelUrl }
: undefined
return {
2018-08-03 09:27:30 +02:00
id: this.id,
2018-08-07 09:54:36 +02:00
targetUrl: this.targetUrl,
2018-08-07 09:54:36 +02:00
magnetUri: this.magnetUri,
torrentName: this.torrentName,
2018-08-02 17:48:50 +02:00
state: {
id: this.state,
label: VideoImportModel.getStateLabel(this.state)
},
2018-08-03 09:27:30 +02:00
error: this.error,
2018-08-02 17:48:50 +02:00
updatedAt: this.updatedAt.toISOString(),
createdAt: this.createdAt.toISOString(),
video,
videoChannelSync
}
}
2018-08-02 17:48:50 +02:00
private static getStateLabel (id: number) {
return VIDEO_IMPORT_STATES[id] || 'Unknown'
}
}