client/src/app/shared/video/abstract-video-list.ts

   1 import { debounceTime, first, tap } from 'rxjs/operators'
   2 import { OnDestroy, OnInit } from '@angular/core'
   3 import { ActivatedRoute, Router } from '@angular/router'
   4 import { fromEvent, Observable, of, Subject, Subscription } from 'rxjs'
   5 import { AuthService } from '../../core/auth'
   6 import { ComponentPagination } from '../rest/component-pagination.model'
   7 import { VideoSortField } from './sort-field.type'
   8 import { Video } from './video.model'
   9 import { ScreenService } from '@app/shared/misc/screen.service'
  10 import { MiniatureDisplayOptions, OwnerDisplayType } from '@app/shared/video/video-miniature.component'
  11 import { Syndication } from '@app/shared/video/syndication.model'
  12 import { Notifier, ServerService } from '@app/core'
  13 import { DisableForReuseHook } from '@app/core/routing/disable-for-reuse-hook'
  14 import { I18n } from '@ngx-translate/i18n-polyfill'
  15 import { isLastMonth, isLastWeek, isToday, isYesterday } from '@shared/core-utils/miscs/date'
  16 import { ResultList, ServerConfig } from '@shared/models'
  17
  18 enum GroupDate {
  19   UNKNOWN = 0,
  20   TODAY = 1,
  21   YESTERDAY = 2,
  22   LAST_WEEK = 3,
  23   LAST_MONTH = 4,
  24   OLDER = 5
  25 }
  26
  27 export abstract class AbstractVideoList implements OnInit, OnDestroy, DisableForReuseHook {
  28   pagination: ComponentPagination = {
  29     currentPage: 1,
  30     itemsPerPage: 25,
  31     totalItems: null
  32   }
  33   sort: VideoSortField = '-publishedAt'
  34
  35   categoryOneOf?: number
  36   languageOneOf?: string[]
  37   defaultSort: VideoSortField = '-publishedAt'
  38
  39   syndicationItems: Syndication[] = []
  40
  41   loadOnInit = true
  42   useUserVideoLanguagePreferences = false
  43   ownerDisplayType: OwnerDisplayType = 'account'
  44   displayModerationBlock = false
  45   titleTooltip: string
  46   displayVideoActions = true
  47   groupByDate = false
  48
  49   videos: Video[] = []
  50   disabled = false
  51
  52   displayOptions: MiniatureDisplayOptions = {
  53     date: true,
  54     views: true,
  55     by: true,
  56     privacyLabel: true,
  57     privacyText: false,
  58     state: false,
  59     blacklistInfo: false
  60   }
  61
  62   onDataSubject = new Subject<any[]>()
  63
  64   protected serverConfig: ServerConfig
  65
  66   protected abstract notifier: Notifier
  67   protected abstract authService: AuthService
  68   protected abstract route: ActivatedRoute
  69   protected abstract serverService: ServerService
  70   protected abstract screenService: ScreenService
  71   protected abstract router: Router
  72   protected abstract i18n: I18n
  73   abstract titlePage: string
  74
  75   private resizeSubscription: Subscription
  76   private angularState: number
  77
  78   private groupedDateLabels: { [id in GroupDate]: string }
  79   private groupedDates: { [id: number]: GroupDate } = {}
  80
  81   abstract getVideosObservable (page: number): Observable<ResultList<Video>>
  82
  83   abstract generateSyndicationList (): void
  84
  85   get user () {
  86     return this.authService.getUser()
  87   }
  88
  89   ngOnInit () {
  90     this.serverConfig = this.serverService.getTmpConfig()
  91     this.serverService.getConfig()
  92       .subscribe(config => this.serverConfig = config)
  93
  94     this.groupedDateLabels = {
  95       [GroupDate.UNKNOWN]: null,
  96       [GroupDate.TODAY]: this.i18n('Today'),
  97       [GroupDate.YESTERDAY]: this.i18n('Yesterday'),
  98       [GroupDate.LAST_WEEK]: this.i18n('Last week'),
  99       [GroupDate.LAST_MONTH]: this.i18n('Last month'),
 100       [GroupDate.OLDER]: this.i18n('Older')
 101     }
 102
 103     // Subscribe to route changes
 104     const routeParams = this.route.snapshot.queryParams
 105     this.loadRouteParams(routeParams)
 106
 107     this.resizeSubscription = fromEvent(window, 'resize')
 108       .pipe(debounceTime(500))
 109       .subscribe(() => this.calcPageSizes())
 110
 111     this.calcPageSizes()
 112
 113     const loadUserObservable = this.loadUserVideoLanguagesIfNeeded()
 114
 115     if (this.loadOnInit === true) {
 116       loadUserObservable.subscribe(() => this.loadMoreVideos())
 117     }
 118   }
 119
 120   ngOnDestroy () {
 121     if (this.resizeSubscription) this.resizeSubscription.unsubscribe()
 122   }
 123
 124   disableForReuse () {
 125     this.disabled = true
 126   }
 127
 128   enabledForReuse () {
 129     this.disabled = false
 130   }
 131
 132   videoById (index: number, video: Video) {
 133     return video.id
 134   }
 135
 136   onNearOfBottom () {
 137     if (this.disabled) return
 138
 139     // Last page
 140     if (this.pagination.totalItems <= (this.pagination.currentPage * this.pagination.itemsPerPage)) return
 141
 142     this.pagination.currentPage += 1
 143
 144     this.setScrollRouteParams()
 145
 146     this.loadMoreVideos()
 147   }
 148
 149   loadMoreVideos () {
 150     this.getVideosObservable(this.pagination.currentPage).subscribe(
 151       ({ data, total }) => {
 152         this.pagination.totalItems = total
 153         this.videos = this.videos.concat(data)
 154
 155         if (this.groupByDate) this.buildGroupedDateLabels()
 156
 157         this.onMoreVideos()
 158
 159         this.onDataSubject.next(data)
 160       },
 161
 162       error => this.notifier.error(error.message)
 163     )
 164   }
 165
 166   reloadVideos () {
 167     this.pagination.currentPage = 1
 168     this.videos = []
 169     this.loadMoreVideos()
 170   }
 171
 172   toggleModerationDisplay () {
 173     throw new Error('toggleModerationDisplay is not implemented')
 174   }
 175
 176   removeVideoFromArray (video: Video) {
 177     this.videos = this.videos.filter(v => v.id !== video.id)
 178   }
 179
 180   buildGroupedDateLabels () {
 181     let currentGroupedDate: GroupDate = GroupDate.UNKNOWN
 182
 183     for (const video of this.videos) {
 184       const publishedDate = video.publishedAt
 185
 186       if (currentGroupedDate <= GroupDate.TODAY && isToday(publishedDate)) {
 187         if (currentGroupedDate === GroupDate.TODAY) continue
 188
 189         currentGroupedDate = GroupDate.TODAY
 190         this.groupedDates[ video.id ] = currentGroupedDate
 191         continue
 192       }
 193
 194       if (currentGroupedDate <= GroupDate.YESTERDAY && isYesterday(publishedDate)) {
 195         if (currentGroupedDate === GroupDate.YESTERDAY) continue
 196
 197         currentGroupedDate = GroupDate.YESTERDAY
 198         this.groupedDates[ video.id ] = currentGroupedDate
 199         continue
 200       }
 201
 202       if (currentGroupedDate <= GroupDate.LAST_WEEK && isLastWeek(publishedDate)) {
 203         if (currentGroupedDate === GroupDate.LAST_WEEK) continue
 204
 205         currentGroupedDate = GroupDate.LAST_WEEK
 206         this.groupedDates[ video.id ] = currentGroupedDate
 207         continue
 208       }
 209
 210       if (currentGroupedDate <= GroupDate.LAST_MONTH && isLastMonth(publishedDate)) {
 211         if (currentGroupedDate === GroupDate.LAST_MONTH) continue
 212
 213         currentGroupedDate = GroupDate.LAST_MONTH
 214         this.groupedDates[ video.id ] = currentGroupedDate
 215         continue
 216       }
 217
 218       if (currentGroupedDate <= GroupDate.OLDER) {
 219         if (currentGroupedDate === GroupDate.OLDER) continue
 220
 221         currentGroupedDate = GroupDate.OLDER
 222         this.groupedDates[ video.id ] = currentGroupedDate
 223       }
 224     }
 225   }
 226
 227   getCurrentGroupedDateLabel (video: Video) {
 228     if (this.groupByDate === false) return undefined
 229
 230     return this.groupedDateLabels[this.groupedDates[video.id]]
 231   }
 232
 233   // On videos hook for children that want to do something
 234   protected onMoreVideos () { /* empty */ }
 235
 236   protected loadRouteParams (routeParams: { [ key: string ]: any }) {
 237     this.sort = routeParams[ 'sort' ] as VideoSortField || this.defaultSort
 238     this.categoryOneOf = routeParams[ 'categoryOneOf' ]
 239     this.angularState = routeParams[ 'a-state' ]
 240   }
 241
 242   private calcPageSizes () {
 243     if (this.screenService.isInMobileView()) {
 244       this.pagination.itemsPerPage = 5
 245     }
 246   }
 247
 248   private setScrollRouteParams () {
 249     // Already set
 250     if (this.angularState) return
 251
 252     this.angularState = 42
 253
 254     const queryParams = {
 255       'a-state': this.angularState,
 256       categoryOneOf: this.categoryOneOf
 257     }
 258
 259     let path = this.router.url
 260     if (!path || path === '/') path = this.serverConfig.instance.defaultClientRoute
 261
 262     this.router.navigate([ path ], { queryParams, replaceUrl: true, queryParamsHandling: 'merge' })
 263   }
 264
 265   private loadUserVideoLanguagesIfNeeded () {
 266     if (!this.authService.isLoggedIn() || !this.useUserVideoLanguagePreferences) {
 267       return of(true)
 268     }
 269
 270     return this.authService.userInformationLoaded
 271         .pipe(
 272           first(),
 273           tap(() => this.languageOneOf = this.user.videoLanguages)
 274         )
 275   }
 276 }