]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/models/video/video.ts
Add transition on play/loading player
[github/Chocobozzz/PeerTube.git] / server / models / video / video.ts
CommitLineData
39445ead 1import * as Bluebird from 'bluebird'
53abc4c2 2import { map, maxBy, truncate } from 'lodash'
571389d4 3import * as magnetUtil from 'magnet-uri'
4d4e5cd4 4import * as parseTorrent from 'parse-torrent'
65fcc311 5import { join } from 'path'
e02643f3 6import * as Sequelize from 'sequelize'
3fd3ab2d
C
7import {
8 AfterDestroy,
9 AllowNull,
10 BelongsTo,
11 BelongsToMany,
12 Column,
13 CreatedAt,
14 DataType,
15 Default,
16 ForeignKey,
17 HasMany,
18 IFindOptions,
19 Is,
20 IsInt,
21 IsUUID,
22 Min,
23 Model,
d48ff09d 24 Scopes,
3fd3ab2d
C
25 Table,
26 UpdatedAt
27} from 'sequelize-typescript'
28import { IIncludeOptions } from 'sequelize-typescript/lib/interfaces/IIncludeOptions'
571389d4 29import { VideoPrivacy, VideoResolution } from '../../../shared'
3fd3ab2d 30import { VideoTorrentObject } from '../../../shared/models/activitypub/objects'
d48ff09d 31import { Video, VideoDetails } from '../../../shared/models/videos'
3fd3ab2d
C
32import {
33 activityPubCollection,
34 createTorrentPromise,
35 generateImageFromVideoFile,
36 getVideoFileHeight,
37 logger,
38 renamePromise,
39 statPromise,
40 transcode,
41 unlinkPromise,
42 writeFilePromise
43} from '../../helpers'
44import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub'
a2431b7d 45import {
3fd3ab2d 46 isVideoCategoryValid,
a2431b7d
C
47 isVideoDescriptionValid,
48 isVideoDurationValid,
3fd3ab2d 49 isVideoLanguageValid,
a2431b7d
C
50 isVideoLicenceValid,
51 isVideoNameValid,
3fd3ab2d
C
52 isVideoNSFWValid,
53 isVideoPrivacyValid
54} from '../../helpers/custom-validators/videos'
65fcc311 55import {
571389d4 56 API_VERSION,
65fcc311 57 CONFIG,
571389d4
C
58 CONSTRAINTS_FIELDS,
59 PREVIEWS_SIZE,
65fcc311
C
60 REMOTE_SCHEME,
61 STATIC_PATHS,
571389d4 62 THUMBNAILS_SIZE,
65fcc311 63 VIDEO_CATEGORIES,
65fcc311 64 VIDEO_LANGUAGES,
571389d4 65 VIDEO_LICENCES,
fd45e8f4 66 VIDEO_PRIVACIES
3fd3ab2d
C
67} from '../../initializers'
68import { getAnnounceActivityPubUrl } from '../../lib/activitypub'
50d6de9c 69import { sendDeleteVideo } from '../../lib/activitypub/send'
3fd3ab2d
C
70import { AccountModel } from '../account/account'
71import { AccountVideoRateModel } from '../account/account-video-rate'
50d6de9c 72import { ActorModel } from '../activitypub/actor'
3fd3ab2d
C
73import { ServerModel } from '../server/server'
74import { getSort, throwIfNotValid } from '../utils'
75import { TagModel } from './tag'
76import { VideoAbuseModel } from './video-abuse'
77import { VideoChannelModel } from './video-channel'
78import { VideoFileModel } from './video-file'
79import { VideoShareModel } from './video-share'
80import { VideoTagModel } from './video-tag'
81
d48ff09d 82enum ScopeNames {
50d6de9c 83 AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST',
d48ff09d
C
84 WITH_ACCOUNT = 'WITH_ACCOUNT',
85 WITH_TAGS = 'WITH_TAGS',
86 WITH_FILES = 'WITH_FILES',
87 WITH_SHARES = 'WITH_SHARES',
88 WITH_RATES = 'WITH_RATES'
89}
90
91@Scopes({
50d6de9c 92 [ScopeNames.AVAILABLE_FOR_LIST]: {
d48ff09d
C
93 where: {
94 id: {
95 [Sequelize.Op.notIn]: Sequelize.literal(
96 '(SELECT "videoBlacklist"."videoId" FROM "videoBlacklist")'
97 )
50d6de9c 98 },
d48ff09d
C
99 privacy: VideoPrivacy.PUBLIC
100 }
101 },
102 [ScopeNames.WITH_ACCOUNT]: {
103 include: [
104 {
105 model: () => VideoChannelModel,
106 required: true,
107 include: [
108 {
109 model: () => AccountModel,
110 required: true,
111 include: [
112 {
50d6de9c
C
113 model: () => ActorModel,
114 required: true,
115 include: [
116 {
117 model: () => ServerModel,
118 required: false
119 }
120 ]
d48ff09d
C
121 }
122 ]
123 }
124 ]
125 }
126 ]
127 },
128 [ScopeNames.WITH_TAGS]: {
129 include: [ () => TagModel ]
130 },
131 [ScopeNames.WITH_FILES]: {
132 include: [
133 {
134 model: () => VideoFileModel,
135 required: true
136 }
137 ]
138 },
139 [ScopeNames.WITH_SHARES]: {
140 include: [
141 {
142 model: () => VideoShareModel,
50d6de9c 143 include: [ () => ActorModel ]
d48ff09d
C
144 }
145 ]
146 },
147 [ScopeNames.WITH_RATES]: {
148 include: [
149 {
150 model: () => AccountVideoRateModel,
151 include: [ () => AccountModel ]
152 }
153 ]
154 }
155})
3fd3ab2d
C
156@Table({
157 tableName: 'video',
158 indexes: [
feb4bdfd 159 {
3fd3ab2d 160 fields: [ 'name' ]
feb4bdfd
C
161 },
162 {
3fd3ab2d
C
163 fields: [ 'createdAt' ]
164 },
165 {
166 fields: [ 'duration' ]
167 },
168 {
169 fields: [ 'views' ]
170 },
171 {
172 fields: [ 'likes' ]
173 },
174 {
175 fields: [ 'uuid' ]
176 },
177 {
178 fields: [ 'channelId' ]
feb4bdfd 179 }
e02643f3 180 ]
3fd3ab2d
C
181})
182export class VideoModel extends Model<VideoModel> {
183
184 @AllowNull(false)
185 @Default(DataType.UUIDV4)
186 @IsUUID(4)
187 @Column(DataType.UUID)
188 uuid: string
189
190 @AllowNull(false)
191 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
192 @Column
193 name: string
194
195 @AllowNull(true)
196 @Default(null)
197 @Is('VideoCategory', value => throwIfNotValid(value, isVideoCategoryValid, 'category'))
198 @Column
199 category: number
200
201 @AllowNull(true)
202 @Default(null)
203 @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence'))
204 @Column
205 licence: number
206
207 @AllowNull(true)
208 @Default(null)
209 @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language'))
210 @Column
211 language: number
212
213 @AllowNull(false)
214 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
215 @Column
216 privacy: number
217
218 @AllowNull(false)
219 @Is('VideoNSFW', value => throwIfNotValid(value, isVideoNSFWValid, 'NSFW boolean'))
220 @Column
221 nsfw: boolean
222
223 @AllowNull(true)
224 @Default(null)
225 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description'))
226 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
227 description: string
228
229 @AllowNull(false)
230 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
231 @Column
232 duration: number
233
234 @AllowNull(false)
235 @Default(0)
236 @IsInt
237 @Min(0)
238 @Column
239 views: number
240
241 @AllowNull(false)
242 @Default(0)
243 @IsInt
244 @Min(0)
245 @Column
246 likes: number
247
248 @AllowNull(false)
249 @Default(0)
250 @IsInt
251 @Min(0)
252 @Column
253 dislikes: number
254
255 @AllowNull(false)
256 @Column
257 remote: boolean
258
259 @AllowNull(false)
260 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
261 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
262 url: string
263
264 @CreatedAt
265 createdAt: Date
266
267 @UpdatedAt
268 updatedAt: Date
269
270 @ForeignKey(() => VideoChannelModel)
271 @Column
272 channelId: number
273
274 @BelongsTo(() => VideoChannelModel, {
feb4bdfd 275 foreignKey: {
50d6de9c 276 allowNull: true
feb4bdfd
C
277 },
278 onDelete: 'cascade'
279 })
3fd3ab2d 280 VideoChannel: VideoChannelModel
7920c273 281
3fd3ab2d 282 @BelongsToMany(() => TagModel, {
7920c273 283 foreignKey: 'videoId',
3fd3ab2d
C
284 through: () => VideoTagModel,
285 onDelete: 'CASCADE'
7920c273 286 })
3fd3ab2d 287 Tags: TagModel[]
55fa55a9 288
3fd3ab2d 289 @HasMany(() => VideoAbuseModel, {
55fa55a9
C
290 foreignKey: {
291 name: 'videoId',
292 allowNull: false
293 },
294 onDelete: 'cascade'
295 })
3fd3ab2d 296 VideoAbuses: VideoAbuseModel[]
93e1258c 297
3fd3ab2d 298 @HasMany(() => VideoFileModel, {
93e1258c
C
299 foreignKey: {
300 name: 'videoId',
301 allowNull: false
302 },
303 onDelete: 'cascade'
304 })
3fd3ab2d 305 VideoFiles: VideoFileModel[]
e71bcc0f 306
3fd3ab2d 307 @HasMany(() => VideoShareModel, {
e71bcc0f
C
308 foreignKey: {
309 name: 'videoId',
310 allowNull: false
311 },
312 onDelete: 'cascade'
313 })
3fd3ab2d 314 VideoShares: VideoShareModel[]
16b90975 315
3fd3ab2d 316 @HasMany(() => AccountVideoRateModel, {
16b90975
C
317 foreignKey: {
318 name: 'videoId',
319 allowNull: false
320 },
321 onDelete: 'cascade'
322 })
3fd3ab2d 323 AccountVideoRates: AccountVideoRateModel[]
f285faa0 324
3fd3ab2d
C
325 @AfterDestroy
326 static removeFilesAndSendDelete (instance: VideoModel) {
327 const tasks = []
f285faa0 328
93e1258c 329 tasks.push(
3fd3ab2d 330 instance.removeThumbnail()
93e1258c
C
331 )
332
3fd3ab2d
C
333 if (instance.isOwned()) {
334 tasks.push(
335 instance.removePreview(),
336 sendDeleteVideo(instance, undefined)
337 )
40298b02 338
3fd3ab2d
C
339 // Remove physical files and torrents
340 instance.VideoFiles.forEach(file => {
341 tasks.push(instance.removeFile(file))
342 tasks.push(instance.removeTorrent(file))
343 })
344 }
40298b02 345
3fd3ab2d
C
346 return Promise.all(tasks)
347 .catch(err => {
348 logger.error('Some errors when removing files of video %s in after destroy hook.', instance.uuid, err)
349 })
350 }
f285faa0 351
3fd3ab2d 352 static list () {
d48ff09d 353 return VideoModel.scope(ScopeNames.WITH_FILES).findAll()
3fd3ab2d 354 }
f285faa0 355
50d6de9c 356 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
3fd3ab2d
C
357 function getRawQuery (select: string) {
358 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
359 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
50d6de9c
C
360 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
361 'WHERE "Account"."actorId" = ' + actorId
3fd3ab2d
C
362 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
363 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
50d6de9c 364 'WHERE "VideoShare"."actorId" = ' + actorId
558d7c23 365
3fd3ab2d
C
366 return `(${queryVideo}) UNION (${queryVideoShare})`
367 }
aaf61f38 368
3fd3ab2d
C
369 const rawQuery = getRawQuery('"Video"."id"')
370 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
371
372 const query = {
373 distinct: true,
374 offset: start,
375 limit: count,
376 order: [ getSort('createdAt'), [ 'Tags', 'name', 'ASC' ] ],
377 where: {
378 id: {
379 [Sequelize.Op.in]: Sequelize.literal('(' + rawQuery + ')')
380 }
381 },
382 include: [
383 {
384 model: VideoShareModel,
385 required: false,
386 where: {
387 [Sequelize.Op.and]: [
388 {
389 id: {
390 [Sequelize.Op.not]: null
391 }
392 },
393 {
50d6de9c 394 actorId
3fd3ab2d
C
395 }
396 ]
397 },
50d6de9c
C
398 include: [
399 {
400 model: ActorModel,
401 required: true
402 }
403 ]
3fd3ab2d
C
404 },
405 {
406 model: VideoChannelModel,
407 required: true,
408 include: [
409 {
410 model: AccountModel,
411 required: true
412 }
413 ]
414 },
415 {
416 model: AccountVideoRateModel,
417 include: [ AccountModel ]
418 },
419 VideoFileModel,
420 TagModel
421 ]
422 }
164174a6 423
3fd3ab2d
C
424 return Bluebird.all([
425 // FIXME: typing issue
426 VideoModel.findAll(query as any),
427 VideoModel.sequelize.query(rawCountQuery, { type: Sequelize.QueryTypes.SELECT })
428 ]).then(([ rows, totals ]) => {
429 // totals: totalVideos + totalVideoShares
430 let totalVideos = 0
431 let totalVideoShares = 0
432 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
433 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
434
435 const total = totalVideos + totalVideoShares
436 return {
437 data: rows,
438 total: total
439 }
440 })
441 }
93e1258c 442
3fd3ab2d
C
443 static listUserVideosForApi (userId: number, start: number, count: number, sort: string) {
444 const query = {
3fd3ab2d
C
445 offset: start,
446 limit: count,
d48ff09d 447 order: [ getSort(sort) ],
3fd3ab2d
C
448 include: [
449 {
450 model: VideoChannelModel,
451 required: true,
452 include: [
453 {
454 model: AccountModel,
455 where: {
456 userId
457 },
458 required: true
459 }
460 ]
d48ff09d 461 }
3fd3ab2d
C
462 ]
463 }
d8755eed 464
3fd3ab2d
C
465 return VideoModel.findAndCountAll(query).then(({ rows, count }) => {
466 return {
467 data: rows,
468 total: count
469 }
470 })
471 }
93e1258c 472
3fd3ab2d
C
473 static listForApi (start: number, count: number, sort: string) {
474 const query = {
3fd3ab2d
C
475 offset: start,
476 limit: count,
d48ff09d 477 order: [ getSort(sort) ]
3fd3ab2d 478 }
93e1258c 479
50d6de9c 480 return VideoModel.scope([ ScopeNames.AVAILABLE_FOR_LIST, ScopeNames.WITH_ACCOUNT ])
d48ff09d
C
481 .findAndCountAll(query)
482 .then(({ rows, count }) => {
483 return {
484 data: rows,
485 total: count
486 }
487 })
93e1258c
C
488 }
489
3fd3ab2d
C
490 static load (id: number) {
491 return VideoModel.findById(id)
492 }
fdbda9e3 493
3fd3ab2d
C
494 static loadByUrlAndPopulateAccount (url: string, t?: Sequelize.Transaction) {
495 const query: IFindOptions<VideoModel> = {
496 where: {
497 url
d48ff09d 498 }
3fd3ab2d 499 }
d8755eed 500
3fd3ab2d 501 if (t !== undefined) query.transaction = t
d8755eed 502
d48ff09d 503 return VideoModel.scope([ ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_FILES ]).findOne(query)
3fd3ab2d 504 }
d8755eed 505
3fd3ab2d
C
506 static loadByUUIDOrURL (uuid: string, url: string, t?: Sequelize.Transaction) {
507 const query: IFindOptions<VideoModel> = {
508 where: {
509 [Sequelize.Op.or]: [
510 { uuid },
511 { url }
512 ]
d48ff09d 513 }
3fd3ab2d 514 }
feb4bdfd 515
3fd3ab2d 516 if (t !== undefined) query.transaction = t
feb4bdfd 517
d48ff09d 518 return VideoModel.scope(ScopeNames.WITH_FILES).findOne(query)
72c7248b
C
519 }
520
3fd3ab2d
C
521 static loadAndPopulateAccountAndServerAndTags (id: number) {
522 const options = {
d48ff09d 523 order: [ [ 'Tags', 'name', 'ASC' ] ]
3fd3ab2d 524 }
72c7248b 525
d48ff09d
C
526 return VideoModel
527 .scope([ ScopeNames.WITH_RATES, ScopeNames.WITH_SHARES, ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT ])
528 .findById(id, options)
3fd3ab2d 529 }
72c7248b 530
8fa5653a
C
531 static loadByUUID (uuid: string) {
532 const options = {
533 where: {
534 uuid
535 }
536 }
537
538 return VideoModel
539 .scope([ ScopeNames.WITH_FILES ])
540 .findOne(options)
541 }
542
3fd3ab2d
C
543 static loadByUUIDAndPopulateAccountAndServerAndTags (uuid: string) {
544 const options = {
545 order: [ [ 'Tags', 'name', 'ASC' ] ],
546 where: {
547 uuid
d48ff09d 548 }
3fd3ab2d 549 }
fd45e8f4 550
d48ff09d
C
551 return VideoModel
552 .scope([ ScopeNames.WITH_RATES, ScopeNames.WITH_SHARES, ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT ])
553 .findOne(options)
aaf61f38
C
554 }
555
3fd3ab2d
C
556 static searchAndPopulateAccountAndServerAndTags (value: string, start: number, count: number, sort: string) {
557 const serverInclude: IIncludeOptions = {
558 model: ServerModel,
559 required: false
560 }
aaf61f38 561
3fd3ab2d
C
562 const accountInclude: IIncludeOptions = {
563 model: AccountModel,
50d6de9c
C
564 include: [
565 {
566 model: ActorModel,
567 required: true,
568 include: [ serverInclude ]
569 }
570 ]
3fd3ab2d 571 }
e4f97bab 572
3fd3ab2d
C
573 const videoChannelInclude: IIncludeOptions = {
574 model: VideoChannelModel,
575 include: [ accountInclude ],
576 required: true
40ff5707 577 }
40ff5707 578
3fd3ab2d
C
579 const tagInclude: IIncludeOptions = {
580 model: TagModel
f595d394 581 }
f595d394 582
3fd3ab2d 583 const query: IFindOptions<VideoModel> = {
d48ff09d 584 distinct: true, // Because we have tags
3fd3ab2d
C
585 offset: start,
586 limit: count,
d48ff09d
C
587 order: [ getSort(sort) ],
588 where: {}
f595d394 589 }
f595d394 590
3fd3ab2d
C
591 // TODO: search on tags too
592 // const escapedValue = Video['sequelize'].escape('%' + value + '%')
593 // query.where['id'][Sequelize.Op.in] = Video['sequelize'].literal(
594 // `(SELECT "VideoTags"."videoId"
595 // FROM "Tags"
596 // INNER JOIN "VideoTags" ON "Tags"."id" = "VideoTags"."tagId"
597 // WHERE name ILIKE ${escapedValue}
598 // )`
599 // )
600
601 // TODO: search on account too
602 // accountInclude.where = {
603 // name: {
604 // [Sequelize.Op.iLike]: '%' + value + '%'
605 // }
606 // }
607 query.where['name'] = {
608 [Sequelize.Op.iLike]: '%' + value + '%'
609 }
16b90975 610
3fd3ab2d
C
611 query.include = [
612 videoChannelInclude, tagInclude
613 ]
16b90975 614
50d6de9c 615 return VideoModel.scope([ ScopeNames.AVAILABLE_FOR_LIST ])
d48ff09d
C
616 .findAndCountAll(query).then(({ rows, count }) => {
617 return {
618 data: rows,
619 total: count
620 }
621 })
4e50b6a1
C
622 }
623
3fd3ab2d
C
624 getOriginalFile () {
625 if (Array.isArray(this.VideoFiles) === false) return undefined
aaf61f38 626
3fd3ab2d
C
627 // The original file is the file that have the higher resolution
628 return maxBy(this.VideoFiles, file => file.resolution)
e4f97bab 629 }
aaf61f38 630
3fd3ab2d
C
631 getVideoFilename (videoFile: VideoFileModel) {
632 return this.uuid + '-' + videoFile.resolution + videoFile.extname
633 }
165cdc75 634
3fd3ab2d
C
635 getThumbnailName () {
636 // We always have a copy of the thumbnail
637 const extension = '.jpg'
638 return this.uuid + extension
7b1f49de
C
639 }
640
3fd3ab2d
C
641 getPreviewName () {
642 const extension = '.jpg'
643 return this.uuid + extension
644 }
7b1f49de 645
3fd3ab2d
C
646 getTorrentFileName (videoFile: VideoFileModel) {
647 const extension = '.torrent'
648 return this.uuid + '-' + videoFile.resolution + extension
649 }
8e7f08b5 650
3fd3ab2d
C
651 isOwned () {
652 return this.remote === false
9567011b
C
653 }
654
3fd3ab2d
C
655 createPreview (videoFile: VideoFileModel) {
656 const imageSize = PREVIEWS_SIZE.width + 'x' + PREVIEWS_SIZE.height
657
658 return generateImageFromVideoFile(
659 this.getVideoFilePath(videoFile),
660 CONFIG.STORAGE.PREVIEWS_DIR,
661 this.getPreviewName(),
662 imageSize
663 )
664 }
9567011b 665
3fd3ab2d
C
666 createThumbnail (videoFile: VideoFileModel) {
667 const imageSize = THUMBNAILS_SIZE.width + 'x' + THUMBNAILS_SIZE.height
227d02fe 668
3fd3ab2d
C
669 return generateImageFromVideoFile(
670 this.getVideoFilePath(videoFile),
671 CONFIG.STORAGE.THUMBNAILS_DIR,
672 this.getThumbnailName(),
673 imageSize
674 )
14d3270f
C
675 }
676
3fd3ab2d
C
677 getVideoFilePath (videoFile: VideoFileModel) {
678 return join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
679 }
14d3270f 680
3fd3ab2d
C
681 createTorrentAndSetInfoHash = async function (videoFile: VideoFileModel) {
682 const options = {
683 announceList: [
684 [ CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT + '/tracker/socket' ]
685 ],
686 urlList: [
687 CONFIG.WEBSERVER.URL + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile)
688 ]
689 }
14d3270f 690
3fd3ab2d 691 const torrent = await createTorrentPromise(this.getVideoFilePath(videoFile), options)
e4f97bab 692
3fd3ab2d
C
693 const filePath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
694 logger.info('Creating torrent %s.', filePath)
e4f97bab 695
3fd3ab2d 696 await writeFilePromise(filePath, torrent)
e4f97bab 697
3fd3ab2d
C
698 const parsedTorrent = parseTorrent(torrent)
699 videoFile.infoHash = parsedTorrent.infoHash
700 }
e4f97bab 701
3fd3ab2d
C
702 getEmbedPath () {
703 return '/videos/embed/' + this.uuid
704 }
e4f97bab 705
3fd3ab2d
C
706 getThumbnailPath () {
707 return join(STATIC_PATHS.THUMBNAILS, this.getThumbnailName())
e4f97bab 708 }
227d02fe 709
3fd3ab2d
C
710 getPreviewPath () {
711 return join(STATIC_PATHS.PREVIEWS, this.getPreviewName())
712 }
40298b02 713
3fd3ab2d
C
714 toFormattedJSON () {
715 let serverHost
40298b02 716
50d6de9c
C
717 if (this.VideoChannel.Account.Actor.Server) {
718 serverHost = this.VideoChannel.Account.Actor.Server.host
3fd3ab2d
C
719 } else {
720 // It means it's our video
721 serverHost = CONFIG.WEBSERVER.HOST
722 }
14d3270f 723
3fd3ab2d
C
724 return {
725 id: this.id,
726 uuid: this.uuid,
727 name: this.name,
728 category: this.category,
729 categoryLabel: this.getCategoryLabel(),
730 licence: this.licence,
731 licenceLabel: this.getLicenceLabel(),
732 language: this.language,
733 languageLabel: this.getLanguageLabel(),
734 nsfw: this.nsfw,
735 description: this.getTruncatedDescription(),
736 serverHost,
737 isLocal: this.isOwned(),
738 accountName: this.VideoChannel.Account.name,
739 duration: this.duration,
740 views: this.views,
741 likes: this.likes,
742 dislikes: this.dislikes,
3fd3ab2d
C
743 thumbnailPath: this.getThumbnailPath(),
744 previewPath: this.getPreviewPath(),
745 embedPath: this.getEmbedPath(),
746 createdAt: this.createdAt,
747 updatedAt: this.updatedAt
d48ff09d 748 } as Video
14d3270f 749 }
14d3270f 750
3fd3ab2d
C
751 toFormattedDetailsJSON () {
752 const formattedJson = this.toFormattedJSON()
e4f97bab 753
3fd3ab2d
C
754 // Maybe our server is not up to date and there are new privacy settings since our version
755 let privacyLabel = VIDEO_PRIVACIES[this.privacy]
756 if (!privacyLabel) privacyLabel = 'Unknown'
e4f97bab 757
3fd3ab2d
C
758 const detailsJson = {
759 privacyLabel,
760 privacy: this.privacy,
761 descriptionPath: this.getDescriptionPath(),
762 channel: this.VideoChannel.toFormattedJSON(),
763 account: this.VideoChannel.Account.toFormattedJSON(),
d48ff09d 764 tags: map<TagModel, string>(this.Tags, 'name'),
3fd3ab2d
C
765 files: []
766 }
e4f97bab 767
3fd3ab2d
C
768 // Format and sort video files
769 const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
770 detailsJson.files = this.VideoFiles
771 .map(videoFile => {
772 let resolutionLabel = videoFile.resolution + 'p'
773
774 return {
775 resolution: videoFile.resolution,
776 resolutionLabel,
777 magnetUri: this.generateMagnetUri(videoFile, baseUrlHttp, baseUrlWs),
778 size: videoFile.size,
779 torrentUrl: this.getTorrentUrl(videoFile, baseUrlHttp),
780 fileUrl: this.getVideoFileUrl(videoFile, baseUrlHttp)
781 }
782 })
783 .sort((a, b) => {
784 if (a.resolution < b.resolution) return 1
785 if (a.resolution === b.resolution) return 0
786 return -1
787 })
788
d48ff09d 789 return Object.assign(formattedJson, detailsJson) as VideoDetails
3fd3ab2d 790 }
e4f97bab 791
3fd3ab2d
C
792 toActivityPubObject (): VideoTorrentObject {
793 const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
794 if (!this.Tags) this.Tags = []
e4f97bab 795
3fd3ab2d
C
796 const tag = this.Tags.map(t => ({
797 type: 'Hashtag' as 'Hashtag',
798 name: t.name
799 }))
40298b02 800
3fd3ab2d
C
801 let language
802 if (this.language) {
803 language = {
804 identifier: this.language + '',
805 name: this.getLanguageLabel()
806 }
807 }
40298b02 808
3fd3ab2d
C
809 let category
810 if (this.category) {
811 category = {
812 identifier: this.category + '',
813 name: this.getCategoryLabel()
814 }
815 }
40298b02 816
3fd3ab2d
C
817 let licence
818 if (this.licence) {
819 licence = {
820 identifier: this.licence + '',
821 name: this.getLicenceLabel()
822 }
823 }
9567011b 824
3fd3ab2d
C
825 let likesObject
826 let dislikesObject
e4f97bab 827
3fd3ab2d
C
828 if (Array.isArray(this.AccountVideoRates)) {
829 const likes: string[] = []
830 const dislikes: string[] = []
e4f97bab 831
3fd3ab2d
C
832 for (const rate of this.AccountVideoRates) {
833 if (rate.type === 'like') {
50d6de9c 834 likes.push(rate.Account.Actor.url)
3fd3ab2d 835 } else if (rate.type === 'dislike') {
50d6de9c 836 dislikes.push(rate.Account.Actor.url)
3fd3ab2d
C
837 }
838 }
e4f97bab 839
3fd3ab2d
C
840 likesObject = activityPubCollection(likes)
841 dislikesObject = activityPubCollection(dislikes)
842 }
e4f97bab 843
3fd3ab2d
C
844 let sharesObject
845 if (Array.isArray(this.VideoShares)) {
846 const shares: string[] = []
e4f97bab 847
3fd3ab2d 848 for (const videoShare of this.VideoShares) {
50d6de9c 849 const shareUrl = getAnnounceActivityPubUrl(this.url, videoShare.Actor)
3fd3ab2d
C
850 shares.push(shareUrl)
851 }
e4f97bab 852
3fd3ab2d
C
853 sharesObject = activityPubCollection(shares)
854 }
93e1258c 855
3fd3ab2d
C
856 const url = []
857 for (const file of this.VideoFiles) {
858 url.push({
859 type: 'Link',
860 mimeType: 'video/' + file.extname.replace('.', ''),
861 url: this.getVideoFileUrl(file, baseUrlHttp),
862 width: file.resolution,
863 size: file.size
864 })
865
866 url.push({
867 type: 'Link',
868 mimeType: 'application/x-bittorrent',
869 url: this.getTorrentUrl(file, baseUrlHttp),
870 width: file.resolution
871 })
872
873 url.push({
874 type: 'Link',
875 mimeType: 'application/x-bittorrent;x-scheme-handler/magnet',
876 url: this.generateMagnetUri(file, baseUrlHttp, baseUrlWs),
877 width: file.resolution
878 })
879 }
93e1258c 880
3fd3ab2d
C
881 // Add video url too
882 url.push({
883 type: 'Link',
884 mimeType: 'text/html',
885 url: CONFIG.WEBSERVER.URL + '/videos/watch/' + this.uuid
886 })
93e1258c 887
3fd3ab2d
C
888 return {
889 type: 'Video' as 'Video',
890 id: this.url,
891 name: this.name,
892 // https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
893 duration: 'PT' + this.duration + 'S',
894 uuid: this.uuid,
895 tag,
896 category,
897 licence,
898 language,
899 views: this.views,
900 nsfw: this.nsfw,
901 published: this.createdAt.toISOString(),
902 updated: this.updatedAt.toISOString(),
903 mediaType: 'text/markdown',
904 content: this.getTruncatedDescription(),
905 icon: {
906 type: 'Image',
907 url: this.getThumbnailUrl(baseUrlHttp),
908 mediaType: 'image/jpeg',
909 width: THUMBNAILS_SIZE.width,
910 height: THUMBNAILS_SIZE.height
911 },
912 url,
913 likes: likesObject,
914 dislikes: dislikesObject,
50d6de9c
C
915 shares: sharesObject,
916 attributedTo: [
917 {
918 type: 'Group',
919 id: this.VideoChannel.Actor.url
920 }
921 ]
3fd3ab2d
C
922 }
923 }
924
925 getTruncatedDescription () {
926 if (!this.description) return null
93e1258c 927
3fd3ab2d
C
928 const options = {
929 length: CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
930 }
aaf61f38 931
3fd3ab2d 932 return truncate(this.description, options)
93e1258c
C
933 }
934
3fd3ab2d
C
935 optimizeOriginalVideofile = async function () {
936 const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR
937 const newExtname = '.mp4'
938 const inputVideoFile = this.getOriginalFile()
939 const videoInputPath = join(videosDirectory, this.getVideoFilename(inputVideoFile))
940 const videoOutputPath = join(videosDirectory, this.id + '-transcoded' + newExtname)
b769007f 941
3fd3ab2d
C
942 const transcodeOptions = {
943 inputPath: videoInputPath,
944 outputPath: videoOutputPath
945 }
c46edbc2 946
3fd3ab2d
C
947 try {
948 // Could be very long!
949 await transcode(transcodeOptions)
c46edbc2 950
3fd3ab2d 951 await unlinkPromise(videoInputPath)
c46edbc2 952
3fd3ab2d
C
953 // Important to do this before getVideoFilename() to take in account the new file extension
954 inputVideoFile.set('extname', newExtname)
e71bcc0f 955
3fd3ab2d
C
956 await renamePromise(videoOutputPath, this.getVideoFilePath(inputVideoFile))
957 const stats = await statPromise(this.getVideoFilePath(inputVideoFile))
e71bcc0f 958
3fd3ab2d 959 inputVideoFile.set('size', stats.size)
e71bcc0f 960
3fd3ab2d
C
961 await this.createTorrentAndSetInfoHash(inputVideoFile)
962 await inputVideoFile.save()
fd45e8f4 963
3fd3ab2d
C
964 } catch (err) {
965 // Auto destruction...
966 this.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', err))
fd45e8f4 967
3fd3ab2d
C
968 throw err
969 }
feb4bdfd
C
970 }
971
3fd3ab2d
C
972 transcodeOriginalVideofile = async function (resolution: VideoResolution) {
973 const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR
974 const extname = '.mp4'
aaf61f38 975
3fd3ab2d
C
976 // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed
977 const videoInputPath = join(videosDirectory, this.getVideoFilename(this.getOriginalFile()))
feb4bdfd 978
3fd3ab2d
C
979 const newVideoFile = new VideoFileModel({
980 resolution,
981 extname,
982 size: 0,
983 videoId: this.id
984 })
985 const videoOutputPath = join(videosDirectory, this.getVideoFilename(newVideoFile))
a041b171 986
3fd3ab2d
C
987 const transcodeOptions = {
988 inputPath: videoInputPath,
989 outputPath: videoOutputPath,
990 resolution
991 }
a041b171 992
3fd3ab2d 993 await transcode(transcodeOptions)
a041b171 994
3fd3ab2d 995 const stats = await statPromise(videoOutputPath)
d7d5611c 996
3fd3ab2d 997 newVideoFile.set('size', stats.size)
d7d5611c 998
3fd3ab2d 999 await this.createTorrentAndSetInfoHash(newVideoFile)
d7d5611c 1000
3fd3ab2d
C
1001 await newVideoFile.save()
1002
1003 this.VideoFiles.push(newVideoFile)
0d0e8dd0
C
1004 }
1005
3fd3ab2d
C
1006 getOriginalFileHeight () {
1007 const originalFilePath = this.getVideoFilePath(this.getOriginalFile())
0d0e8dd0 1008
3fd3ab2d
C
1009 return getVideoFileHeight(originalFilePath)
1010 }
0d0e8dd0 1011
3fd3ab2d
C
1012 getDescriptionPath () {
1013 return `/api/${API_VERSION}/videos/${this.uuid}/description`
feb4bdfd
C
1014 }
1015
3fd3ab2d
C
1016 getCategoryLabel () {
1017 let categoryLabel = VIDEO_CATEGORIES[this.category]
1018 if (!categoryLabel) categoryLabel = 'Misc'
aaf61f38 1019
3fd3ab2d 1020 return categoryLabel
0a6658fd
C
1021 }
1022
3fd3ab2d
C
1023 getLicenceLabel () {
1024 let licenceLabel = VIDEO_LICENCES[this.licence]
1025 if (!licenceLabel) licenceLabel = 'Unknown'
0a6658fd 1026
3fd3ab2d 1027 return licenceLabel
feb4bdfd 1028 }
7920c273 1029
3fd3ab2d
C
1030 getLanguageLabel () {
1031 let languageLabel = VIDEO_LANGUAGES[this.language]
1032 if (!languageLabel) languageLabel = 'Unknown'
1033
1034 return languageLabel
72c7248b
C
1035 }
1036
3fd3ab2d
C
1037 removeThumbnail () {
1038 const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName())
1039 return unlinkPromise(thumbnailPath)
feb4bdfd
C
1040 }
1041
3fd3ab2d
C
1042 removePreview () {
1043 // Same name than video thumbnail
1044 return unlinkPromise(CONFIG.STORAGE.PREVIEWS_DIR + this.getPreviewName())
7920c273
C
1045 }
1046
3fd3ab2d
C
1047 removeFile (videoFile: VideoFileModel) {
1048 const filePath = join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
1049 return unlinkPromise(filePath)
feb4bdfd
C
1050 }
1051
3fd3ab2d
C
1052 removeTorrent (videoFile: VideoFileModel) {
1053 const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1054 return unlinkPromise(torrentPath)
aaf61f38
C
1055 }
1056
3fd3ab2d
C
1057 private getBaseUrls () {
1058 let baseUrlHttp
1059 let baseUrlWs
7920c273 1060
3fd3ab2d
C
1061 if (this.isOwned()) {
1062 baseUrlHttp = CONFIG.WEBSERVER.URL
1063 baseUrlWs = CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
1064 } else {
50d6de9c
C
1065 baseUrlHttp = REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host
1066 baseUrlWs = REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host
6fcd19ba 1067 }
aaf61f38 1068
3fd3ab2d 1069 return { baseUrlHttp, baseUrlWs }
15d4ee04 1070 }
a96aed15 1071
3fd3ab2d
C
1072 private getThumbnailUrl (baseUrlHttp: string) {
1073 return baseUrlHttp + STATIC_PATHS.THUMBNAILS + this.getThumbnailName()
a96aed15
C
1074 }
1075
3fd3ab2d
C
1076 private getTorrentUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1077 return baseUrlHttp + STATIC_PATHS.TORRENTS + this.getTorrentFileName(videoFile)
1078 }
e4f97bab 1079
3fd3ab2d
C
1080 private getVideoFileUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1081 return baseUrlHttp + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile)
1082 }
a96aed15 1083
3fd3ab2d
C
1084 private generateMagnetUri (videoFile: VideoFileModel, baseUrlHttp: string, baseUrlWs: string) {
1085 const xs = this.getTorrentUrl(videoFile, baseUrlHttp)
1086 const announce = [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ]
1087 const urlList = [ this.getVideoFileUrl(videoFile, baseUrlHttp) ]
1088
1089 const magnetHash = {
1090 xs,
1091 announce,
1092 urlList,
1093 infoHash: videoFile.infoHash,
1094 name: this.name
1095 }
a96aed15 1096
3fd3ab2d 1097 return magnetUtil.encode(magnetHash)
a96aed15 1098 }
a96aed15 1099}