client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.ts

   1 import { forkJoin } from 'rxjs'
   2 import { ViewportScroller } from '@angular/common'
   3 import { AfterViewChecked, Component, OnInit, ViewChild } from '@angular/core'
   4 import { ConfigService } from '@app/+admin/config/shared/config.service'
   5 import { Notifier } from '@app/core'
   6 import { ServerService } from '@app/core/server/server.service'
   7 import {
   8   ADMIN_EMAIL_VALIDATOR,
   9   CACHE_CAPTIONS_SIZE_VALIDATOR,
  10   CACHE_PREVIEWS_SIZE_VALIDATOR,
  11   INDEX_URL_VALIDATOR,
  12   INSTANCE_NAME_VALIDATOR,
  13   INSTANCE_SHORT_DESCRIPTION_VALIDATOR,
  14   SEARCH_INDEX_URL_VALIDATOR,
  15   SERVICES_TWITTER_USERNAME_VALIDATOR,
  16   SIGNUP_LIMIT_VALIDATOR,
  17   TRANSCODING_THREADS_VALIDATOR
  18 } from '@app/shared/form-validators/custom-config-validators'
  19 import { USER_VIDEO_QUOTA_DAILY_VALIDATOR, USER_VIDEO_QUOTA_VALIDATOR } from '@app/shared/form-validators/user-validators'
  20 import { FormReactive, FormValidatorService, SelectOptionsItem } from '@app/shared/shared-forms'
  21 import { NgbNav } from '@ng-bootstrap/ng-bootstrap'
  22 import { CustomConfig, ServerConfig } from '@shared/models'
  23 import { pairwise } from 'rxjs/operators'
  24
  25 @Component({
  26   selector: 'my-edit-custom-config',
  27   templateUrl: './edit-custom-config.component.html',
  28   styleUrls: [ './edit-custom-config.component.scss' ]
  29 })
  30 export class EditCustomConfigComponent extends FormReactive implements OnInit, AfterViewChecked {
  31   // FIXME: use built-in router
  32   @ViewChild('nav') nav: NgbNav
  33
  34   initDone = false
  35   customConfig: CustomConfig
  36
  37   resolutions: { id: string, label: string, description?: string }[] = []
  38   liveResolutions: { id: string, label: string, description?: string }[] = []
  39   transcodingThreadOptions: { label: string, value: number }[] = []
  40   liveMaxDurationOptions: { label: string, value: number }[] = []
  41
  42   languageItems: SelectOptionsItem[] = []
  43   categoryItems: SelectOptionsItem[] = []
  44
  45   signupAlertMessage: string
  46
  47   private serverConfig: ServerConfig
  48
  49   constructor (
  50     private viewportScroller: ViewportScroller,
  51     protected formValidatorService: FormValidatorService,
  52     private notifier: Notifier,
  53     private configService: ConfigService,
  54     private serverService: ServerService
  55   ) {
  56     super()
  57
  58     this.resolutions = [
  59       {
  60         id: '0p',
  61         label: $localize`Audio-only`,
  62         description: $localize`A <code>.mp4</code> that keeps the original audio track, with no video`
  63       },
  64       {
  65         id: '240p',
  66         label: $localize`240p`
  67       },
  68       {
  69         id: '360p',
  70         label: $localize`360p`
  71       },
  72       {
  73         id: '480p',
  74         label: $localize`480p`
  75       },
  76       {
  77         id: '720p',
  78         label: $localize`720p`
  79       },
  80       {
  81         id: '1080p',
  82         label: $localize`1080p`
  83       },
  84       {
  85         id: '1440p',
  86         label: $localize`1440p`
  87       },
  88       {
  89         id: '2160p',
  90         label: $localize`2160p`
  91       }
  92     ]
  93
  94     this.liveResolutions = this.resolutions.filter(r => r.id !== '0p')
  95
  96     this.transcodingThreadOptions = [
  97       { value: 0, label: $localize`Auto (via ffmpeg)` },
  98       { value: 1, label: '1' },
  99       { value: 2, label: '2' },
 100       { value: 4, label: '4' },
 101       { value: 8, label: '8' }
 102     ]
 103
 104     this.liveMaxDurationOptions = [
 105       { value: -1, label: $localize`No limit` },
 106       { value: 1000 * 3600, label: $localize`1 hour` },
 107       { value: 1000 * 3600 * 3, label: $localize`3 hours` },
 108       { value: 1000 * 3600 * 5, label: $localize`5 hours` },
 109       { value: 1000 * 3600 * 10, label: $localize`10 hours` }
 110     ]
 111   }
 112
 113   get videoQuotaOptions () {
 114     return this.configService.videoQuotaOptions
 115   }
 116
 117   get videoQuotaDailyOptions () {
 118     return this.configService.videoQuotaDailyOptions
 119   }
 120
 121   get availableThemes () {
 122     return this.serverConfig.theme.registered
 123       .map(t => t.name)
 124   }
 125
 126   get liveRTMPPort () {
 127     return this.serverConfig.live.rtmp.port
 128   }
 129
 130   getTotalTranscodingThreads () {
 131     const transcodingEnabled = this.form.value['transcoding']['enabled']
 132     const transcodingThreads = this.form.value['transcoding']['threads']
 133     const liveTranscodingEnabled = this.form.value['live']['transcoding']['enabled']
 134     const liveTranscodingThreads = this.form.value['live']['transcoding']['threads']
 135
 136     // checks whether all enabled method are on fixed values and not on auto (= 0)
 137     let noneOnAuto = !transcodingEnabled || +transcodingThreads > 0
 138     noneOnAuto &&= !liveTranscodingEnabled || +liveTranscodingThreads > 0
 139
 140     // count total of fixed value, repalcing auto by a single thread (knowing it will display "at least")
 141     let value = 0
 142     if (transcodingEnabled) value += +transcodingThreads || 1
 143     if (liveTranscodingEnabled) value += +liveTranscodingThreads || 1
 144
 145     return {
 146       value,
 147       atMost: noneOnAuto, // auto switches everything to a least estimation since ffmpeg will take as many threads as possible
 148       unit: value > 1
 149         ? $localize`threads`
 150         : $localize`thread`
 151     }
 152   }
 153
 154   getResolutionKey (resolution: string) {
 155     return 'transcoding.resolutions.' + resolution
 156   }
 157
 158   ngOnInit () {
 159     this.serverConfig = this.serverService.getTmpConfig()
 160     this.serverService.getConfig()
 161         .subscribe(config => {
 162           this.serverConfig = config
 163         })
 164
 165     const formGroupData: { [key in keyof CustomConfig ]: any } = {
 166       instance: {
 167         name: INSTANCE_NAME_VALIDATOR,
 168         shortDescription: INSTANCE_SHORT_DESCRIPTION_VALIDATOR,
 169         description: null,
 170
 171         isNSFW: false,
 172         defaultNSFWPolicy: null,
 173
 174         terms: null,
 175         codeOfConduct: null,
 176
 177         creationReason: null,
 178         moderationInformation: null,
 179         administrator: null,
 180         maintenanceLifetime: null,
 181         businessModel: null,
 182
 183         hardwareInformation: null,
 184
 185         categories: null,
 186         languages: null,
 187
 188         defaultClientRoute: null,
 189
 190         customizations: {
 191           javascript: null,
 192           css: null
 193         }
 194       },
 195       theme: {
 196         default: null
 197       },
 198       services: {
 199         twitter: {
 200           username: SERVICES_TWITTER_USERNAME_VALIDATOR,
 201           whitelisted: null
 202         }
 203       },
 204       cache: {
 205         previews: {
 206           size: CACHE_PREVIEWS_SIZE_VALIDATOR
 207         },
 208         captions: {
 209           size: CACHE_CAPTIONS_SIZE_VALIDATOR
 210         }
 211       },
 212       signup: {
 213         enabled: null,
 214         limit: SIGNUP_LIMIT_VALIDATOR,
 215         requiresEmailVerification: null
 216       },
 217       import: {
 218         videos: {
 219           http: {
 220             enabled: null
 221           },
 222           torrent: {
 223             enabled: null
 224           }
 225         }
 226       },
 227       admin: {
 228         email: ADMIN_EMAIL_VALIDATOR
 229       },
 230       contactForm: {
 231         enabled: null
 232       },
 233       user: {
 234         videoQuota: USER_VIDEO_QUOTA_VALIDATOR,
 235         videoQuotaDaily: USER_VIDEO_QUOTA_DAILY_VALIDATOR
 236       },
 237       transcoding: {
 238         enabled: null,
 239         threads: TRANSCODING_THREADS_VALIDATOR,
 240         allowAdditionalExtensions: null,
 241         allowAudioFiles: null,
 242         resolutions: {},
 243         hls: {
 244           enabled: null
 245         },
 246         webtorrent: {
 247           enabled: null
 248         }
 249       },
 250       live: {
 251         enabled: null,
 252
 253         maxDuration: null,
 254         maxInstanceLives: null,
 255         maxUserLives: null,
 256         allowReplay: null,
 257
 258         transcoding: {
 259           enabled: null,
 260           threads: TRANSCODING_THREADS_VALIDATOR,
 261           resolutions: {}
 262         }
 263       },
 264       autoBlacklist: {
 265         videos: {
 266           ofUsers: {
 267             enabled: null
 268           }
 269         }
 270       },
 271       followers: {
 272         instance: {
 273           enabled: null,
 274           manualApproval: null
 275         }
 276       },
 277       followings: {
 278         instance: {
 279           autoFollowBack: {
 280             enabled: null
 281           },
 282           autoFollowIndex: {
 283             enabled: null,
 284             indexUrl: INDEX_URL_VALIDATOR
 285           }
 286         }
 287       },
 288       broadcastMessage: {
 289         enabled: null,
 290         level: null,
 291         dismissable: null,
 292         message: null
 293       },
 294       search: {
 295         remoteUri: {
 296           users: null,
 297           anonymous: null
 298         },
 299         searchIndex: {
 300           enabled: null,
 301           url: SEARCH_INDEX_URL_VALIDATOR,
 302           disableLocalSearch: null,
 303           isDefaultSearch: null
 304         }
 305       }
 306     }
 307
 308     const defaultValues = {
 309       transcoding: {
 310         resolutions: {}
 311       },
 312       live: {
 313         transcoding: {
 314           resolutions: {}
 315         }
 316       }
 317     }
 318
 319     for (const resolution of this.resolutions) {
 320       defaultValues.transcoding.resolutions[resolution.id] = 'false'
 321       formGroupData.transcoding.resolutions[resolution.id] = null
 322     }
 323
 324     for (const resolution of this.liveResolutions) {
 325       defaultValues.live.transcoding.resolutions[resolution.id] = 'false'
 326       formGroupData.live.transcoding.resolutions[resolution.id] = null
 327     }
 328
 329     this.buildForm(formGroupData)
 330     this.loadForm()
 331
 332     this.checkTranscodingFields()
 333     this.checkSignupField()
 334   }
 335
 336   ngAfterViewChecked () {
 337     if (!this.initDone) {
 338       this.initDone = true
 339       this.gotoAnchor()
 340     }
 341   }
 342
 343   isTranscodingEnabled () {
 344     return this.form.value['transcoding']['enabled'] === true
 345   }
 346
 347   isLiveEnabled () {
 348     return this.form.value['live']['enabled'] === true
 349   }
 350
 351   isLiveTranscodingEnabled () {
 352     return this.form.value['live']['transcoding']['enabled'] === true
 353   }
 354
 355   isSignupEnabled () {
 356     return this.form.value['signup']['enabled'] === true
 357   }
 358
 359   isSearchIndexEnabled () {
 360     return this.form.value['search']['searchIndex']['enabled'] === true
 361   }
 362
 363   isAutoFollowIndexEnabled () {
 364     return this.form.value['followings']['instance']['autoFollowIndex']['enabled'] === true
 365   }
 366
 367   async formValidated () {
 368     const value: CustomConfig = this.form.getRawValue()
 369
 370     this.configService.updateCustomConfig(value)
 371       .subscribe(
 372         res => {
 373           this.customConfig = res
 374
 375           // Reload general configuration
 376           this.serverService.resetConfig()
 377
 378           this.updateForm()
 379
 380           this.notifier.success($localize`Configuration updated.`)
 381         },
 382
 383         err => this.notifier.error(err.message)
 384       )
 385   }
 386
 387   gotoAnchor () {
 388     const hashToNav = {
 389       'customizations': 'advanced-configuration'
 390     }
 391     const hash = window.location.hash.replace('#', '')
 392
 393     if (hash && Object.keys(hashToNav).includes(hash)) {
 394       this.nav.select(hashToNav[hash])
 395       setTimeout(() => this.viewportScroller.scrollToAnchor(hash), 100)
 396     }
 397   }
 398
 399   hasConsistentOptions () {
 400     if (this.hasLiveAllowReplayConsistentOptions()) return true
 401
 402     return false
 403   }
 404
 405   hasLiveAllowReplayConsistentOptions () {
 406     if (this.isTranscodingEnabled() === false && this.isLiveEnabled() && this.form.value['live']['allowReplay'] === true) {
 407       return false
 408     }
 409
 410     return true
 411   }
 412
 413   private updateForm () {
 414     this.form.patchValue(this.customConfig)
 415   }
 416
 417   private loadForm () {
 418     forkJoin([
 419       this.configService.getCustomConfig(),
 420       this.serverService.getVideoLanguages(),
 421       this.serverService.getVideoCategories()
 422     ]).subscribe(
 423       ([ config, languages, categories ]) => {
 424         this.customConfig = config
 425
 426         this.languageItems = languages.map(l => ({ label: l.label, id: l.id }))
 427         this.categoryItems = categories.map(l => ({ label: l.label, id: l.id + '' }))
 428
 429         this.updateForm()
 430         // Force form validation
 431         this.forceCheck()
 432       },
 433
 434       err => this.notifier.error(err.message)
 435     )
 436   }
 437
 438   private checkTranscodingFields () {
 439     const hlsControl = this.form.get('transcoding.hls.enabled')
 440     const webtorrentControl = this.form.get('transcoding.webtorrent.enabled')
 441
 442     webtorrentControl.valueChanges
 443                      .subscribe(newValue => {
 444                        if (newValue === false && !hlsControl.disabled) {
 445                          hlsControl.disable()
 446                        }
 447
 448                        if (newValue === true && !hlsControl.enabled) {
 449                          hlsControl.enable()
 450                        }
 451                      })
 452
 453     hlsControl.valueChanges
 454               .subscribe(newValue => {
 455                 if (newValue === false && !webtorrentControl.disabled) {
 456                   webtorrentControl.disable()
 457                 }
 458
 459                 if (newValue === true && !webtorrentControl.enabled) {
 460                   webtorrentControl.enable()
 461                 }
 462               })
 463   }
 464
 465   private checkSignupField () {
 466     const signupControl = this.form.get('signup.enabled')
 467
 468     signupControl.valueChanges
 469       .pipe(pairwise())
 470       .subscribe(([ oldValue, newValue ]) => {
 471         if (oldValue !== true && newValue === true) {
 472           // tslint:disable:max-line-length
 473           this.signupAlertMessage = $localize`You enabled signup: we automatically enabled the "Block new videos automatically" checkbox of the "Videos" section just below.`
 474
 475           this.form.patchValue({
 476             autoBlacklist: {
 477               videos: {
 478                 ofUsers: {
 479                   enabled: true
 480                 }
 481               }
 482             }
 483           })
 484         }
 485       })
 486   }
 487 }