client/src/app/core/server/server.service.ts

   1 import { Observable, of, Subject } from 'rxjs'
   2 import { first, map, share, shareReplay, switchMap, tap } from 'rxjs/operators'
   3 import { HttpClient } from '@angular/common/http'
   4 import { Inject, Injectable, LOCALE_ID } from '@angular/core'
   5 import { getDevLocale, isOnDevLocale, sortBy } from '@app/helpers'
   6 import { peertubeLocalStorage } from '@root-helpers/peertube-web-storage'
   7 import { getCompleteLocale, isDefaultLocale, peertubeTranslate } from '@shared/core-utils/i18n'
   8 import { SearchTargetType, ServerConfig, ServerStats, VideoConstant } from '@shared/models'
   9 import { environment } from '../../../environments/environment'
  10
  11 @Injectable()
  12 export class ServerService {
  13   private static BASE_CONFIG_URL = environment.apiUrl + '/api/v1/config/'
  14   private static BASE_VIDEO_URL = environment.apiUrl + '/api/v1/videos/'
  15   private static BASE_VIDEO_PLAYLIST_URL = environment.apiUrl + '/api/v1/video-playlists/'
  16   private static BASE_LOCALE_URL = environment.apiUrl + '/client/locales/'
  17   private static BASE_STATS_URL = environment.apiUrl + '/api/v1/server/stats'
  18
  19   private static CONFIG_LOCAL_STORAGE_KEY = 'server-config'
  20
  21   configReloaded = new Subject<ServerConfig>()
  22
  23   private localeObservable: Observable<any>
  24   private videoLicensesObservable: Observable<VideoConstant<number>[]>
  25   private videoCategoriesObservable: Observable<VideoConstant<number>[]>
  26   private videoPrivaciesObservable: Observable<VideoConstant<number>[]>
  27   private videoPlaylistPrivaciesObservable: Observable<VideoConstant<number>[]>
  28   private videoLanguagesObservable: Observable<VideoConstant<string>[]>
  29   private configObservable: Observable<ServerConfig>
  30
  31   private configReset = false
  32
  33   private configLoaded = false
  34   private config: ServerConfig = {
  35     instance: {
  36       name: 'PeerTube',
  37       shortDescription: 'PeerTube, a federated (ActivityPub) video streaming platform  ' +
  38                         'using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.',
  39       isNSFW: false,
  40       defaultNSFWPolicy: 'do_not_list' as 'do_not_list',
  41       defaultClientRoute: '',
  42       customizations: {
  43         javascript: '',
  44         css: ''
  45       }
  46     },
  47     plugin: {
  48       registered: [],
  49       registeredExternalAuths: [],
  50       registeredIdAndPassAuths: []
  51     },
  52     theme: {
  53       registered: [],
  54       default: 'default'
  55     },
  56     email: {
  57       enabled: false
  58     },
  59     contactForm: {
  60       enabled: false
  61     },
  62     serverVersion: 'Unknown',
  63     signup: {
  64       allowed: false,
  65       allowedForCurrentIP: false,
  66       requiresEmailVerification: false
  67     },
  68     transcoding: {
  69       profile: 'default',
  70       availableProfiles: [ 'default' ],
  71       enabledResolutions: [],
  72       hls: {
  73         enabled: false
  74       },
  75       webtorrent: {
  76         enabled: true
  77       }
  78     },
  79     live: {
  80       enabled: false,
  81       allowReplay: true,
  82       maxDuration: null,
  83       maxInstanceLives: -1,
  84       maxUserLives: -1,
  85       transcoding: {
  86         enabled: false,
  87         profile: 'default',
  88         availableProfiles: [ 'default' ],
  89         enabledResolutions: []
  90       },
  91       rtmp: {
  92         port: 1935
  93       }
  94     },
  95     avatar: {
  96       file: {
  97         size: { max: 0 },
  98         extensions: []
  99       }
 100     },
 101     video: {
 102       image: {
 103         size: { max: 0 },
 104         extensions: []
 105       },
 106       file: {
 107         extensions: []
 108       }
 109     },
 110     videoCaption: {
 111       file: {
 112         size: { max: 0 },
 113         extensions: []
 114       }
 115     },
 116     user: {
 117       videoQuota: -1,
 118       videoQuotaDaily: -1
 119     },
 120     import: {
 121       videos: {
 122         http: {
 123           enabled: false
 124         },
 125         torrent: {
 126           enabled: false
 127         }
 128       }
 129     },
 130     trending: {
 131       videos: {
 132         intervalDays: 0,
 133         algorithms: {
 134           enabled: [ 'hot', 'most-viewed', 'most-liked' ],
 135           default: 'most-viewed'
 136         }
 137       }
 138     },
 139     autoBlacklist: {
 140       videos: {
 141         ofUsers: {
 142           enabled: false
 143         }
 144       }
 145     },
 146     tracker: {
 147       enabled: true
 148     },
 149     followings: {
 150       instance: {
 151         autoFollowIndex: {
 152           indexUrl: 'https://instances.joinpeertube.org'
 153         }
 154       }
 155     },
 156     broadcastMessage: {
 157       enabled: false,
 158       message: '',
 159       level: 'info',
 160       dismissable: false
 161     },
 162     search: {
 163       remoteUri: {
 164         users: true,
 165         anonymous: false
 166       },
 167       searchIndex: {
 168         enabled: false,
 169         url: '',
 170         disableLocalSearch: false,
 171         isDefaultSearch: false
 172       }
 173     }
 174   }
 175
 176   constructor (
 177     private http: HttpClient,
 178     @Inject(LOCALE_ID) private localeId: string
 179   ) {
 180     this.loadConfigLocally()
 181   }
 182
 183   getServerVersionAndCommit () {
 184     const serverVersion = this.config.serverVersion
 185     const commit = this.config.serverCommit || ''
 186
 187     let result = serverVersion
 188     if (commit) result += '...' + commit
 189
 190     return result
 191   }
 192
 193   resetConfig () {
 194     this.configLoaded = false
 195     this.configReset = true
 196
 197     // Notify config update
 198     this.getConfig().subscribe(() => {
 199       // empty, to fire a reset config event
 200     })
 201   }
 202
 203   getConfig () {
 204     if (this.configLoaded) return of(this.config)
 205
 206     if (!this.configObservable) {
 207       this.configObservable = this.http.get<ServerConfig>(ServerService.BASE_CONFIG_URL)
 208                                   .pipe(
 209                                     tap(config => this.saveConfigLocally(config)),
 210                                     tap(config => {
 211                                       this.config = config
 212                                       this.configLoaded = true
 213                                     }),
 214                                     tap(config => {
 215                                       if (this.configReset) {
 216                                         this.configReloaded.next(config)
 217                                         this.configReset = false
 218                                       }
 219                                     }),
 220                                     share()
 221                                   )
 222     }
 223
 224     return this.configObservable
 225   }
 226
 227   getTmpConfig () {
 228     return this.config
 229   }
 230
 231   getVideoCategories () {
 232     if (!this.videoCategoriesObservable) {
 233       this.videoCategoriesObservable = this.loadAttributeEnum<number>(ServerService.BASE_VIDEO_URL, 'categories', true)
 234     }
 235
 236     return this.videoCategoriesObservable.pipe(first())
 237   }
 238
 239   getVideoLicences () {
 240     if (!this.videoLicensesObservable) {
 241       this.videoLicensesObservable = this.loadAttributeEnum<number>(ServerService.BASE_VIDEO_URL, 'licences')
 242     }
 243
 244     return this.videoLicensesObservable.pipe(first())
 245   }
 246
 247   getVideoLanguages () {
 248     if (!this.videoLanguagesObservable) {
 249       this.videoLanguagesObservable = this.loadAttributeEnum<string>(ServerService.BASE_VIDEO_URL, 'languages', true)
 250     }
 251
 252     return this.videoLanguagesObservable.pipe(first())
 253   }
 254
 255   getVideoPrivacies () {
 256     if (!this.videoPrivaciesObservable) {
 257       this.videoPrivaciesObservable = this.loadAttributeEnum<number>(ServerService.BASE_VIDEO_URL, 'privacies')
 258     }
 259
 260     return this.videoPrivaciesObservable.pipe(first())
 261   }
 262
 263   getVideoPlaylistPrivacies () {
 264     if (!this.videoPlaylistPrivaciesObservable) {
 265       this.videoPlaylistPrivaciesObservable = this.loadAttributeEnum<number>(ServerService.BASE_VIDEO_PLAYLIST_URL, 'privacies')
 266     }
 267
 268     return this.videoPlaylistPrivaciesObservable.pipe(first())
 269   }
 270
 271   getServerLocale () {
 272     if (!this.localeObservable) {
 273       const completeLocale = isOnDevLocale() ? getDevLocale() : getCompleteLocale(this.localeId)
 274
 275       // Default locale, nothing to translate
 276       if (isDefaultLocale(completeLocale)) {
 277         this.localeObservable = of({}).pipe(shareReplay())
 278       } else {
 279         this.localeObservable = this.http
 280                                     .get(ServerService.BASE_LOCALE_URL + completeLocale + '/server.json')
 281                                     .pipe(shareReplay())
 282       }
 283     }
 284
 285     return this.localeObservable.pipe(first())
 286   }
 287
 288   getServerStats () {
 289     return this.http.get<ServerStats>(ServerService.BASE_STATS_URL)
 290   }
 291
 292   getDefaultSearchTarget (): Promise<SearchTargetType> {
 293     return this.getConfig().pipe(
 294       map(config => {
 295         const searchIndexConfig = config.search.searchIndex
 296
 297         if (searchIndexConfig.enabled && (searchIndexConfig.isDefaultSearch || searchIndexConfig.disableLocalSearch)) {
 298           return 'search-index'
 299         }
 300
 301         return 'local'
 302       })
 303     ).toPromise()
 304   }
 305
 306   private loadAttributeEnum <T extends string | number> (
 307     baseUrl: string,
 308     attributeName: 'categories' | 'licences' | 'languages' | 'privacies',
 309     sort = false
 310   ) {
 311     return this.getServerLocale()
 312                .pipe(
 313                  switchMap(translations => {
 314                    return this.http.get<{ [ id: string ]: string }>(baseUrl + attributeName)
 315                               .pipe(map(data => ({ data, translations })))
 316                  }),
 317                  map(({ data, translations }) => {
 318                    const hashToPopulate: VideoConstant<T>[] = Object.keys(data)
 319                                                                     .map(dataKey => {
 320                                                                       const label = data[ dataKey ]
 321
 322                                                                       const id = attributeName === 'languages'
 323                                                                         ? dataKey as T
 324                                                                         : parseInt(dataKey, 10) as T
 325
 326                                                                       return {
 327                                                                         id,
 328                                                                         label: peertubeTranslate(label, translations)
 329                                                                       }
 330                                                                     })
 331
 332                    if (sort === true) sortBy(hashToPopulate, 'label')
 333
 334                    return hashToPopulate
 335                  }),
 336                  shareReplay()
 337                )
 338   }
 339
 340   private saveConfigLocally (config: ServerConfig) {
 341     peertubeLocalStorage.setItem(ServerService.CONFIG_LOCAL_STORAGE_KEY, JSON.stringify(config))
 342   }
 343
 344   private loadConfigLocally () {
 345     const configString = peertubeLocalStorage.getItem(ServerService.CONFIG_LOCAL_STORAGE_KEY)
 346
 347     if (configString) {
 348       try {
 349         const parsed = JSON.parse(configString)
 350         Object.assign(this.config, parsed)
 351       } catch (err) {
 352         console.error('Cannot parse config saved in local storage.', err)
 353       }
 354     }
 355   }
 356 }