]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/models/video/video.ts
Trending by interval
[github/Chocobozzz/PeerTube.git] / server / models / video / video.ts
CommitLineData
39445ead 1import * as Bluebird from 'bluebird'
c73e83da 2import { map, maxBy } from 'lodash'
571389d4 3import * as magnetUtil from 'magnet-uri'
4d4e5cd4 4import * as parseTorrent from 'parse-torrent'
28be8916 5import { extname, join } from 'path'
e02643f3 6import * as Sequelize from 'sequelize'
3fd3ab2d 7import {
4ba3b8ea
C
8 AllowNull,
9 BeforeDestroy,
10 BelongsTo,
11 BelongsToMany,
12 Column,
13 CreatedAt,
14 DataType,
15 Default,
16 ForeignKey,
17 HasMany,
2baea0c7 18 HasOne,
4ba3b8ea 19 IFindOptions,
9a629c6e 20 IIncludeOptions,
4ba3b8ea
C
21 Is,
22 IsInt,
23 IsUUID,
24 Min,
25 Model,
26 Scopes,
27 Table,
9a629c6e 28 UpdatedAt
3fd3ab2d 29} from 'sequelize-typescript'
2186386c 30import { VideoPrivacy, VideoResolution, VideoState } from '../../../shared'
3fd3ab2d 31import { VideoTorrentObject } from '../../../shared/models/activitypub/objects'
a8462c8e 32import { Video, VideoDetails, VideoFile } from '../../../shared/models/videos'
066e94c5 33import { VideoFilter } from '../../../shared/models/videos/video-query.type'
62689b94 34import { createTorrentPromise, peertubeTruncate } from '../../helpers/core-utils'
da854ddd 35import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
47564bbe 36import { isBooleanValid } from '../../helpers/custom-validators/misc'
3fd3ab2d 37import {
4ba3b8ea
C
38 isVideoCategoryValid,
39 isVideoDescriptionValid,
40 isVideoDurationValid,
41 isVideoLanguageValid,
42 isVideoLicenceValid,
43 isVideoNameValid,
2baea0c7
C
44 isVideoPrivacyValid,
45 isVideoStateValid,
b64c950a 46 isVideoSupportValid
3fd3ab2d 47} from '../../helpers/custom-validators/videos'
3a6f351b 48import { generateImageFromVideoFile, getVideoFileFPS, getVideoFileResolution, transcode } from '../../helpers/ffmpeg-utils'
da854ddd 49import { logger } from '../../helpers/logger'
f05a1c30 50import { getServerActor } from '../../helpers/utils'
65fcc311 51import {
1297eb5d 52 ACTIVITY_PUB,
4ba3b8ea
C
53 API_VERSION,
54 CONFIG,
55 CONSTRAINTS_FIELDS,
56 PREVIEWS_SIZE,
57 REMOTE_SCHEME,
02756fbd 58 STATIC_DOWNLOAD_PATHS,
4ba3b8ea
C
59 STATIC_PATHS,
60 THUMBNAILS_SIZE,
61 VIDEO_CATEGORIES,
28be8916 62 VIDEO_EXT_MIMETYPE,
4ba3b8ea
C
63 VIDEO_LANGUAGES,
64 VIDEO_LICENCES,
2baea0c7
C
65 VIDEO_PRIVACIES,
66 VIDEO_STATES
3fd3ab2d 67} from '../../initializers'
46531a0a
C
68import {
69 getVideoCommentsActivityPubUrl,
70 getVideoDislikesActivityPubUrl,
71 getVideoLikesActivityPubUrl,
72 getVideoSharesActivityPubUrl
73} from '../../lib/activitypub'
50d6de9c 74import { sendDeleteVideo } from '../../lib/activitypub/send'
3fd3ab2d
C
75import { AccountModel } from '../account/account'
76import { AccountVideoRateModel } from '../account/account-video-rate'
50d6de9c 77import { ActorModel } from '../activitypub/actor'
b6a4fd6b 78import { AvatarModel } from '../avatar/avatar'
3fd3ab2d 79import { ServerModel } from '../server/server'
9a629c6e 80import { buildTrigramSearchIndex, createSimilarityAttribute, getVideoSort, throwIfNotValid } from '../utils'
3fd3ab2d
C
81import { TagModel } from './tag'
82import { VideoAbuseModel } from './video-abuse'
83import { VideoChannelModel } from './video-channel'
da854ddd 84import { VideoCommentModel } from './video-comment'
3fd3ab2d
C
85import { VideoFileModel } from './video-file'
86import { VideoShareModel } from './video-share'
87import { VideoTagModel } from './video-tag'
2baea0c7 88import { ScheduleVideoUpdateModel } from './schedule-video-update'
40e87e9e 89import { VideoCaptionModel } from './video-caption'
26b7305a 90import { VideoBlacklistModel } from './video-blacklist'
62689b94 91import { copy, remove, rename, stat, writeFile } from 'fs-extra'
9a629c6e 92import { VideoViewModel } from './video-views'
3fd3ab2d 93
57c36b27
C
94// FIXME: Define indexes here because there is an issue with TS and Sequelize.literal when called directly in the annotation
95const indexes: Sequelize.DefineIndexesOptions[] = [
96 buildTrigramSearchIndex('video_name_trigram', 'name'),
97
8cd72bd3
C
98 { fields: [ 'createdAt' ] },
99 { fields: [ 'publishedAt' ] },
100 { fields: [ 'duration' ] },
101 { fields: [ 'category' ] },
102 { fields: [ 'licence' ] },
103 { fields: [ 'nsfw' ] },
104 { fields: [ 'language' ] },
105 { fields: [ 'waitTranscoding' ] },
106 { fields: [ 'state' ] },
107 { fields: [ 'remote' ] },
108 { fields: [ 'views' ] },
109 { fields: [ 'likes' ] },
110 { fields: [ 'channelId' ] },
57c36b27 111 {
8cd72bd3
C
112 fields: [ 'uuid' ],
113 unique: true
57c36b27
C
114 },
115 {
116 fields: [ 'url'],
117 unique: true
118 }
119]
120
2baea0c7 121export enum ScopeNames {
afd2cba5
C
122 AVAILABLE_FOR_LIST_IDS = 'AVAILABLE_FOR_LIST_IDS',
123 FOR_API = 'FOR_API',
4cb6d457 124 WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
d48ff09d 125 WITH_TAGS = 'WITH_TAGS',
bbe0f064 126 WITH_FILES = 'WITH_FILES',
191764f3
C
127 WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE',
128 WITH_BLACKLISTED = 'WITH_BLACKLISTED'
d48ff09d
C
129}
130
afd2cba5
C
131type ForAPIOptions = {
132 ids: number[]
133 withFiles?: boolean
134}
135
136type AvailableForListIDsOptions = {
137 actorId: number
138 includeLocalVideos: boolean
139 filter?: VideoFilter
140 categoryOneOf?: number[]
141 nsfw?: boolean
142 licenceOneOf?: number[]
143 languageOneOf?: string[]
144 tagsOneOf?: string[]
145 tagsAllOf?: string[]
146 withFiles?: boolean
147 accountId?: number
d525fc39 148 videoChannelId?: number
9a629c6e 149 trendingDays?: number
d525fc39
C
150}
151
d48ff09d 152@Scopes({
afd2cba5 153 [ScopeNames.FOR_API]: (options: ForAPIOptions) => {
0626e7af 154 const accountInclude = {
03e12d7c 155 attributes: [ 'id', 'name' ],
0626e7af
C
156 model: AccountModel.unscoped(),
157 required: true,
0626e7af
C
158 include: [
159 {
03e12d7c 160 attributes: [ 'id', 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
0626e7af
C
161 model: ActorModel.unscoped(),
162 required: true,
0626e7af
C
163 include: [
164 {
165 attributes: [ 'host' ],
166 model: ServerModel.unscoped(),
167 required: false
168 },
169 {
170 model: AvatarModel.unscoped(),
171 required: false
172 }
173 ]
174 }
175 ]
176 }
177
48dce1c9 178 const videoChannelInclude = {
0f320037 179 attributes: [ 'name', 'description', 'id' ],
48dce1c9
C
180 model: VideoChannelModel.unscoped(),
181 required: true,
48dce1c9 182 include: [
0f320037
C
183 {
184 attributes: [ 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
185 model: ActorModel.unscoped(),
186 required: true,
187 include: [
188 {
189 attributes: [ 'host' ],
190 model: ServerModel.unscoped(),
191 required: false
192 },
193 {
194 model: AvatarModel.unscoped(),
195 required: false
196 }
197 ]
198 },
48dce1c9
C
199 accountInclude
200 ]
201 }
202
244e76a5 203 const query: IFindOptions<VideoModel> = {
afd2cba5
C
204 where: {
205 id: {
206 [Sequelize.Op.any]: options.ids
207 }
208 },
209 include: [ videoChannelInclude ]
210 }
211
212 if (options.withFiles === true) {
213 query.include.push({
214 model: VideoFileModel.unscoped(),
215 required: true
216 })
217 }
218
219 return query
220 },
221 [ScopeNames.AVAILABLE_FOR_LIST_IDS]: (options: AvailableForListIDsOptions) => {
222 const query: IFindOptions<VideoModel> = {
223 attributes: [ 'id' ],
244e76a5
RK
224 where: {
225 id: {
b6314e3c
C
226 [Sequelize.Op.and]: [
227 {
228 [ Sequelize.Op.notIn ]: Sequelize.literal(
229 '(SELECT "videoBlacklist"."videoId" FROM "videoBlacklist")'
230 )
231 }
232 ]
244e76a5 233 },
2186386c
C
234 // Always list public videos
235 privacy: VideoPrivacy.PUBLIC,
236 // Always list published videos, or videos that are being transcoded but on which we don't want to wait for transcoding
237 [ Sequelize.Op.or ]: [
238 {
239 state: VideoState.PUBLISHED
240 },
241 {
242 [ Sequelize.Op.and ]: {
243 state: VideoState.TO_TRANSCODE,
244 waitTranscoding: false
245 }
246 }
247 ]
50d6de9c 248 },
afd2cba5
C
249 include: [ ]
250 }
251
252 if (options.filter || options.accountId || options.videoChannelId) {
253 const videoChannelInclude: IIncludeOptions = {
254 attributes: [],
255 model: VideoChannelModel.unscoped(),
256 required: true
257 }
258
259 if (options.videoChannelId) {
260 videoChannelInclude.where = {
261 id: options.videoChannelId
262 }
263 }
264
265 if (options.filter || options.accountId) {
266 const accountInclude: IIncludeOptions = {
267 attributes: [],
268 model: AccountModel.unscoped(),
269 required: true
270 }
271
272 if (options.filter) {
273 accountInclude.include = [
274 {
275 attributes: [],
276 model: ActorModel.unscoped(),
277 required: true,
278 where: VideoModel.buildActorWhereWithFilter(options.filter)
279 }
280 ]
281 }
282
283 if (options.accountId) {
284 accountInclude.where = { id: options.accountId }
285 }
286
287 videoChannelInclude.include = [ accountInclude ]
288 }
289
290 query.include.push(videoChannelInclude)
244e76a5
RK
291 }
292
687d638c
C
293 if (options.actorId) {
294 let localVideosReq = ''
295 if (options.includeLocalVideos === true) {
296 localVideosReq = ' UNION ALL ' +
297 'SELECT "video"."id" AS "id" FROM "video" ' +
298 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
299 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
300 'INNER JOIN "actor" ON "account"."actorId" = "actor"."id" ' +
301 'WHERE "actor"."serverId" IS NULL'
302 }
303
304 // Force actorId to be a number to avoid SQL injections
305 const actorIdNumber = parseInt(options.actorId.toString(), 10)
b6314e3c
C
306 query.where['id'][Sequelize.Op.and].push({
307 [ Sequelize.Op.in ]: Sequelize.literal(
308 '(' +
309 'SELECT "videoShare"."videoId" AS "id" FROM "videoShare" ' +
310 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
311 'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
312 ' UNION ALL ' +
313 'SELECT "video"."id" AS "id" FROM "video" ' +
314 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
315 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
316 'INNER JOIN "actor" ON "account"."actorId" = "actor"."id" ' +
317 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "actor"."id" ' +
318 'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
319 localVideosReq +
320 ')'
321 )
322 })
687d638c
C
323 }
324
48dce1c9 325 if (options.withFiles === true) {
b6314e3c
C
326 query.where['id'][Sequelize.Op.and].push({
327 [ Sequelize.Op.in ]: Sequelize.literal(
328 '(SELECT "videoId" FROM "videoFile")'
329 )
244e76a5
RK
330 })
331 }
332
d525fc39
C
333 // FIXME: issues with sequelize count when making a join on n:m relation, so we just make a IN()
334 if (options.tagsAllOf || options.tagsOneOf) {
335 const createTagsIn = (tags: string[]) => {
336 return tags.map(t => VideoModel.sequelize.escape(t))
337 .join(', ')
338 }
339
340 if (options.tagsOneOf) {
b6314e3c
C
341 query.where['id'][Sequelize.Op.and].push({
342 [Sequelize.Op.in]: Sequelize.literal(
343 '(' +
d525fc39
C
344 'SELECT "videoId" FROM "videoTag" ' +
345 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
346 'WHERE "tag"."name" IN (' + createTagsIn(options.tagsOneOf) + ')' +
b6314e3c
C
347 ')'
348 )
349 })
d525fc39
C
350 }
351
352 if (options.tagsAllOf) {
b6314e3c
C
353 query.where['id'][Sequelize.Op.and].push({
354 [Sequelize.Op.in]: Sequelize.literal(
d525fc39 355 '(' +
b6314e3c
C
356 'SELECT "videoId" FROM "videoTag" ' +
357 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
358 'WHERE "tag"."name" IN (' + createTagsIn(options.tagsAllOf) + ')' +
359 'GROUP BY "videoTag"."videoId" HAVING COUNT(*) = ' + options.tagsAllOf.length +
d525fc39 360 ')'
b6314e3c
C
361 )
362 })
d525fc39
C
363 }
364 }
365
366 if (options.nsfw === true || options.nsfw === false) {
367 query.where['nsfw'] = options.nsfw
368 }
369
370 if (options.categoryOneOf) {
371 query.where['category'] = {
372 [Sequelize.Op.or]: options.categoryOneOf
373 }
374 }
375
376 if (options.licenceOneOf) {
377 query.where['licence'] = {
378 [Sequelize.Op.or]: options.licenceOneOf
379 }
0883b324
C
380 }
381
d525fc39
C
382 if (options.languageOneOf) {
383 query.where['language'] = {
384 [Sequelize.Op.or]: options.languageOneOf
385 }
61b909b9
P
386 }
387
9a629c6e
C
388 if (options.trendingDays) {
389 query.include.push({
390 attributes: [],
391 model: VideoViewModel,
392 required: false,
393 where: {
394 startDate: {
395 [ Sequelize.Op.gte ]: new Date(new Date().getTime() - (24 * 3600 * 1000) * options.trendingDays)
396 }
397 }
398 })
399
400 query.subQuery = false
401 }
402
244e76a5
RK
403 return query
404 },
4cb6d457 405 [ScopeNames.WITH_ACCOUNT_DETAILS]: {
d48ff09d
C
406 include: [
407 {
6120941f 408 model: () => VideoChannelModel.unscoped(),
d48ff09d
C
409 required: true,
410 include: [
6120941f
C
411 {
412 attributes: {
413 exclude: [ 'privateKey', 'publicKey' ]
414 },
3e500247
C
415 model: () => ActorModel.unscoped(),
416 required: true,
417 include: [
418 {
419 attributes: [ 'host' ],
420 model: () => ServerModel.unscoped(),
421 required: false
52d9f792
C
422 },
423 {
424 model: () => AvatarModel.unscoped(),
425 required: false
3e500247
C
426 }
427 ]
6120941f 428 },
d48ff09d 429 {
3e500247 430 model: () => AccountModel.unscoped(),
d48ff09d
C
431 required: true,
432 include: [
433 {
3e500247 434 model: () => ActorModel.unscoped(),
6120941f
C
435 attributes: {
436 exclude: [ 'privateKey', 'publicKey' ]
437 },
50d6de9c
C
438 required: true,
439 include: [
440 {
3e500247
C
441 attributes: [ 'host' ],
442 model: () => ServerModel.unscoped(),
50d6de9c 443 required: false
b6a4fd6b
C
444 },
445 {
446 model: () => AvatarModel.unscoped(),
447 required: false
50d6de9c
C
448 }
449 ]
d48ff09d
C
450 }
451 ]
452 }
453 ]
454 }
455 ]
456 },
457 [ScopeNames.WITH_TAGS]: {
458 include: [ () => TagModel ]
459 },
191764f3
C
460 [ScopeNames.WITH_BLACKLISTED]: {
461 include: [
462 {
463 attributes: [ 'id', 'reason' ],
464 model: () => VideoBlacklistModel,
465 required: false
466 }
467 ]
468 },
d48ff09d
C
469 [ScopeNames.WITH_FILES]: {
470 include: [
471 {
e53f952e 472 model: () => VideoFileModel.unscoped(),
fbad87b0 473 required: false
d48ff09d
C
474 }
475 ]
bbe0f064
C
476 },
477 [ScopeNames.WITH_SCHEDULED_UPDATE]: {
478 include: [
479 {
480 model: () => ScheduleVideoUpdateModel.unscoped(),
481 required: false
482 }
483 ]
d48ff09d
C
484 }
485})
3fd3ab2d
C
486@Table({
487 tableName: 'video',
57c36b27 488 indexes
3fd3ab2d
C
489})
490export class VideoModel extends Model<VideoModel> {
491
492 @AllowNull(false)
493 @Default(DataType.UUIDV4)
494 @IsUUID(4)
495 @Column(DataType.UUID)
496 uuid: string
497
498 @AllowNull(false)
499 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
500 @Column
501 name: string
502
503 @AllowNull(true)
504 @Default(null)
505 @Is('VideoCategory', value => throwIfNotValid(value, isVideoCategoryValid, 'category'))
506 @Column
507 category: number
508
509 @AllowNull(true)
510 @Default(null)
511 @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence'))
512 @Column
513 licence: number
514
515 @AllowNull(true)
516 @Default(null)
517 @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language'))
9d3ef9fe
C
518 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
519 language: string
3fd3ab2d
C
520
521 @AllowNull(false)
522 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
523 @Column
524 privacy: number
525
526 @AllowNull(false)
47564bbe 527 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
3fd3ab2d
C
528 @Column
529 nsfw: boolean
530
531 @AllowNull(true)
532 @Default(null)
533 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description'))
534 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
535 description: string
536
2422c46b
C
537 @AllowNull(true)
538 @Default(null)
539 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support'))
540 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
541 support: string
542
3fd3ab2d
C
543 @AllowNull(false)
544 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
545 @Column
546 duration: number
547
548 @AllowNull(false)
549 @Default(0)
550 @IsInt
551 @Min(0)
552 @Column
553 views: number
554
555 @AllowNull(false)
556 @Default(0)
557 @IsInt
558 @Min(0)
559 @Column
560 likes: number
561
562 @AllowNull(false)
563 @Default(0)
564 @IsInt
565 @Min(0)
566 @Column
567 dislikes: number
568
569 @AllowNull(false)
570 @Column
571 remote: boolean
572
573 @AllowNull(false)
574 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
575 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
576 url: string
577
47564bbe
C
578 @AllowNull(false)
579 @Column
580 commentsEnabled: boolean
581
2186386c
C
582 @AllowNull(false)
583 @Column
584 waitTranscoding: boolean
585
586 @AllowNull(false)
587 @Default(null)
588 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
589 @Column
590 state: VideoState
591
3fd3ab2d
C
592 @CreatedAt
593 createdAt: Date
594
595 @UpdatedAt
596 updatedAt: Date
597
2922e048
JLB
598 @AllowNull(false)
599 @Default(Sequelize.NOW)
600 @Column
601 publishedAt: Date
602
3fd3ab2d
C
603 @ForeignKey(() => VideoChannelModel)
604 @Column
605 channelId: number
606
607 @BelongsTo(() => VideoChannelModel, {
feb4bdfd 608 foreignKey: {
50d6de9c 609 allowNull: true
feb4bdfd 610 },
6b738c7a 611 hooks: true
feb4bdfd 612 })
3fd3ab2d 613 VideoChannel: VideoChannelModel
7920c273 614
3fd3ab2d 615 @BelongsToMany(() => TagModel, {
7920c273 616 foreignKey: 'videoId',
3fd3ab2d
C
617 through: () => VideoTagModel,
618 onDelete: 'CASCADE'
7920c273 619 })
3fd3ab2d 620 Tags: TagModel[]
55fa55a9 621
3fd3ab2d 622 @HasMany(() => VideoAbuseModel, {
55fa55a9
C
623 foreignKey: {
624 name: 'videoId',
625 allowNull: false
626 },
627 onDelete: 'cascade'
628 })
3fd3ab2d 629 VideoAbuses: VideoAbuseModel[]
93e1258c 630
3fd3ab2d 631 @HasMany(() => VideoFileModel, {
93e1258c
C
632 foreignKey: {
633 name: 'videoId',
634 allowNull: false
635 },
636 onDelete: 'cascade'
637 })
3fd3ab2d 638 VideoFiles: VideoFileModel[]
e71bcc0f 639
3fd3ab2d 640 @HasMany(() => VideoShareModel, {
e71bcc0f
C
641 foreignKey: {
642 name: 'videoId',
643 allowNull: false
644 },
645 onDelete: 'cascade'
646 })
3fd3ab2d 647 VideoShares: VideoShareModel[]
16b90975 648
3fd3ab2d 649 @HasMany(() => AccountVideoRateModel, {
16b90975
C
650 foreignKey: {
651 name: 'videoId',
652 allowNull: false
653 },
654 onDelete: 'cascade'
655 })
3fd3ab2d 656 AccountVideoRates: AccountVideoRateModel[]
f285faa0 657
da854ddd
C
658 @HasMany(() => VideoCommentModel, {
659 foreignKey: {
660 name: 'videoId',
661 allowNull: false
662 },
f05a1c30
C
663 onDelete: 'cascade',
664 hooks: true
da854ddd
C
665 })
666 VideoComments: VideoCommentModel[]
667
9a629c6e
C
668 @HasMany(() => VideoViewModel, {
669 foreignKey: {
670 name: 'videoId',
671 allowNull: false
672 },
673 onDelete: 'cascade',
674 hooks: true
675 })
676 VideoViews: VideoViewModel[]
677
2baea0c7
C
678 @HasOne(() => ScheduleVideoUpdateModel, {
679 foreignKey: {
680 name: 'videoId',
681 allowNull: false
682 },
683 onDelete: 'cascade'
684 })
685 ScheduleVideoUpdate: ScheduleVideoUpdateModel
686
26b7305a
C
687 @HasOne(() => VideoBlacklistModel, {
688 foreignKey: {
689 name: 'videoId',
690 allowNull: false
691 },
692 onDelete: 'cascade'
693 })
694 VideoBlacklist: VideoBlacklistModel
695
40e87e9e
C
696 @HasMany(() => VideoCaptionModel, {
697 foreignKey: {
698 name: 'videoId',
699 allowNull: false
700 },
701 onDelete: 'cascade',
702 hooks: true,
703 ['separate' as any]: true
704 })
705 VideoCaptions: VideoCaptionModel[]
706
f05a1c30
C
707 @BeforeDestroy
708 static async sendDelete (instance: VideoModel, options) {
709 if (instance.isOwned()) {
710 if (!instance.VideoChannel) {
711 instance.VideoChannel = await instance.$get('VideoChannel', {
712 include: [
713 {
714 model: AccountModel,
715 include: [ ActorModel ]
716 }
717 ],
718 transaction: options.transaction
719 }) as VideoChannelModel
720 }
721
f05a1c30
C
722 return sendDeleteVideo(instance, options.transaction)
723 }
724
725 return undefined
726 }
727
6b738c7a 728 @BeforeDestroy
40e87e9e 729 static async removeFiles (instance: VideoModel) {
f05a1c30 730 const tasks: Promise<any>[] = []
f285faa0 731
8e0fd45e 732 logger.info('Removing files of video %s.', instance.url)
6b738c7a 733
f05a1c30 734 tasks.push(instance.removeThumbnail())
93e1258c 735
3fd3ab2d 736 if (instance.isOwned()) {
f05a1c30
C
737 if (!Array.isArray(instance.VideoFiles)) {
738 instance.VideoFiles = await instance.$get('VideoFiles') as VideoFileModel[]
739 }
740
741 tasks.push(instance.removePreview())
40298b02 742
3fd3ab2d
C
743 // Remove physical files and torrents
744 instance.VideoFiles.forEach(file => {
745 tasks.push(instance.removeFile(file))
746 tasks.push(instance.removeTorrent(file))
747 })
748 }
40298b02 749
6b738c7a
C
750 // Do not wait video deletion because we could be in a transaction
751 Promise.all(tasks)
3fd3ab2d 752 .catch(err => {
18dbb5b9 753 logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err })
3fd3ab2d 754 })
6b738c7a
C
755
756 return undefined
3fd3ab2d 757 }
f285faa0 758
3fd3ab2d 759 static list () {
d48ff09d 760 return VideoModel.scope(ScopeNames.WITH_FILES).findAll()
3fd3ab2d 761 }
f285faa0 762
50d6de9c 763 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
3fd3ab2d
C
764 function getRawQuery (select: string) {
765 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
766 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
50d6de9c
C
767 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
768 'WHERE "Account"."actorId" = ' + actorId
3fd3ab2d
C
769 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
770 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
50d6de9c 771 'WHERE "VideoShare"."actorId" = ' + actorId
558d7c23 772
3fd3ab2d
C
773 return `(${queryVideo}) UNION (${queryVideoShare})`
774 }
aaf61f38 775
3fd3ab2d
C
776 const rawQuery = getRawQuery('"Video"."id"')
777 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
778
779 const query = {
780 distinct: true,
781 offset: start,
782 limit: count,
9a629c6e 783 order: getVideoSort('createdAt', [ 'Tags', 'name', 'ASC' ]),
3fd3ab2d
C
784 where: {
785 id: {
786 [Sequelize.Op.in]: Sequelize.literal('(' + rawQuery + ')')
3c75ce12
C
787 },
788 [Sequelize.Op.or]: [
789 { privacy: VideoPrivacy.PUBLIC },
790 { privacy: VideoPrivacy.UNLISTED }
791 ]
3fd3ab2d
C
792 },
793 include: [
40e87e9e
C
794 {
795 attributes: [ 'language' ],
796 model: VideoCaptionModel.unscoped(),
797 required: false
798 },
3fd3ab2d 799 {
1d230c44 800 attributes: [ 'id', 'url' ],
2c897999 801 model: VideoShareModel.unscoped(),
3fd3ab2d 802 required: false,
e3d5ea4f
C
803 // We only want videos shared by this actor
804 where: {
805 [Sequelize.Op.and]: [
806 {
807 id: {
808 [Sequelize.Op.not]: null
809 }
810 },
811 {
812 actorId
813 }
814 ]
815 },
50d6de9c
C
816 include: [
817 {
2c897999
C
818 attributes: [ 'id', 'url' ],
819 model: ActorModel.unscoped()
50d6de9c
C
820 }
821 ]
3fd3ab2d
C
822 },
823 {
2c897999 824 model: VideoChannelModel.unscoped(),
3fd3ab2d
C
825 required: true,
826 include: [
827 {
2c897999
C
828 attributes: [ 'name' ],
829 model: AccountModel.unscoped(),
830 required: true,
831 include: [
832 {
e3d5ea4f 833 attributes: [ 'id', 'url', 'followersUrl' ],
2c897999
C
834 model: ActorModel.unscoped(),
835 required: true
836 }
837 ]
838 },
839 {
e3d5ea4f 840 attributes: [ 'id', 'url', 'followersUrl' ],
2c897999 841 model: ActorModel.unscoped(),
3fd3ab2d
C
842 required: true
843 }
844 ]
845 },
3fd3ab2d 846 VideoFileModel,
2c897999 847 TagModel
3fd3ab2d
C
848 ]
849 }
164174a6 850
3fd3ab2d
C
851 return Bluebird.all([
852 // FIXME: typing issue
853 VideoModel.findAll(query as any),
854 VideoModel.sequelize.query(rawCountQuery, { type: Sequelize.QueryTypes.SELECT })
855 ]).then(([ rows, totals ]) => {
856 // totals: totalVideos + totalVideoShares
857 let totalVideos = 0
858 let totalVideoShares = 0
859 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
860 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
861
862 const total = totalVideos + totalVideoShares
863 return {
864 data: rows,
865 total: total
866 }
867 })
868 }
93e1258c 869
26b7305a 870 static listUserVideosForApi (accountId: number, start: number, count: number, sort: string, withFiles = false) {
244e76a5 871 const query: IFindOptions<VideoModel> = {
3fd3ab2d
C
872 offset: start,
873 limit: count,
9a629c6e 874 order: getVideoSort(sort),
3fd3ab2d
C
875 include: [
876 {
877 model: VideoChannelModel,
878 required: true,
879 include: [
880 {
881 model: AccountModel,
882 where: {
7b87d2d5 883 id: accountId
3fd3ab2d
C
884 },
885 required: true
886 }
887 ]
2baea0c7
C
888 },
889 {
890 model: ScheduleVideoUpdateModel,
891 required: false
26b7305a
C
892 },
893 {
894 model: VideoBlacklistModel,
895 required: false
d48ff09d 896 }
3fd3ab2d
C
897 ]
898 }
d8755eed 899
244e76a5
RK
900 if (withFiles === true) {
901 query.include.push({
902 model: VideoFileModel.unscoped(),
903 required: true
904 })
905 }
906
3fd3ab2d
C
907 return VideoModel.findAndCountAll(query).then(({ rows, count }) => {
908 return {
909 data: rows,
910 total: count
911 }
912 })
913 }
93e1258c 914
48dce1c9 915 static async listForApi (options: {
0626e7af
C
916 start: number,
917 count: number,
918 sort: string,
d525fc39 919 nsfw: boolean,
06a05d5f 920 includeLocalVideos: boolean,
48dce1c9 921 withFiles: boolean,
d525fc39
C
922 categoryOneOf?: number[],
923 licenceOneOf?: number[],
924 languageOneOf?: string[],
925 tagsOneOf?: string[],
926 tagsAllOf?: string[],
0626e7af 927 filter?: VideoFilter,
48dce1c9 928 accountId?: number,
06a05d5f
C
929 videoChannelId?: number,
930 actorId?: number
9a629c6e 931 trendingDays?: number
48dce1c9 932 }) {
9a629c6e 933 const query: IFindOptions<VideoModel> = {
48dce1c9
C
934 offset: options.start,
935 limit: options.count,
9a629c6e
C
936 order: getVideoSort(options.sort)
937 }
938
939 let trendingDays: number
940 if (options.sort.endsWith('trending')) {
941 trendingDays = CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
942
943 query.group = 'VideoModel.id'
3fd3ab2d 944 }
93e1258c 945
687d638c
C
946 // actorId === null has a meaning, so just check undefined
947 const actorId = options.actorId !== undefined ? options.actorId : (await getServerActor()).id
06a05d5f 948
afd2cba5
C
949 const queryOptions = {
950 actorId,
951 nsfw: options.nsfw,
952 categoryOneOf: options.categoryOneOf,
953 licenceOneOf: options.licenceOneOf,
954 languageOneOf: options.languageOneOf,
955 tagsOneOf: options.tagsOneOf,
956 tagsAllOf: options.tagsAllOf,
957 filter: options.filter,
958 withFiles: options.withFiles,
959 accountId: options.accountId,
960 videoChannelId: options.videoChannelId,
9a629c6e
C
961 includeLocalVideos: options.includeLocalVideos,
962 trendingDays
48dce1c9
C
963 }
964
afd2cba5 965 return VideoModel.getAvailableForApi(query, queryOptions)
93e1258c
C
966 }
967
0b18f4aa 968 static async searchAndPopulateAccountAndServer (options: {
06a05d5f 969 includeLocalVideos: boolean
d4112450 970 search?: string
0b18f4aa
C
971 start?: number
972 count?: number
973 sort?: string
974 startDate?: string // ISO 8601
975 endDate?: string // ISO 8601
976 nsfw?: boolean
977 categoryOneOf?: number[]
978 licenceOneOf?: number[]
979 languageOneOf?: string[]
980 tagsOneOf?: string[]
981 tagsAllOf?: string[]
982 durationMin?: number // seconds
983 durationMax?: number // seconds
984 }) {
d525fc39
C
985 const whereAnd = [ ]
986
987 if (options.startDate || options.endDate) {
988 const publishedAtRange = { }
989
990 if (options.startDate) publishedAtRange[Sequelize.Op.gte] = options.startDate
991 if (options.endDate) publishedAtRange[Sequelize.Op.lte] = options.endDate
992
993 whereAnd.push({ publishedAt: publishedAtRange })
994 }
995
996 if (options.durationMin || options.durationMax) {
997 const durationRange = { }
998
999 if (options.durationMin) durationRange[Sequelize.Op.gte] = options.durationMin
1000 if (options.durationMax) durationRange[Sequelize.Op.lte] = options.durationMax
1001
1002 whereAnd.push({ duration: durationRange })
1003 }
1004
d4112450 1005 const attributesInclude = []
dbfd3e9b
C
1006 const escapedSearch = VideoModel.sequelize.escape(options.search)
1007 const escapedLikeSearch = VideoModel.sequelize.escape('%' + options.search + '%')
d4112450
C
1008 if (options.search) {
1009 whereAnd.push(
1010 {
dbfd3e9b
C
1011 id: {
1012 [ Sequelize.Op.in ]: Sequelize.literal(
1013 '(' +
687d638c
C
1014 'SELECT "video"."id" FROM "video" ' +
1015 'WHERE ' +
dbfd3e9b
C
1016 'lower(immutable_unaccent("video"."name")) % lower(immutable_unaccent(' + escapedSearch + ')) OR ' +
1017 'lower(immutable_unaccent("video"."name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + '))' +
1018 'UNION ALL ' +
1019 'SELECT "video"."id" FROM "video" LEFT JOIN "videoTag" ON "videoTag"."videoId" = "video"."id" ' +
1020 'INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
1021 'WHERE "tag"."name" = ' + escapedSearch +
1022 ')'
1023 )
1024 }
d4112450
C
1025 }
1026 )
1027
1028 attributesInclude.push(createSimilarityAttribute('VideoModel.name', options.search))
1029 }
1030
1031 // Cannot search on similarity if we don't have a search
1032 if (!options.search) {
1033 attributesInclude.push(
1034 Sequelize.literal('0 as similarity')
1035 )
1036 }
d525fc39 1037
f05a1c30 1038 const query: IFindOptions<VideoModel> = {
57c36b27 1039 attributes: {
d4112450 1040 include: attributesInclude
57c36b27 1041 },
d525fc39
C
1042 offset: options.start,
1043 limit: options.count,
9a629c6e 1044 order: getVideoSort(options.sort),
d525fc39
C
1045 where: {
1046 [ Sequelize.Op.and ]: whereAnd
1047 }
f05a1c30
C
1048 }
1049
1050 const serverActor = await getServerActor()
afd2cba5
C
1051 const queryOptions = {
1052 actorId: serverActor.id,
1053 includeLocalVideos: options.includeLocalVideos,
1054 nsfw: options.nsfw,
1055 categoryOneOf: options.categoryOneOf,
1056 licenceOneOf: options.licenceOneOf,
1057 languageOneOf: options.languageOneOf,
1058 tagsOneOf: options.tagsOneOf,
1059 tagsAllOf: options.tagsAllOf
48dce1c9 1060 }
f05a1c30 1061
afd2cba5 1062 return VideoModel.getAvailableForApi(query, queryOptions)
f05a1c30
C
1063 }
1064
516df59b
C
1065 static load (id: number, t?: Sequelize.Transaction) {
1066 const options = t ? { transaction: t } : undefined
1067
1068 return VideoModel.findById(id, options)
3fd3ab2d 1069 }
fdbda9e3 1070
3fd3ab2d
C
1071 static loadByUrlAndPopulateAccount (url: string, t?: Sequelize.Transaction) {
1072 const query: IFindOptions<VideoModel> = {
1073 where: {
1074 url
d48ff09d 1075 }
3fd3ab2d 1076 }
d8755eed 1077
3fd3ab2d 1078 if (t !== undefined) query.transaction = t
d8755eed 1079
4cb6d457 1080 return VideoModel.scope([ ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_FILES ]).findOne(query)
3fd3ab2d 1081 }
d8755eed 1082
3fd3ab2d
C
1083 static loadAndPopulateAccountAndServerAndTags (id: number) {
1084 const options = {
d48ff09d 1085 order: [ [ 'Tags', 'name', 'ASC' ] ]
3fd3ab2d 1086 }
72c7248b 1087
d48ff09d 1088 return VideoModel
191764f3
C
1089 .scope([
1090 ScopeNames.WITH_TAGS,
1091 ScopeNames.WITH_BLACKLISTED,
1092 ScopeNames.WITH_FILES,
1093 ScopeNames.WITH_ACCOUNT_DETAILS,
1094 ScopeNames.WITH_SCHEDULED_UPDATE
1095 ])
d48ff09d 1096 .findById(id, options)
3fd3ab2d 1097 }
72c7248b 1098
8fa5653a
C
1099 static loadByUUID (uuid: string) {
1100 const options = {
1101 where: {
1102 uuid
1103 }
1104 }
1105
1106 return VideoModel
1107 .scope([ ScopeNames.WITH_FILES ])
1108 .findOne(options)
1109 }
1110
2186386c 1111 static loadByUUIDAndPopulateAccountAndServerAndTags (uuid: string, t?: Sequelize.Transaction) {
3fd3ab2d
C
1112 const options = {
1113 order: [ [ 'Tags', 'name', 'ASC' ] ],
1114 where: {
1115 uuid
2186386c
C
1116 },
1117 transaction: t
3fd3ab2d 1118 }
fd45e8f4 1119
d48ff09d 1120 return VideoModel
191764f3
C
1121 .scope([
1122 ScopeNames.WITH_TAGS,
1123 ScopeNames.WITH_BLACKLISTED,
1124 ScopeNames.WITH_FILES,
1125 ScopeNames.WITH_ACCOUNT_DETAILS,
1126 ScopeNames.WITH_SCHEDULED_UPDATE
1127 ])
da854ddd
C
1128 .findOne(options)
1129 }
1130
09cababd
C
1131 static async getStats () {
1132 const totalLocalVideos = await VideoModel.count({
1133 where: {
1134 remote: false
1135 }
1136 })
1137 const totalVideos = await VideoModel.count()
1138
1139 let totalLocalVideoViews = await VideoModel.sum('views', {
1140 where: {
1141 remote: false
1142 }
1143 })
1144 // Sequelize could return null...
1145 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1146
1147 return {
1148 totalLocalVideos,
1149 totalLocalVideoViews,
1150 totalVideos
1151 }
1152 }
1153
6b616860
C
1154 static incrementViews (id: number, views: number) {
1155 return VideoModel.increment('views', {
1156 by: views,
1157 where: {
1158 id
1159 }
1160 })
1161 }
1162
2d3741d6
C
1163 // threshold corresponds to how many video the field should have to be returned
1164 static getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
1165 const query: IFindOptions<VideoModel> = {
1166 attributes: [ field ],
1167 limit: count,
1168 group: field,
1169 having: Sequelize.where(Sequelize.fn('COUNT', Sequelize.col(field)), {
1170 [Sequelize.Op.gte]: threshold
1171 }) as any, // FIXME: typings
1172 where: {
1173 [field]: {
afd2cba5 1174 [Sequelize.Op.not]: null
2d3741d6
C
1175 },
1176 privacy: VideoPrivacy.PUBLIC,
1177 state: VideoState.PUBLISHED
1178 },
1179 order: [ this.sequelize.random() ]
1180 }
1181
1182 return VideoModel.findAll(query)
1183 .then(rows => rows.map(r => r[field]))
1184 }
1185
066e94c5
C
1186 private static buildActorWhereWithFilter (filter?: VideoFilter) {
1187 if (filter && filter === 'local') {
1188 return {
1189 serverId: null
1190 }
1191 }
1192
1193 return {}
1194 }
afd2cba5
C
1195
1196 private static async getAvailableForApi (query: IFindOptions<VideoModel>, options: AvailableForListIDsOptions) {
1197 const idsScope = {
1198 method: [
1199 ScopeNames.AVAILABLE_FOR_LIST_IDS, options
1200 ]
1201 }
1202
1203 const { count, rows: rowsId } = await VideoModel.scope(idsScope).findAndCountAll(query)
1204 const ids = rowsId.map(r => r.id)
1205
1206 if (ids.length === 0) return { data: [], total: count }
1207
1208 const apiScope = {
1209 method: [ ScopeNames.FOR_API, { ids, withFiles: options.withFiles } as ForAPIOptions ]
1210 }
b6314e3c
C
1211
1212 const secondQuery = {
1213 offset: 0,
1214 limit: query.limit,
9a629c6e
C
1215 attributes: query.attributes,
1216 order: [ // Keep original order
1217 Sequelize.literal(
1218 ids.map(id => `"VideoModel".id = ${id} DESC`).join(', ')
1219 )
1220 ]
b6314e3c
C
1221 }
1222 const rows = await VideoModel.scope(apiScope).findAll(secondQuery)
afd2cba5
C
1223
1224 return {
1225 data: rows,
1226 total: count
1227 }
1228 }
066e94c5 1229
ae5a3dd6 1230 private static getCategoryLabel (id: number) {
2186386c 1231 return VIDEO_CATEGORIES[id] || 'Misc'
ae5a3dd6
C
1232 }
1233
1234 private static getLicenceLabel (id: number) {
2186386c 1235 return VIDEO_LICENCES[id] || 'Unknown'
ae5a3dd6
C
1236 }
1237
9d3ef9fe 1238 private static getLanguageLabel (id: string) {
2186386c 1239 return VIDEO_LANGUAGES[id] || 'Unknown'
ae5a3dd6
C
1240 }
1241
2243730c 1242 private static getPrivacyLabel (id: number) {
2186386c
C
1243 return VIDEO_PRIVACIES[id] || 'Unknown'
1244 }
2243730c 1245
2186386c
C
1246 private static getStateLabel (id: number) {
1247 return VIDEO_STATES[id] || 'Unknown'
2243730c
C
1248 }
1249
3fd3ab2d
C
1250 getOriginalFile () {
1251 if (Array.isArray(this.VideoFiles) === false) return undefined
aaf61f38 1252
3fd3ab2d
C
1253 // The original file is the file that have the higher resolution
1254 return maxBy(this.VideoFiles, file => file.resolution)
e4f97bab 1255 }
aaf61f38 1256
3fd3ab2d
C
1257 getVideoFilename (videoFile: VideoFileModel) {
1258 return this.uuid + '-' + videoFile.resolution + videoFile.extname
1259 }
165cdc75 1260
3fd3ab2d
C
1261 getThumbnailName () {
1262 // We always have a copy of the thumbnail
1263 const extension = '.jpg'
1264 return this.uuid + extension
7b1f49de
C
1265 }
1266
3fd3ab2d
C
1267 getPreviewName () {
1268 const extension = '.jpg'
1269 return this.uuid + extension
1270 }
7b1f49de 1271
3fd3ab2d
C
1272 getTorrentFileName (videoFile: VideoFileModel) {
1273 const extension = '.torrent'
1274 return this.uuid + '-' + videoFile.resolution + extension
1275 }
8e7f08b5 1276
3fd3ab2d
C
1277 isOwned () {
1278 return this.remote === false
9567011b
C
1279 }
1280
3fd3ab2d 1281 createPreview (videoFile: VideoFileModel) {
3fd3ab2d
C
1282 return generateImageFromVideoFile(
1283 this.getVideoFilePath(videoFile),
1284 CONFIG.STORAGE.PREVIEWS_DIR,
1285 this.getPreviewName(),
26670720 1286 PREVIEWS_SIZE
3fd3ab2d
C
1287 )
1288 }
9567011b 1289
3fd3ab2d 1290 createThumbnail (videoFile: VideoFileModel) {
3fd3ab2d
C
1291 return generateImageFromVideoFile(
1292 this.getVideoFilePath(videoFile),
1293 CONFIG.STORAGE.THUMBNAILS_DIR,
1294 this.getThumbnailName(),
26670720 1295 THUMBNAILS_SIZE
3fd3ab2d 1296 )
14d3270f
C
1297 }
1298
02756fbd
C
1299 getTorrentFilePath (videoFile: VideoFileModel) {
1300 return join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1301 }
1302
3fd3ab2d
C
1303 getVideoFilePath (videoFile: VideoFileModel) {
1304 return join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
1305 }
14d3270f 1306
81e504b3 1307 async createTorrentAndSetInfoHash (videoFile: VideoFileModel) {
3fd3ab2d 1308 const options = {
6cced8f9
C
1309 // Keep the extname, it's used by the client to stream the file inside a web browser
1310 name: `${this.name} ${videoFile.resolution}p${videoFile.extname}`,
81e504b3 1311 createdBy: 'PeerTube',
3fd3ab2d 1312 announceList: [
0edf0581
C
1313 [ CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT + '/tracker/socket' ],
1314 [ CONFIG.WEBSERVER.URL + '/tracker/announce' ]
3fd3ab2d
C
1315 ],
1316 urlList: [
1317 CONFIG.WEBSERVER.URL + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile)
1318 ]
1319 }
14d3270f 1320
3fd3ab2d 1321 const torrent = await createTorrentPromise(this.getVideoFilePath(videoFile), options)
e4f97bab 1322
3fd3ab2d
C
1323 const filePath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1324 logger.info('Creating torrent %s.', filePath)
e4f97bab 1325
62689b94 1326 await writeFile(filePath, torrent)
e4f97bab 1327
3fd3ab2d
C
1328 const parsedTorrent = parseTorrent(torrent)
1329 videoFile.infoHash = parsedTorrent.infoHash
1330 }
e4f97bab 1331
40e87e9e 1332 getEmbedStaticPath () {
3fd3ab2d
C
1333 return '/videos/embed/' + this.uuid
1334 }
e4f97bab 1335
40e87e9e 1336 getThumbnailStaticPath () {
3fd3ab2d 1337 return join(STATIC_PATHS.THUMBNAILS, this.getThumbnailName())
e4f97bab 1338 }
227d02fe 1339
40e87e9e 1340 getPreviewStaticPath () {
3fd3ab2d
C
1341 return join(STATIC_PATHS.PREVIEWS, this.getPreviewName())
1342 }
40298b02 1343
2186386c
C
1344 toFormattedJSON (options?: {
1345 additionalAttributes: {
bbe0f064
C
1346 state?: boolean,
1347 waitTranscoding?: boolean,
26b7305a
C
1348 scheduledUpdate?: boolean,
1349 blacklistInfo?: boolean
2186386c
C
1350 }
1351 }): Video {
b64c950a 1352 const formattedAccount = this.VideoChannel.Account.toFormattedJSON()
0f320037 1353 const formattedVideoChannel = this.VideoChannel.toFormattedJSON()
14d3270f 1354
2186386c 1355 const videoObject: Video = {
3fd3ab2d
C
1356 id: this.id,
1357 uuid: this.uuid,
1358 name: this.name,
ae5a3dd6
C
1359 category: {
1360 id: this.category,
1361 label: VideoModel.getCategoryLabel(this.category)
1362 },
1363 licence: {
1364 id: this.licence,
1365 label: VideoModel.getLicenceLabel(this.licence)
1366 },
1367 language: {
1368 id: this.language,
1369 label: VideoModel.getLanguageLabel(this.language)
1370 },
2243730c
C
1371 privacy: {
1372 id: this.privacy,
1373 label: VideoModel.getPrivacyLabel(this.privacy)
1374 },
3fd3ab2d
C
1375 nsfw: this.nsfw,
1376 description: this.getTruncatedDescription(),
3fd3ab2d 1377 isLocal: this.isOwned(),
3fd3ab2d
C
1378 duration: this.duration,
1379 views: this.views,
1380 likes: this.likes,
1381 dislikes: this.dislikes,
40e87e9e
C
1382 thumbnailPath: this.getThumbnailStaticPath(),
1383 previewPath: this.getPreviewStaticPath(),
1384 embedPath: this.getEmbedStaticPath(),
3fd3ab2d 1385 createdAt: this.createdAt,
b64c950a 1386 updatedAt: this.updatedAt,
2922e048 1387 publishedAt: this.publishedAt,
b64c950a 1388 account: {
03e12d7c
C
1389 id: formattedAccount.id,
1390 uuid: formattedAccount.uuid,
b64c950a
C
1391 name: formattedAccount.name,
1392 displayName: formattedAccount.displayName,
1393 url: formattedAccount.url,
1394 host: formattedAccount.host,
1395 avatar: formattedAccount.avatar
0f320037
C
1396 },
1397 channel: {
1398 id: formattedVideoChannel.id,
1399 uuid: formattedVideoChannel.uuid,
1400 name: formattedVideoChannel.name,
1401 displayName: formattedVideoChannel.displayName,
1402 url: formattedVideoChannel.url,
1403 host: formattedVideoChannel.host,
1404 avatar: formattedVideoChannel.avatar
b64c950a 1405 }
2422c46b 1406 }
2186386c
C
1407
1408 if (options) {
bbe0f064 1409 if (options.additionalAttributes.state === true) {
2186386c
C
1410 videoObject.state = {
1411 id: this.state,
1412 label: VideoModel.getStateLabel(this.state)
1413 }
1414 }
1415
bbe0f064 1416 if (options.additionalAttributes.waitTranscoding === true) {
2baea0c7
C
1417 videoObject.waitTranscoding = this.waitTranscoding
1418 }
1419
bbe0f064 1420 if (options.additionalAttributes.scheduledUpdate === true && this.ScheduleVideoUpdate) {
2baea0c7
C
1421 videoObject.scheduledUpdate = {
1422 updateAt: this.ScheduleVideoUpdate.updateAt,
1423 privacy: this.ScheduleVideoUpdate.privacy || undefined
1424 }
1425 }
26b7305a
C
1426
1427 if (options.additionalAttributes.blacklistInfo === true) {
1428 videoObject.blacklisted = !!this.VideoBlacklist
1429 videoObject.blacklistedReason = this.VideoBlacklist ? this.VideoBlacklist.reason : null
1430 }
2186386c
C
1431 }
1432
1433 return videoObject
14d3270f 1434 }
14d3270f 1435
2422c46b 1436 toFormattedDetailsJSON (): VideoDetails {
bbe0f064
C
1437 const formattedJson = this.toFormattedJSON({
1438 additionalAttributes: {
191764f3
C
1439 scheduledUpdate: true,
1440 blacklistInfo: true
bbe0f064
C
1441 }
1442 })
e4f97bab 1443
3fd3ab2d 1444 const detailsJson = {
2422c46b 1445 support: this.support,
3fd3ab2d
C
1446 descriptionPath: this.getDescriptionPath(),
1447 channel: this.VideoChannel.toFormattedJSON(),
1448 account: this.VideoChannel.Account.toFormattedJSON(),
ee28cdf1 1449 tags: map(this.Tags, 'name'),
47564bbe 1450 commentsEnabled: this.commentsEnabled,
2186386c
C
1451 waitTranscoding: this.waitTranscoding,
1452 state: {
1453 id: this.state,
1454 label: VideoModel.getStateLabel(this.state)
1455 },
3fd3ab2d
C
1456 files: []
1457 }
e4f97bab 1458
3fd3ab2d 1459 // Format and sort video files
244e76a5
RK
1460 detailsJson.files = this.getFormattedVideoFilesJSON()
1461
1462 return Object.assign(formattedJson, detailsJson)
1463 }
1464
1465 getFormattedVideoFilesJSON (): VideoFile[] {
3fd3ab2d 1466 const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
3fd3ab2d 1467
244e76a5
RK
1468 return this.VideoFiles
1469 .map(videoFile => {
1470 let resolutionLabel = videoFile.resolution + 'p'
3fd3ab2d 1471
244e76a5
RK
1472 return {
1473 resolution: {
1474 id: videoFile.resolution,
1475 label: resolutionLabel
1476 },
1477 magnetUri: this.generateMagnetUri(videoFile, baseUrlHttp, baseUrlWs),
1478 size: videoFile.size,
3a6f351b 1479 fps: videoFile.fps,
244e76a5 1480 torrentUrl: this.getTorrentUrl(videoFile, baseUrlHttp),
02756fbd
C
1481 torrentDownloadUrl: this.getTorrentDownloadUrl(videoFile, baseUrlHttp),
1482 fileUrl: this.getVideoFileUrl(videoFile, baseUrlHttp),
1483 fileDownloadUrl: this.getVideoFileDownloadUrl(videoFile, baseUrlHttp)
244e76a5
RK
1484 } as VideoFile
1485 })
1486 .sort((a, b) => {
1487 if (a.resolution.id < b.resolution.id) return 1
1488 if (a.resolution.id === b.resolution.id) return 0
1489 return -1
1490 })
3fd3ab2d 1491 }
e4f97bab 1492
3fd3ab2d
C
1493 toActivityPubObject (): VideoTorrentObject {
1494 const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
1495 if (!this.Tags) this.Tags = []
e4f97bab 1496
3fd3ab2d
C
1497 const tag = this.Tags.map(t => ({
1498 type: 'Hashtag' as 'Hashtag',
1499 name: t.name
1500 }))
40298b02 1501
3fd3ab2d
C
1502 let language
1503 if (this.language) {
1504 language = {
9d3ef9fe 1505 identifier: this.language,
ae5a3dd6 1506 name: VideoModel.getLanguageLabel(this.language)
3fd3ab2d
C
1507 }
1508 }
40298b02 1509
3fd3ab2d
C
1510 let category
1511 if (this.category) {
1512 category = {
1513 identifier: this.category + '',
ae5a3dd6 1514 name: VideoModel.getCategoryLabel(this.category)
3fd3ab2d
C
1515 }
1516 }
40298b02 1517
3fd3ab2d
C
1518 let licence
1519 if (this.licence) {
1520 licence = {
1521 identifier: this.licence + '',
ae5a3dd6 1522 name: VideoModel.getLicenceLabel(this.licence)
3fd3ab2d
C
1523 }
1524 }
9567011b 1525
3fd3ab2d
C
1526 const url = []
1527 for (const file of this.VideoFiles) {
1528 url.push({
1529 type: 'Link',
28be8916 1530 mimeType: VIDEO_EXT_MIMETYPE[file.extname],
9fb3abfd 1531 href: this.getVideoFileUrl(file, baseUrlHttp),
965c4b22 1532 height: file.resolution,
b2977eec
C
1533 size: file.size,
1534 fps: file.fps
3fd3ab2d
C
1535 })
1536
1537 url.push({
1538 type: 'Link',
1539 mimeType: 'application/x-bittorrent',
9fb3abfd 1540 href: this.getTorrentUrl(file, baseUrlHttp),
965c4b22 1541 height: file.resolution
3fd3ab2d
C
1542 })
1543
1544 url.push({
1545 type: 'Link',
1546 mimeType: 'application/x-bittorrent;x-scheme-handler/magnet',
9fb3abfd 1547 href: this.generateMagnetUri(file, baseUrlHttp, baseUrlWs),
965c4b22 1548 height: file.resolution
3fd3ab2d
C
1549 })
1550 }
93e1258c 1551
3fd3ab2d
C
1552 // Add video url too
1553 url.push({
1554 type: 'Link',
1555 mimeType: 'text/html',
9fb3abfd 1556 href: CONFIG.WEBSERVER.URL + '/videos/watch/' + this.uuid
3fd3ab2d 1557 })
93e1258c 1558
40e87e9e
C
1559 const subtitleLanguage = []
1560 for (const caption of this.VideoCaptions) {
1561 subtitleLanguage.push({
1562 identifier: caption.language,
1563 name: VideoCaptionModel.getLanguageLabel(caption.language)
1564 })
1565 }
1566
3fd3ab2d
C
1567 return {
1568 type: 'Video' as 'Video',
1569 id: this.url,
1570 name: this.name,
093237cf 1571 duration: this.getActivityStreamDuration(),
3fd3ab2d
C
1572 uuid: this.uuid,
1573 tag,
1574 category,
1575 licence,
1576 language,
1577 views: this.views,
0a67e28b 1578 sensitive: this.nsfw,
2186386c
C
1579 waitTranscoding: this.waitTranscoding,
1580 state: this.state,
47564bbe 1581 commentsEnabled: this.commentsEnabled,
2922e048 1582 published: this.publishedAt.toISOString(),
3fd3ab2d
C
1583 updated: this.updatedAt.toISOString(),
1584 mediaType: 'text/markdown',
1585 content: this.getTruncatedDescription(),
2422c46b 1586 support: this.support,
40e87e9e 1587 subtitleLanguage,
3fd3ab2d
C
1588 icon: {
1589 type: 'Image',
1590 url: this.getThumbnailUrl(baseUrlHttp),
1591 mediaType: 'image/jpeg',
1592 width: THUMBNAILS_SIZE.width,
1593 height: THUMBNAILS_SIZE.height
1594 },
1595 url,
8fffe21a
C
1596 likes: getVideoLikesActivityPubUrl(this),
1597 dislikes: getVideoDislikesActivityPubUrl(this),
1598 shares: getVideoSharesActivityPubUrl(this),
1599 comments: getVideoCommentsActivityPubUrl(this),
50d6de9c 1600 attributedTo: [
2ccaeeb3
C
1601 {
1602 type: 'Person',
1603 id: this.VideoChannel.Account.Actor.url
fc27b17c
C
1604 },
1605 {
1606 type: 'Group',
1607 id: this.VideoChannel.Actor.url
50d6de9c
C
1608 }
1609 ]
3fd3ab2d
C
1610 }
1611 }
1612
1613 getTruncatedDescription () {
1614 if (!this.description) return null
93e1258c 1615
bffbebbe 1616 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
c73e83da 1617 return peertubeTruncate(this.description, maxLength)
93e1258c
C
1618 }
1619
81e504b3 1620 async optimizeOriginalVideofile () {
3fd3ab2d
C
1621 const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR
1622 const newExtname = '.mp4'
1623 const inputVideoFile = this.getOriginalFile()
1624 const videoInputPath = join(videosDirectory, this.getVideoFilename(inputVideoFile))
3a6f351b 1625 const videoTranscodedPath = join(videosDirectory, this.id + '-transcoded' + newExtname)
b769007f 1626
3fd3ab2d
C
1627 const transcodeOptions = {
1628 inputPath: videoInputPath,
3a6f351b 1629 outputPath: videoTranscodedPath
3fd3ab2d 1630 }
c46edbc2 1631
b0ef1782
C
1632 // Could be very long!
1633 await transcode(transcodeOptions)
c46edbc2 1634
b0ef1782 1635 try {
62689b94 1636 await remove(videoInputPath)
c46edbc2 1637
3fd3ab2d
C
1638 // Important to do this before getVideoFilename() to take in account the new file extension
1639 inputVideoFile.set('extname', newExtname)
e71bcc0f 1640
3a6f351b 1641 const videoOutputPath = this.getVideoFilePath(inputVideoFile)
62689b94
C
1642 await rename(videoTranscodedPath, videoOutputPath)
1643 const stats = await stat(videoOutputPath)
3a6f351b 1644 const fps = await getVideoFileFPS(videoOutputPath)
e71bcc0f 1645
3fd3ab2d 1646 inputVideoFile.set('size', stats.size)
3a6f351b 1647 inputVideoFile.set('fps', fps)
e71bcc0f 1648
3fd3ab2d
C
1649 await this.createTorrentAndSetInfoHash(inputVideoFile)
1650 await inputVideoFile.save()
fd45e8f4 1651
3fd3ab2d
C
1652 } catch (err) {
1653 // Auto destruction...
d5b7d911 1654 this.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', { err }))
fd45e8f4 1655
3fd3ab2d
C
1656 throw err
1657 }
feb4bdfd
C
1658 }
1659
81e504b3 1660 async transcodeOriginalVideofile (resolution: VideoResolution, isPortraitMode: boolean) {
3fd3ab2d
C
1661 const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR
1662 const extname = '.mp4'
aaf61f38 1663
3fd3ab2d
C
1664 // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed
1665 const videoInputPath = join(videosDirectory, this.getVideoFilename(this.getOriginalFile()))
feb4bdfd 1666
3fd3ab2d
C
1667 const newVideoFile = new VideoFileModel({
1668 resolution,
1669 extname,
1670 size: 0,
1671 videoId: this.id
1672 })
1673 const videoOutputPath = join(videosDirectory, this.getVideoFilename(newVideoFile))
a041b171 1674
3fd3ab2d
C
1675 const transcodeOptions = {
1676 inputPath: videoInputPath,
1677 outputPath: videoOutputPath,
056aa7f2
C
1678 resolution,
1679 isPortraitMode
3fd3ab2d 1680 }
a041b171 1681
3fd3ab2d 1682 await transcode(transcodeOptions)
a041b171 1683
62689b94 1684 const stats = await stat(videoOutputPath)
3a6f351b 1685 const fps = await getVideoFileFPS(videoOutputPath)
d7d5611c 1686
3fd3ab2d 1687 newVideoFile.set('size', stats.size)
3a6f351b 1688 newVideoFile.set('fps', fps)
d7d5611c 1689
3fd3ab2d 1690 await this.createTorrentAndSetInfoHash(newVideoFile)
d7d5611c 1691
3fd3ab2d
C
1692 await newVideoFile.save()
1693
1694 this.VideoFiles.push(newVideoFile)
0d0e8dd0
C
1695 }
1696
0138af92 1697 async importVideoFile (inputFilePath: string) {
3a6f351b 1698 const { videoFileResolution } = await getVideoFileResolution(inputFilePath)
62689b94 1699 const { size } = await stat(inputFilePath)
3a6f351b
C
1700 const fps = await getVideoFileFPS(inputFilePath)
1701
0138af92 1702 let updatedVideoFile = new VideoFileModel({
3a6f351b 1703 resolution: videoFileResolution,
0138af92 1704 extname: extname(inputFilePath),
3a6f351b
C
1705 size,
1706 fps,
0138af92
FF
1707 videoId: this.id
1708 })
1709
0138af92 1710 const currentVideoFile = this.VideoFiles.find(videoFile => videoFile.resolution === updatedVideoFile.resolution)
0138af92 1711
28be8916
C
1712 if (currentVideoFile) {
1713 // Remove old file and old torrent
1714 await this.removeFile(currentVideoFile)
1715 await this.removeTorrent(currentVideoFile)
1716 // Remove the old video file from the array
1717 this.VideoFiles = this.VideoFiles.filter(f => f !== currentVideoFile)
1718
1719 // Update the database
1720 currentVideoFile.set('extname', updatedVideoFile.extname)
0138af92 1721 currentVideoFile.set('size', updatedVideoFile.size)
3a6f351b 1722 currentVideoFile.set('fps', updatedVideoFile.fps)
28be8916 1723
0138af92
FF
1724 updatedVideoFile = currentVideoFile
1725 }
1726
6ccdf3a2 1727 const outputPath = this.getVideoFilePath(updatedVideoFile)
62689b94 1728 await copy(inputFilePath, outputPath)
6ccdf3a2 1729
0138af92
FF
1730 await this.createTorrentAndSetInfoHash(updatedVideoFile)
1731
1732 await updatedVideoFile.save()
1733
28be8916 1734 this.VideoFiles.push(updatedVideoFile)
0138af92
FF
1735 }
1736
056aa7f2 1737 getOriginalFileResolution () {
3fd3ab2d 1738 const originalFilePath = this.getVideoFilePath(this.getOriginalFile())
0d0e8dd0 1739
056aa7f2 1740 return getVideoFileResolution(originalFilePath)
3fd3ab2d 1741 }
0d0e8dd0 1742
3fd3ab2d
C
1743 getDescriptionPath () {
1744 return `/api/${API_VERSION}/videos/${this.uuid}/description`
feb4bdfd
C
1745 }
1746
3fd3ab2d
C
1747 removeThumbnail () {
1748 const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName())
62689b94 1749 return remove(thumbnailPath)
ed31c059 1750 .catch(err => logger.warn('Cannot delete thumbnail %s.', thumbnailPath, { err }))
feb4bdfd
C
1751 }
1752
3fd3ab2d 1753 removePreview () {
ed31c059 1754 const previewPath = join(CONFIG.STORAGE.PREVIEWS_DIR + this.getPreviewName())
62689b94 1755 return remove(previewPath)
ed31c059 1756 .catch(err => logger.warn('Cannot delete preview %s.', previewPath, { err }))
7920c273
C
1757 }
1758
3fd3ab2d
C
1759 removeFile (videoFile: VideoFileModel) {
1760 const filePath = join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
62689b94 1761 return remove(filePath)
ed31c059 1762 .catch(err => logger.warn('Cannot delete file %s.', filePath, { err }))
feb4bdfd
C
1763 }
1764
3fd3ab2d
C
1765 removeTorrent (videoFile: VideoFileModel) {
1766 const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
62689b94 1767 return remove(torrentPath)
ed31c059 1768 .catch(err => logger.warn('Cannot delete torrent %s.', torrentPath, { err }))
aaf61f38
C
1769 }
1770
093237cf
C
1771 getActivityStreamDuration () {
1772 // https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
1773 return 'PT' + this.duration + 'S'
1774 }
1775
1297eb5d
C
1776 isOutdated () {
1777 if (this.isOwned()) return false
1778
1779 const now = Date.now()
1780 const createdAtTime = this.createdAt.getTime()
1781 const updatedAtTime = this.updatedAt.getTime()
1782
1783 return (now - createdAtTime) > ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL &&
1784 (now - updatedAtTime) > ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL
1785 }
1786
3fd3ab2d
C
1787 private getBaseUrls () {
1788 let baseUrlHttp
1789 let baseUrlWs
7920c273 1790
3fd3ab2d
C
1791 if (this.isOwned()) {
1792 baseUrlHttp = CONFIG.WEBSERVER.URL
1793 baseUrlWs = CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
1794 } else {
50d6de9c
C
1795 baseUrlHttp = REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host
1796 baseUrlWs = REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host
6fcd19ba 1797 }
aaf61f38 1798
3fd3ab2d 1799 return { baseUrlHttp, baseUrlWs }
15d4ee04 1800 }
a96aed15 1801
3fd3ab2d
C
1802 private getThumbnailUrl (baseUrlHttp: string) {
1803 return baseUrlHttp + STATIC_PATHS.THUMBNAILS + this.getThumbnailName()
a96aed15
C
1804 }
1805
3fd3ab2d
C
1806 private getTorrentUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1807 return baseUrlHttp + STATIC_PATHS.TORRENTS + this.getTorrentFileName(videoFile)
1808 }
e4f97bab 1809
02756fbd
C
1810 private getTorrentDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1811 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + this.getTorrentFileName(videoFile)
1812 }
1813
3fd3ab2d
C
1814 private getVideoFileUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1815 return baseUrlHttp + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile)
1816 }
a96aed15 1817
02756fbd
C
1818 private getVideoFileDownloadUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1819 return baseUrlHttp + STATIC_DOWNLOAD_PATHS.VIDEOS + this.getVideoFilename(videoFile)
1820 }
1821
3fd3ab2d
C
1822 private generateMagnetUri (videoFile: VideoFileModel, baseUrlHttp: string, baseUrlWs: string) {
1823 const xs = this.getTorrentUrl(videoFile, baseUrlHttp)
1824 const announce = [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ]
1825 const urlList = [ this.getVideoFileUrl(videoFile, baseUrlHttp) ]
1826
1827 const magnetHash = {
1828 xs,
1829 announce,
1830 urlList,
1831 infoHash: videoFile.infoHash,
1832 name: this.name
1833 }
a96aed15 1834
3fd3ab2d 1835 return magnetUtil.encode(magnetHash)
a96aed15 1836 }
a96aed15 1837}