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