client/src/app/+videos/+video-edit/shared/video-edit.component.ts

   1 import { forkJoin } from 'rxjs'
   2 import { map } from 'rxjs/operators'
   3 import { SelectChannelItem, SelectOptionsItem } from 'src/types/select-options-item.model'
   4 import { ChangeDetectorRef, Component, EventEmitter, Input, NgZone, OnDestroy, OnInit, Output, ViewChild } from '@angular/core'
   5 import { AbstractControl, FormArray, FormControl, FormGroup, Validators } from '@angular/forms'
   6 import { HooksService, PluginService, ServerService } from '@app/core'
   7 import { removeElementFromArray } from '@app/helpers'
   8 import { BuildFormValidator } from '@app/shared/form-validators'
   9 import {
  10   VIDEO_CATEGORY_VALIDATOR,
  11   VIDEO_CHANNEL_VALIDATOR,
  12   VIDEO_DESCRIPTION_VALIDATOR,
  13   VIDEO_LANGUAGE_VALIDATOR,
  14   VIDEO_LICENCE_VALIDATOR,
  15   VIDEO_NAME_VALIDATOR,
  16   VIDEO_ORIGINALLY_PUBLISHED_AT_VALIDATOR,
  17   VIDEO_PRIVACY_VALIDATOR,
  18   VIDEO_SCHEDULE_PUBLICATION_AT_VALIDATOR,
  19   VIDEO_SUPPORT_VALIDATOR,
  20   VIDEO_TAGS_ARRAY_VALIDATOR
  21 } from '@app/shared/form-validators/video-validators'
  22 import { FormReactiveValidationMessages, FormValidatorService } from '@app/shared/shared-forms'
  23 import { InstanceService } from '@app/shared/shared-instance'
  24 import { VideoCaptionEdit, VideoCaptionWithPathEdit, VideoEdit, VideoService } from '@app/shared/shared-main'
  25 import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
  26 import { logger } from '@root-helpers/logger'
  27 import { PluginInfo } from '@root-helpers/plugins-manager'
  28 import {
  29   HTMLServerConfig,
  30   LiveVideo,
  31   LiveVideoLatencyMode,
  32   RegisterClientFormFieldOptions,
  33   RegisterClientVideoFieldOptions,
  34   VideoConstant,
  35   VideoDetails,
  36   VideoPrivacy
  37 } from '@shared/models'
  38 import { VideoSource } from '@shared/models/videos/video-source'
  39 import { I18nPrimengCalendarService } from './i18n-primeng-calendar.service'
  40 import { VideoCaptionAddModalComponent } from './video-caption-add-modal.component'
  41 import { VideoCaptionEditModalContentComponent } from './video-caption-edit-modal-content/video-caption-edit-modal-content.component'
  42 import { VideoEditType } from './video-edit.type'
  43
  44 type VideoLanguages = VideoConstant<string> & { group?: string }
  45 type PluginField = {
  46   pluginInfo: PluginInfo
  47   commonOptions: RegisterClientFormFieldOptions
  48   videoFormOptions: RegisterClientVideoFieldOptions
  49 }
  50
  51 @Component({
  52   selector: 'my-video-edit',
  53   styleUrls: [ './video-edit.component.scss' ],
  54   templateUrl: './video-edit.component.html'
  55 })
  56 export class VideoEditComponent implements OnInit, OnDestroy {
  57   @Input() form: FormGroup
  58   @Input() formErrors: { [ id: string ]: string } = {}
  59   @Input() validationMessages: FormReactiveValidationMessages = {}
  60
  61   @Input() videoToUpdate: VideoDetails
  62
  63   @Input() userVideoChannels: SelectChannelItem[] = []
  64   @Input() forbidScheduledPublication = true
  65
  66   @Input() videoCaptions: VideoCaptionWithPathEdit[] = []
  67   @Input() videoSource: VideoSource
  68
  69   @Input() hideWaitTranscoding = false
  70
  71   @Input() type: VideoEditType
  72   @Input() liveVideo: LiveVideo
  73
  74   @ViewChild('videoCaptionAddModal', { static: true }) videoCaptionAddModal: VideoCaptionAddModalComponent
  75
  76   @Output() formBuilt = new EventEmitter<void>()
  77   @Output() pluginFieldsAdded = new EventEmitter<void>()
  78
  79   // So that it can be accessed in the template
  80   readonly SPECIAL_SCHEDULED_PRIVACY = VideoEdit.SPECIAL_SCHEDULED_PRIVACY
  81
  82   videoPrivacies: VideoConstant<VideoPrivacy>[] = []
  83   videoCategories: VideoConstant<number>[] = []
  84   videoLicences: VideoConstant<number>[] = []
  85   videoLanguages: VideoLanguages[] = []
  86   latencyModes: SelectOptionsItem[] = [
  87     {
  88       id: LiveVideoLatencyMode.SMALL_LATENCY,
  89       label: $localize`Small latency`,
  90       description: $localize`Reduce latency to ~15s disabling P2P`
  91     },
  92     {
  93       id: LiveVideoLatencyMode.DEFAULT,
  94       label: $localize`Default`,
  95       description: $localize`Average latency of 30s`
  96     },
  97     {
  98       id: LiveVideoLatencyMode.HIGH_LATENCY,
  99       label: $localize`High latency`,
 100       description: $localize`Average latency of 60s increasing P2P ratio`
 101     }
 102   ]
 103
 104   pluginDataFormGroup: FormGroup
 105
 106   schedulePublicationEnabled = false
 107
 108   calendarLocale: any = {}
 109   minScheduledDate = new Date()
 110   myYearRange = '1880:' + (new Date()).getFullYear()
 111
 112   calendarTimezone: string
 113   calendarDateFormat: string
 114
 115   serverConfig: HTMLServerConfig
 116
 117   pluginFields: PluginField[] = []
 118
 119   private schedulerInterval: any
 120   private firstPatchDone = false
 121   private initialVideoCaptions: string[] = []
 122
 123   constructor (
 124     private formValidatorService: FormValidatorService,
 125     private videoService: VideoService,
 126     private serverService: ServerService,
 127     private pluginService: PluginService,
 128     private instanceService: InstanceService,
 129     private i18nPrimengCalendarService: I18nPrimengCalendarService,
 130     private ngZone: NgZone,
 131     private hooks: HooksService,
 132     private cd: ChangeDetectorRef,
 133     private modalService: NgbModal
 134   ) {
 135     this.calendarTimezone = this.i18nPrimengCalendarService.getTimezone()
 136     this.calendarDateFormat = this.i18nPrimengCalendarService.getDateFormat()
 137   }
 138
 139   updateForm () {
 140     const defaultValues: any = {
 141       nsfw: 'false',
 142       commentsEnabled: this.serverConfig.defaults.publish.commentsEnabled,
 143       downloadEnabled: this.serverConfig.defaults.publish.downloadEnabled,
 144       waitTranscoding: true,
 145       licence: this.serverConfig.defaults.publish.licence,
 146       tags: []
 147     }
 148     const obj: { [ id: string ]: BuildFormValidator } = {
 149       name: VIDEO_NAME_VALIDATOR,
 150       privacy: VIDEO_PRIVACY_VALIDATOR,
 151       channelId: VIDEO_CHANNEL_VALIDATOR,
 152       nsfw: null,
 153       commentsEnabled: null,
 154       downloadEnabled: null,
 155       waitTranscoding: null,
 156       category: VIDEO_CATEGORY_VALIDATOR,
 157       licence: VIDEO_LICENCE_VALIDATOR,
 158       language: VIDEO_LANGUAGE_VALIDATOR,
 159       description: VIDEO_DESCRIPTION_VALIDATOR,
 160       tags: VIDEO_TAGS_ARRAY_VALIDATOR,
 161       previewfile: null,
 162       support: VIDEO_SUPPORT_VALIDATOR,
 163       schedulePublicationAt: VIDEO_SCHEDULE_PUBLICATION_AT_VALIDATOR,
 164       originallyPublishedAt: VIDEO_ORIGINALLY_PUBLISHED_AT_VALIDATOR,
 165       liveStreamKey: null,
 166       permanentLive: null,
 167       latencyMode: null,
 168       saveReplay: null
 169     }
 170
 171     this.formValidatorService.updateFormGroup(
 172       this.form,
 173       this.formErrors,
 174       this.validationMessages,
 175       obj,
 176       defaultValues
 177     )
 178
 179     this.form.addControl('captions', new FormArray([
 180       new FormGroup({
 181         language: new FormControl(),
 182         captionfile: new FormControl()
 183       })
 184     ]))
 185
 186     this.trackChannelChange()
 187     this.trackPrivacyChange()
 188
 189     this.formBuilt.emit()
 190   }
 191
 192   ngOnInit () {
 193     this.serverConfig = this.serverService.getHTMLConfig()
 194
 195     this.updateForm()
 196
 197     this.pluginService.ensurePluginsAreLoaded('video-edit')
 198       .then(() => this.updatePluginFields())
 199
 200     this.serverService.getVideoCategories()
 201         .subscribe(res => this.videoCategories = res)
 202
 203     this.serverService.getVideoLicences()
 204         .subscribe(res => this.videoLicences = res)
 205
 206     forkJoin([
 207       this.instanceService.getAbout(),
 208       this.serverService.getVideoLanguages()
 209     ]).pipe(map(([ about, languages ]) => ({ about, languages })))
 210       .subscribe(res => {
 211         this.videoLanguages = res.languages
 212           .map(l => {
 213             if (l.id === 'zxx') return { ...l, group: $localize`Other`, groupOrder: 1 }
 214
 215             return res.about.instance.languages.includes(l.id)
 216               ? { ...l, group: $localize`Instance languages`, groupOrder: 0 }
 217               : { ...l, group: $localize`All languages`, groupOrder: 2 }
 218           })
 219           .sort((a, b) => a.groupOrder - b.groupOrder)
 220       })
 221
 222     this.serverService.getVideoPrivacies()
 223       .subscribe(privacies => {
 224         this.videoPrivacies = this.videoService.explainedPrivacyLabels(privacies).videoPrivacies
 225
 226         // Can't schedule publication if private privacy is not available (could be deleted by a plugin)
 227         const hasPrivatePrivacy = this.videoPrivacies.some(p => p.id === VideoPrivacy.PRIVATE)
 228         if (this.forbidScheduledPublication || !hasPrivatePrivacy) return
 229
 230         this.videoPrivacies.push({
 231           id: this.SPECIAL_SCHEDULED_PRIVACY,
 232           label: $localize`Scheduled`,
 233           description: $localize`Hide the video until a specific date`
 234         })
 235       })
 236
 237     this.initialVideoCaptions = this.videoCaptions.map(c => c.language.id)
 238
 239     this.ngZone.runOutsideAngular(() => {
 240       this.schedulerInterval = setInterval(() => this.minScheduledDate = new Date(), 1000 * 60) // Update every minute
 241     })
 242
 243     const updateFormForPlugins = (values: any) => {
 244       this.form.patchValue(values)
 245       this.cd.detectChanges()
 246     }
 247     this.hooks.runAction('action:video-edit.init', 'video-edit', { type: this.type, updateForm: updateFormForPlugins })
 248
 249     this.form.valueChanges.subscribe(() => {
 250       this.hooks.runAction('action:video-edit.form.updated', 'video-edit', { type: this.type, formValues: this.form.value })
 251     })
 252   }
 253
 254   ngOnDestroy () {
 255     if (this.schedulerInterval) clearInterval(this.schedulerInterval)
 256   }
 257
 258   getExistingCaptions () {
 259     return this.videoCaptions
 260                .filter(c => c.action !== 'REMOVE')
 261                .map(c => c.language.id)
 262   }
 263
 264   onCaptionEdited (caption: VideoCaptionEdit) {
 265     const existingCaption = this.videoCaptions.find(c => c.language.id === caption.language.id)
 266
 267     // Replace existing caption?
 268     if (existingCaption) {
 269       Object.assign(existingCaption, caption)
 270     } else {
 271       this.videoCaptions.push(
 272         Object.assign(caption, { action: 'CREATE' as 'CREATE' })
 273       )
 274     }
 275
 276     this.sortVideoCaptions()
 277   }
 278
 279   deleteCaption (caption: VideoCaptionEdit) {
 280     // Caption recovers his former state
 281     if (caption.action && this.initialVideoCaptions.includes(caption.language.id)) {
 282       caption.action = undefined
 283       return
 284     }
 285
 286     // This caption is not on the server, just remove it from our array
 287     if (caption.action === 'CREATE' || caption.action === 'UPDATE') {
 288       removeElementFromArray(this.videoCaptions, caption)
 289       return
 290     }
 291
 292     caption.action = 'REMOVE' as 'REMOVE'
 293   }
 294
 295   openAddCaptionModal () {
 296     this.videoCaptionAddModal.show()
 297   }
 298
 299   openEditCaptionModal (videoCaption: VideoCaptionWithPathEdit) {
 300     const modalRef = this.modalService.open(VideoCaptionEditModalContentComponent, { centered: true, keyboard: false })
 301     modalRef.componentInstance.videoCaption = videoCaption
 302     modalRef.componentInstance.serverConfig = this.serverConfig
 303     modalRef.componentInstance.captionEdited.subscribe(this.onCaptionEdited.bind(this))
 304   }
 305
 306   isSaveReplayEnabled () {
 307     return this.serverConfig.live.allowReplay
 308   }
 309
 310   isPermanentLiveEnabled () {
 311     return this.form.value['permanentLive'] === true
 312   }
 313
 314   isLatencyModeEnabled () {
 315     return this.serverConfig.live.latencySetting.enabled
 316   }
 317
 318   isPluginFieldHidden (pluginField: PluginField) {
 319     if (typeof pluginField.commonOptions.hidden !== 'function') return false
 320
 321     return pluginField.commonOptions.hidden({
 322       formValues: this.form.value,
 323       videoToUpdate: this.videoToUpdate,
 324       liveVideo: this.liveVideo
 325     })
 326   }
 327
 328   getPluginsFields (tab: 'main' | 'plugin-settings') {
 329     return this.pluginFields.filter(p => {
 330       const wanted = p.videoFormOptions.tab ?? 'plugin-settings'
 331
 332       return wanted === tab
 333     })
 334   }
 335
 336   private sortVideoCaptions () {
 337     this.videoCaptions.sort((v1, v2) => {
 338       if (v1.language.label < v2.language.label) return -1
 339       if (v1.language.label === v2.language.label) return 0
 340
 341       return 1
 342     })
 343   }
 344
 345   private async updatePluginFields () {
 346     this.pluginFields = this.pluginService.getRegisteredVideoFormFields(this.type)
 347
 348     if (this.pluginFields.length === 0) return
 349
 350     const pluginObj: { [ id: string ]: BuildFormValidator } = {}
 351     const pluginValidationMessages: FormReactiveValidationMessages = {}
 352     const pluginFormErrors: any = {}
 353     const pluginDefaults: any = {}
 354
 355     for (const setting of this.pluginFields) {
 356       await this.pluginService.translateSetting(setting.pluginInfo.plugin.npmName, setting.commonOptions)
 357
 358       // Not a form input, just a HTML tag
 359       if (setting.commonOptions.type === 'html') continue
 360
 361       const validator = async (control: AbstractControl) => {
 362         if (!setting.commonOptions.error) return null
 363
 364         const error = await setting.commonOptions.error({ formValues: this.form.value, value: control.value })
 365
 366         return error?.error ? { [setting.commonOptions.name]: error.text } : null
 367       }
 368
 369       const name = setting.commonOptions.name
 370
 371       pluginObj[name] = {
 372         ASYNC_VALIDATORS: [ validator ],
 373         VALIDATORS: [],
 374         MESSAGES: {}
 375       }
 376
 377       pluginDefaults[name] = setting.commonOptions.default
 378     }
 379
 380     this.pluginDataFormGroup = new FormGroup({})
 381     this.formValidatorService.updateFormGroup(
 382       this.pluginDataFormGroup,
 383       pluginFormErrors,
 384       pluginValidationMessages,
 385       pluginObj,
 386       pluginDefaults
 387     )
 388
 389     this.form.addControl('pluginData', this.pluginDataFormGroup)
 390     this.formErrors['pluginData'] = pluginFormErrors
 391     this.validationMessages['pluginData'] = pluginValidationMessages
 392
 393     this.cd.detectChanges()
 394     this.pluginFieldsAdded.emit()
 395
 396     // Plugins may need other control values to calculate potential errors
 397     this.form.valueChanges.subscribe(() => this.formValidatorService.updateTreeValidity(this.pluginDataFormGroup))
 398   }
 399
 400   private trackPrivacyChange () {
 401     // We will update the schedule input and the wait transcoding checkbox validators
 402     this.form.controls['privacy']
 403       .valueChanges
 404       .pipe(map(res => parseInt(res.toString(), 10)))
 405       .subscribe(
 406         newPrivacyId => {
 407
 408           this.schedulePublicationEnabled = newPrivacyId === this.SPECIAL_SCHEDULED_PRIVACY
 409
 410           // Value changed
 411           const scheduleControl = this.form.get('schedulePublicationAt')
 412           const waitTranscodingControl = this.form.get('waitTranscoding')
 413
 414           if (this.schedulePublicationEnabled) {
 415             scheduleControl.setValidators([ Validators.required ])
 416
 417             waitTranscodingControl.disable()
 418             waitTranscodingControl.setValue(false)
 419           } else {
 420             scheduleControl.clearValidators()
 421
 422             waitTranscodingControl.enable()
 423
 424             // Do not update the control value on first patch (values come from the server)
 425             if (this.firstPatchDone === true) {
 426               waitTranscodingControl.setValue(true)
 427             }
 428           }
 429
 430           scheduleControl.updateValueAndValidity()
 431           waitTranscodingControl.updateValueAndValidity()
 432
 433           this.firstPatchDone = true
 434
 435         }
 436       )
 437   }
 438
 439   private trackChannelChange () {
 440     // We will update the "support" field depending on the channel
 441     this.form.controls['channelId']
 442       .valueChanges
 443       .pipe(map(res => parseInt(res.toString(), 10)))
 444       .subscribe(
 445         newChannelId => {
 446           const oldChannelId = parseInt(this.form.value['channelId'], 10)
 447
 448           // Not initialized yet
 449           if (isNaN(newChannelId)) return
 450           const newChannel = this.userVideoChannels.find(c => c.id === newChannelId)
 451           if (!newChannel) return
 452
 453           // Wait support field update
 454           setTimeout(() => {
 455             const currentSupport = this.form.value['support']
 456
 457             // First time we set the channel?
 458             if (isNaN(oldChannelId)) {
 459               // Fill support if it's empty
 460               if (!currentSupport) this.updateSupportField(newChannel.support)
 461
 462               return
 463             }
 464
 465             const oldChannel = this.userVideoChannels.find(c => c.id === oldChannelId)
 466             if (!newChannel || !oldChannel) {
 467               logger.error('Cannot find new or old channel.')
 468               return
 469             }
 470
 471             // If the current support text is not the same than the old channel, the user updated it.
 472             // We don't want the user to lose his text, so stop here
 473             if (currentSupport && currentSupport !== oldChannel.support) return
 474
 475             // Update the support text with our new channel
 476             this.updateSupportField(newChannel.support)
 477           })
 478         }
 479       )
 480   }
 481
 482   private updateSupportField (support: string) {
 483     return this.form.patchValue({ support: support || '' })
 484   }
 485 }