server/models/video/video.ts

   1 import * as Bluebird from 'bluebird'
   2 import { map, maxBy } from 'lodash'
   3 import * as magnetUtil from 'magnet-uri'
   4 import * as parseTorrent from 'parse-torrent'
   5 import { join } from 'path'
   6 import * as Sequelize from 'sequelize'
   7 import {
   8   AllowNull,
   9   BeforeDestroy,
  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,
  24   Scopes,
  25   Table,
  26   UpdatedAt
  27 } from 'sequelize-typescript'
  28 import { VideoPrivacy, VideoResolution } from '../../../shared'
  29 import { VideoTorrentObject } from '../../../shared/models/activitypub/objects'
  30 import { Video, VideoDetails, VideoFile } from '../../../shared/models/videos'
  31 import { VideoFilter } from '../../../shared/models/videos/video-query.type'
  32 import { activityPubCollection } from '../../helpers/activitypub'
  33 import {
  34   createTorrentPromise,
  35   peertubeTruncate,
  36   renamePromise,
  37   statPromise,
  38   unlinkPromise,
  39   writeFilePromise
  40 } from '../../helpers/core-utils'
  41 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
  42 import { isBooleanValid } from '../../helpers/custom-validators/misc'
  43 import {
  44   isVideoCategoryValid,
  45   isVideoDescriptionValid,
  46   isVideoDurationValid,
  47   isVideoLanguageValid,
  48   isVideoLicenceValid,
  49   isVideoNameValid,
  50   isVideoPrivacyValid,
  51   isVideoSupportValid
  52 } from '../../helpers/custom-validators/videos'
  53 import { generateImageFromVideoFile, getVideoFileResolution, transcode } from '../../helpers/ffmpeg-utils'
  54 import { logger } from '../../helpers/logger'
  55 import { getServerActor } from '../../helpers/utils'
  56 import {
  57   API_VERSION,
  58   CONFIG,
  59   CONSTRAINTS_FIELDS,
  60   PREVIEWS_SIZE,
  61   REMOTE_SCHEME,
  62   STATIC_PATHS,
  63   THUMBNAILS_SIZE,
  64   VIDEO_CATEGORIES,
  65   VIDEO_LANGUAGES,
  66   VIDEO_LICENCES,
  67   VIDEO_PRIVACIES
  68 } from '../../initializers'
  69 import {
  70   getVideoCommentsActivityPubUrl,
  71   getVideoDislikesActivityPubUrl,
  72   getVideoLikesActivityPubUrl,
  73   getVideoSharesActivityPubUrl
  74 } from '../../lib/activitypub'
  75 import { sendDeleteVideo } from '../../lib/activitypub/send'
  76 import { AccountModel } from '../account/account'
  77 import { AccountVideoRateModel } from '../account/account-video-rate'
  78 import { ActorModel } from '../activitypub/actor'
  79 import { AvatarModel } from '../avatar/avatar'
  80 import { ServerModel } from '../server/server'
  81 import { getSort, throwIfNotValid } from '../utils'
  82 import { TagModel } from './tag'
  83 import { VideoAbuseModel } from './video-abuse'
  84 import { VideoChannelModel } from './video-channel'
  85 import { VideoCommentModel } from './video-comment'
  86 import { VideoFileModel } from './video-file'
  87 import { VideoShareModel } from './video-share'
  88 import { VideoTagModel } from './video-tag'
  89
  90 enum ScopeNames {
  91   AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST',
  92   WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
  93   WITH_TAGS = 'WITH_TAGS',
  94   WITH_FILES = 'WITH_FILES',
  95   WITH_SHARES = 'WITH_SHARES',
  96   WITH_RATES = 'WITH_RATES',
  97   WITH_COMMENTS = 'WITH_COMMENTS'
  98 }
  99
 100 @Scopes({
 101   [ScopeNames.AVAILABLE_FOR_LIST]: (options: {
 102     actorId: number,
 103     hideNSFW: boolean,
 104     filter?: VideoFilter,
 105     withFiles?: boolean,
 106     accountId?: number,
 107     videoChannelId?: number
 108   }) => {
 109     const accountInclude = {
 110       attributes: [ 'id', 'name' ],
 111       model: AccountModel.unscoped(),
 112       required: true,
 113       where: {},
 114       include: [
 115         {
 116           attributes: [ 'id', 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
 117           model: ActorModel.unscoped(),
 118           required: true,
 119           where: VideoModel.buildActorWhereWithFilter(options.filter),
 120           include: [
 121             {
 122               attributes: [ 'host' ],
 123               model: ServerModel.unscoped(),
 124               required: false
 125             },
 126             {
 127               model: AvatarModel.unscoped(),
 128               required: false
 129             }
 130           ]
 131         }
 132       ]
 133     }
 134
 135     const videoChannelInclude = {
 136       attributes: [ 'name', 'description', 'id' ],
 137       model: VideoChannelModel.unscoped(),
 138       required: true,
 139       where: {},
 140       include: [
 141         {
 142           attributes: [ 'uuid', 'preferredUsername', 'url', 'serverId', 'avatarId' ],
 143           model: ActorModel.unscoped(),
 144           required: true,
 145           include: [
 146             {
 147               attributes: [ 'host' ],
 148               model: ServerModel.unscoped(),
 149               required: false
 150             },
 151             {
 152               model: AvatarModel.unscoped(),
 153               required: false
 154             }
 155           ]
 156         },
 157         accountInclude
 158       ]
 159     }
 160
 161     // Force actorId to be a number to avoid SQL injections
 162     const actorIdNumber = parseInt(options.actorId.toString(), 10)
 163     const query: IFindOptions<VideoModel> = {
 164       where: {
 165         id: {
 166           [Sequelize.Op.notIn]: Sequelize.literal(
 167             '(SELECT "videoBlacklist"."videoId" FROM "videoBlacklist")'
 168           ),
 169           [ Sequelize.Op.in ]: Sequelize.literal(
 170             '(' +
 171             'SELECT "videoShare"."videoId" AS "id" FROM "videoShare" ' +
 172             'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
 173             'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
 174             ' UNION ' +
 175             'SELECT "video"."id" AS "id" FROM "video" ' +
 176             'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
 177             'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
 178             'INNER JOIN "actor" ON "account"."actorId" = "actor"."id" ' +
 179             'LEFT JOIN "actorFollow" ON "actorFollow"."targetActorId" = "actor"."id" ' +
 180             'WHERE "actor"."serverId" IS NULL OR "actorFollow"."actorId" = ' + actorIdNumber +
 181             ')'
 182           )
 183         },
 184         privacy: VideoPrivacy.PUBLIC
 185       },
 186       include: [ videoChannelInclude ]
 187     }
 188
 189     if (options.withFiles === true) {
 190       query.include.push({
 191         model: VideoFileModel.unscoped(),
 192         required: true
 193       })
 194     }
 195
 196     // Hide nsfw videos?
 197     if (options.hideNSFW === true) {
 198       query.where['nsfw'] = false
 199     }
 200
 201     if (options.accountId) {
 202       accountInclude.where = {
 203         id: options.accountId
 204       }
 205     }
 206
 207     if (options.videoChannelId) {
 208       videoChannelInclude.where = {
 209         id: options.videoChannelId
 210       }
 211     }
 212
 213     return query
 214   },
 215   [ScopeNames.WITH_ACCOUNT_DETAILS]: {
 216     include: [
 217       {
 218         model: () => VideoChannelModel.unscoped(),
 219         required: true,
 220         include: [
 221           {
 222             attributes: {
 223               exclude: [ 'privateKey', 'publicKey' ]
 224             },
 225             model: () => ActorModel.unscoped(),
 226             required: true,
 227             include: [
 228               {
 229                 attributes: [ 'host' ],
 230                 model: () => ServerModel.unscoped(),
 231                 required: false
 232               }
 233             ]
 234           },
 235           {
 236             model: () => AccountModel.unscoped(),
 237             required: true,
 238             include: [
 239               {
 240                 model: () => ActorModel.unscoped(),
 241                 attributes: {
 242                   exclude: [ 'privateKey', 'publicKey' ]
 243                 },
 244                 required: true,
 245                 include: [
 246                   {
 247                     attributes: [ 'host' ],
 248                     model: () => ServerModel.unscoped(),
 249                     required: false
 250                   },
 251                   {
 252                     model: () => AvatarModel.unscoped(),
 253                     required: false
 254                   }
 255                 ]
 256               }
 257             ]
 258           }
 259         ]
 260       }
 261     ]
 262   },
 263   [ScopeNames.WITH_TAGS]: {
 264     include: [ () => TagModel ]
 265   },
 266   [ScopeNames.WITH_FILES]: {
 267     include: [
 268       {
 269         model: () => VideoFileModel.unscoped(),
 270         required: true
 271       }
 272     ]
 273   },
 274   [ScopeNames.WITH_SHARES]: {
 275     include: [
 276       {
 277         ['separate' as any]: true,
 278         model: () => VideoShareModel.unscoped()
 279       }
 280     ]
 281   },
 282   [ScopeNames.WITH_RATES]: {
 283     include: [
 284       {
 285         ['separate' as any]: true,
 286         model: () => AccountVideoRateModel,
 287         include: [
 288           {
 289             model: () => AccountModel.unscoped(),
 290             required: true,
 291             include: [
 292               {
 293                 attributes: [ 'url' ],
 294                 model: () => ActorModel.unscoped()
 295               }
 296             ]
 297           }
 298         ]
 299       }
 300     ]
 301   },
 302   [ScopeNames.WITH_COMMENTS]: {
 303     include: [
 304       {
 305         ['separate' as any]: true,
 306         model: () => VideoCommentModel.unscoped()
 307       }
 308     ]
 309   }
 310 })
 311 @Table({
 312   tableName: 'video',
 313   indexes: [
 314     {
 315       fields: [ 'name' ]
 316     },
 317     {
 318       fields: [ 'createdAt' ]
 319     },
 320     {
 321       fields: [ 'duration' ]
 322     },
 323     {
 324       fields: [ 'views' ]
 325     },
 326     {
 327       fields: [ 'likes' ]
 328     },
 329     {
 330       fields: [ 'uuid' ]
 331     },
 332     {
 333       fields: [ 'channelId' ]
 334     },
 335     {
 336       fields: [ 'id', 'privacy' ]
 337     },
 338     {
 339       fields: [ 'url'],
 340       unique: true
 341     }
 342   ]
 343 })
 344 export class VideoModel extends Model<VideoModel> {
 345
 346   @AllowNull(false)
 347   @Default(DataType.UUIDV4)
 348   @IsUUID(4)
 349   @Column(DataType.UUID)
 350   uuid: string
 351
 352   @AllowNull(false)
 353   @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
 354   @Column
 355   name: string
 356
 357   @AllowNull(true)
 358   @Default(null)
 359   @Is('VideoCategory', value => throwIfNotValid(value, isVideoCategoryValid, 'category'))
 360   @Column
 361   category: number
 362
 363   @AllowNull(true)
 364   @Default(null)
 365   @Is('VideoLicence', value => throwIfNotValid(value, isVideoLicenceValid, 'licence'))
 366   @Column
 367   licence: number
 368
 369   @AllowNull(true)
 370   @Default(null)
 371   @Is('VideoLanguage', value => throwIfNotValid(value, isVideoLanguageValid, 'language'))
 372   @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
 373   language: string
 374
 375   @AllowNull(false)
 376   @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
 377   @Column
 378   privacy: number
 379
 380   @AllowNull(false)
 381   @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
 382   @Column
 383   nsfw: boolean
 384
 385   @AllowNull(true)
 386   @Default(null)
 387   @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description'))
 388   @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
 389   description: string
 390
 391   @AllowNull(true)
 392   @Default(null)
 393   @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support'))
 394   @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
 395   support: string
 396
 397   @AllowNull(false)
 398   @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
 399   @Column
 400   duration: number
 401
 402   @AllowNull(false)
 403   @Default(0)
 404   @IsInt
 405   @Min(0)
 406   @Column
 407   views: number
 408
 409   @AllowNull(false)
 410   @Default(0)
 411   @IsInt
 412   @Min(0)
 413   @Column
 414   likes: number
 415
 416   @AllowNull(false)
 417   @Default(0)
 418   @IsInt
 419   @Min(0)
 420   @Column
 421   dislikes: number
 422
 423   @AllowNull(false)
 424   @Column
 425   remote: boolean
 426
 427   @AllowNull(false)
 428   @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
 429   @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
 430   url: string
 431
 432   @AllowNull(false)
 433   @Column
 434   commentsEnabled: boolean
 435
 436   @CreatedAt
 437   createdAt: Date
 438
 439   @UpdatedAt
 440   updatedAt: Date
 441
 442   @AllowNull(false)
 443   @Default(Sequelize.NOW)
 444   @Column
 445   publishedAt: Date
 446
 447   @ForeignKey(() => VideoChannelModel)
 448   @Column
 449   channelId: number
 450
 451   @BelongsTo(() => VideoChannelModel, {
 452     foreignKey: {
 453       allowNull: true
 454     },
 455     hooks: true
 456   })
 457   VideoChannel: VideoChannelModel
 458
 459   @BelongsToMany(() => TagModel, {
 460     foreignKey: 'videoId',
 461     through: () => VideoTagModel,
 462     onDelete: 'CASCADE'
 463   })
 464   Tags: TagModel[]
 465
 466   @HasMany(() => VideoAbuseModel, {
 467     foreignKey: {
 468       name: 'videoId',
 469       allowNull: false
 470     },
 471     onDelete: 'cascade'
 472   })
 473   VideoAbuses: VideoAbuseModel[]
 474
 475   @HasMany(() => VideoFileModel, {
 476     foreignKey: {
 477       name: 'videoId',
 478       allowNull: false
 479     },
 480     onDelete: 'cascade'
 481   })
 482   VideoFiles: VideoFileModel[]
 483
 484   @HasMany(() => VideoShareModel, {
 485     foreignKey: {
 486       name: 'videoId',
 487       allowNull: false
 488     },
 489     onDelete: 'cascade'
 490   })
 491   VideoShares: VideoShareModel[]
 492
 493   @HasMany(() => AccountVideoRateModel, {
 494     foreignKey: {
 495       name: 'videoId',
 496       allowNull: false
 497     },
 498     onDelete: 'cascade'
 499   })
 500   AccountVideoRates: AccountVideoRateModel[]
 501
 502   @HasMany(() => VideoCommentModel, {
 503     foreignKey: {
 504       name: 'videoId',
 505       allowNull: false
 506     },
 507     onDelete: 'cascade',
 508     hooks: true
 509   })
 510   VideoComments: VideoCommentModel[]
 511
 512   @BeforeDestroy
 513   static async sendDelete (instance: VideoModel, options) {
 514     if (instance.isOwned()) {
 515       if (!instance.VideoChannel) {
 516         instance.VideoChannel = await instance.$get('VideoChannel', {
 517           include: [
 518             {
 519               model: AccountModel,
 520               include: [ ActorModel ]
 521             }
 522           ],
 523           transaction: options.transaction
 524         }) as VideoChannelModel
 525       }
 526
 527       logger.debug('Sending delete of video %s.', instance.url)
 528
 529       return sendDeleteVideo(instance, options.transaction)
 530     }
 531
 532     return undefined
 533   }
 534
 535   @BeforeDestroy
 536   static async removeFilesAndSendDelete (instance: VideoModel) {
 537     const tasks: Promise<any>[] = []
 538
 539     logger.debug('Removing files of video %s.', instance.url)
 540
 541     tasks.push(instance.removeThumbnail())
 542
 543     if (instance.isOwned()) {
 544       if (!Array.isArray(instance.VideoFiles)) {
 545         instance.VideoFiles = await instance.$get('VideoFiles') as VideoFileModel[]
 546       }
 547
 548       tasks.push(instance.removePreview())
 549
 550       // Remove physical files and torrents
 551       instance.VideoFiles.forEach(file => {
 552         tasks.push(instance.removeFile(file))
 553         tasks.push(instance.removeTorrent(file))
 554       })
 555     }
 556
 557     // Do not wait video deletion because we could be in a transaction
 558     Promise.all(tasks)
 559       .catch(err => {
 560         logger.error('Some errors when removing files of video %s in after destroy hook.', instance.uuid, { err })
 561       })
 562
 563     return undefined
 564   }
 565
 566   static list () {
 567     return VideoModel.scope(ScopeNames.WITH_FILES).findAll()
 568   }
 569
 570   static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
 571     function getRawQuery (select: string) {
 572       const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
 573         'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
 574         'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
 575         'WHERE "Account"."actorId" = ' + actorId
 576       const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
 577         'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
 578         'WHERE "VideoShare"."actorId" = ' + actorId
 579
 580       return `(${queryVideo}) UNION (${queryVideoShare})`
 581     }
 582
 583     const rawQuery = getRawQuery('"Video"."id"')
 584     const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
 585
 586     const query = {
 587       distinct: true,
 588       offset: start,
 589       limit: count,
 590       order: getSort('createdAt', [ 'Tags', 'name', 'ASC' ]),
 591       where: {
 592         id: {
 593           [Sequelize.Op.in]: Sequelize.literal('(' + rawQuery + ')')
 594         },
 595         [Sequelize.Op.or]: [
 596           { privacy: VideoPrivacy.PUBLIC },
 597           { privacy: VideoPrivacy.UNLISTED }
 598         ]
 599       },
 600       include: [
 601         {
 602           attributes: [ 'id', 'url' ],
 603           model: VideoShareModel.unscoped(),
 604           required: false,
 605           where: {
 606             [Sequelize.Op.and]: [
 607               {
 608                 id: {
 609                   [Sequelize.Op.not]: null
 610                 }
 611               },
 612               {
 613                 actorId
 614               }
 615             ]
 616           },
 617           include: [
 618             {
 619               attributes: [ 'id', 'url' ],
 620               model: ActorModel.unscoped()
 621             }
 622           ]
 623         },
 624         {
 625           model: VideoChannelModel.unscoped(),
 626           required: true,
 627           include: [
 628             {
 629               attributes: [ 'name' ],
 630               model: AccountModel.unscoped(),
 631               required: true,
 632               include: [
 633                 {
 634                   attributes: [ 'id', 'url' ],
 635                   model: ActorModel.unscoped(),
 636                   required: true
 637                 }
 638               ]
 639             },
 640             {
 641               attributes: [ 'id', 'url' ],
 642               model: ActorModel.unscoped(),
 643               required: true
 644             }
 645           ]
 646         },
 647         {
 648           attributes: [ 'type' ],
 649           model: AccountVideoRateModel,
 650           required: false,
 651           include: [
 652             {
 653               attributes: [ 'id' ],
 654               model: AccountModel.unscoped(),
 655               include: [
 656                 {
 657                   attributes: [ 'url' ],
 658                   model: ActorModel.unscoped(),
 659                   include: [
 660                     {
 661                       attributes: [ 'host' ],
 662                       model: ServerModel,
 663                       required: false
 664                     }
 665                   ]
 666                 }
 667               ]
 668             }
 669           ]
 670         },
 671         {
 672           attributes: [ 'url' ],
 673           model: VideoCommentModel,
 674           required: false
 675         },
 676         VideoFileModel,
 677         TagModel
 678       ]
 679     }
 680
 681     return Bluebird.all([
 682       // FIXME: typing issue
 683       VideoModel.findAll(query as any),
 684       VideoModel.sequelize.query(rawCountQuery, { type: Sequelize.QueryTypes.SELECT })
 685     ]).then(([ rows, totals ]) => {
 686       // totals: totalVideos + totalVideoShares
 687       let totalVideos = 0
 688       let totalVideoShares = 0
 689       if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
 690       if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
 691
 692       const total = totalVideos + totalVideoShares
 693       return {
 694         data: rows,
 695         total: total
 696       }
 697     })
 698   }
 699
 700   static listAccountVideosForApi (accountId: number, start: number, count: number, sort: string, hideNSFW: boolean, withFiles = false) {
 701     const query: IFindOptions<VideoModel> = {
 702       offset: start,
 703       limit: count,
 704       order: getSort(sort),
 705       include: [
 706         {
 707           model: VideoChannelModel,
 708           required: true,
 709           include: [
 710             {
 711               model: AccountModel,
 712               where: {
 713                 id: accountId
 714               },
 715               required: true
 716             }
 717           ]
 718         }
 719       ]
 720     }
 721
 722     if (withFiles === true) {
 723       query.include.push({
 724         model: VideoFileModel.unscoped(),
 725         required: true
 726       })
 727     }
 728
 729     if (hideNSFW === true) {
 730       query.where = {
 731         nsfw: false
 732       }
 733     }
 734
 735     return VideoModel.findAndCountAll(query).then(({ rows, count }) => {
 736       return {
 737         data: rows,
 738         total: count
 739       }
 740     })
 741   }
 742
 743   static async listForApi (options: {
 744     start: number,
 745     count: number,
 746     sort: string,
 747     hideNSFW: boolean,
 748     withFiles: boolean,
 749     filter?: VideoFilter,
 750     accountId?: number,
 751     videoChannelId?: number
 752   }) {
 753     const query = {
 754       offset: options.start,
 755       limit: options.count,
 756       order: getSort(options.sort)
 757     }
 758
 759     const serverActor = await getServerActor()
 760     const scopes = {
 761       method: [
 762         ScopeNames.AVAILABLE_FOR_LIST, {
 763           actorId: serverActor.id,
 764           hideNSFW: options.hideNSFW,
 765           filter: options.filter,
 766           withFiles: options.withFiles,
 767           accountId: options.accountId,
 768           videoChannelId: options.videoChannelId
 769         }
 770       ]
 771     }
 772
 773     return VideoModel.scope(scopes)
 774       .findAndCountAll(query)
 775       .then(({ rows, count }) => {
 776         return {
 777           data: rows,
 778           total: count
 779         }
 780       })
 781   }
 782
 783   static async searchAndPopulateAccountAndServer (value: string, start: number, count: number, sort: string, hideNSFW: boolean) {
 784     const query: IFindOptions<VideoModel> = {
 785       offset: start,
 786       limit: count,
 787       order: getSort(sort),
 788       where: {
 789         [Sequelize.Op.or]: [
 790           {
 791             name: {
 792               [ Sequelize.Op.iLike ]: '%' + value + '%'
 793             }
 794           },
 795           {
 796             preferredUsernameChannel: Sequelize.where(Sequelize.col('VideoChannel->Actor.preferredUsername'), {
 797               [ Sequelize.Op.iLike ]: '%' + value + '%'
 798             })
 799           },
 800           {
 801             preferredUsernameAccount: Sequelize.where(Sequelize.col('VideoChannel->Account->Actor.preferredUsername'), {
 802               [ Sequelize.Op.iLike ]: '%' + value + '%'
 803             })
 804           },
 805           {
 806             host: Sequelize.where(Sequelize.col('VideoChannel->Account->Actor->Server.host'), {
 807               [ Sequelize.Op.iLike ]: '%' + value + '%'
 808             })
 809           }
 810         ]
 811       }
 812     }
 813
 814     const serverActor = await getServerActor()
 815     const scopes = {
 816       method: [
 817         ScopeNames.AVAILABLE_FOR_LIST, {
 818           actorId: serverActor.id,
 819           hideNSFW
 820         }
 821       ]
 822     }
 823
 824     return VideoModel.scope(scopes)
 825       .findAndCountAll(query)
 826       .then(({ rows, count }) => {
 827         return {
 828           data: rows,
 829           total: count
 830         }
 831       })
 832   }
 833
 834   static load (id: number) {
 835     return VideoModel.findById(id)
 836   }
 837
 838   static loadByUrlAndPopulateAccount (url: string, t?: Sequelize.Transaction) {
 839     const query: IFindOptions<VideoModel> = {
 840       where: {
 841         url
 842       }
 843     }
 844
 845     if (t !== undefined) query.transaction = t
 846
 847     return VideoModel.scope([ ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_FILES ]).findOne(query)
 848   }
 849
 850   static loadByUUIDOrURLAndPopulateAccount (uuid: string, url: string, t?: Sequelize.Transaction) {
 851     const query: IFindOptions<VideoModel> = {
 852       where: {
 853         [Sequelize.Op.or]: [
 854           { uuid },
 855           { url }
 856         ]
 857       }
 858     }
 859
 860     if (t !== undefined) query.transaction = t
 861
 862     return VideoModel.scope([ ScopeNames.WITH_ACCOUNT_DETAILS, ScopeNames.WITH_FILES ]).findOne(query)
 863   }
 864
 865   static loadAndPopulateAccountAndServerAndTags (id: number) {
 866     const options = {
 867       order: [ [ 'Tags', 'name', 'ASC' ] ]
 868     }
 869
 870     return VideoModel
 871       .scope([ ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT_DETAILS ])
 872       .findById(id, options)
 873   }
 874
 875   static loadByUUID (uuid: string) {
 876     const options = {
 877       where: {
 878         uuid
 879       }
 880     }
 881
 882     return VideoModel
 883       .scope([ ScopeNames.WITH_FILES ])
 884       .findOne(options)
 885   }
 886
 887   static loadByUUIDAndPopulateAccountAndServerAndTags (uuid: string) {
 888     const options = {
 889       order: [ [ 'Tags', 'name', 'ASC' ] ],
 890       where: {
 891         uuid
 892       }
 893     }
 894
 895     return VideoModel
 896       .scope([ ScopeNames.WITH_TAGS, ScopeNames.WITH_FILES, ScopeNames.WITH_ACCOUNT_DETAILS ])
 897       .findOne(options)
 898   }
 899
 900   static loadAndPopulateAll (id: number) {
 901     const options = {
 902       order: [ [ 'Tags', 'name', 'ASC' ] ],
 903       where: {
 904         id
 905       }
 906     }
 907
 908     return VideoModel
 909       .scope([
 910         ScopeNames.WITH_RATES,
 911         ScopeNames.WITH_SHARES,
 912         ScopeNames.WITH_TAGS,
 913         ScopeNames.WITH_FILES,
 914         ScopeNames.WITH_ACCOUNT_DETAILS,
 915         ScopeNames.WITH_COMMENTS
 916       ])
 917       .findOne(options)
 918   }
 919
 920   static async getStats () {
 921     const totalLocalVideos = await VideoModel.count({
 922       where: {
 923         remote: false
 924       }
 925     })
 926     const totalVideos = await VideoModel.count()
 927
 928     let totalLocalVideoViews = await VideoModel.sum('views', {
 929       where: {
 930         remote: false
 931       }
 932     })
 933     // Sequelize could return null...
 934     if (!totalLocalVideoViews) totalLocalVideoViews = 0
 935
 936     return {
 937       totalLocalVideos,
 938       totalLocalVideoViews,
 939       totalVideos
 940     }
 941   }
 942
 943   private static buildActorWhereWithFilter (filter?: VideoFilter) {
 944     if (filter && filter === 'local') {
 945       return {
 946         serverId: null
 947       }
 948     }
 949
 950     return {}
 951   }
 952
 953   private static getCategoryLabel (id: number) {
 954     let categoryLabel = VIDEO_CATEGORIES[id]
 955     if (!categoryLabel) categoryLabel = 'Misc'
 956
 957     return categoryLabel
 958   }
 959
 960   private static getLicenceLabel (id: number) {
 961     let licenceLabel = VIDEO_LICENCES[id]
 962     if (!licenceLabel) licenceLabel = 'Unknown'
 963
 964     return licenceLabel
 965   }
 966
 967   private static getLanguageLabel (id: string) {
 968     let languageLabel = VIDEO_LANGUAGES[id]
 969     if (!languageLabel) languageLabel = 'Unknown'
 970
 971     return languageLabel
 972   }
 973
 974   private static getPrivacyLabel (id: number) {
 975     let privacyLabel = VIDEO_PRIVACIES[id]
 976     if (!privacyLabel) privacyLabel = 'Unknown'
 977
 978     return privacyLabel
 979   }
 980
 981   getOriginalFile () {
 982     if (Array.isArray(this.VideoFiles) === false) return undefined
 983
 984     // The original file is the file that have the higher resolution
 985     return maxBy(this.VideoFiles, file => file.resolution)
 986   }
 987
 988   getVideoFilename (videoFile: VideoFileModel) {
 989     return this.uuid + '-' + videoFile.resolution + videoFile.extname
 990   }
 991
 992   getThumbnailName () {
 993     // We always have a copy of the thumbnail
 994     const extension = '.jpg'
 995     return this.uuid + extension
 996   }
 997
 998   getPreviewName () {
 999     const extension = '.jpg'
1000     return this.uuid + extension
1001   }
1002
1003   getTorrentFileName (videoFile: VideoFileModel) {
1004     const extension = '.torrent'
1005     return this.uuid + '-' + videoFile.resolution + extension
1006   }
1007
1008   isOwned () {
1009     return this.remote === false
1010   }
1011
1012   createPreview (videoFile: VideoFileModel) {
1013     return generateImageFromVideoFile(
1014       this.getVideoFilePath(videoFile),
1015       CONFIG.STORAGE.PREVIEWS_DIR,
1016       this.getPreviewName(),
1017       PREVIEWS_SIZE
1018     )
1019   }
1020
1021   createThumbnail (videoFile: VideoFileModel) {
1022     return generateImageFromVideoFile(
1023       this.getVideoFilePath(videoFile),
1024       CONFIG.STORAGE.THUMBNAILS_DIR,
1025       this.getThumbnailName(),
1026       THUMBNAILS_SIZE
1027     )
1028   }
1029
1030   getVideoFilePath (videoFile: VideoFileModel) {
1031     return join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
1032   }
1033
1034   async createTorrentAndSetInfoHash (videoFile: VideoFileModel) {
1035     const options = {
1036       // Keep the extname, it's used by the client to stream the file inside a web browser
1037       name: `${this.name} ${videoFile.resolution}p${videoFile.extname}`,
1038       createdBy: 'PeerTube',
1039       announceList: [
1040         [ CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT + '/tracker/socket' ],
1041         [ CONFIG.WEBSERVER.URL + '/tracker/announce' ]
1042       ],
1043       urlList: [
1044         CONFIG.WEBSERVER.URL + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile)
1045       ]
1046     }
1047
1048     const torrent = await createTorrentPromise(this.getVideoFilePath(videoFile), options)
1049
1050     const filePath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1051     logger.info('Creating torrent %s.', filePath)
1052
1053     await writeFilePromise(filePath, torrent)
1054
1055     const parsedTorrent = parseTorrent(torrent)
1056     videoFile.infoHash = parsedTorrent.infoHash
1057   }
1058
1059   getEmbedPath () {
1060     return '/videos/embed/' + this.uuid
1061   }
1062
1063   getThumbnailPath () {
1064     return join(STATIC_PATHS.THUMBNAILS, this.getThumbnailName())
1065   }
1066
1067   getPreviewPath () {
1068     return join(STATIC_PATHS.PREVIEWS, this.getPreviewName())
1069   }
1070
1071   toFormattedJSON (): Video {
1072     const formattedAccount = this.VideoChannel.Account.toFormattedJSON()
1073     const formattedVideoChannel = this.VideoChannel.toFormattedJSON()
1074
1075     return {
1076       id: this.id,
1077       uuid: this.uuid,
1078       name: this.name,
1079       category: {
1080         id: this.category,
1081         label: VideoModel.getCategoryLabel(this.category)
1082       },
1083       licence: {
1084         id: this.licence,
1085         label: VideoModel.getLicenceLabel(this.licence)
1086       },
1087       language: {
1088         id: this.language,
1089         label: VideoModel.getLanguageLabel(this.language)
1090       },
1091       privacy: {
1092         id: this.privacy,
1093         label: VideoModel.getPrivacyLabel(this.privacy)
1094       },
1095       nsfw: this.nsfw,
1096       description: this.getTruncatedDescription(),
1097       isLocal: this.isOwned(),
1098       duration: this.duration,
1099       views: this.views,
1100       likes: this.likes,
1101       dislikes: this.dislikes,
1102       thumbnailPath: this.getThumbnailPath(),
1103       previewPath: this.getPreviewPath(),
1104       embedPath: this.getEmbedPath(),
1105       createdAt: this.createdAt,
1106       updatedAt: this.updatedAt,
1107       publishedAt: this.publishedAt,
1108       account: {
1109         id: formattedAccount.id,
1110         uuid: formattedAccount.uuid,
1111         name: formattedAccount.name,
1112         displayName: formattedAccount.displayName,
1113         url: formattedAccount.url,
1114         host: formattedAccount.host,
1115         avatar: formattedAccount.avatar
1116       },
1117       channel: {
1118         id: formattedVideoChannel.id,
1119         uuid: formattedVideoChannel.uuid,
1120         name: formattedVideoChannel.name,
1121         displayName: formattedVideoChannel.displayName,
1122         url: formattedVideoChannel.url,
1123         host: formattedVideoChannel.host,
1124         avatar: formattedVideoChannel.avatar
1125       }
1126     }
1127   }
1128
1129   toFormattedDetailsJSON (): VideoDetails {
1130     const formattedJson = this.toFormattedJSON()
1131
1132     const detailsJson = {
1133       support: this.support,
1134       descriptionPath: this.getDescriptionPath(),
1135       channel: this.VideoChannel.toFormattedJSON(),
1136       account: this.VideoChannel.Account.toFormattedJSON(),
1137       tags: map(this.Tags, 'name'),
1138       commentsEnabled: this.commentsEnabled,
1139       files: []
1140     }
1141
1142     // Format and sort video files
1143     detailsJson.files = this.getFormattedVideoFilesJSON()
1144
1145     return Object.assign(formattedJson, detailsJson)
1146   }
1147
1148   getFormattedVideoFilesJSON (): VideoFile[] {
1149     const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
1150
1151     return this.VideoFiles
1152         .map(videoFile => {
1153           let resolutionLabel = videoFile.resolution + 'p'
1154
1155           return {
1156             resolution: {
1157               id: videoFile.resolution,
1158               label: resolutionLabel
1159             },
1160             magnetUri: this.generateMagnetUri(videoFile, baseUrlHttp, baseUrlWs),
1161             size: videoFile.size,
1162             torrentUrl: this.getTorrentUrl(videoFile, baseUrlHttp),
1163             fileUrl: this.getVideoFileUrl(videoFile, baseUrlHttp)
1164           } as VideoFile
1165         })
1166         .sort((a, b) => {
1167           if (a.resolution.id < b.resolution.id) return 1
1168           if (a.resolution.id === b.resolution.id) return 0
1169           return -1
1170         })
1171   }
1172
1173   toActivityPubObject (): VideoTorrentObject {
1174     const { baseUrlHttp, baseUrlWs } = this.getBaseUrls()
1175     if (!this.Tags) this.Tags = []
1176
1177     const tag = this.Tags.map(t => ({
1178       type: 'Hashtag' as 'Hashtag',
1179       name: t.name
1180     }))
1181
1182     let language
1183     if (this.language) {
1184       language = {
1185         identifier: this.language,
1186         name: VideoModel.getLanguageLabel(this.language)
1187       }
1188     }
1189
1190     let category
1191     if (this.category) {
1192       category = {
1193         identifier: this.category + '',
1194         name: VideoModel.getCategoryLabel(this.category)
1195       }
1196     }
1197
1198     let licence
1199     if (this.licence) {
1200       licence = {
1201         identifier: this.licence + '',
1202         name: VideoModel.getLicenceLabel(this.licence)
1203       }
1204     }
1205
1206     let likesObject
1207     let dislikesObject
1208
1209     if (Array.isArray(this.AccountVideoRates)) {
1210       const res = this.toRatesActivityPubObjects()
1211       likesObject = res.likesObject
1212       dislikesObject = res.dislikesObject
1213     }
1214
1215     let sharesObject
1216     if (Array.isArray(this.VideoShares)) {
1217       sharesObject = this.toAnnouncesActivityPubObject()
1218     }
1219
1220     let commentsObject
1221     if (Array.isArray(this.VideoComments)) {
1222       commentsObject = this.toCommentsActivityPubObject()
1223     }
1224
1225     const url = []
1226     for (const file of this.VideoFiles) {
1227       url.push({
1228         type: 'Link',
1229         mimeType: 'video/' + file.extname.replace('.', ''),
1230         href: this.getVideoFileUrl(file, baseUrlHttp),
1231         width: file.resolution,
1232         size: file.size
1233       })
1234
1235       url.push({
1236         type: 'Link',
1237         mimeType: 'application/x-bittorrent',
1238         href: this.getTorrentUrl(file, baseUrlHttp),
1239         width: file.resolution
1240       })
1241
1242       url.push({
1243         type: 'Link',
1244         mimeType: 'application/x-bittorrent;x-scheme-handler/magnet',
1245         href: this.generateMagnetUri(file, baseUrlHttp, baseUrlWs),
1246         width: file.resolution
1247       })
1248     }
1249
1250     // Add video url too
1251     url.push({
1252       type: 'Link',
1253       mimeType: 'text/html',
1254       href: CONFIG.WEBSERVER.URL + '/videos/watch/' + this.uuid
1255     })
1256
1257     return {
1258       type: 'Video' as 'Video',
1259       id: this.url,
1260       name: this.name,
1261       duration: this.getActivityStreamDuration(),
1262       uuid: this.uuid,
1263       tag,
1264       category,
1265       licence,
1266       language,
1267       views: this.views,
1268       sensitive: this.nsfw,
1269       commentsEnabled: this.commentsEnabled,
1270       published: this.publishedAt.toISOString(),
1271       updated: this.updatedAt.toISOString(),
1272       mediaType: 'text/markdown',
1273       content: this.getTruncatedDescription(),
1274       support: this.support,
1275       icon: {
1276         type: 'Image',
1277         url: this.getThumbnailUrl(baseUrlHttp),
1278         mediaType: 'image/jpeg',
1279         width: THUMBNAILS_SIZE.width,
1280         height: THUMBNAILS_SIZE.height
1281       },
1282       url,
1283       likes: likesObject,
1284       dislikes: dislikesObject,
1285       shares: sharesObject,
1286       comments: commentsObject,
1287       attributedTo: [
1288         {
1289           type: 'Person',
1290           id: this.VideoChannel.Account.Actor.url
1291         },
1292         {
1293           type: 'Group',
1294           id: this.VideoChannel.Actor.url
1295         }
1296       ]
1297     }
1298   }
1299
1300   toAnnouncesActivityPubObject () {
1301     const shares: string[] = []
1302
1303     for (const videoShare of this.VideoShares) {
1304       shares.push(videoShare.url)
1305     }
1306
1307     return activityPubCollection(getVideoSharesActivityPubUrl(this), shares)
1308   }
1309
1310   toCommentsActivityPubObject () {
1311     const comments: string[] = []
1312
1313     for (const videoComment of this.VideoComments) {
1314       comments.push(videoComment.url)
1315     }
1316
1317     return activityPubCollection(getVideoCommentsActivityPubUrl(this), comments)
1318   }
1319
1320   toRatesActivityPubObjects () {
1321     const likes: string[] = []
1322     const dislikes: string[] = []
1323
1324     for (const rate of this.AccountVideoRates) {
1325       if (rate.type === 'like') {
1326         likes.push(rate.Account.Actor.url)
1327       } else if (rate.type === 'dislike') {
1328         dislikes.push(rate.Account.Actor.url)
1329       }
1330     }
1331
1332     const likesObject = activityPubCollection(getVideoLikesActivityPubUrl(this), likes)
1333     const dislikesObject = activityPubCollection(getVideoDislikesActivityPubUrl(this), dislikes)
1334
1335     return { likesObject, dislikesObject }
1336   }
1337
1338   getTruncatedDescription () {
1339     if (!this.description) return null
1340
1341     const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
1342     return peertubeTruncate(this.description, maxLength)
1343   }
1344
1345   async optimizeOriginalVideofile () {
1346     const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR
1347     const newExtname = '.mp4'
1348     const inputVideoFile = this.getOriginalFile()
1349     const videoInputPath = join(videosDirectory, this.getVideoFilename(inputVideoFile))
1350     const videoOutputPath = join(videosDirectory, this.id + '-transcoded' + newExtname)
1351
1352     const transcodeOptions = {
1353       inputPath: videoInputPath,
1354       outputPath: videoOutputPath
1355     }
1356
1357     // Could be very long!
1358     await transcode(transcodeOptions)
1359
1360     try {
1361       await unlinkPromise(videoInputPath)
1362
1363       // Important to do this before getVideoFilename() to take in account the new file extension
1364       inputVideoFile.set('extname', newExtname)
1365
1366       await renamePromise(videoOutputPath, this.getVideoFilePath(inputVideoFile))
1367       const stats = await statPromise(this.getVideoFilePath(inputVideoFile))
1368
1369       inputVideoFile.set('size', stats.size)
1370
1371       await this.createTorrentAndSetInfoHash(inputVideoFile)
1372       await inputVideoFile.save()
1373
1374     } catch (err) {
1375       // Auto destruction...
1376       this.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', { err }))
1377
1378       throw err
1379     }
1380   }
1381
1382   async transcodeOriginalVideofile (resolution: VideoResolution, isPortraitMode: boolean) {
1383     const videosDirectory = CONFIG.STORAGE.VIDEOS_DIR
1384     const extname = '.mp4'
1385
1386     // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed
1387     const videoInputPath = join(videosDirectory, this.getVideoFilename(this.getOriginalFile()))
1388
1389     const newVideoFile = new VideoFileModel({
1390       resolution,
1391       extname,
1392       size: 0,
1393       videoId: this.id
1394     })
1395     const videoOutputPath = join(videosDirectory, this.getVideoFilename(newVideoFile))
1396
1397     const transcodeOptions = {
1398       inputPath: videoInputPath,
1399       outputPath: videoOutputPath,
1400       resolution,
1401       isPortraitMode
1402     }
1403
1404     await transcode(transcodeOptions)
1405
1406     const stats = await statPromise(videoOutputPath)
1407
1408     newVideoFile.set('size', stats.size)
1409
1410     await this.createTorrentAndSetInfoHash(newVideoFile)
1411
1412     await newVideoFile.save()
1413
1414     this.VideoFiles.push(newVideoFile)
1415   }
1416
1417   getOriginalFileResolution () {
1418     const originalFilePath = this.getVideoFilePath(this.getOriginalFile())
1419
1420     return getVideoFileResolution(originalFilePath)
1421   }
1422
1423   getDescriptionPath () {
1424     return `/api/${API_VERSION}/videos/${this.uuid}/description`
1425   }
1426
1427   removeThumbnail () {
1428     const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, this.getThumbnailName())
1429     return unlinkPromise(thumbnailPath)
1430   }
1431
1432   removePreview () {
1433     // Same name than video thumbnail
1434     return unlinkPromise(CONFIG.STORAGE.PREVIEWS_DIR + this.getPreviewName())
1435   }
1436
1437   removeFile (videoFile: VideoFileModel) {
1438     const filePath = join(CONFIG.STORAGE.VIDEOS_DIR, this.getVideoFilename(videoFile))
1439     return unlinkPromise(filePath)
1440   }
1441
1442   removeTorrent (videoFile: VideoFileModel) {
1443     const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, this.getTorrentFileName(videoFile))
1444     return unlinkPromise(torrentPath)
1445   }
1446
1447   getActivityStreamDuration () {
1448     // https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
1449     return 'PT' + this.duration + 'S'
1450   }
1451
1452   private getBaseUrls () {
1453     let baseUrlHttp
1454     let baseUrlWs
1455
1456     if (this.isOwned()) {
1457       baseUrlHttp = CONFIG.WEBSERVER.URL
1458       baseUrlWs = CONFIG.WEBSERVER.WS + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
1459     } else {
1460       baseUrlHttp = REMOTE_SCHEME.HTTP + '://' + this.VideoChannel.Account.Actor.Server.host
1461       baseUrlWs = REMOTE_SCHEME.WS + '://' + this.VideoChannel.Account.Actor.Server.host
1462     }
1463
1464     return { baseUrlHttp, baseUrlWs }
1465   }
1466
1467   private getThumbnailUrl (baseUrlHttp: string) {
1468     return baseUrlHttp + STATIC_PATHS.THUMBNAILS + this.getThumbnailName()
1469   }
1470
1471   private getTorrentUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1472     return baseUrlHttp + STATIC_PATHS.TORRENTS + this.getTorrentFileName(videoFile)
1473   }
1474
1475   private getVideoFileUrl (videoFile: VideoFileModel, baseUrlHttp: string) {
1476     return baseUrlHttp + STATIC_PATHS.WEBSEED + this.getVideoFilename(videoFile)
1477   }
1478
1479   private generateMagnetUri (videoFile: VideoFileModel, baseUrlHttp: string, baseUrlWs: string) {
1480     const xs = this.getTorrentUrl(videoFile, baseUrlHttp)
1481     const announce = [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ]
1482     const urlList = [ this.getVideoFileUrl(videoFile, baseUrlHttp) ]
1483
1484     const magnetHash = {
1485       xs,
1486       announce,
1487       urlList,
1488       infoHash: videoFile.infoHash,
1489       name: this.name
1490     }
1491
1492     return magnetUtil.encode(magnetHash)
1493   }
1494 }