move API and AP object from number to string enum

client/src/app/+admin/moderation/video-abuse-list/video-abuse-details.component.ts

@@ -1,6 +1,6 @@
 import { Component, Input } from '@angular/core'
 import { Actor } from '@app/shared/actor/actor.model'
-import { VideoAbusePredefinedReasons } from '../../../../../../shared/models/videos/abuse/video-abuse-reason.model'
+import { VideoAbusePredefinedReasonsString } from '../../../../../../shared/models/videos/abuse/video-abuse-reason.model'
 import { ProcessedVideoAbuse } from './video-abuse-list.component'
 import { I18n } from '@ngx-translate/i18n-polyfill'
 import { durationToString } from '@app/shared/misc/utils'
@@ -13,20 +13,20 @@ import { durationToString } from '@app/shared/misc/utils'
 export class VideoAbuseDetailsComponent {
   @Input() videoAbuse: ProcessedVideoAbuse
 
-  private predefinedReasonsTranslations: { [key: number]: string }
+  private predefinedReasonsTranslations: { [key in VideoAbusePredefinedReasonsString]: string }
 
   constructor (
     private i18n: I18n
   ) {
     this.predefinedReasonsTranslations = {
-      [VideoAbusePredefinedReasons.VIOLENT_OR_REPULSIVE]: this.i18n('Violent or Repulsive'),
-      [VideoAbusePredefinedReasons.HATEFUL_OR_ABUSIVE]: this.i18n('Hateful or Abusive'),
-      [VideoAbusePredefinedReasons.SPAM_OR_MISLEADING]: this.i18n('Spam or Misleading'),
-      [VideoAbusePredefinedReasons.PRIVACY]: this.i18n('Privacy'),
-      [VideoAbusePredefinedReasons.RIGHTS]: this.i18n('Rights'),
-      [VideoAbusePredefinedReasons.SERVER_RULES]: this.i18n('Server rules'),
-      [VideoAbusePredefinedReasons.THUMBNAILS]: this.i18n('Thumbnails'),
-      [VideoAbusePredefinedReasons.CAPTIONS]: this.i18n('Captions')
+      violentOrRepulsive: this.i18n('Violent or Repulsive'),
+      hatefulOrAbusive: this.i18n('Hateful or Abusive'),
+      spamOrMisleading: this.i18n('Spam or Misleading'),
+      privacy: this.i18n('Privacy'),
+      rights: this.i18n('Rights'),
+      serverRules: this.i18n('Server rules'),
+      thumbnails: this.i18n('Thumbnails'),
+      captions: this.i18n('Captions')
     }
   }
 

client/src/app/shared/video-abuse/video-abuse.service.ts

@@ -53,18 +53,7 @@ export class VideoAbuseService {
         },
         searchReporter: { prefix: 'reporter:' },
         searchReportee: { prefix: 'reportee:' },
-        predefinedReasonId: {
-          prefix: 'tag:',
-          handler: v => {
-            try {
-              const id = parseInt(v, 10)
-              return id
-            } catch (e) {
-              console.error('Cannot parse predefinedReasonId in search.', e)
-              return undefined
-            }
-          }
-        }
+        predefinedReason: { prefix: 'tag:' }
       })
 
       params = this.restService.addObjectParams(params, filters)

client/src/app/shared/video/modals/video-report.component.ts

@@ -10,8 +10,8 @@ import { VideoAbuseService } from '@app/shared/video-abuse'
 import { Video } from '@app/shared/video/video.model'
 import { buildVideoEmbed, buildVideoLink } from 'src/assets/player/utils'
 import { DomSanitizer, SafeHtml } from '@angular/platform-browser'
