]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/models/video/video.ts
Add migrate-to-object-storage script (#4481)
[github/Chocobozzz/PeerTube.git] / server / models / video / video.ts
CommitLineData
41fb13c3 1import Bluebird from 'bluebird'
d95d1559 2import { remove } from 'fs-extra'
e5dbd508 3import { maxBy, minBy } from 'lodash'
098eb377 4import { join } from 'path'
b49f22d8 5import { FindOptions, Includeable, IncludeOptions, Op, QueryTypes, ScopeOptions, Sequelize, Transaction, WhereOptions } from 'sequelize'
3fd3ab2d 6import {
4ba3b8ea
C
7 AllowNull,
8 BeforeDestroy,
9 BelongsTo,
10 BelongsToMany,
11 Column,
12 CreatedAt,
13 DataType,
14 Default,
15 ForeignKey,
16 HasMany,
2baea0c7 17 HasOne,
4ba3b8ea
C
18 Is,
19 IsInt,
20 IsUUID,
21 Min,
22 Model,
23 Scopes,
24 Table,
9a629c6e 25 UpdatedAt
3fd3ab2d 26} from 'sequelize-typescript'
d95d1559 27import { buildNSFWFilter } from '@server/helpers/express-utils'
29837f88 28import { uuidToShort } from '@server/helpers/uuid'
68e70a74 29import { getPrivaciesForFederation, isPrivacyForFederation, isStateForFederation } from '@server/helpers/video'
8ebf2a5d 30import { LiveManager } from '@server/lib/live/live-manager'
0305db28
JB
31import { removeHLSObjectStorage, removeWebTorrentObjectStorage } from '@server/lib/object-storage'
32import { getHLSDirectory, getHLSRedundancyDirectory } from '@server/lib/paths'
33import { VideoPathManager } from '@server/lib/video-path-manager'
d95d1559
C
34import { getServerActor } from '@server/models/application/application'
35import { ModelCache } from '@server/models/model-cache'
9c9a236b 36import { AttributesOnly, buildVideoEmbedPath, buildVideoWatchPath, pick } from '@shared/core-utils'
2760b454 37import { VideoInclude } from '@shared/models'
d95d1559
C
38import { VideoFile } from '@shared/models/videos/video-file.model'
39import { ResultList, UserRight, VideoPrivacy, VideoState } from '../../../shared'
de6310b2 40import { VideoObject } from '../../../shared/models/activitypub/objects'
0305db28 41import { Video, VideoDetails, VideoRateType, VideoStorage } from '../../../shared/models/videos'
d95d1559 42import { ThumbnailType } from '../../../shared/models/videos/thumbnail.type'
d95d1559 43import { VideoStreamingPlaylistType } from '../../../shared/models/videos/video-streaming-playlist.type'
30ff39e7 44import { peertubeTruncate } from '../../helpers/core-utils'
da854ddd 45import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
c4c0c311 46import { exists, isBooleanValid } from '../../helpers/custom-validators/misc'
3fd3ab2d 47import {
4ba3b8ea
C
48 isVideoDescriptionValid,
49 isVideoDurationValid,
418d092a 50 isVideoNameValid,
2baea0c7
C
51 isVideoPrivacyValid,
52 isVideoStateValid,
b64c950a 53 isVideoSupportValid
3fd3ab2d 54} from '../../helpers/custom-validators/videos'
daf6e480 55import { getVideoFileResolution } from '../../helpers/ffprobe-utils'
da854ddd 56import { logger } from '../../helpers/logger'
d95d1559 57import { CONFIG } from '../../initializers/config'
69322042 58import { ACTIVITY_PUB, API_VERSION, CONSTRAINTS_FIELDS, LAZY_STATIC_PATHS, STATIC_PATHS, WEBSERVER } from '../../initializers/constants'
50d6de9c 59import { sendDeleteVideo } from '../../lib/activitypub/send'
453e83ea
C
60import {
61 MChannel,
0283eaac 62 MChannelAccountDefault,
453e83ea 63 MChannelId,
d7a25329
C
64 MStreamingPlaylist,
65 MStreamingPlaylistFilesVideo,
453e83ea
C
66 MUserAccountId,
67 MUserId,
90a8bd30 68 MVideo,
453e83ea 69 MVideoAccountLight,
0283eaac 70 MVideoAccountLightBlacklistAllFiles,
b5fecbf4 71 MVideoAP,
453e83ea 72 MVideoDetails,
d7a25329 73 MVideoFileVideo,
b5fecbf4
C
74 MVideoFormattable,
75 MVideoFormattableDetails,
0283eaac 76 MVideoForUser,
453e83ea 77 MVideoFullLight,
71d4af1e 78 MVideoId,
5f3e2425 79 MVideoImmutable,
453e83ea 80 MVideoThumbnail,
d636ab58 81 MVideoThumbnailBlacklist,
b5fecbf4 82 MVideoWithAllFiles,
71d4af1e 83 MVideoWithFile
26d6bf65 84} from '../../types/models'
26d6bf65 85import { MThumbnail } from '../../types/models/video/thumbnail'
1896bca0 86import { MVideoFile, MVideoFileStreamingPlaylistVideo } from '../../types/models/video/video-file'
d95d1559
C
87import { VideoAbuseModel } from '../abuse/video-abuse'
88import { AccountModel } from '../account/account'
89import { AccountVideoRateModel } from '../account/account-video-rate'
7d9ba5c0
C
90import { ActorModel } from '../actor/actor'
91import { ActorImageModel } from '../actor/actor-image'
d95d1559
C
92import { VideoRedundancyModel } from '../redundancy/video-redundancy'
93import { ServerModel } from '../server/server'
d9a2a031
C
94import { TrackerModel } from '../server/tracker'
95import { VideoTrackerModel } from '../server/video-tracker'
fa47956e 96import { setAsUpdated } from '../shared'
7d9ba5c0
C
97import { UserModel } from '../user/user'
98import { UserVideoHistoryModel } from '../user/user-video-history'
d95d1559 99import { buildTrigramSearchIndex, buildWhereIdOrUUID, getVideoSort, isOutdated, throwIfNotValid } from '../utils'
e5dbd508
C
100import {
101 videoFilesModelToFormattedJSON,
102 VideoFormattingJSONOptions,
103 videoModelToActivityPubObject,
104 videoModelToFormattedDetailsJSON,
105 videoModelToFormattedJSON
106} from './formatter/video-format-utils'
d95d1559 107import { ScheduleVideoUpdateModel } from './schedule-video-update'
3c10840f 108import { VideoModelGetQueryBuilder } from './sql/video-model-get-query-builder'
2760b454 109import { BuildVideosListQueryOptions, DisplayOnlyForFollowerOptions, VideosIdListQueryBuilder } from './sql/videos-id-list-query-builder'
e5dbd508 110import { VideosModelListQueryBuilder } from './sql/videos-model-list-query-builder'
d95d1559
C
111import { TagModel } from './tag'
112import { ThumbnailModel } from './thumbnail'
113import { VideoBlacklistModel } from './video-blacklist'
114import { VideoCaptionModel } from './video-caption'
115import { ScopeNames as VideoChannelScopeNames, SummaryOptions, VideoChannelModel } from './video-channel'
116import { VideoCommentModel } from './video-comment'
117import { VideoFileModel } from './video-file'
d95d1559 118import { VideoImportModel } from './video-import'
0305db28 119import { VideoJobInfoModel } from './video-job-info'
af4ae64f 120import { VideoLiveModel } from './video-live'
d95d1559 121import { VideoPlaylistElementModel } from './video-playlist-element'
d95d1559
C
122import { VideoShareModel } from './video-share'
123import { VideoStreamingPlaylistModel } from './video-streaming-playlist'
124import { VideoTagModel } from './video-tag'
125import { VideoViewModel } from './video-view'
6e46de09 126
2baea0c7 127export enum ScopeNames {
afd2cba5 128 FOR_API = 'FOR_API',
4cb6d457 129 WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
d48ff09d 130 WITH_TAGS = 'WITH_TAGS',
d7a25329 131 WITH_WEBTORRENT_FILES = 'WITH_WEBTORRENT_FILES',
191764f3 132 WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE',
6e46de09 133 WITH_BLACKLISTED = 'WITH_BLACKLISTED',
09209296 134 WITH_STREAMING_PLAYLISTS = 'WITH_STREAMING_PLAYLISTS',
943e5193 135 WITH_IMMUTABLE_ATTRIBUTES = 'WITH_IMMUTABLE_ATTRIBUTES',
69322042
C
136 WITH_USER_HISTORY = 'WITH_USER_HISTORY',
137 WITH_THUMBNAILS = 'WITH_THUMBNAILS'
d48ff09d
C
138}
139
bfbd9128
C
140export type ForAPIOptions = {
141 ids?: number[]
418d092a
C
142
143 videoPlaylistId?: number
144
bfbd9128 145 withAccountBlockerIds?: number[]
afd2cba5
C
146}
147
3acc5084 148@Scopes(() => ({
943e5193
C
149 [ScopeNames.WITH_IMMUTABLE_ATTRIBUTES]: {
150 attributes: [ 'id', 'url', 'uuid', 'remote' ]
151 },
a1587156 152 [ScopeNames.FOR_API]: (options: ForAPIOptions) => {
b49f22d8
C
153 const include: Includeable[] = [
154 {
155 model: VideoChannelModel.scope({
156 method: [
157 VideoChannelScopeNames.SUMMARY, {
158 withAccount: true,
159 withAccountBlockerIds: options.withAccountBlockerIds
160 } as SummaryOptions
161 ]
162 }),
163 required: true
164 },
165 {
166 attributes: [ 'type', 'filename' ],
167 model: ThumbnailModel,
168 required: false
169 }
170 ]
171
172 const query: FindOptions = {}
afd2cba5 173
bfbd9128
C
174 if (options.ids) {
175 query.where = {
176 id: {
a1587156 177 [Op.in]: options.ids
bfbd9128
C
178 }
179 }
180 }
181
418d092a 182 if (options.videoPlaylistId) {
b49f22d8 183 include.push({
418d092a 184 model: VideoPlaylistElementModel.unscoped(),
15e9d5ca
C
185 required: true,
186 where: {
187 videoPlaylistId: options.videoPlaylistId
188 }
418d092a
C
189 })
190 }
191
b49f22d8
C
192 query.include = include
193
afd2cba5
C
194 return query
195 },
a1587156 196 [ScopeNames.WITH_THUMBNAILS]: {
e8bafea3
C
197 include: [
198 {
3acc5084 199 model: ThumbnailModel,
e8bafea3
C
200 required: false
201 }
202 ]
203 },
a1587156 204 [ScopeNames.WITH_ACCOUNT_DETAILS]: {
d48ff09d
C
205 include: [
206 {
3acc5084 207 model: VideoChannelModel.unscoped(),
d48ff09d
C
208 required: true,
209 include: [
6120941f
C
210 {
211 attributes: {
212 exclude: [ 'privateKey', 'publicKey' ]
213 },
3acc5084 214 model: ActorModel.unscoped(),
3e500247
C
215 required: true,
216 include: [
217 {
218 attributes: [ 'host' ],
3acc5084 219 model: ServerModel.unscoped(),
3e500247 220 required: false
52d9f792
C
221 },
222 {
f4796856
C
223 model: ActorImageModel.unscoped(),
224 as: 'Avatar',
52d9f792 225 required: false
3e500247
C
226 }
227 ]
6120941f 228 },
d48ff09d 229 {
3acc5084 230 model: AccountModel.unscoped(),
d48ff09d
C
231 required: true,
232 include: [
233 {
3acc5084 234 model: ActorModel.unscoped(),
6120941f
C
235 attributes: {
236 exclude: [ 'privateKey', 'publicKey' ]
237 },
50d6de9c
C
238 required: true,
239 include: [
240 {
3e500247 241 attributes: [ 'host' ],
3acc5084 242 model: ServerModel.unscoped(),
50d6de9c 243 required: false
b6a4fd6b
C
244 },
245 {
f4796856
C
246 model: ActorImageModel.unscoped(),
247 as: 'Avatar',
b6a4fd6b 248 required: false
50d6de9c
C
249 }
250 ]
d48ff09d
C
251 }
252 ]
253 }
254 ]
255 }
3acc5084 256 ]
d48ff09d 257 },
a1587156 258 [ScopeNames.WITH_TAGS]: {
3acc5084 259 include: [ TagModel ]
d48ff09d 260 },
a1587156 261 [ScopeNames.WITH_BLACKLISTED]: {
191764f3
C
262 include: [
263 {
453e83ea 264 attributes: [ 'id', 'reason', 'unfederated' ],
3acc5084 265 model: VideoBlacklistModel,
191764f3
C
266 required: false
267 }
268 ]
269 },
a1587156 270 [ScopeNames.WITH_WEBTORRENT_FILES]: (withRedundancies = false) => {
09209296
C
271 let subInclude: any[] = []
272
273 if (withRedundancies === true) {
274 subInclude = [
275 {
276 attributes: [ 'fileUrl' ],
277 model: VideoRedundancyModel.unscoped(),
278 required: false
279 }
280 ]
281 }
282
283 return {
284 include: [
285 {
8319d6ae 286 model: VideoFileModel,
d7df188f 287 separate: true,
09209296
C
288 required: false,
289 include: subInclude
290 }
291 ]
292 }
293 },
a1587156 294 [ScopeNames.WITH_STREAMING_PLAYLISTS]: (withRedundancies = false) => {
d7a25329
C
295 const subInclude: IncludeOptions[] = [
296 {
8319d6ae 297 model: VideoFileModel,
d7a25329
C
298 required: false
299 }
300 ]
09209296
C
301
302 if (withRedundancies === true) {
d7a25329
C
303 subInclude.push({
304 attributes: [ 'fileUrl' ],
305 model: VideoRedundancyModel.unscoped(),
306 required: false
307 })
09209296
C
308 }
309
310 return {
311 include: [
312 {
313 model: VideoStreamingPlaylistModel.unscoped(),
09209296 314 required: false,
d7df188f 315 separate: true,
09209296
C
316 include: subInclude
317 }
318 ]
319 }
bbe0f064 320 },
a1587156 321 [ScopeNames.WITH_SCHEDULED_UPDATE]: {
bbe0f064
C
322 include: [
323 {
3acc5084 324 model: ScheduleVideoUpdateModel.unscoped(),
bbe0f064
C
325 required: false
326 }
327 ]
6e46de09 328 },
a1587156 329 [ScopeNames.WITH_USER_HISTORY]: (userId: number) => {
6e46de09
C
330 return {
331 include: [
332 {
333 attributes: [ 'currentTime' ],
334 model: UserVideoHistoryModel.unscoped(),
335 required: false,
336 where: {
337 userId
338 }
339 }
340 ]
341 }
d48ff09d 342 }
3acc5084 343}))
3fd3ab2d
C
344@Table({
345 tableName: 'video',
0374b6b5
C
346 indexes: [
347 buildTrigramSearchIndex('video_name_trigram', 'name'),
348
349 { fields: [ 'createdAt' ] },
350 {
351 fields: [
352 { name: 'publishedAt', order: 'DESC' },
353 { name: 'id', order: 'ASC' }
354 ]
355 },
356 { fields: [ 'duration' ] },
53455605
C
357 {
358 fields: [
359 { name: 'views', order: 'DESC' },
360 { name: 'id', order: 'ASC' }
361 ]
362 },
0374b6b5
C
363 { fields: [ 'channelId' ] },
364 {
365 fields: [ 'originallyPublishedAt' ],
366 where: {
367 originallyPublishedAt: {
368 [Op.ne]: null
369 }
370 }
371 },
372 {
373 fields: [ 'category' ], // We don't care videos with an unknown category
374 where: {
375 category: {
376 [Op.ne]: null
377 }
378 }
379 },
380 {
381 fields: [ 'licence' ], // We don't care videos with an unknown licence
382 where: {
383 licence: {
384 [Op.ne]: null
385 }
386 }
387 },
388 {
389 fields: [ 'language' ], // We don't care videos with an unknown language
390 where: {
391 language: {
392 [Op.ne]: null
393 }
394 }
395 },
396 {
397 fields: [ 'nsfw' ], // Most of the videos are not NSFW
398 where: {
399 nsfw: true
400 }
401 },
402 {
403 fields: [ 'remote' ], // Only index local videos
404 where: {
405 remote: false
406 }
407 },
408 {
409 fields: [ 'uuid' ],
410 unique: true
411 },
412 {
413 fields: [ 'url' ],
414 unique: true
415 }
416 ]
3fd3ab2d 417})
16c016e8 418export class VideoModel extends Model<Partial<AttributesOnly<VideoModel>>> {
3fd3ab2d
C
419
420 @AllowNull(false)
421 @Default(DataType.UUIDV4)
422 @IsUUID(4)
423 @Column(DataType.UUID)
424 uuid: string
425
426 @AllowNull(false)
427 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
428 @Column
429 name: string
430
431 @AllowNull(true)
432 @Default(null)
3fd3ab2d
C
433 @Column
434 category: number
435
436 @AllowNull(true)
437 @Default(null)
3fd3ab2d
C
438 @Column
439 licence: number
440
441 @AllowNull(true)
442 @Default(null)
9d3ef9fe
C
443 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
444 language: string
3fd3ab2d
C
445
446 @AllowNull(false)
447 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
448 @Column
1ba471c5 449 privacy: VideoPrivacy
3fd3ab2d
C
450
451 @AllowNull(false)
47564bbe 452 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
3fd3ab2d
C
453 @Column
454 nsfw: boolean
455
456 @AllowNull(true)
457 @Default(null)
1735c825 458 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description', true))
3fd3ab2d
C
459 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
460 description: string
461
2422c46b
C
462 @AllowNull(true)
463 @Default(null)
1735c825 464 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support', true))
2422c46b
C
465 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
466 support: string
467
3fd3ab2d
C
468 @AllowNull(false)
469 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
470 @Column
471 duration: number
472
473 @AllowNull(false)
474 @Default(0)
475 @IsInt
476 @Min(0)
477 @Column
478 views: number
479
480 @AllowNull(false)
481 @Default(0)
482 @IsInt
483 @Min(0)
484 @Column
485 likes: number
486
487 @AllowNull(false)
488 @Default(0)
489 @IsInt
490 @Min(0)
491 @Column
492 dislikes: number
493
494 @AllowNull(false)
495 @Column
496 remote: boolean
497
498 @AllowNull(false)
c6c0fa6c
C
499 @Default(false)
500 @Column
501 isLive: boolean
502
503 @AllowNull(false)
3fd3ab2d
C
504 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
505 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
506 url: string
507
47564bbe
C
508 @AllowNull(false)
509 @Column
510 commentsEnabled: boolean
511
156c50af
LD
512 @AllowNull(false)
513 @Column
7f2cfe3a 514 downloadEnabled: boolean
156c50af 515
2186386c
C
516 @AllowNull(false)
517 @Column
518 waitTranscoding: boolean
519
520 @AllowNull(false)
521 @Default(null)
522 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
523 @Column
524 state: VideoState
525
3fd3ab2d
C
526 @CreatedAt
527 createdAt: Date
528
529 @UpdatedAt
530 updatedAt: Date
531
2922e048 532 @AllowNull(false)
1735c825 533 @Default(DataType.NOW)
2922e048
JLB
534 @Column
535 publishedAt: Date
536
7519127b
C
537 @AllowNull(true)
538 @Default(null)
c8034165 539 @Column
540 originallyPublishedAt: Date
541
3fd3ab2d
C
542 @ForeignKey(() => VideoChannelModel)
543 @Column
544 channelId: number
545
546 @BelongsTo(() => VideoChannelModel, {
feb4bdfd 547 foreignKey: {
50d6de9c 548 allowNull: true
feb4bdfd 549 },
693c6586 550 onDelete: 'cascade'
feb4bdfd 551 })
3fd3ab2d 552 VideoChannel: VideoChannelModel
7920c273 553
3fd3ab2d 554 @BelongsToMany(() => TagModel, {
7920c273 555 foreignKey: 'videoId',
3fd3ab2d
C
556 through: () => VideoTagModel,
557 onDelete: 'CASCADE'
7920c273 558 })
3fd3ab2d 559 Tags: TagModel[]
55fa55a9 560
d9a2a031
C
561 @BelongsToMany(() => TrackerModel, {
562 foreignKey: 'videoId',
563 through: () => VideoTrackerModel,
564 onDelete: 'CASCADE'
565 })
566 Trackers: TrackerModel[]
567
e8bafea3
C
568 @HasMany(() => ThumbnailModel, {
569 foreignKey: {
570 name: 'videoId',
571 allowNull: true
572 },
573 hooks: true,
574 onDelete: 'cascade'
575 })
576 Thumbnails: ThumbnailModel[]
577
418d092a
C
578 @HasMany(() => VideoPlaylistElementModel, {
579 foreignKey: {
580 name: 'videoId',
bfbd9128 581 allowNull: true
418d092a 582 },
bfbd9128 583 onDelete: 'set null'
418d092a
C
584 })
585 VideoPlaylistElements: VideoPlaylistElementModel[]
586
3fd3ab2d 587 @HasMany(() => VideoAbuseModel, {
55fa55a9
C
588 foreignKey: {
589 name: 'videoId',
68d19a0a 590 allowNull: true
55fa55a9 591 },
68d19a0a 592 onDelete: 'set null'
55fa55a9 593 })
3fd3ab2d 594 VideoAbuses: VideoAbuseModel[]
93e1258c 595
3fd3ab2d 596 @HasMany(() => VideoFileModel, {
93e1258c
C
597 foreignKey: {
598 name: 'videoId',
d7a25329 599 allowNull: true
93e1258c 600 },
c48e82b5 601 hooks: true,
93e1258c
C
602 onDelete: 'cascade'
603 })
3fd3ab2d 604 VideoFiles: VideoFileModel[]
e71bcc0f 605
09209296
C
606 @HasMany(() => VideoStreamingPlaylistModel, {
607 foreignKey: {
608 name: 'videoId',
609 allowNull: false
610 },
611 hooks: true,
612 onDelete: 'cascade'
613 })
614 VideoStreamingPlaylists: VideoStreamingPlaylistModel[]
615
3fd3ab2d 616 @HasMany(() => VideoShareModel, {
e71bcc0f
C
617 foreignKey: {
618 name: 'videoId',
619 allowNull: false
620 },
621 onDelete: 'cascade'
622 })
3fd3ab2d 623 VideoShares: VideoShareModel[]
16b90975 624
3fd3ab2d 625 @HasMany(() => AccountVideoRateModel, {
16b90975
C
626 foreignKey: {
627 name: 'videoId',
628 allowNull: false
629 },
630 onDelete: 'cascade'
631 })
3fd3ab2d 632 AccountVideoRates: AccountVideoRateModel[]
f285faa0 633
da854ddd
C
634 @HasMany(() => VideoCommentModel, {
635 foreignKey: {
636 name: 'videoId',
637 allowNull: false
638 },
f05a1c30
C
639 onDelete: 'cascade',
640 hooks: true
da854ddd
C
641 })
642 VideoComments: VideoCommentModel[]
643
9a629c6e
C
644 @HasMany(() => VideoViewModel, {
645 foreignKey: {
646 name: 'videoId',
647 allowNull: false
648 },
6e46de09 649 onDelete: 'cascade'
9a629c6e
C
650 })
651 VideoViews: VideoViewModel[]
652
6e46de09
C
653 @HasMany(() => UserVideoHistoryModel, {
654 foreignKey: {
655 name: 'videoId',
656 allowNull: false
657 },
658 onDelete: 'cascade'
659 })
660 UserVideoHistories: UserVideoHistoryModel[]
661
2baea0c7
C
662 @HasOne(() => ScheduleVideoUpdateModel, {
663 foreignKey: {
664 name: 'videoId',
665 allowNull: false
666 },
667 onDelete: 'cascade'
668 })
669 ScheduleVideoUpdate: ScheduleVideoUpdateModel
670
26b7305a
C
671 @HasOne(() => VideoBlacklistModel, {
672 foreignKey: {
673 name: 'videoId',
674 allowNull: false
675 },
676 onDelete: 'cascade'
677 })
678 VideoBlacklist: VideoBlacklistModel
679
31c82cd9
C
680 @HasOne(() => VideoLiveModel, {
681 foreignKey: {
682 name: 'videoId',
683 allowNull: false
684 },
685 onDelete: 'cascade'
686 })
687 VideoLive: VideoLiveModel
688
dc133480
C
689 @HasOne(() => VideoImportModel, {
690 foreignKey: {
691 name: 'videoId',
692 allowNull: true
693 },
694 onDelete: 'set null'
695 })
696 VideoImport: VideoImportModel
697
40e87e9e
C
698 @HasMany(() => VideoCaptionModel, {
699 foreignKey: {
700 name: 'videoId',
701 allowNull: false
702 },
703 onDelete: 'cascade',
704 hooks: true,
a1587156 705 ['separate' as any]: true
40e87e9e
C
706 })
707 VideoCaptions: VideoCaptionModel[]
708
0305db28
JB
709 @HasOne(() => VideoJobInfoModel, {
710 foreignKey: {
711 name: 'videoId',
712 allowNull: false
713 },
714 onDelete: 'cascade'
715 })
716 VideoJobInfo: VideoJobInfoModel
717
f05a1c30 718 @BeforeDestroy
453e83ea 719 static async sendDelete (instance: MVideoAccountLight, options) {
42ec411b 720 if (!instance.isOwned()) return undefined
f05a1c30 721
42ec411b
C
722 // Lazy load channels
723 if (!instance.VideoChannel) {
724 instance.VideoChannel = await instance.$get('VideoChannel', {
725 include: [
726 ActorModel,
727 AccountModel
728 ],
729 transaction: options.transaction
730 }) as MChannelAccountDefault
f05a1c30
C
731 }
732
42ec411b 733 return sendDeleteVideo(instance, options.transaction)
f05a1c30
C
734 }
735
6b738c7a 736 @BeforeDestroy
9f7657b6 737 static async removeFiles (instance: VideoModel, options) {
f05a1c30 738 const tasks: Promise<any>[] = []
f285faa0 739
8e0fd45e 740 logger.info('Removing files of video %s.', instance.url)
6b738c7a 741
3fd3ab2d 742 if (instance.isOwned()) {
f05a1c30 743 if (!Array.isArray(instance.VideoFiles)) {
9f7657b6 744 instance.VideoFiles = await instance.$get('VideoFiles', { transaction: options.transaction })
f05a1c30
C
745 }
746
3fd3ab2d
C
747 // Remove physical files and torrents
748 instance.VideoFiles.forEach(file => {
764b1a14 749 tasks.push(instance.removeFileAndTorrent(file))
3fd3ab2d 750 })
09209296
C
751
752 // Remove playlists file
ffc65cbd 753 if (!Array.isArray(instance.VideoStreamingPlaylists)) {
9f7657b6 754 instance.VideoStreamingPlaylists = await instance.$get('VideoStreamingPlaylists', { transaction: options.transaction })
ffc65cbd
C
755 }
756
757 for (const p of instance.VideoStreamingPlaylists) {
758 tasks.push(instance.removeStreamingPlaylistFiles(p))
759 }
3fd3ab2d 760 }
40298b02 761
6b738c7a
C
762 // Do not wait video deletion because we could be in a transaction
763 Promise.all(tasks)
8ea6f49a
C
764 .catch(err => {
765 logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err })
766 })
6b738c7a
C
767
768 return undefined
3fd3ab2d 769 }
f285faa0 770
a5cf76af
C
771 @BeforeDestroy
772 static stopLiveIfNeeded (instance: VideoModel) {
773 if (!instance.isLive) return
774
68e70a74
C
775 logger.info('Stopping live of video %s after video deletion.', instance.uuid)
776
9f7657b6 777 LiveManager.Instance.stopSessionOf(instance.id)
a5cf76af
C
778 }
779
7eba5e1f
C
780 @BeforeDestroy
781 static invalidateCache (instance: VideoModel) {
782 ModelCache.Instance.invalidateCache('video', instance.id)
783 }
784
68d19a0a
RK
785 @BeforeDestroy
786 static async saveEssentialDataToAbuses (instance: VideoModel, options) {
787 const tasks: Promise<any>[] = []
788
68d19a0a 789 if (!Array.isArray(instance.VideoAbuses)) {
9f7657b6 790 instance.VideoAbuses = await instance.$get('VideoAbuses', { transaction: options.transaction })
68d19a0a
RK
791
792 if (instance.VideoAbuses.length === 0) return undefined
793 }
794
57f6896f
C
795 logger.info('Saving video abuses details of video %s.', instance.url)
796
42ec411b 797 if (!instance.Trackers) instance.Trackers = await instance.$get('Trackers', { transaction: options.transaction })
86521a67 798 const details = instance.toFormattedDetailsJSON()
68d19a0a
RK
799
800 for (const abuse of instance.VideoAbuses) {
0251197e
RK
801 abuse.deletedVideo = details
802 tasks.push(abuse.save({ transaction: options.transaction }))
68d19a0a
RK
803 }
804
9f7657b6 805 await Promise.all(tasks)
68d19a0a
RK
806 }
807
e1ab52d7 808 static listLocalIds (): Promise<number[]> {
9f1ddd24 809 const query = {
e1ab52d7 810 attributes: [ 'id' ],
811 raw: true,
9f1ddd24
C
812 where: {
813 remote: false
814 }
815 }
816
90a8bd30 817 return VideoModel.findAll(query)
e1ab52d7 818 .then(rows => rows.map(r => r.id))
9f1ddd24
C
819 }
820
50d6de9c 821 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
3fd3ab2d
C
822 function getRawQuery (select: string) {
823 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
824 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
50d6de9c
C
825 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
826 'WHERE "Account"."actorId" = ' + actorId
3fd3ab2d
C
827 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
828 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
50d6de9c 829 'WHERE "VideoShare"."actorId" = ' + actorId
558d7c23 830
3fd3ab2d
C
831 return `(${queryVideo}) UNION (${queryVideoShare})`
832 }
aaf61f38 833
3fd3ab2d
C
834 const rawQuery = getRawQuery('"Video"."id"')
835 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
836
837 const query = {
838 distinct: true,
839 offset: start,
840 limit: count,
0c691a18 841 order: getVideoSort('-createdAt', [ 'Tags', 'name', 'ASC' ]),
3fd3ab2d
C
842 where: {
843 id: {
a1587156 844 [Op.in]: Sequelize.literal('(' + rawQuery + ')')
3c75ce12 845 },
3092e9bb 846 [Op.or]: getPrivaciesForFederation()
3fd3ab2d
C
847 },
848 include: [
40e87e9e 849 {
1afb3c47 850 attributes: [ 'filename', 'language', 'fileUrl' ],
40e87e9e
C
851 model: VideoCaptionModel.unscoped(),
852 required: false
853 },
3fd3ab2d 854 {
1d230c44 855 attributes: [ 'id', 'url' ],
2c897999 856 model: VideoShareModel.unscoped(),
3fd3ab2d 857 required: false,
e3d5ea4f
C
858 // We only want videos shared by this actor
859 where: {
a1587156 860 [Op.and]: [
e3d5ea4f
C
861 {
862 id: {
a1587156 863 [Op.not]: null
e3d5ea4f
C
864 }
865 },
866 {
867 actorId
868 }
869 ]
870 },
50d6de9c
C
871 include: [
872 {
2c897999
C
873 attributes: [ 'id', 'url' ],
874 model: ActorModel.unscoped()
50d6de9c
C
875 }
876 ]
3fd3ab2d
C
877 },
878 {
2c897999 879 model: VideoChannelModel.unscoped(),
3fd3ab2d
C
880 required: true,
881 include: [
882 {
2c897999
C
883 attributes: [ 'name' ],
884 model: AccountModel.unscoped(),
885 required: true,
886 include: [
887 {
e3d5ea4f 888 attributes: [ 'id', 'url', 'followersUrl' ],
2c897999
C
889 model: ActorModel.unscoped(),
890 required: true
891 }
892 ]
893 },
894 {
e3d5ea4f 895 attributes: [ 'id', 'url', 'followersUrl' ],
2c897999 896 model: ActorModel.unscoped(),
3fd3ab2d
C
897 required: true
898 }
899 ]
900 },
af4ae64f
C
901 {
902 model: VideoStreamingPlaylistModel.unscoped(),
903 required: false,
904 include: [
905 {
906 model: VideoFileModel,
907 required: false
908 }
909 ]
910 },
c8f3cfeb 911 VideoLiveModel.unscoped(),
3fd3ab2d 912 VideoFileModel,
2c897999 913 TagModel
3fd3ab2d
C
914 ]
915 }
164174a6 916
3fd3ab2d 917 return Bluebird.all([
3acc5084
C
918 VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findAll(query),
919 VideoModel.sequelize.query<{ total: string }>(rawCountQuery, { type: QueryTypes.SELECT })
3fd3ab2d
C
920 ]).then(([ rows, totals ]) => {
921 // totals: totalVideos + totalVideoShares
922 let totalVideos = 0
923 let totalVideoShares = 0
a1587156
C
924 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
925 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
3fd3ab2d
C
926
927 const total = totalVideos + totalVideoShares
928 return {
929 data: rows,
930 total: total
931 }
932 })
933 }
93e1258c 934
9e2e51dc 935 static async listPublishedLiveUUIDs () {
5c0904fc 936 const options = {
9e2e51dc 937 attributes: [ 'uuid' ],
5c0904fc
C
938 where: {
939 isLive: true,
f49b3231 940 remote: false,
5c0904fc
C
941 state: VideoState.PUBLISHED
942 }
943 }
944
b49f22d8
C
945 const result = await VideoModel.findAll(options)
946
9e2e51dc 947 return result.map(v => v.uuid)
5c0904fc
C
948 }
949
a4d2ca07
C
950 static listUserVideosForApi (options: {
951 accountId: number
952 start: number
953 count: number
954 sort: string
978c87e7
C
955
956 channelId?: number
1fd61899 957 isLive?: boolean
bf64ed41 958 search?: string
a4d2ca07 959 }) {
978c87e7 960 const { accountId, channelId, start, count, sort, search, isLive } = options
a4d2ca07 961
3acc5084 962 function buildBaseQuery (): FindOptions {
1fd61899
C
963 const where: WhereOptions = {}
964
965 if (search) {
966 where.name = {
967 [Op.iLike]: '%' + search + '%'
968 }
969 }
970
c4c0c311 971 if (exists(isLive)) {
1fd61899
C
972 where.isLive = isLive
973 }
974
978c87e7
C
975 const channelWhere = channelId
976 ? { id: channelId }
977 : {}
978
1fd61899 979 const baseQuery = {
3acc5084
C
980 offset: start,
981 limit: count,
1fd61899 982 where,
3acc5084
C
983 order: getVideoSort(sort),
984 include: [
985 {
986 model: VideoChannelModel,
987 required: true,
978c87e7 988 where: channelWhere,
3acc5084
C
989 include: [
990 {
991 model: AccountModel,
992 where: {
993 id: accountId
994 },
995 required: true
996 }
997 ]
998 }
999 ]
1000 }
bf64ed41 1001
bf64ed41 1002 return baseQuery
3fd3ab2d 1003 }
d8755eed 1004
3acc5084
C
1005 const countQuery = buildBaseQuery()
1006 const findQuery = buildBaseQuery()
1007
bf64ed41 1008 const findScopes: (string | ScopeOptions)[] = [
a18f275d
C
1009 ScopeNames.WITH_SCHEDULED_UPDATE,
1010 ScopeNames.WITH_BLACKLISTED,
1011 ScopeNames.WITH_THUMBNAILS
1012 ]
3acc5084 1013
3acc5084
C
1014 return Promise.all([
1015 VideoModel.count(countQuery),
0283eaac 1016 VideoModel.scope(findScopes).findAll<MVideoForUser>(findQuery)
3acc5084
C
1017 ]).then(([ count, rows ]) => {
1018 return {
0283eaac 1019 data: rows,
3acc5084
C
1020 total: count
1021 }
1022 })
3fd3ab2d 1023 }
93e1258c 1024
48dce1c9 1025 static async listForApi (options: {
a1587156
C
1026 start: number
1027 count: number
1028 sort: string
1fd61899 1029
a1587156 1030 nsfw: boolean
1fd61899 1031 isLive?: boolean
2760b454
C
1032 isLocal?: boolean
1033 include?: VideoInclude
1fd61899 1034
3c10840f 1035 hasFiles?: boolean // default false
d324756e
C
1036 hasWebtorrentFiles?: boolean
1037 hasHLSFiles?: boolean
1fd61899 1038
a1587156
C
1039 categoryOneOf?: number[]
1040 licenceOneOf?: number[]
1041 languageOneOf?: string[]
1042 tagsOneOf?: string[]
1043 tagsAllOf?: string[]
1fd61899 1044
a1587156
C
1045 accountId?: number
1046 videoChannelId?: number
1fd61899 1047
2760b454 1048 displayOnlyForFollower: DisplayOnlyForFollowerOptions | null
1fd61899 1049
a1587156 1050 videoPlaylistId?: number
1fd61899 1051
a1587156 1052 trendingDays?: number
1fd61899 1053
a1587156
C
1054 user?: MUserAccountId
1055 historyOfUser?: MUserId
1fd61899 1056
fe987656 1057 countVideos?: boolean
1fd61899 1058
d8b34ee5 1059 search?: string
fe987656 1060 }) {
d324756e 1061 VideoModel.throwIfPrivateIncludeWithoutUser(options.include, options.user)
1cd3facc 1062
5f3e2425
C
1063 const trendingDays = options.sort.endsWith('trending')
1064 ? CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
1065 : undefined
d6886027
C
1066
1067 let trendingAlgorithm: string
3d4e112d
RK
1068 if (options.sort.endsWith('hot')) trendingAlgorithm = 'hot'
1069 if (options.sort.endsWith('best')) trendingAlgorithm = 'best'
93e1258c 1070
7ad9b984
C
1071 const serverActor = await getServerActor()
1072
afd2cba5 1073 const queryOptions = {
9c9a236b
C
1074 ...pick(options, [
1075 'start',
1076 'count',
1077 'sort',
1078 'nsfw',
1079 'isLive',
1080 'categoryOneOf',
1081 'licenceOneOf',
1082 'languageOneOf',
1083 'tagsOneOf',
1084 'tagsAllOf',
2760b454
C
1085 'isLocal',
1086 'include',
1087 'displayOnlyForFollower',
3c10840f 1088 'hasFiles',
9c9a236b
C
1089 'accountId',
1090 'videoChannelId',
1091 'videoPlaylistId',
9c9a236b
C
1092 'user',
1093 'historyOfUser',
d324756e
C
1094 'hasHLSFiles',
1095 'hasWebtorrentFiles',
9c9a236b
C
1096 'search'
1097 ]),
1098
2760b454 1099 serverAccountIdForBlock: serverActor.Account.id,
d8b34ee5 1100 trendingDays,
9c9a236b 1101 trendingAlgorithm
48dce1c9
C
1102 }
1103
5f3e2425 1104 return VideoModel.getAvailableForApi(queryOptions, options.countVideos)
93e1258c
C
1105 }
1106
0b18f4aa 1107 static async searchAndPopulateAccountAndServer (options: {
9c9a236b
C
1108 start: number
1109 count: number
1110 sort: string
d324756e 1111
0b18f4aa 1112 nsfw?: boolean
1fd61899 1113 isLive?: boolean
2760b454
C
1114 isLocal?: boolean
1115 include?: VideoInclude
d324756e 1116
0b18f4aa
C
1117 categoryOneOf?: number[]
1118 licenceOneOf?: number[]
1119 languageOneOf?: string[]
1120 tagsOneOf?: string[]
1121 tagsAllOf?: string[]
d324756e
C
1122
1123 displayOnlyForFollower: DisplayOnlyForFollowerOptions | null
1124
1125 user?: MUserAccountId
1126
1127 hasWebtorrentFiles?: boolean
1128 hasHLSFiles?: boolean
1129
1130 search?: string
1131
1132 host?: string
1133 startDate?: string // ISO 8601
1134 endDate?: string // ISO 8601
1135 originallyPublishedStartDate?: string
1136 originallyPublishedEndDate?: string
1137
0b18f4aa
C
1138 durationMin?: number // seconds
1139 durationMax?: number // seconds
fbd67e7f 1140 uuids?: string[]
0b18f4aa 1141 }) {
d324756e
C
1142 VideoModel.throwIfPrivateIncludeWithoutUser(options.include, options.user)
1143
f05a1c30 1144 const serverActor = await getServerActor()
1fd61899 1145
afd2cba5 1146 const queryOptions = {
9c9a236b 1147 ...pick(options, [
2760b454 1148 'include',
9c9a236b
C
1149 'nsfw',
1150 'isLive',
1151 'categoryOneOf',
1152 'licenceOneOf',
1153 'languageOneOf',
1154 'tagsOneOf',
1155 'tagsAllOf',
1156 'user',
2760b454 1157 'isLocal',
9c9a236b
C
1158 'host',
1159 'start',
1160 'count',
1161 'sort',
1162 'startDate',
1163 'endDate',
1164 'originallyPublishedStartDate',
1165 'originallyPublishedEndDate',
1166 'durationMin',
1167 'durationMax',
d324756e
C
1168 'hasHLSFiles',
1169 'hasWebtorrentFiles',
9c9a236b 1170 'uuids',
2760b454
C
1171 'search',
1172 'displayOnlyForFollower'
9c9a236b 1173 ]),
2760b454 1174 serverAccountIdForBlock: serverActor.Account.id
48dce1c9 1175 }
f05a1c30 1176
5f3e2425 1177 return VideoModel.getAvailableForApi(queryOptions)
f05a1c30
C
1178 }
1179
a056ca48
C
1180 static countLocalLives () {
1181 const options = {
1182 where: {
1183 remote: false,
875f0610
C
1184 isLive: true,
1185 state: {
1186 [Op.ne]: VideoState.LIVE_ENDED
1187 }
a056ca48
C
1188 }
1189 }
1190
1191 return VideoModel.count(options)
1192 }
1193
77d7e851
C
1194 static countVideosUploadedByUserSince (userId: number, since: Date) {
1195 const options = {
1196 include: [
1197 {
1198 model: VideoChannelModel.unscoped(),
1199 required: true,
1200 include: [
1201 {
1202 model: AccountModel.unscoped(),
1203 required: true,
1204 include: [
1205 {
1206 model: UserModel.unscoped(),
1207 required: true,
1208 where: {
1209 id: userId
1210 }
1211 }
1212 ]
1213 }
1214 ]
1215 }
1216 ],
1217 where: {
1218 createdAt: {
1219 [Op.gte]: since
1220 }
1221 }
1222 }
1223
1224 return VideoModel.unscoped().count(options)
1225 }
1226
a056ca48
C
1227 static countLivesOfAccount (accountId: number) {
1228 const options = {
1229 where: {
1230 remote: false,
fb4b3f91
C
1231 isLive: true,
1232 state: {
1233 [Op.ne]: VideoState.LIVE_ENDED
1234 }
a056ca48
C
1235 },
1236 include: [
1237 {
1238 required: true,
1239 model: VideoChannelModel.unscoped(),
1240 where: {
1241 accountId
1242 }
1243 }
1244 ]
1245 }
1246
1247 return VideoModel.count(options)
1248 }
1249
71d4af1e 1250 static load (id: number | string, transaction?: Transaction): Promise<MVideoThumbnail> {
3c10840f 1251 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
d8755eed 1252
71d4af1e 1253 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails' })
3fd3ab2d 1254 }
d8755eed 1255
71d4af1e 1256 static loadWithBlacklist (id: number | string, transaction?: Transaction): Promise<MVideoThumbnailBlacklist> {
3c10840f 1257 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
d636ab58 1258
71d4af1e 1259 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails-blacklist' })
d636ab58
C
1260 }
1261
b49f22d8 1262 static loadImmutableAttributes (id: number | string, t?: Transaction): Promise<MVideoImmutable> {
7eba5e1f 1263 const fun = () => {
943e5193
C
1264 const query = {
1265 where: buildWhereIdOrUUID(id),
7eba5e1f
C
1266 transaction: t
1267 }
1268
943e5193 1269 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
7eba5e1f
C
1270 }
1271
1272 return ModelCache.Instance.doCache({
943e5193 1273 cacheType: 'load-video-immutable-id',
7eba5e1f
C
1274 key: '' + id,
1275 deleteKey: 'video',
1276 fun
1277 })
1278 }
1279
b49f22d8 1280 static loadByUrlImmutableAttributes (url: string, transaction?: Transaction): Promise<MVideoImmutable> {
943e5193
C
1281 const fun = () => {
1282 const query: FindOptions = {
1283 where: {
1284 url
1285 },
1286 transaction
1287 }
1288
1289 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1290 }
1291
1292 return ModelCache.Instance.doCache({
1293 cacheType: 'load-video-immutable-url',
1294 key: url,
1295 deleteKey: 'video',
1296 fun
1297 })
1298 }
1299
71d4af1e 1300 static loadOnlyId (id: number | string, transaction?: Transaction): Promise<MVideoId> {
3c10840f 1301 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
627621c1 1302
71d4af1e 1303 return queryBuilder.queryVideo({ id, transaction, type: 'id' })
627621c1
C
1304 }
1305
71d4af1e 1306 static loadWithFiles (id: number | string, transaction?: Transaction, logging?: boolean): Promise<MVideoWithAllFiles> {
3c10840f 1307 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
627621c1 1308
71d4af1e
C
1309 return queryBuilder.queryVideo({ id, transaction, type: 'all-files', logging })
1310 }
fd45e8f4 1311
71d4af1e 1312 static loadByUrl (url: string, transaction?: Transaction): Promise<MVideoThumbnail> {
3c10840f 1313 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
09209296 1314
71d4af1e
C
1315 return queryBuilder.queryVideo({ url, transaction, type: 'thumbnails' })
1316 }
1317
1318 static loadByUrlAndPopulateAccount (url: string, transaction?: Transaction): Promise<MVideoAccountLightBlacklistAllFiles> {
3c10840f 1319 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
71d4af1e
C
1320
1321 return queryBuilder.queryVideo({ url, transaction, type: 'account-blacklist-files' })
1322 }
1323
1324 static loadAndPopulateAccountAndServerAndTags (id: number | string, t?: Transaction, userId?: number): Promise<MVideoFullLight> {
3c10840f 1325 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
09209296 1326
71d4af1e 1327 return queryBuilder.queryVideo({ id, transaction: t, type: 'full-light', userId })
09209296
C
1328 }
1329
89cd1275 1330 static loadForGetAPI (parameters: {
a1587156 1331 id: number | string
ca4b4b2e 1332 transaction?: Transaction
89cd1275 1333 userId?: number
b49f22d8 1334 }): Promise<MVideoDetails> {
ca4b4b2e 1335 const { id, transaction, userId } = parameters
3c10840f 1336 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
09209296 1337
71d4af1e 1338 return queryBuilder.queryVideo({ id, transaction, type: 'api', userId })
da854ddd
C
1339 }
1340
09cababd
C
1341 static async getStats () {
1342 const totalLocalVideos = await VideoModel.count({
1343 where: {
1344 remote: false
1345 }
1346 })
09cababd
C
1347
1348 let totalLocalVideoViews = await VideoModel.sum('views', {
1349 where: {
1350 remote: false
1351 }
1352 })
baab47ca 1353
09cababd
C
1354 // Sequelize could return null...
1355 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1356
2760b454
C
1357 const serverActor = await getServerActor()
1358
baab47ca
C
1359 const { total: totalVideos } = await VideoModel.listForApi({
1360 start: 0,
1361 count: 0,
1362 sort: '-publishedAt',
1363 nsfw: buildNSFWFilter(),
2760b454
C
1364 displayOnlyForFollower: {
1365 actorId: serverActor.id,
1366 orLocalVideos: true
3c10840f 1367 }
baab47ca
C
1368 })
1369
09cababd
C
1370 return {
1371 totalLocalVideos,
1372 totalLocalVideoViews,
1373 totalVideos
1374 }
1375 }
1376
6b616860
C
1377 static incrementViews (id: number, views: number) {
1378 return VideoModel.increment('views', {
1379 by: views,
1380 where: {
1381 id
1382 }
1383 })
1384 }
1385
74d249bc
C
1386 static updateRatesOf (videoId: number, type: VideoRateType, t: Transaction) {
1387 const field = type === 'like'
1388 ? 'likes'
1389 : 'dislikes'
1390
1391 const rawQuery = `UPDATE "video" SET "${field}" = ` +
1392 '(' +
69322042 1393 'SELECT COUNT(id) FROM "accountVideoRate" WHERE "accountVideoRate"."videoId" = "video"."id" AND type = :rateType' +
74d249bc
C
1394 ') ' +
1395 'WHERE "video"."id" = :videoId'
1396
1397 return AccountVideoRateModel.sequelize.query(rawQuery, {
1398 transaction: t,
1399 replacements: { videoId, rateType: type },
1400 type: QueryTypes.UPDATE
1401 })
1402 }
1403
8d427346
C
1404 static checkVideoHasInstanceFollow (videoId: number, followerActorId: number) {
1405 // Instances only share videos
1406 const query = 'SELECT 1 FROM "videoShare" ' +
a1587156 1407 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
f046e2fa 1408 'WHERE "actorFollow"."actorId" = $followerActorId AND "actorFollow"."state" = \'accepted\' AND "videoShare"."videoId" = $videoId ' +
a1587156 1409 'LIMIT 1'
8d427346
C
1410
1411 const options = {
d5d9b6d7 1412 type: QueryTypes.SELECT as QueryTypes.SELECT,
8d427346
C
1413 bind: { followerActorId, videoId },
1414 raw: true
1415 }
1416
1417 return VideoModel.sequelize.query(query, options)
1418 .then(results => results.length === 1)
1419 }
1420
69322042 1421 static bulkUpdateSupportField (ofChannel: MChannel, t: Transaction) {
7d14d4d2
C
1422 const options = {
1423 where: {
69322042 1424 channelId: ofChannel.id
7d14d4d2
C
1425 },
1426 transaction: t
1427 }
1428
69322042 1429 return VideoModel.update({ support: ofChannel.support }, options)
7d14d4d2
C
1430 }
1431
b49f22d8 1432 static getAllIdsFromChannel (videoChannel: MChannelId): Promise<number[]> {
7d14d4d2
C
1433 const query = {
1434 attributes: [ 'id' ],
1435 where: {
1436 channelId: videoChannel.id
1437 }
1438 }
1439
1440 return VideoModel.findAll(query)
a1587156 1441 .then(videos => videos.map(v => v.id))
7d14d4d2
C
1442 }
1443
2d3741d6 1444 // threshold corresponds to how many video the field should have to be returned
7348b1fd 1445 static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
65b21c96 1446 const serverActor = await getServerActor()
7348b1fd 1447
e5dbd508 1448 const queryOptions: BuildVideosListQueryOptions = {
5f3e2425
C
1449 attributes: [ `"${field}"` ],
1450 group: `GROUP BY "${field}"`,
1451 having: `HAVING COUNT("${field}") >= ${threshold}`,
1452 start: 0,
1453 sort: 'random',
1454 count,
2760b454
C
1455 serverAccountIdForBlock: serverActor.Account.id,
1456 displayOnlyForFollower: {
1457 actorId: serverActor.id,
1458 orLocalVideos: true
1459 }
7348b1fd
C
1460 }
1461
e5dbd508 1462 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
2d3741d6 1463
e5dbd508
C
1464 return queryBuilder.queryVideoIds(queryOptions)
1465 .then(rows => rows.map(r => r[field]))
2d3741d6
C
1466 }
1467
b36f41ca
C
1468 static buildTrendingQuery (trendingDays: number) {
1469 return {
1470 attributes: [],
1471 subQuery: false,
1472 model: VideoViewModel,
1473 required: false,
1474 where: {
1475 startDate: {
a1587156 1476 [Op.gte]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays)
b36f41ca
C
1477 }
1478 }
1479 }
1480 }
1481
6e46de09 1482 private static async getAvailableForApi (
e5dbd508 1483 options: BuildVideosListQueryOptions,
6e46de09 1484 countVideos = true
b84d4c80 1485 ): Promise<ResultList<VideoModel>> {
6b842050
C
1486 function getCount () {
1487 if (countVideos !== true) return Promise.resolve(undefined)
8ea6f49a 1488
6b842050 1489 const countOptions = Object.assign({}, options, { isCount: true })
e5dbd508 1490 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
3caf77d3 1491
e5dbd508 1492 return queryBuilder.countVideoIds(countOptions)
6b842050
C
1493 }
1494
1495 function getModels () {
baab47ca
C
1496 if (options.count === 0) return Promise.resolve([])
1497
e5dbd508 1498 const queryBuilder = new VideosModelListQueryBuilder(VideoModel.sequelize)
6b842050 1499
e5dbd508 1500 return queryBuilder.queryVideos(options)
6b842050
C
1501 }
1502
1503 const [ count, rows ] = await Promise.all([ getCount(), getModels() ])
afd2cba5 1504
ddc07312
C
1505 return {
1506 data: rows,
1507 total: count
1508 }
1509 }
1510
d324756e
C
1511 private static throwIfPrivateIncludeWithoutUser (include: VideoInclude, user: MUserAccountId) {
1512 if (VideoModel.isPrivateInclude(include) && !user?.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1513 throw new Error('Try to filter all-local but no user has not the see all videos right')
1514 }
1515 }
1516
3c10840f
C
1517 private static isPrivateInclude (include: VideoInclude) {
1518 return include & VideoInclude.BLACKLISTED ||
1519 include & VideoInclude.BLOCKED_OWNER ||
1520 include & VideoInclude.HIDDEN_PRIVACY ||
1521 include & VideoInclude.NOT_PUBLISHED_STATE
1522 }
1523
5b77537c
C
1524 isBlacklisted () {
1525 return !!this.VideoBlacklist
1526 }
1527
bfbd9128 1528 isBlocked () {
faa9d434 1529 return this.VideoChannel.Account.Actor.Server?.isBlocked() || this.VideoChannel.Account.isBlocked()
bfbd9128
C
1530 }
1531
a1587156 1532 getQualityFileBy<T extends MVideoWithFile> (this: T, fun: (files: MVideoFile[], it: (file: MVideoFile) => number) => MVideoFile) {
24516aa2 1533 // We first transcode to WebTorrent format, so try this array first
d7a25329 1534 if (Array.isArray(this.VideoFiles) && this.VideoFiles.length !== 0) {
92e0f42e 1535 const file = fun(this.VideoFiles, file => file.resolution)
d7a25329
C
1536
1537 return Object.assign(file, { Video: this })
1538 }
1539
1540 // No webtorrent files, try with streaming playlist files
1541 if (Array.isArray(this.VideoStreamingPlaylists) && this.VideoStreamingPlaylists.length !== 0) {
1542 const streamingPlaylistWithVideo = Object.assign(this.VideoStreamingPlaylists[0], { Video: this })
1543
92e0f42e 1544 const file = fun(streamingPlaylistWithVideo.VideoFiles, file => file.resolution)
d7a25329
C
1545 return Object.assign(file, { VideoStreamingPlaylist: streamingPlaylistWithVideo })
1546 }
aaf61f38 1547
d7a25329 1548 return undefined
e4f97bab 1549 }
aaf61f38 1550
a1587156 1551 getMaxQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
92e0f42e
C
1552 return this.getQualityFileBy(maxBy)
1553 }
1554
a1587156 1555 getMinQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
92e0f42e
C
1556 return this.getQualityFileBy(minBy)
1557 }
1558
a1587156 1559 getWebTorrentFile<T extends MVideoWithFile> (this: T, resolution: number): MVideoFileVideo {
29d4e137
C
1560 if (Array.isArray(this.VideoFiles) === false) return undefined
1561
d7a25329
C
1562 const file = this.VideoFiles.find(f => f.resolution === resolution)
1563 if (!file) return undefined
1564
1565 return Object.assign(file, { Video: this })
29d4e137
C
1566 }
1567
6939cbac
C
1568 hasWebTorrentFiles () {
1569 return Array.isArray(this.VideoFiles) === true && this.VideoFiles.length !== 0
1570 }
1571
28dfb44b 1572 async addAndSaveThumbnail (thumbnail: MThumbnail, transaction?: Transaction) {
3acc5084
C
1573 thumbnail.videoId = this.id
1574
1575 const savedThumbnail = await thumbnail.save({ transaction })
1576
e8bafea3
C
1577 if (Array.isArray(this.Thumbnails) === false) this.Thumbnails = []
1578
1579 // Already have this thumbnail, skip
3acc5084 1580 if (this.Thumbnails.find(t => t.id === savedThumbnail.id)) return
e8bafea3 1581
3acc5084 1582 this.Thumbnails.push(savedThumbnail)
e8bafea3
C
1583 }
1584
3acc5084 1585 getMiniature () {
e8bafea3
C
1586 if (Array.isArray(this.Thumbnails) === false) return undefined
1587
3acc5084 1588 return this.Thumbnails.find(t => t.type === ThumbnailType.MINIATURE)
e8bafea3
C
1589 }
1590
6872996d
C
1591 hasPreview () {
1592 return !!this.getPreview()
1593 }
1594
e8bafea3
C
1595 getPreview () {
1596 if (Array.isArray(this.Thumbnails) === false) return undefined
1597
1598 return this.Thumbnails.find(t => t.type === ThumbnailType.PREVIEW)
3fd3ab2d 1599 }
7b1f49de 1600
3fd3ab2d
C
1601 isOwned () {
1602 return this.remote === false
9567011b
C
1603 }
1604
cef534ed 1605 getWatchStaticPath () {
29837f88 1606 return buildVideoWatchPath({ shortUUID: uuidToShort(this.uuid) })
cef534ed
C
1607 }
1608
40e87e9e 1609 getEmbedStaticPath () {
15a7eafb 1610 return buildVideoEmbedPath(this)
3fd3ab2d 1611 }
e4f97bab 1612
3acc5084
C
1613 getMiniatureStaticPath () {
1614 const thumbnail = this.getMiniature()
e8bafea3
C
1615 if (!thumbnail) return null
1616
1617 return join(STATIC_PATHS.THUMBNAILS, thumbnail.filename)
e4f97bab 1618 }
227d02fe 1619
40e87e9e 1620 getPreviewStaticPath () {
e8bafea3
C
1621 const preview = this.getPreview()
1622 if (!preview) return null
1623
1624 // We use a local cache, so specify our cache endpoint instead of potential remote URL
557b13ae 1625 return join(LAZY_STATIC_PATHS.PREVIEWS, preview.filename)
3fd3ab2d 1626 }
40298b02 1627
b5fecbf4 1628 toFormattedJSON (this: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
098eb377 1629 return videoModelToFormattedJSON(this, options)
14d3270f 1630 }
14d3270f 1631
b5fecbf4 1632 toFormattedDetailsJSON (this: MVideoFormattableDetails): VideoDetails {
098eb377 1633 return videoModelToFormattedDetailsJSON(this)
244e76a5
RK
1634 }
1635
f66db4d5 1636 getFormattedVideoFilesJSON (includeMagnet = true): VideoFile[] {
7a499487 1637 let files: VideoFile[] = []
97816649 1638
97816649 1639 if (Array.isArray(this.VideoFiles)) {
f66db4d5 1640 const result = videoFilesModelToFormattedJSON(this, this.VideoFiles, includeMagnet)
7a499487 1641 files = files.concat(result)
97816649
C
1642 }
1643
1644 for (const p of (this.VideoStreamingPlaylists || [])) {
f66db4d5 1645 const result = videoFilesModelToFormattedJSON(this, p.VideoFiles, includeMagnet)
7a499487 1646 files = files.concat(result)
97816649
C
1647 }
1648
7a499487 1649 return files
3fd3ab2d 1650 }
e4f97bab 1651
de6310b2 1652 toActivityPubObject (this: MVideoAP): VideoObject {
098eb377 1653 return videoModelToActivityPubObject(this)
3fd3ab2d
C
1654 }
1655
1656 getTruncatedDescription () {
1657 if (!this.description) return null
93e1258c 1658
bffbebbe 1659 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
687c6180 1660 return peertubeTruncate(this.description, { length: maxLength })
93e1258c
C
1661 }
1662
d7a25329
C
1663 getMaxQualityResolution () {
1664 const file = this.getMaxQualityFile()
1665 const videoOrPlaylist = file.getVideoOrStreamingPlaylist()
0d0e8dd0 1666
0305db28
JB
1667 return VideoPathManager.Instance.makeAvailableVideoFile(videoOrPlaylist, file, originalFilePath => {
1668 return getVideoFileResolution(originalFilePath)
1669 })
3fd3ab2d 1670 }
0d0e8dd0 1671
96f29c0f 1672 getDescriptionAPIPath () {
3fd3ab2d 1673 return `/api/${API_VERSION}/videos/${this.uuid}/description`
feb4bdfd
C
1674 }
1675
d7a25329 1676 getHLSPlaylist (): MStreamingPlaylistFilesVideo {
e2600d8b
C
1677 if (!this.VideoStreamingPlaylists) return undefined
1678
d7a25329 1679 const playlist = this.VideoStreamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
e1ab52d7 1680 if (!playlist) return undefined
1681
d7a25329
C
1682 playlist.Video = this
1683
1684 return playlist
e2600d8b
C
1685 }
1686
d7a25329
C
1687 setHLSPlaylist (playlist: MStreamingPlaylist) {
1688 const toAdd = [ playlist ] as [ VideoStreamingPlaylistModel ]
b9fffa29 1689
d7a25329
C
1690 if (Array.isArray(this.VideoStreamingPlaylists) === false || this.VideoStreamingPlaylists.length === 0) {
1691 this.VideoStreamingPlaylists = toAdd
1692 return
1693 }
1694
1695 this.VideoStreamingPlaylists = this.VideoStreamingPlaylists
a1587156
C
1696 .filter(s => s.type !== VideoStreamingPlaylistType.HLS)
1697 .concat(toAdd)
d7a25329
C
1698 }
1699
764b1a14 1700 removeFileAndTorrent (videoFile: MVideoFile, isRedundancy = false) {
0305db28
JB
1701 const filePath = isRedundancy
1702 ? VideoPathManager.Instance.getFSRedundancyVideoFilePath(this, videoFile)
1703 : VideoPathManager.Instance.getFSVideoFileOutputPath(this, videoFile)
764b1a14
C
1704
1705 const promises: Promise<any>[] = [ remove(filePath) ]
1706 if (!isRedundancy) promises.push(videoFile.removeTorrent())
1707
0305db28
JB
1708 if (videoFile.storage === VideoStorage.OBJECT_STORAGE) {
1709 promises.push(removeWebTorrentObjectStorage(videoFile))
1710 }
1711
764b1a14 1712 return Promise.all(promises)
feb4bdfd
C
1713 }
1714
ffc65cbd 1715 async removeStreamingPlaylistFiles (streamingPlaylist: MStreamingPlaylist, isRedundancy = false) {
0305db28
JB
1716 const directoryPath = isRedundancy
1717 ? getHLSRedundancyDirectory(this)
1718 : getHLSDirectory(this)
09209296 1719
ffc65cbd
C
1720 await remove(directoryPath)
1721
1722 if (isRedundancy !== true) {
a1587156 1723 const streamingPlaylistWithFiles = streamingPlaylist as MStreamingPlaylistFilesVideo
ffc65cbd
C
1724 streamingPlaylistWithFiles.Video = this
1725
1726 if (!Array.isArray(streamingPlaylistWithFiles.VideoFiles)) {
1727 streamingPlaylistWithFiles.VideoFiles = await streamingPlaylistWithFiles.$get('VideoFiles')
1728 }
1729
1730 // Remove physical files and torrents
1731 await Promise.all(
90a8bd30 1732 streamingPlaylistWithFiles.VideoFiles.map(file => file.removeTorrent())
ffc65cbd 1733 )
0305db28
JB
1734
1735 if (streamingPlaylist.storage === VideoStorage.OBJECT_STORAGE) {
1736 await removeHLSObjectStorage(streamingPlaylist, this)
1737 }
ffc65cbd 1738 }
09209296
C
1739 }
1740
1297eb5d
C
1741 isOutdated () {
1742 if (this.isOwned()) return false
1743
9f79ade6 1744 return isOutdated(this, ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL)
1297eb5d
C
1745 }
1746
22a73cb8 1747 hasPrivacyForFederation () {
3092e9bb 1748 return isPrivacyForFederation(this.privacy)
22a73cb8
C
1749 }
1750
68e70a74
C
1751 hasStateForFederation () {
1752 return isStateForFederation(this.state)
1753 }
1754
22a73cb8 1755 isNewVideo (newPrivacy: VideoPrivacy) {
3092e9bb 1756 return this.hasPrivacyForFederation() === false && isPrivacyForFederation(newPrivacy) === true
22a73cb8
C
1757 }
1758
04b8c3fb 1759 setAsRefreshed () {
e024fd6a 1760 return setAsUpdated('video', this.id)
04b8c3fb
C
1761 }
1762
22a73cb8
C
1763 requiresAuth () {
1764 return this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.INTERNAL || !!this.VideoBlacklist
1765 }
1766
1767 setPrivacy (newPrivacy: VideoPrivacy) {
1768 if (this.privacy === VideoPrivacy.PRIVATE && newPrivacy !== VideoPrivacy.PRIVATE) {
1769 this.publishedAt = new Date()
1770 }
1771
1772 this.privacy = newPrivacy
1773 }
1774
1775 isConfidential () {
1776 return this.privacy === VideoPrivacy.PRIVATE ||
1777 this.privacy === VideoPrivacy.UNLISTED ||
1778 this.privacy === VideoPrivacy.INTERNAL
1779 }
1780
9db2330e 1781 async setNewState (newState: VideoState, isNewVideo: boolean, transaction: Transaction) {
0305db28
JB
1782 if (this.state === newState) throw new Error('Cannot use same state ' + newState)
1783
1784 this.state = newState
7920c273 1785
9db2330e 1786 if (this.state === VideoState.PUBLISHED && isNewVideo) {
0305db28 1787 this.publishedAt = new Date()
6fcd19ba 1788 }
aaf61f38 1789
0305db28 1790 await this.save({ transaction })
15d4ee04 1791 }
a96aed15 1792
e1ab52d7 1793 getBandwidthBits (this: MVideo, videoFile: MVideoFile) {
d9a2a031 1794 return Math.ceil((videoFile.size * 8) / this.duration)
c48e82b5
C
1795 }
1796
d9a2a031
C
1797 getTrackerUrls () {
1798 if (this.isOwned()) {
1799 return [
1800 WEBSERVER.URL + '/tracker/announce',
1801 WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket'
1802 ]
1803 }
09209296 1804
d9a2a031 1805 return this.Trackers.map(t => t.url)
09209296 1806 }
a96aed15 1807}