]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/models/video/video.ts
Add ability to filter by file type
[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
90a8bd30 808 static listLocal (): Promise<MVideo[]> {
9f1ddd24
C
809 const query = {
810 where: {
811 remote: false
812 }
813 }
814
90a8bd30 815 return VideoModel.findAll(query)
9f1ddd24
C
816 }
817
50d6de9c 818 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
3fd3ab2d
C
819 function getRawQuery (select: string) {
820 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
821 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
50d6de9c
C
822 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
823 'WHERE "Account"."actorId" = ' + actorId
3fd3ab2d
C
824 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
825 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
50d6de9c 826 'WHERE "VideoShare"."actorId" = ' + actorId
558d7c23 827
3fd3ab2d
C
828 return `(${queryVideo}) UNION (${queryVideoShare})`
829 }
aaf61f38 830
3fd3ab2d
C
831 const rawQuery = getRawQuery('"Video"."id"')
832 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
833
834 const query = {
835 distinct: true,
836 offset: start,
837 limit: count,
0c691a18 838 order: getVideoSort('-createdAt', [ 'Tags', 'name', 'ASC' ]),
3fd3ab2d
C
839 where: {
840 id: {
a1587156 841 [Op.in]: Sequelize.literal('(' + rawQuery + ')')
3c75ce12 842 },
3092e9bb 843 [Op.or]: getPrivaciesForFederation()
3fd3ab2d
C
844 },
845 include: [
40e87e9e 846 {
1afb3c47 847 attributes: [ 'filename', 'language', 'fileUrl' ],
40e87e9e
C
848 model: VideoCaptionModel.unscoped(),
849 required: false
850 },
3fd3ab2d 851 {
1d230c44 852 attributes: [ 'id', 'url' ],
2c897999 853 model: VideoShareModel.unscoped(),
3fd3ab2d 854 required: false,
e3d5ea4f
C
855 // We only want videos shared by this actor
856 where: {
a1587156 857 [Op.and]: [
e3d5ea4f
C
858 {
859 id: {
a1587156 860 [Op.not]: null
e3d5ea4f
C
861 }
862 },
863 {
864 actorId
865 }
866 ]
867 },
50d6de9c
C
868 include: [
869 {
2c897999
C
870 attributes: [ 'id', 'url' ],
871 model: ActorModel.unscoped()
50d6de9c
C
872 }
873 ]
3fd3ab2d
C
874 },
875 {
2c897999 876 model: VideoChannelModel.unscoped(),
3fd3ab2d
C
877 required: true,
878 include: [
879 {
2c897999
C
880 attributes: [ 'name' ],
881 model: AccountModel.unscoped(),
882 required: true,
883 include: [
884 {
e3d5ea4f 885 attributes: [ 'id', 'url', 'followersUrl' ],
2c897999
C
886 model: ActorModel.unscoped(),
887 required: true
888 }
889 ]
890 },
891 {
e3d5ea4f 892 attributes: [ 'id', 'url', 'followersUrl' ],
2c897999 893 model: ActorModel.unscoped(),
3fd3ab2d
C
894 required: true
895 }
896 ]
897 },
af4ae64f
C
898 {
899 model: VideoStreamingPlaylistModel.unscoped(),
900 required: false,
901 include: [
902 {
903 model: VideoFileModel,
904 required: false
905 }
906 ]
907 },
c8f3cfeb 908 VideoLiveModel.unscoped(),
3fd3ab2d 909 VideoFileModel,
2c897999 910 TagModel
3fd3ab2d
C
911 ]
912 }
164174a6 913
3fd3ab2d 914 return Bluebird.all([
3acc5084
C
915 VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findAll(query),
916 VideoModel.sequelize.query<{ total: string }>(rawCountQuery, { type: QueryTypes.SELECT })
3fd3ab2d
C
917 ]).then(([ rows, totals ]) => {
918 // totals: totalVideos + totalVideoShares
919 let totalVideos = 0
920 let totalVideoShares = 0
a1587156
C
921 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
922 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
3fd3ab2d
C
923
924 const total = totalVideos + totalVideoShares
925 return {
926 data: rows,
927 total: total
928 }
929 })
930 }
93e1258c 931
9e2e51dc 932 static async listPublishedLiveUUIDs () {
5c0904fc 933 const options = {
9e2e51dc 934 attributes: [ 'uuid' ],
5c0904fc
C
935 where: {
936 isLive: true,
f49b3231 937 remote: false,
5c0904fc
C
938 state: VideoState.PUBLISHED
939 }
940 }
941
b49f22d8
C
942 const result = await VideoModel.findAll(options)
943
9e2e51dc 944 return result.map(v => v.uuid)
5c0904fc
C
945 }
946
a4d2ca07
C
947 static listUserVideosForApi (options: {
948 accountId: number
949 start: number
950 count: number
951 sort: string
978c87e7
C
952
953 channelId?: number
1fd61899 954 isLive?: boolean
bf64ed41 955 search?: string
a4d2ca07 956 }) {
978c87e7 957 const { accountId, channelId, start, count, sort, search, isLive } = options
a4d2ca07 958
3acc5084 959 function buildBaseQuery (): FindOptions {
1fd61899
C
960 const where: WhereOptions = {}
961
962 if (search) {
963 where.name = {
964 [Op.iLike]: '%' + search + '%'
965 }
966 }
967
c4c0c311 968 if (exists(isLive)) {
1fd61899
C
969 where.isLive = isLive
970 }
971
978c87e7
C
972 const channelWhere = channelId
973 ? { id: channelId }
974 : {}
975
1fd61899 976 const baseQuery = {
3acc5084
C
977 offset: start,
978 limit: count,
1fd61899 979 where,
3acc5084
C
980 order: getVideoSort(sort),
981 include: [
982 {
983 model: VideoChannelModel,
984 required: true,
978c87e7 985 where: channelWhere,
3acc5084
C
986 include: [
987 {
988 model: AccountModel,
989 where: {
990 id: accountId
991 },
992 required: true
993 }
994 ]
995 }
996 ]
997 }
bf64ed41 998
bf64ed41 999 return baseQuery
3fd3ab2d 1000 }
d8755eed 1001
3acc5084
C
1002 const countQuery = buildBaseQuery()
1003 const findQuery = buildBaseQuery()
1004
bf64ed41 1005 const findScopes: (string | ScopeOptions)[] = [
a18f275d
C
1006 ScopeNames.WITH_SCHEDULED_UPDATE,
1007 ScopeNames.WITH_BLACKLISTED,
1008 ScopeNames.WITH_THUMBNAILS
1009 ]
3acc5084 1010
3acc5084
C
1011 return Promise.all([
1012 VideoModel.count(countQuery),
0283eaac 1013 VideoModel.scope(findScopes).findAll<MVideoForUser>(findQuery)
3acc5084
C
1014 ]).then(([ count, rows ]) => {
1015 return {
0283eaac 1016 data: rows,
3acc5084
C
1017 total: count
1018 }
1019 })
3fd3ab2d 1020 }
93e1258c 1021
48dce1c9 1022 static async listForApi (options: {
a1587156
C
1023 start: number
1024 count: number
1025 sort: string
1fd61899 1026
a1587156 1027 nsfw: boolean
1fd61899 1028 isLive?: boolean
2760b454
C
1029 isLocal?: boolean
1030 include?: VideoInclude
1fd61899 1031
3c10840f 1032 hasFiles?: boolean // default false
d324756e
C
1033 hasWebtorrentFiles?: boolean
1034 hasHLSFiles?: boolean
1fd61899 1035
a1587156
C
1036 categoryOneOf?: number[]
1037 licenceOneOf?: number[]
1038 languageOneOf?: string[]
1039 tagsOneOf?: string[]
1040 tagsAllOf?: string[]
1fd61899 1041
a1587156
C
1042 accountId?: number
1043 videoChannelId?: number
1fd61899 1044
2760b454 1045 displayOnlyForFollower: DisplayOnlyForFollowerOptions | null
1fd61899 1046
a1587156 1047 videoPlaylistId?: number
1fd61899 1048
a1587156 1049 trendingDays?: number
1fd61899 1050
a1587156
C
1051 user?: MUserAccountId
1052 historyOfUser?: MUserId
1fd61899 1053
fe987656 1054 countVideos?: boolean
1fd61899 1055
d8b34ee5 1056 search?: string
fe987656 1057 }) {
d324756e 1058 VideoModel.throwIfPrivateIncludeWithoutUser(options.include, options.user)
1cd3facc 1059
5f3e2425
C
1060 const trendingDays = options.sort.endsWith('trending')
1061 ? CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
1062 : undefined
d6886027
C
1063
1064 let trendingAlgorithm: string
3d4e112d
RK
1065 if (options.sort.endsWith('hot')) trendingAlgorithm = 'hot'
1066 if (options.sort.endsWith('best')) trendingAlgorithm = 'best'
93e1258c 1067
7ad9b984
C
1068 const serverActor = await getServerActor()
1069
afd2cba5 1070 const queryOptions = {
9c9a236b
C
1071 ...pick(options, [
1072 'start',
1073 'count',
1074 'sort',
1075 'nsfw',
1076 'isLive',
1077 'categoryOneOf',
1078 'licenceOneOf',
1079 'languageOneOf',
1080 'tagsOneOf',
1081 'tagsAllOf',
2760b454
C
1082 'isLocal',
1083 'include',
1084 'displayOnlyForFollower',
3c10840f 1085 'hasFiles',
9c9a236b
C
1086 'accountId',
1087 'videoChannelId',
1088 'videoPlaylistId',
9c9a236b
C
1089 'user',
1090 'historyOfUser',
d324756e
C
1091 'hasHLSFiles',
1092 'hasWebtorrentFiles',
9c9a236b
C
1093 'search'
1094 ]),
1095
2760b454 1096 serverAccountIdForBlock: serverActor.Account.id,
d8b34ee5 1097 trendingDays,
9c9a236b 1098 trendingAlgorithm
48dce1c9
C
1099 }
1100
5f3e2425 1101 return VideoModel.getAvailableForApi(queryOptions, options.countVideos)
93e1258c
C
1102 }
1103
0b18f4aa 1104 static async searchAndPopulateAccountAndServer (options: {
9c9a236b
C
1105 start: number
1106 count: number
1107 sort: string
d324756e 1108
0b18f4aa 1109 nsfw?: boolean
1fd61899 1110 isLive?: boolean
2760b454
C
1111 isLocal?: boolean
1112 include?: VideoInclude
d324756e 1113
0b18f4aa
C
1114 categoryOneOf?: number[]
1115 licenceOneOf?: number[]
1116 languageOneOf?: string[]
1117 tagsOneOf?: string[]
1118 tagsAllOf?: string[]
d324756e
C
1119
1120 displayOnlyForFollower: DisplayOnlyForFollowerOptions | null
1121
1122 user?: MUserAccountId
1123
1124 hasWebtorrentFiles?: boolean
1125 hasHLSFiles?: boolean
1126
1127 search?: string
1128
1129 host?: string
1130 startDate?: string // ISO 8601
1131 endDate?: string // ISO 8601
1132 originallyPublishedStartDate?: string
1133 originallyPublishedEndDate?: string
1134
0b18f4aa
C
1135 durationMin?: number // seconds
1136 durationMax?: number // seconds
fbd67e7f 1137 uuids?: string[]
0b18f4aa 1138 }) {
d324756e
C
1139 VideoModel.throwIfPrivateIncludeWithoutUser(options.include, options.user)
1140
f05a1c30 1141 const serverActor = await getServerActor()
1fd61899 1142
afd2cba5 1143 const queryOptions = {
9c9a236b 1144 ...pick(options, [
2760b454 1145 'include',
9c9a236b
C
1146 'nsfw',
1147 'isLive',
1148 'categoryOneOf',
1149 'licenceOneOf',
1150 'languageOneOf',
1151 'tagsOneOf',
1152 'tagsAllOf',
1153 'user',
2760b454 1154 'isLocal',
9c9a236b
C
1155 'host',
1156 'start',
1157 'count',
1158 'sort',
1159 'startDate',
1160 'endDate',
1161 'originallyPublishedStartDate',
1162 'originallyPublishedEndDate',
1163 'durationMin',
1164 'durationMax',
d324756e
C
1165 'hasHLSFiles',
1166 'hasWebtorrentFiles',
9c9a236b 1167 'uuids',
2760b454
C
1168 'search',
1169 'displayOnlyForFollower'
9c9a236b 1170 ]),
2760b454 1171 serverAccountIdForBlock: serverActor.Account.id
48dce1c9 1172 }
f05a1c30 1173
5f3e2425 1174 return VideoModel.getAvailableForApi(queryOptions)
f05a1c30
C
1175 }
1176
a056ca48
C
1177 static countLocalLives () {
1178 const options = {
1179 where: {
1180 remote: false,
875f0610
C
1181 isLive: true,
1182 state: {
1183 [Op.ne]: VideoState.LIVE_ENDED
1184 }
a056ca48
C
1185 }
1186 }
1187
1188 return VideoModel.count(options)
1189 }
1190
77d7e851
C
1191 static countVideosUploadedByUserSince (userId: number, since: Date) {
1192 const options = {
1193 include: [
1194 {
1195 model: VideoChannelModel.unscoped(),
1196 required: true,
1197 include: [
1198 {
1199 model: AccountModel.unscoped(),
1200 required: true,
1201 include: [
1202 {
1203 model: UserModel.unscoped(),
1204 required: true,
1205 where: {
1206 id: userId
1207 }
1208 }
1209 ]
1210 }
1211 ]
1212 }
1213 ],
1214 where: {
1215 createdAt: {
1216 [Op.gte]: since
1217 }
1218 }
1219 }
1220
1221 return VideoModel.unscoped().count(options)
1222 }
1223
a056ca48
C
1224 static countLivesOfAccount (accountId: number) {
1225 const options = {
1226 where: {
1227 remote: false,
fb4b3f91
C
1228 isLive: true,
1229 state: {
1230 [Op.ne]: VideoState.LIVE_ENDED
1231 }
a056ca48
C
1232 },
1233 include: [
1234 {
1235 required: true,
1236 model: VideoChannelModel.unscoped(),
1237 where: {
1238 accountId
1239 }
1240 }
1241 ]
1242 }
1243
1244 return VideoModel.count(options)
1245 }
1246
71d4af1e 1247 static load (id: number | string, transaction?: Transaction): Promise<MVideoThumbnail> {
3c10840f 1248 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
d8755eed 1249
71d4af1e 1250 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails' })
3fd3ab2d 1251 }
d8755eed 1252
71d4af1e 1253 static loadWithBlacklist (id: number | string, transaction?: Transaction): Promise<MVideoThumbnailBlacklist> {
3c10840f 1254 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
d636ab58 1255
71d4af1e 1256 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails-blacklist' })
d636ab58
C
1257 }
1258
b49f22d8 1259 static loadImmutableAttributes (id: number | string, t?: Transaction): Promise<MVideoImmutable> {
7eba5e1f 1260 const fun = () => {
943e5193
C
1261 const query = {
1262 where: buildWhereIdOrUUID(id),
7eba5e1f
C
1263 transaction: t
1264 }
1265
943e5193 1266 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
7eba5e1f
C
1267 }
1268
1269 return ModelCache.Instance.doCache({
943e5193 1270 cacheType: 'load-video-immutable-id',
7eba5e1f
C
1271 key: '' + id,
1272 deleteKey: 'video',
1273 fun
1274 })
1275 }
1276
b49f22d8 1277 static loadByUrlImmutableAttributes (url: string, transaction?: Transaction): Promise<MVideoImmutable> {
943e5193
C
1278 const fun = () => {
1279 const query: FindOptions = {
1280 where: {
1281 url
1282 },
1283 transaction
1284 }
1285
1286 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1287 }
1288
1289 return ModelCache.Instance.doCache({
1290 cacheType: 'load-video-immutable-url',
1291 key: url,
1292 deleteKey: 'video',
1293 fun
1294 })
1295 }
1296
71d4af1e 1297 static loadOnlyId (id: number | string, transaction?: Transaction): Promise<MVideoId> {
3c10840f 1298 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
627621c1 1299
71d4af1e 1300 return queryBuilder.queryVideo({ id, transaction, type: 'id' })
627621c1
C
1301 }
1302
71d4af1e 1303 static loadWithFiles (id: number | string, transaction?: Transaction, logging?: boolean): Promise<MVideoWithAllFiles> {
3c10840f 1304 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
627621c1 1305
71d4af1e
C
1306 return queryBuilder.queryVideo({ id, transaction, type: 'all-files', logging })
1307 }
fd45e8f4 1308
71d4af1e 1309 static loadByUrl (url: string, transaction?: Transaction): Promise<MVideoThumbnail> {
3c10840f 1310 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
09209296 1311
71d4af1e
C
1312 return queryBuilder.queryVideo({ url, transaction, type: 'thumbnails' })
1313 }
1314
1315 static loadByUrlAndPopulateAccount (url: string, transaction?: Transaction): Promise<MVideoAccountLightBlacklistAllFiles> {
3c10840f 1316 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
71d4af1e
C
1317
1318 return queryBuilder.queryVideo({ url, transaction, type: 'account-blacklist-files' })
1319 }
1320
1321 static loadAndPopulateAccountAndServerAndTags (id: number | string, t?: Transaction, userId?: number): Promise<MVideoFullLight> {
3c10840f 1322 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
09209296 1323
71d4af1e 1324 return queryBuilder.queryVideo({ id, transaction: t, type: 'full-light', userId })
09209296
C
1325 }
1326
89cd1275 1327 static loadForGetAPI (parameters: {
a1587156 1328 id: number | string
ca4b4b2e 1329 transaction?: Transaction
89cd1275 1330 userId?: number
b49f22d8 1331 }): Promise<MVideoDetails> {
ca4b4b2e 1332 const { id, transaction, userId } = parameters
3c10840f 1333 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
09209296 1334
71d4af1e 1335 return queryBuilder.queryVideo({ id, transaction, type: 'api', userId })
da854ddd
C
1336 }
1337
09cababd
C
1338 static async getStats () {
1339 const totalLocalVideos = await VideoModel.count({
1340 where: {
1341 remote: false
1342 }
1343 })
09cababd
C
1344
1345 let totalLocalVideoViews = await VideoModel.sum('views', {
1346 where: {
1347 remote: false
1348 }
1349 })
baab47ca 1350
09cababd
C
1351 // Sequelize could return null...
1352 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1353
2760b454
C
1354 const serverActor = await getServerActor()
1355
baab47ca
C
1356 const { total: totalVideos } = await VideoModel.listForApi({
1357 start: 0,
1358 count: 0,
1359 sort: '-publishedAt',
1360 nsfw: buildNSFWFilter(),
2760b454
C
1361 displayOnlyForFollower: {
1362 actorId: serverActor.id,
1363 orLocalVideos: true
3c10840f 1364 }
baab47ca
C
1365 })
1366
09cababd
C
1367 return {
1368 totalLocalVideos,
1369 totalLocalVideoViews,
1370 totalVideos
1371 }
1372 }
1373
6b616860
C
1374 static incrementViews (id: number, views: number) {
1375 return VideoModel.increment('views', {
1376 by: views,
1377 where: {
1378 id
1379 }
1380 })
1381 }
1382
74d249bc
C
1383 static updateRatesOf (videoId: number, type: VideoRateType, t: Transaction) {
1384 const field = type === 'like'
1385 ? 'likes'
1386 : 'dislikes'
1387
1388 const rawQuery = `UPDATE "video" SET "${field}" = ` +
1389 '(' +
69322042 1390 'SELECT COUNT(id) FROM "accountVideoRate" WHERE "accountVideoRate"."videoId" = "video"."id" AND type = :rateType' +
74d249bc
C
1391 ') ' +
1392 'WHERE "video"."id" = :videoId'
1393
1394 return AccountVideoRateModel.sequelize.query(rawQuery, {
1395 transaction: t,
1396 replacements: { videoId, rateType: type },
1397 type: QueryTypes.UPDATE
1398 })
1399 }
1400
8d427346
C
1401 static checkVideoHasInstanceFollow (videoId: number, followerActorId: number) {
1402 // Instances only share videos
1403 const query = 'SELECT 1 FROM "videoShare" ' +
a1587156 1404 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
f046e2fa 1405 'WHERE "actorFollow"."actorId" = $followerActorId AND "actorFollow"."state" = \'accepted\' AND "videoShare"."videoId" = $videoId ' +
a1587156 1406 'LIMIT 1'
8d427346
C
1407
1408 const options = {
d5d9b6d7 1409 type: QueryTypes.SELECT as QueryTypes.SELECT,
8d427346
C
1410 bind: { followerActorId, videoId },
1411 raw: true
1412 }
1413
1414 return VideoModel.sequelize.query(query, options)
1415 .then(results => results.length === 1)
1416 }
1417
69322042 1418 static bulkUpdateSupportField (ofChannel: MChannel, t: Transaction) {
7d14d4d2
C
1419 const options = {
1420 where: {
69322042 1421 channelId: ofChannel.id
7d14d4d2
C
1422 },
1423 transaction: t
1424 }
1425
69322042 1426 return VideoModel.update({ support: ofChannel.support }, options)
7d14d4d2
C
1427 }
1428
b49f22d8 1429 static getAllIdsFromChannel (videoChannel: MChannelId): Promise<number[]> {
7d14d4d2
C
1430 const query = {
1431 attributes: [ 'id' ],
1432 where: {
1433 channelId: videoChannel.id
1434 }
1435 }
1436
1437 return VideoModel.findAll(query)
a1587156 1438 .then(videos => videos.map(v => v.id))
7d14d4d2
C
1439 }
1440
2d3741d6 1441 // threshold corresponds to how many video the field should have to be returned
7348b1fd 1442 static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
65b21c96 1443 const serverActor = await getServerActor()
7348b1fd 1444
e5dbd508 1445 const queryOptions: BuildVideosListQueryOptions = {
5f3e2425
C
1446 attributes: [ `"${field}"` ],
1447 group: `GROUP BY "${field}"`,
1448 having: `HAVING COUNT("${field}") >= ${threshold}`,
1449 start: 0,
1450 sort: 'random',
1451 count,
2760b454
C
1452 serverAccountIdForBlock: serverActor.Account.id,
1453 displayOnlyForFollower: {
1454 actorId: serverActor.id,
1455 orLocalVideos: true
1456 }
7348b1fd
C
1457 }
1458
e5dbd508 1459 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
2d3741d6 1460
e5dbd508
C
1461 return queryBuilder.queryVideoIds(queryOptions)
1462 .then(rows => rows.map(r => r[field]))
2d3741d6
C
1463 }
1464
b36f41ca
C
1465 static buildTrendingQuery (trendingDays: number) {
1466 return {
1467 attributes: [],
1468 subQuery: false,
1469 model: VideoViewModel,
1470 required: false,
1471 where: {
1472 startDate: {
a1587156 1473 [Op.gte]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays)
b36f41ca
C
1474 }
1475 }
1476 }
1477 }
1478
6e46de09 1479 private static async getAvailableForApi (
e5dbd508 1480 options: BuildVideosListQueryOptions,
6e46de09 1481 countVideos = true
b84d4c80 1482 ): Promise<ResultList<VideoModel>> {
6b842050
C
1483 function getCount () {
1484 if (countVideos !== true) return Promise.resolve(undefined)
8ea6f49a 1485
6b842050 1486 const countOptions = Object.assign({}, options, { isCount: true })
e5dbd508 1487 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
3caf77d3 1488
e5dbd508 1489 return queryBuilder.countVideoIds(countOptions)
6b842050
C
1490 }
1491
1492 function getModels () {
baab47ca
C
1493 if (options.count === 0) return Promise.resolve([])
1494
e5dbd508 1495 const queryBuilder = new VideosModelListQueryBuilder(VideoModel.sequelize)
6b842050 1496
e5dbd508 1497 return queryBuilder.queryVideos(options)
6b842050
C
1498 }
1499
1500 const [ count, rows ] = await Promise.all([ getCount(), getModels() ])
afd2cba5 1501
ddc07312
C
1502 return {
1503 data: rows,
1504 total: count
1505 }
1506 }
1507
d324756e
C
1508 private static throwIfPrivateIncludeWithoutUser (include: VideoInclude, user: MUserAccountId) {
1509 if (VideoModel.isPrivateInclude(include) && !user?.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1510 throw new Error('Try to filter all-local but no user has not the see all videos right')
1511 }
1512 }
1513
3c10840f
C
1514 private static isPrivateInclude (include: VideoInclude) {
1515 return include & VideoInclude.BLACKLISTED ||
1516 include & VideoInclude.BLOCKED_OWNER ||
1517 include & VideoInclude.HIDDEN_PRIVACY ||
1518 include & VideoInclude.NOT_PUBLISHED_STATE
1519 }
1520
5b77537c
C
1521 isBlacklisted () {
1522 return !!this.VideoBlacklist
1523 }
1524
bfbd9128 1525 isBlocked () {
faa9d434 1526 return this.VideoChannel.Account.Actor.Server?.isBlocked() || this.VideoChannel.Account.isBlocked()
bfbd9128
C
1527 }
1528
a1587156 1529 getQualityFileBy<T extends MVideoWithFile> (this: T, fun: (files: MVideoFile[], it: (file: MVideoFile) => number) => MVideoFile) {
24516aa2 1530 // We first transcode to WebTorrent format, so try this array first
d7a25329 1531 if (Array.isArray(this.VideoFiles) && this.VideoFiles.length !== 0) {
92e0f42e 1532 const file = fun(this.VideoFiles, file => file.resolution)
d7a25329
C
1533
1534 return Object.assign(file, { Video: this })
1535 }
1536
1537 // No webtorrent files, try with streaming playlist files
1538 if (Array.isArray(this.VideoStreamingPlaylists) && this.VideoStreamingPlaylists.length !== 0) {
1539 const streamingPlaylistWithVideo = Object.assign(this.VideoStreamingPlaylists[0], { Video: this })
1540
92e0f42e 1541 const file = fun(streamingPlaylistWithVideo.VideoFiles, file => file.resolution)
d7a25329
C
1542 return Object.assign(file, { VideoStreamingPlaylist: streamingPlaylistWithVideo })
1543 }
aaf61f38 1544
d7a25329 1545 return undefined
e4f97bab 1546 }
aaf61f38 1547
a1587156 1548 getMaxQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
92e0f42e
C
1549 return this.getQualityFileBy(maxBy)
1550 }
1551
a1587156 1552 getMinQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
92e0f42e
C
1553 return this.getQualityFileBy(minBy)
1554 }
1555
a1587156 1556 getWebTorrentFile<T extends MVideoWithFile> (this: T, resolution: number): MVideoFileVideo {
29d4e137
C
1557 if (Array.isArray(this.VideoFiles) === false) return undefined
1558
d7a25329
C
1559 const file = this.VideoFiles.find(f => f.resolution === resolution)
1560 if (!file) return undefined
1561
1562 return Object.assign(file, { Video: this })
29d4e137
C
1563 }
1564
6939cbac
C
1565 hasWebTorrentFiles () {
1566 return Array.isArray(this.VideoFiles) === true && this.VideoFiles.length !== 0
1567 }
1568
28dfb44b 1569 async addAndSaveThumbnail (thumbnail: MThumbnail, transaction?: Transaction) {
3acc5084
C
1570 thumbnail.videoId = this.id
1571
1572 const savedThumbnail = await thumbnail.save({ transaction })
1573
e8bafea3
C
1574 if (Array.isArray(this.Thumbnails) === false) this.Thumbnails = []
1575
1576 // Already have this thumbnail, skip
3acc5084 1577 if (this.Thumbnails.find(t => t.id === savedThumbnail.id)) return
e8bafea3 1578
3acc5084 1579 this.Thumbnails.push(savedThumbnail)
e8bafea3
C
1580 }
1581
3acc5084 1582 getMiniature () {
e8bafea3
C
1583 if (Array.isArray(this.Thumbnails) === false) return undefined
1584
3acc5084 1585 return this.Thumbnails.find(t => t.type === ThumbnailType.MINIATURE)
e8bafea3
C
1586 }
1587
6872996d
C
1588 hasPreview () {
1589 return !!this.getPreview()
1590 }
1591
e8bafea3
C
1592 getPreview () {
1593 if (Array.isArray(this.Thumbnails) === false) return undefined
1594
1595 return this.Thumbnails.find(t => t.type === ThumbnailType.PREVIEW)
3fd3ab2d 1596 }
7b1f49de 1597
3fd3ab2d
C
1598 isOwned () {
1599 return this.remote === false
9567011b
C
1600 }
1601
cef534ed 1602 getWatchStaticPath () {
29837f88 1603 return buildVideoWatchPath({ shortUUID: uuidToShort(this.uuid) })
cef534ed
C
1604 }
1605
40e87e9e 1606 getEmbedStaticPath () {
15a7eafb 1607 return buildVideoEmbedPath(this)
3fd3ab2d 1608 }
e4f97bab 1609
3acc5084
C
1610 getMiniatureStaticPath () {
1611 const thumbnail = this.getMiniature()
e8bafea3
C
1612 if (!thumbnail) return null
1613
1614 return join(STATIC_PATHS.THUMBNAILS, thumbnail.filename)
e4f97bab 1615 }
227d02fe 1616
40e87e9e 1617 getPreviewStaticPath () {
e8bafea3
C
1618 const preview = this.getPreview()
1619 if (!preview) return null
1620
1621 // We use a local cache, so specify our cache endpoint instead of potential remote URL
557b13ae 1622 return join(LAZY_STATIC_PATHS.PREVIEWS, preview.filename)
3fd3ab2d 1623 }
40298b02 1624
b5fecbf4 1625 toFormattedJSON (this: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
098eb377 1626 return videoModelToFormattedJSON(this, options)
14d3270f 1627 }
14d3270f 1628
b5fecbf4 1629 toFormattedDetailsJSON (this: MVideoFormattableDetails): VideoDetails {
098eb377 1630 return videoModelToFormattedDetailsJSON(this)
244e76a5
RK
1631 }
1632
f66db4d5 1633 getFormattedVideoFilesJSON (includeMagnet = true): VideoFile[] {
7a499487 1634 let files: VideoFile[] = []
97816649 1635
97816649 1636 if (Array.isArray(this.VideoFiles)) {
f66db4d5 1637 const result = videoFilesModelToFormattedJSON(this, this.VideoFiles, includeMagnet)
7a499487 1638 files = files.concat(result)
97816649
C
1639 }
1640
1641 for (const p of (this.VideoStreamingPlaylists || [])) {
f66db4d5 1642 const result = videoFilesModelToFormattedJSON(this, p.VideoFiles, includeMagnet)
7a499487 1643 files = files.concat(result)
97816649
C
1644 }
1645
7a499487 1646 return files
3fd3ab2d 1647 }
e4f97bab 1648
de6310b2 1649 toActivityPubObject (this: MVideoAP): VideoObject {
098eb377 1650 return videoModelToActivityPubObject(this)
3fd3ab2d
C
1651 }
1652
1653 getTruncatedDescription () {
1654 if (!this.description) return null
93e1258c 1655
bffbebbe 1656 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
687c6180 1657 return peertubeTruncate(this.description, { length: maxLength })
93e1258c
C
1658 }
1659
d7a25329
C
1660 getMaxQualityResolution () {
1661 const file = this.getMaxQualityFile()
1662 const videoOrPlaylist = file.getVideoOrStreamingPlaylist()
0d0e8dd0 1663
0305db28
JB
1664 return VideoPathManager.Instance.makeAvailableVideoFile(videoOrPlaylist, file, originalFilePath => {
1665 return getVideoFileResolution(originalFilePath)
1666 })
3fd3ab2d 1667 }
0d0e8dd0 1668
96f29c0f 1669 getDescriptionAPIPath () {
3fd3ab2d 1670 return `/api/${API_VERSION}/videos/${this.uuid}/description`
feb4bdfd
C
1671 }
1672
d7a25329 1673 getHLSPlaylist (): MStreamingPlaylistFilesVideo {
e2600d8b
C
1674 if (!this.VideoStreamingPlaylists) return undefined
1675
d7a25329
C
1676 const playlist = this.VideoStreamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
1677 playlist.Video = this
1678
1679 return playlist
e2600d8b
C
1680 }
1681
d7a25329
C
1682 setHLSPlaylist (playlist: MStreamingPlaylist) {
1683 const toAdd = [ playlist ] as [ VideoStreamingPlaylistModel ]
b9fffa29 1684
d7a25329
C
1685 if (Array.isArray(this.VideoStreamingPlaylists) === false || this.VideoStreamingPlaylists.length === 0) {
1686 this.VideoStreamingPlaylists = toAdd
1687 return
1688 }
1689
1690 this.VideoStreamingPlaylists = this.VideoStreamingPlaylists
a1587156
C
1691 .filter(s => s.type !== VideoStreamingPlaylistType.HLS)
1692 .concat(toAdd)
d7a25329
C
1693 }
1694
764b1a14 1695 removeFileAndTorrent (videoFile: MVideoFile, isRedundancy = false) {
0305db28
JB
1696 const filePath = isRedundancy
1697 ? VideoPathManager.Instance.getFSRedundancyVideoFilePath(this, videoFile)
1698 : VideoPathManager.Instance.getFSVideoFileOutputPath(this, videoFile)
764b1a14
C
1699
1700 const promises: Promise<any>[] = [ remove(filePath) ]
1701 if (!isRedundancy) promises.push(videoFile.removeTorrent())
1702
0305db28
JB
1703 if (videoFile.storage === VideoStorage.OBJECT_STORAGE) {
1704 promises.push(removeWebTorrentObjectStorage(videoFile))
1705 }
1706
764b1a14 1707 return Promise.all(promises)
feb4bdfd
C
1708 }
1709
ffc65cbd 1710 async removeStreamingPlaylistFiles (streamingPlaylist: MStreamingPlaylist, isRedundancy = false) {
0305db28
JB
1711 const directoryPath = isRedundancy
1712 ? getHLSRedundancyDirectory(this)
1713 : getHLSDirectory(this)
09209296 1714
ffc65cbd
C
1715 await remove(directoryPath)
1716
1717 if (isRedundancy !== true) {
a1587156 1718 const streamingPlaylistWithFiles = streamingPlaylist as MStreamingPlaylistFilesVideo
ffc65cbd
C
1719 streamingPlaylistWithFiles.Video = this
1720
1721 if (!Array.isArray(streamingPlaylistWithFiles.VideoFiles)) {
1722 streamingPlaylistWithFiles.VideoFiles = await streamingPlaylistWithFiles.$get('VideoFiles')
1723 }
1724
1725 // Remove physical files and torrents
1726 await Promise.all(
90a8bd30 1727 streamingPlaylistWithFiles.VideoFiles.map(file => file.removeTorrent())
ffc65cbd 1728 )
0305db28
JB
1729
1730 if (streamingPlaylist.storage === VideoStorage.OBJECT_STORAGE) {
1731 await removeHLSObjectStorage(streamingPlaylist, this)
1732 }
ffc65cbd 1733 }
09209296
C
1734 }
1735
1297eb5d
C
1736 isOutdated () {
1737 if (this.isOwned()) return false
1738
9f79ade6 1739 return isOutdated(this, ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL)
1297eb5d
C
1740 }
1741
22a73cb8 1742 hasPrivacyForFederation () {
3092e9bb 1743 return isPrivacyForFederation(this.privacy)
22a73cb8
C
1744 }
1745
68e70a74
C
1746 hasStateForFederation () {
1747 return isStateForFederation(this.state)
1748 }
1749
22a73cb8 1750 isNewVideo (newPrivacy: VideoPrivacy) {
3092e9bb 1751 return this.hasPrivacyForFederation() === false && isPrivacyForFederation(newPrivacy) === true
22a73cb8
C
1752 }
1753
04b8c3fb 1754 setAsRefreshed () {
e024fd6a 1755 return setAsUpdated('video', this.id)
04b8c3fb
C
1756 }
1757
22a73cb8
C
1758 requiresAuth () {
1759 return this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.INTERNAL || !!this.VideoBlacklist
1760 }
1761
1762 setPrivacy (newPrivacy: VideoPrivacy) {
1763 if (this.privacy === VideoPrivacy.PRIVATE && newPrivacy !== VideoPrivacy.PRIVATE) {
1764 this.publishedAt = new Date()
1765 }
1766
1767 this.privacy = newPrivacy
1768 }
1769
1770 isConfidential () {
1771 return this.privacy === VideoPrivacy.PRIVATE ||
1772 this.privacy === VideoPrivacy.UNLISTED ||
1773 this.privacy === VideoPrivacy.INTERNAL
1774 }
1775
9db2330e 1776 async setNewState (newState: VideoState, isNewVideo: boolean, transaction: Transaction) {
0305db28
JB
1777 if (this.state === newState) throw new Error('Cannot use same state ' + newState)
1778
1779 this.state = newState
7920c273 1780
9db2330e 1781 if (this.state === VideoState.PUBLISHED && isNewVideo) {
0305db28 1782 this.publishedAt = new Date()
6fcd19ba 1783 }
aaf61f38 1784
0305db28 1785 await this.save({ transaction })
15d4ee04 1786 }
a96aed15 1787
d9a2a031
C
1788 getBandwidthBits (videoFile: MVideoFile) {
1789 return Math.ceil((videoFile.size * 8) / this.duration)
c48e82b5
C
1790 }
1791
d9a2a031
C
1792 getTrackerUrls () {
1793 if (this.isOwned()) {
1794 return [
1795 WEBSERVER.URL + '/tracker/announce',
1796 WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket'
1797 ]
1798 }
09209296 1799
d9a2a031 1800 return this.Trackers.map(t => t.url)
09209296 1801 }
a96aed15 1802}