-import { VideoAbusePredefinedReasonsIn } from '@shared/models/videos/abuse/video-abuse-reason.model'
-import { mapValues, pickBy, keys } from 'lodash-es'
+import { VideoAbusePredefinedReasonsString, VideoAbusePredefinedReasonsMap } from '@shared/models/videos/abuse/video-abuse-reason.model'
+import { mapValues, pickBy } from 'lodash-es'
 
 @Component({
   selector: 'my-video-report',
@@ -24,7 +24,7 @@ export class VideoReportComponent extends FormReactive implements OnInit {
   @ViewChild('modal', { static: true }) modal: NgbModal
 
   error: string = null
-  predefinedReasons: { id: VideoAbusePredefinedReasonsIn, label: string, description?: string, help?: string }[] = []
+  predefinedReasons: { id: VideoAbusePredefinedReasonsString, label: string, description?: string, help?: string }[] = []
   embedHtml: SafeHtml
 
   private openedModal: NgbModalRef
@@ -72,7 +72,7 @@ export class VideoReportComponent extends FormReactive implements OnInit {
   ngOnInit () {
     this.buildForm({
       reason: this.videoAbuseValidatorsService.VIDEO_ABUSE_REASON,
-      predefinedReasons: mapValues(VideoAbusePredefinedReasonsIn, r => null),
+      predefinedReasons: mapValues(VideoAbusePredefinedReasonsMap, r => null),
       timestamp: {
         hasStart: null,
         startAt: null,
@@ -138,7 +138,7 @@ export class VideoReportComponent extends FormReactive implements OnInit {
 
   report () {
     const reason = this.form.get('reason').value
-    const predefinedReasons = keys(pickBy(this.form.get('predefinedReasons').value)) as VideoAbusePredefinedReasonsIn[]
+    const predefinedReasons = Object.keys(pickBy(this.form.get('predefinedReasons').value)) as VideoAbusePredefinedReasonsString[]
     const { hasStart, startAt, hasEnd, endAt } = this.form.get('timestamp').value
 
     this.videoAbuseService.reportVideo({

server/controllers/api/videos/abuse.ts

@@ -1,5 +1,5 @@
 import * as express from 'express'
-import { UserRight, VideoAbuseCreate, VideoAbuseState, VideoAbuse } from '../../../../shared'
+import { UserRight, VideoAbuseCreate, VideoAbuseState, VideoAbuse, VideoAbusePredefinedReasonsMap } from '../../../../shared'
 import { logger } from '../../../helpers/logger'
 import { getFormattedObjects } from '../../../helpers/utils'
 import { sequelizeTypescript } from '../../../initializers/database'
@@ -25,8 +25,6 @@ import { sendVideoAbuse } from '../../../lib/activitypub/send/send-flag'
 import { MVideoAbuseAccountVideo } from '../../../types/models/video'
 import { getServerActor } from '@server/models/application/application'
 import { MAccountDefault } from '@server/types/models'
-import { keys, pickBy } from 'lodash'
-import { VideoAbusePredefinedReasonsIn } from '@shared/models/videos/abuse/video-abuse-reason.model'
 
 const auditLogger = auditLoggerFactory('abuse')
 const abuseVideoRouter = express.Router()
@@ -76,7 +74,7 @@ async function listVideoAbuses (req: express.Request, res: express.Response) {
     count: req.query.count,
     sort: req.query.sort,
     id: req.query.id,
-    predefinedReasonId: req.query.predefinedReasonId,
+    predefinedReason: req.query.predefinedReason,
     search: req.query.search,
     state: req.query.state,
     videoIs: req.query.videoIs,
@@ -126,7 +124,7 @@ async function reportVideoAbuse (req: express.Request, res: express.Response) {
 
   const videoAbuseInstance = await sequelizeTypescript.transaction(async t => {
     reporterAccount = await AccountModel.load(res.locals.oauth.token.User.Account.id, t)
-    const predefinedReasons = body.predefinedReasons.map(r => VideoAbusePredefinedReasonsIn[r])
+    const predefinedReasons = body.predefinedReasons.map(r => VideoAbusePredefinedReasonsMap[r])
 
     const abuseToCreate = {
       reporterAccountId: reporterAccount.id,

server/helpers/custom-validators/video-abuses.ts

@@ -1,19 +1,26 @@
 import validator from 'validator'
-import { keys } from 'lodash'
 
 import { CONSTRAINTS_FIELDS, VIDEO_ABUSE_STATES } from '../../initializers/constants'
-import { exists } from './misc'
+import { exists, isArray } from './misc'
 import { VideoAbuseVideoIs } from '@shared/models/videos/abuse/video-abuse-video-is.type'
-import { VideoAbusePredefinedReasonsIn } from '@shared/models/videos/abuse/video-abuse-reason.model'
+import { VideoAbusePredefinedReasonsString, VideoAbusePredefinedReasonsMap } from '@shared/models/videos/abuse/video-abuse-reason.model'
 
 const VIDEO_ABUSES_CONSTRAINTS_FIELDS = CONSTRAINTS_FIELDS.VIDEO_ABUSES
 
 function isVideoAbuseReasonValid (value: string) {
   return exists(value) && validator.isLength(value, VIDEO_ABUSES_CONSTRAINTS_FIELDS.REASON)
 }
 
-function isVideoAbusePredefinedReasonsValid (value: VideoAbusePredefinedReasonsIn[]) {
-  return exists(value) && value.every(element => keys(VideoAbusePredefinedReasonsIn).includes(element))
+function isVideoAbusePredefinedReasonValid (value: VideoAbusePredefinedReasonsString) {
+  return exists(value) && value in VideoAbusePredefinedReasonsMap
+}
+
+function isVideoAbusePredefinedReasonsValid (value: VideoAbusePredefinedReasonsString[]) {
+  return exists(value) && isArray(value) && value.every(v => v in VideoAbusePredefinedReasonsMap)
+}
+
+function isVideoAbuseTimestampValid (value: number) {
+  return value === null || (exists(value) && validator.isInt('' + value, { min: 0 }))
 }
 
 function isVideoAbuseModerationCommentValid (value: string) {
@@ -35,7 +42,9 @@ function isAbuseVideoIsValid (value: VideoAbuseVideoIs) {
 
 export {
   isVideoAbuseReasonValid,
+  isVideoAbusePredefinedReasonValid,
   isVideoAbusePredefinedReasonsValid,
+  isVideoAbuseTimestampValid,
   isVideoAbuseModerationCommentValid,
   isVideoAbuseStateValid,
   isAbuseVideoIsValid

server/lib/activitypub/process/process-flag.ts

@@ -1,4 +1,9 @@
-import { ActivityCreate, ActivityFlag, VideoAbuseState } from '../../../../shared'
+import {
+  ActivityCreate,
+  ActivityFlag,
+  VideoAbuseState,
+  VideoAbusePredefinedReasonsMap
+} from '../../../../shared'
 import { VideoAbuseObject } from '../../../../shared/models/activitypub/objects'
 import { retryTransactionWrapper } from '../../../helpers/database-utils'
 import { logger } from '../../../helpers/logger'
@@ -39,7 +44,7 @@ async function processCreateVideoAbuse (activity: ActivityCreate | ActivityFlag,
       const { video } = await getOrCreateVideoAndAccountAndChannel({ videoObject: object })
       const reporterAccount = await sequelizeTypescript.transaction(async t => AccountModel.load(account.id, t))
       const tags = Array.isArray(flag.tag) ? flag.tag : []
-      const predefinedReasons = tags.map(tag => parseInt(tag.name, 10))
+      const predefinedReasons = tags.map(tag => VideoAbusePredefinedReasonsMap[tag.name])
                                     .filter(v => !isNaN(v))
       const startAt = flag.startAt
       const endAt = flag.endAt

server/middlewares/validators/videos/video-abuses.ts

@@ -6,7 +6,9 @@ import {
   isVideoAbuseModerationCommentValid,
   isVideoAbuseReasonValid,
   isVideoAbuseStateValid,
-  isVideoAbusePredefinedReasonsValid
+  isVideoAbusePredefinedReasonsValid,
+  isVideoAbusePredefinedReasonValid,
+  isVideoAbuseTimestampValid
 } from '../../../helpers/custom-validators/video-abuses'
 import { logger } from '../../../helpers/logger'
 import { doesVideoAbuseExist, doesVideoExist } from '../../../helpers/middlewares'
@@ -27,11 +29,13 @@ const videoAbuseReportValidator = [
     .withMessage('Should have a valid list of predefined reasons'),
   body('startAt')
     .optional()
-    .custom(toIntOrNull)
+    .customSanitizer(toIntOrNull)
+    .custom(isVideoAbuseTimestampValid)
     .withMessage('Should have valid starting time value'),
   body('endAt')
     .optional()
-    .custom(toIntOrNull)
+    .customSanitizer(toIntOrNull)
+    .custom(isVideoAbuseTimestampValid)
     .withMessage('Should have valid ending time value'),
 
   async (req: express.Request, res: express.Response, next: express.NextFunction) => {
@@ -82,9 +86,10 @@ const videoAbuseListValidator = [
   query('id')
     .optional()
     .custom(isIdValid).withMessage('Should have a valid id'),
-  query('predefinedReasonId')
+  query('predefinedReason')
     .optional()
-    .custom(isIdValid).withMessage('Should have a valid predefinedReasonId'),
+    .custom(isVideoAbusePredefinedReasonValid)
+    .withMessage('Should have a valid predefinedReason'),
   query('search')
     .optional()
     .custom(exists).withMessage('Should have a valid search'),

server/models/video/video-abuse.ts

@@ -15,7 +15,13 @@ import {
   UpdatedAt
 } from 'sequelize-typescript'
 import { VideoAbuseVideoIs } from '@shared/models/videos/abuse/video-abuse-video-is.type'
-import { VideoAbuseState, VideoDetails } from '../../../shared'
+import {
+  VideoAbuseState,
+  VideoDetails,
+  VideoAbusePredefinedReasons,
+  VideoAbusePredefinedReasonsString,
+  VideoAbusePredefinedReasonsMap
+} from '../../../shared'
 import { VideoAbuseObject } from '../../../shared/models/activitypub/objects'
 import { VideoAbuse } from '../../../shared/models/videos'
 import {
@@ -31,6 +37,7 @@ import { ThumbnailModel } from './thumbnail'
 import { VideoModel } from './video'
 import { VideoBlacklistModel } from './video-blacklist'
 import { ScopeNames as VideoChannelScopeNames, SummaryOptions, VideoChannelModel } from './video-channel'
+import { invert } from 'lodash'
 
 export enum ScopeNames {
   FOR_API = 'FOR_API'
@@ -270,7 +277,7 @@ export class VideoAbuseModel extends Model<VideoAbuseModel> {
   @AllowNull(true)
   @Default(null)
   @Column(DataType.ARRAY(DataType.INTEGER))
-  predefinedReasons: number[]
+  predefinedReasons: VideoAbusePredefinedReasons[]
 
   @AllowNull(true)
   @Default(null)
@@ -335,7 +342,7 @@ export class VideoAbuseModel extends Model<VideoAbuseModel> {
     user?: MUserAccountId
 
     id?: number
-    predefinedReasonId?: number
+    predefinedReason?: VideoAbusePredefinedReasonsString
     state?: VideoAbuseState
     videoIs?: VideoAbuseVideoIs
 
@@ -354,7 +361,7 @@ export class VideoAbuseModel extends Model<VideoAbuseModel> {
       serverAccountId,
       state,
       videoIs,
-      predefinedReasonId,
+      predefinedReason,
       searchReportee,
       searchVideo,
       searchVideoChannel,
@@ -363,6 +370,7 @@ export class VideoAbuseModel extends Model<VideoAbuseModel> {
     } = parameters
 
     const userAccountId = user ? user.Account.id : undefined
+    const predefinedReasonId = predefinedReason ? VideoAbusePredefinedReasonsMap[predefinedReason] : undefined
 
     const query = {
       offset: start,
@@ -397,6 +405,7 @@ export class VideoAbuseModel extends Model<VideoAbuseModel> {
   }
 
   toFormattedJSON (this: MVideoAbuseFormattable): VideoAbuse {
+    const predefinedReasons = VideoAbuseModel.getPredefinedReasonsStrings(this.predefinedReasons || [])
     const countReportsForVideo = this.get('countReportsForVideo') as number
     const nthReportForVideo = this.get('nthReportForVideo') as number
     const countReportsForReporterVideo = this.get('countReportsForReporter__video') as number
@@ -411,7 +420,7 @@ export class VideoAbuseModel extends Model<VideoAbuseModel> {
     return {
       id: this.id,
       reason: this.reason,
-      predefinedReasons: this.predefinedReasons,
+      predefinedReasons,
       reporterAccount: this.Account.toFormattedJSON(),
       state: {
         id: this.state,
@@ -440,16 +449,18 @@ export class VideoAbuseModel extends Model<VideoAbuseModel> {
   }
 
   toActivityPubObject (this: MVideoAbuseVideo): VideoAbuseObject {
+    const predefinedReasons = VideoAbuseModel.getPredefinedReasonsStrings(this.predefinedReasons || [])
+
     const startAt = this.startAt
     const endAt = this.endAt
 
     return {
       type: 'Flag' as 'Flag',
       content: this.reason,
       object: this.Video.url,
-      tag: this.predefinedReasons.map(r => ({
+      tag: predefinedReasons.map(r => ({
         type: 'Hashtag' as 'Hashtag',
-        name: r.toString()
+        name: r
       })),
       startAt,
       endAt
@@ -459,4 +470,10 @@ export class VideoAbuseModel extends Model<VideoAbuseModel> {
   private static getStateLabel (id: number) {
     return VIDEO_ABUSE_STATES[id] || 'Unknown'
   }
+
+  private static getPredefinedReasonsStrings (predefinedReasons: VideoAbusePredefinedReasons[]): VideoAbusePredefinedReasonsString[] {
+    return predefinedReasons
+      .filter(r => r in VideoAbusePredefinedReasons)
+      .map(r => invert(VideoAbusePredefinedReasonsMap)[r] as VideoAbusePredefinedReasonsString)
+  }
 }

server/tests/api/videos/video-abuse.ts

@@ -2,7 +2,7 @@
 
 import * as chai from 'chai'
 import 'mocha'
-import { VideoAbuse, VideoAbuseState } from '../../../../shared/models/videos'
+import { VideoAbuse, VideoAbuseState, VideoAbusePredefinedReasonsString } from '../../../../shared/models/videos'
 import {
   cleanupTests,
   deleteVideoAbuse,
@@ -272,7 +272,8 @@ describe('Test video abuses', function () {
     const reason3 = 'my super bad reason 3'
     await reportVideoAbuse(servers[0].url, servers[0].accessToken, video3.id, reason3)
     const reason4 = 'my super bad reason 4'
-    await reportVideoAbuse(servers[0].url, userAccessToken, servers[0].video.id, reason4)
+    const predefinedReasons4: VideoAbusePredefinedReasonsString[] = [ 'violentOrRepulsive', 'captions' ]
+    await reportVideoAbuse(servers[0].url, userAccessToken, servers[0].video.id, reason4, predefinedReasons4, 1, 5)
 
     const res2 = await getVideoAbusesList({ url: servers[0].url, token: servers[0].accessToken })
 

shared/extra-utils/videos/video-abuses.ts

@@ -1,17 +1,26 @@
 import * as request from 'supertest'
 import { VideoAbuseUpdate } from '../../models/videos/abuse/video-abuse-update.model'
 import { makeDeleteRequest, makePutBodyRequest, makeGetRequest } from '../requests/requests'
-import { VideoAbuseState } from '@shared/models'
+import { VideoAbuseState, VideoAbusePredefinedReasonsString } from '@shared/models'
 import { VideoAbuseVideoIs } from '@shared/models/videos/abuse/video-abuse-video-is.type'
 
-function reportVideoAbuse (url: string, token: string, videoId: number | string, reason: string, specialStatus = 200) {
+function reportVideoAbuse (
+  url: string,
+  token: string,
+  videoId: number | string,
+  reason: string,
+  predefinedReasons?: VideoAbusePredefinedReasonsString[],
+  startAt?: number,
+  endAt?: number,
+  specialStatus = 200
+) {
   const path = '/api/v1/videos/' + videoId + '/abuse'
 
   return request(url)
           .post(path)
           .set('Accept', 'application/json')
           .set('Authorization', 'Bearer ' + token)
-          .send({ reason })
+          .send({ reason, predefinedReasons, startAt, endAt })
           .expect(specialStatus)
 }