server/tests/fixtures/peertube-plugin-test/main.js

   1 async function register ({ registerHook, registerSetting, settingsManager, storageManager, peertubeHelpers }) {
   2   const actionHooks = [
   3     'action:application.listening',
   4     'action:notifier.notification.created',
   5
   6     'action:api.video.updated',
   7     'action:api.video.deleted',
   8     'action:api.video.uploaded',
   9     'action:api.video.viewed',
  10
  11     'action:api.video-channel.created',
  12     'action:api.video-channel.updated',
  13     'action:api.video-channel.deleted',
  14
  15     'action:api.live-video.created',
  16
  17     'action:api.video-thread.created',
  18     'action:api.video-comment-reply.created',
  19     'action:api.video-comment.deleted',
  20
  21     'action:api.video-caption.created',
  22     'action:api.video-caption.deleted',
  23
  24     'action:api.user.blocked',
  25     'action:api.user.unblocked',
  26     'action:api.user.registered',
  27     'action:api.user.created',
  28     'action:api.user.deleted',
  29     'action:api.user.updated',
  30     'action:api.user.oauth2-got-token',
  31
  32     'action:api.video-playlist-element.created'
  33   ]
  34
  35   for (const h of actionHooks) {
  36     registerHook({
  37       target: h,
  38       handler: () => peertubeHelpers.logger.debug('Run hook %s.', h)
  39     })
  40   }
  41
  42   registerHook({
  43     target: 'filter:api.videos.list.params',
  44     handler: obj => addToCount(obj)
  45   })
  46
  47   registerHook({
  48     target: 'filter:api.videos.list.result',
  49     handler: obj => addToTotal(obj)
  50   })
  51
  52   registerHook({
  53     target: 'filter:api.video-playlist.videos.list.params',
  54     handler: obj => addToCount(obj)
  55   })
  56
  57   registerHook({
  58     target: 'filter:api.video-playlist.videos.list.result',
  59     handler: obj => addToTotal(obj)
  60   })
  61
  62   registerHook({
  63     target: 'filter:api.accounts.videos.list.params',
  64     handler: obj => addToCount(obj)
  65   })
  66
  67   registerHook({
  68     target: 'filter:api.accounts.videos.list.result',
  69     handler: obj => addToTotal(obj, 2)
  70   })
  71
  72   registerHook({
  73     target: 'filter:api.video-channels.videos.list.params',
  74     handler: obj => addToCount(obj, 3)
  75   })
  76
  77   registerHook({
  78     target: 'filter:api.video-channels.videos.list.result',
  79     handler: obj => addToTotal(obj, 3)
  80   })
  81
  82   registerHook({
  83     target: 'filter:api.user.me.videos.list.params',
  84     handler: obj => addToCount(obj, 4)
  85   })
  86
  87   registerHook({
  88     target: 'filter:api.user.me.videos.list.result',
  89     handler: obj => addToTotal(obj, 4)
  90   })
  91
  92   registerHook({
  93     target: 'filter:api.user.me.subscription-videos.list.params',
  94     handler: obj => Object.assign({}, obj, { count: 1 })
  95   })
  96
  97   registerHook({
  98     target: 'filter:api.user.me.subscription-videos.list.result',
  99     handler: obj => addToTotal(obj, 4)
 100   })
 101
 102   registerHook({
 103     target: 'filter:api.video.get.result',
 104     handler: video => {
 105       video.name += ' <3'
 106
 107       return video
 108     }
 109   })
 110
 111   // ---------------------------------------------------------------------------
 112
 113   registerHook({
 114     target: 'filter:api.video-channels.list.params',
 115     handler: obj => addToCount(obj, 1)
 116   })
 117
 118   registerHook({
 119     target: 'filter:api.video-channels.list.result',
 120     handler: obj => addToTotal(obj, 1)
 121   })
 122
 123   registerHook({
 124     target: 'filter:api.video-channel.get.result',
 125     handler: channel => {
 126       channel.name += ' <3'
 127
 128       return channel
 129     }
 130   })
 131
 132   // ---------------------------------------------------------------------------
 133
 134   for (const hook of [ 'filter:api.video.upload.accept.result', 'filter:api.live-video.create.accept.result' ]) {
 135     registerHook({
 136       target: hook,
 137       handler: ({ accepted }, { videoBody, liveVideoBody }) => {
 138         if (!accepted) return { accepted: false }
 139
 140         const name = videoBody
 141           ? videoBody.name
 142           : liveVideoBody.name
 143
 144         if (name.indexOf('bad word') !== -1) return { accepted: false, errorMessage: 'bad word' }
 145
 146         return { accepted: true }
 147       }
 148     })
 149   }
 150
 151   registerHook({
 152     target: 'filter:api.video.pre-import-url.accept.result',
 153     handler: ({ accepted }, { videoImportBody }) => {
 154       if (!accepted) return { accepted: false }
 155       if (videoImportBody.targetUrl.includes('bad')) return { accepted: false, errorMessage: 'bad target url' }
 156
 157       return { accepted: true }
 158     }
 159   })
 160
 161   registerHook({
 162     target: 'filter:api.video.pre-import-torrent.accept.result',
 163     handler: ({ accepted }, { videoImportBody }) => {
 164       if (!accepted) return { accepted: false }
 165       if (videoImportBody.name.includes('bad torrent')) return { accepted: false, errorMessage: 'bad torrent' }
 166
 167       return { accepted: true }
 168     }
 169   })
 170
 171   registerHook({
 172     target: 'filter:api.video.post-import-url.accept.result',
 173     handler: ({ accepted }, { video }) => {
 174       if (!accepted) return { accepted: false }
 175       if (video.name.includes('bad word')) return { accepted: false, errorMessage: 'bad word' }
 176
 177       return { accepted: true }
 178     }
 179   })
 180
 181   registerHook({
 182     target: 'filter:api.video.post-import-torrent.accept.result',
 183     handler: ({ accepted }, { video }) => {
 184       if (!accepted) return { accepted: false }
 185       if (video.name.includes('bad word')) return { accepted: false, errorMessage: 'bad word' }
 186
 187       return { accepted: true }
 188     }
 189   })
 190
 191   // ---------------------------------------------------------------------------
 192
 193   registerHook({
 194     target: 'filter:api.video-thread.create.accept.result',
 195     handler: ({ accepted }, { commentBody }) => checkCommentBadWord(accepted, commentBody)
 196   })
 197
 198   registerHook({
 199     target: 'filter:api.video-comment-reply.create.accept.result',
 200     handler: ({ accepted }, { commentBody }) => checkCommentBadWord(accepted, commentBody)
 201   })
 202
 203   registerHook({
 204     target: 'filter:activity-pub.remote-video-comment.create.accept.result',
 205     handler: ({ accepted }, { comment }) => checkCommentBadWord(accepted, comment)
 206   })
 207
 208   // ---------------------------------------------------------------------------
 209
 210   registerHook({
 211     target: 'filter:api.video-threads.list.params',
 212     handler: obj => addToCount(obj)
 213   })
 214
 215   registerHook({
 216     target: 'filter:api.video-threads.list.result',
 217     handler: obj => addToTotal(obj)
 218   })
 219
 220   registerHook({
 221     target: 'filter:api.video-thread-comments.list.result',
 222     handler: obj => {
 223       obj.data.forEach(c => c.text += ' <3')
 224
 225       return obj
 226     }
 227   })
 228
 229   registerHook({
 230     target: 'filter:video.auto-blacklist.result',
 231     handler: (blacklisted, { video }) => {
 232       if (blacklisted) return true
 233       if (video.name.includes('please blacklist me')) return true
 234
 235       return false
 236     }
 237   })
 238
 239   {
 240     registerHook({
 241       target: 'filter:api.user.signup.allowed.result',
 242       handler: (result, params) => {
 243         if (params && params.body && params.body.email && params.body.email.includes('jma 1')) {
 244           return { allowed: false, errorMessage: 'No jma 1' }
 245         }
 246
 247         return result
 248       }
 249     })
 250
 251     registerHook({
 252       target: 'filter:api.user.request-signup.allowed.result',
 253       handler: (result, params) => {
 254         if (params && params.body && params.body.email && params.body.email.includes('jma 2')) {
 255           return { allowed: false, errorMessage: 'No jma 2' }
 256         }
 257
 258         return result
 259       }
 260     })
 261   }
 262
 263   registerHook({
 264     target: 'filter:api.download.torrent.allowed.result',
 265     handler: (result, params) => {
 266       if (params && params.downloadName.includes('bad torrent')) {
 267         return { allowed: false, errorMessage: 'Liu Bei' }
 268       }
 269
 270       return result
 271     }
 272   })
 273
 274   registerHook({
 275     target: 'filter:api.download.video.allowed.result',
 276     handler: async (result, params) => {
 277       const loggedInUser = await peertubeHelpers.user.getAuthUser(params.res)
 278       if (loggedInUser) return { allowed: true }
 279
 280       if (params && !params.streamingPlaylist && params.video.name.includes('bad file')) {
 281         return { allowed: false, errorMessage: 'Cao Cao' }
 282       }
 283
 284       if (params && params.streamingPlaylist && params.video.name.includes('bad playlist file')) {
 285         return { allowed: false, errorMessage: 'Sun Jian' }
 286       }
 287
 288       return result
 289     }
 290   })
 291
 292   registerHook({
 293     target: 'filter:html.embed.video.allowed.result',
 294     handler: (result, params) => {
 295       return {
 296         allowed: false,
 297         html: 'Lu Bu'
 298       }
 299     }
 300   })
 301
 302   registerHook({
 303     target: 'filter:html.embed.video-playlist.allowed.result',
 304     handler: (result, params) => {
 305       return {
 306         allowed: false,
 307         html: 'Diao Chan'
 308       }
 309     }
 310   })
 311
 312   registerHook({
 313     target: 'filter:api.server.stats.get.result',
 314     handler: (result) => {
 315       return { ...result, customStats: 14 }
 316     }
 317   })
 318
 319   registerHook({
 320     target: 'filter:job-queue.process.params',
 321     handler: (object, context) => {
 322       if (context.type !== 'video-studio-edition') return object
 323
 324       object.data.tasks = [
 325         {
 326           name: 'cut',
 327           options: {
 328             start: 0,
 329             end: 1
 330           }
 331         }
 332       ]
 333
 334       return object
 335     }
 336   })
 337
 338   registerHook({
 339     target: 'filter:transcoding.auto.resolutions-to-transcode.result',
 340     handler: (object, context) => {
 341       if (context.video.name.includes('transcode-filter')) {
 342         object = [ 100 ]
 343       }
 344
 345       return object
 346     }
 347   })
 348
 349   // Upload/import/live attributes
 350   for (const target of [
 351     'filter:api.video.upload.video-attribute.result',
 352     'filter:api.video.import-url.video-attribute.result',
 353     'filter:api.video.import-torrent.video-attribute.result',
 354     'filter:api.video.live.video-attribute.result'
 355   ]) {
 356     registerHook({
 357       target,
 358       handler: (result) => {
 359         return { ...result, description: result.description + ' - ' + target }
 360       }
 361     })
 362   }
 363
 364   {
 365     const filterHooks = [
 366       'filter:api.search.videos.local.list.params',
 367       'filter:api.search.videos.local.list.result',
 368       'filter:api.search.videos.index.list.params',
 369       'filter:api.search.videos.index.list.result',
 370       'filter:api.search.video-channels.local.list.params',
 371       'filter:api.search.video-channels.local.list.result',
 372       'filter:api.search.video-channels.index.list.params',
 373       'filter:api.search.video-channels.index.list.result',
 374       'filter:api.search.video-playlists.local.list.params',
 375       'filter:api.search.video-playlists.local.list.result',
 376       'filter:api.search.video-playlists.index.list.params',
 377       'filter:api.search.video-playlists.index.list.result',
 378
 379       'filter:api.overviews.videos.list.params',
 380       'filter:api.overviews.videos.list.result',
 381
 382       'filter:job-queue.process.params',
 383       'filter:job-queue.process.result'
 384     ]
 385
 386     for (const h of filterHooks) {
 387       registerHook({
 388         target: h,
 389         handler: (obj) => {
 390           peertubeHelpers.logger.debug('Run hook %s.', h)
 391
 392           return obj
 393         }
 394       })
 395     }
 396   }
 397 }
 398
 399 async function unregister () {
 400   return
 401 }
 402
 403 module.exports = {
 404   register,
 405   unregister
 406 }
 407
 408 // ############################################################################
 409
 410 function addToCount (obj, amount = 1) {
 411   return Object.assign({}, obj, { count: obj.count + amount })
 412 }
 413
 414 function addToTotal (result, amount = 1) {
 415   return {
 416     data: result.data,
 417     total: result.total + amount
 418   }
 419 }
 420
 421 function checkCommentBadWord (accepted, commentBody) {
 422   if (!accepted) return { accepted: false }
 423   if (commentBody.text.indexOf('bad word') !== -1) return { accepted: false, errorMessage: 'bad word '}
 424
 425   return { accepted: true }
 426 }