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.video.get.result',
  94     handler: video => {
  95       video.name += ' <3'
  96
  97       return video
  98     }
  99   })
 100
 101   // ---------------------------------------------------------------------------
 102
 103   registerHook({
 104     target: 'filter:api.video-channels.list.params',
 105     handler: obj => addToCount(obj, 1)
 106   })
 107
 108   registerHook({
 109     target: 'filter:api.video-channels.list.result',
 110     handler: obj => addToTotal(obj, 1)
 111   })
 112
 113   registerHook({
 114     target: 'filter:api.video-channel.get.result',
 115     handler: channel => {
 116       channel.name += ' <3'
 117
 118       return channel
 119     }
 120   })
 121
 122   // ---------------------------------------------------------------------------
 123
 124   for (const hook of [ 'filter:api.video.upload.accept.result', 'filter:api.live-video.create.accept.result' ]) {
 125     registerHook({
 126       target: hook,
 127       handler: ({ accepted }, { videoBody, liveVideoBody }) => {
 128         if (!accepted) return { accepted: false }
 129
 130         const name = videoBody
 131           ? videoBody.name
 132           : liveVideoBody.name
 133
 134         if (name.indexOf('bad word') !== -1) return { accepted: false, errorMessage: 'bad word' }
 135
 136         return { accepted: true }
 137       }
 138     })
 139   }
 140
 141   registerHook({
 142     target: 'filter:api.video.pre-import-url.accept.result',
 143     handler: ({ accepted }, { videoImportBody }) => {
 144       if (!accepted) return { accepted: false }
 145       if (videoImportBody.targetUrl.includes('bad')) return { accepted: false, errorMessage: 'bad target url' }
 146
 147       return { accepted: true }
 148     }
 149   })
 150
 151   registerHook({
 152     target: 'filter:api.video.pre-import-torrent.accept.result',
 153     handler: ({ accepted }, { videoImportBody }) => {
 154       if (!accepted) return { accepted: false }
 155       if (videoImportBody.name.includes('bad torrent')) return { accepted: false, errorMessage: 'bad torrent' }
 156
 157       return { accepted: true }
 158     }
 159   })
 160
 161   registerHook({
 162     target: 'filter:api.video.post-import-url.accept.result',
 163     handler: ({ accepted }, { video }) => {
 164       if (!accepted) return { accepted: false }
 165       if (video.name.includes('bad word')) return { accepted: false, errorMessage: 'bad word' }
 166
 167       return { accepted: true }
 168     }
 169   })
 170
 171   registerHook({
 172     target: 'filter:api.video.post-import-torrent.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   // ---------------------------------------------------------------------------
 182
 183   registerHook({
 184     target: 'filter:api.video-thread.create.accept.result',
 185     handler: ({ accepted }, { commentBody }) => checkCommentBadWord(accepted, commentBody)
 186   })
 187
 188   registerHook({
 189     target: 'filter:api.video-comment-reply.create.accept.result',
 190     handler: ({ accepted }, { commentBody }) => checkCommentBadWord(accepted, commentBody)
 191   })
 192
 193   registerHook({
 194     target: 'filter:activity-pub.remote-video-comment.create.accept.result',
 195     handler: ({ accepted }, { comment }) => checkCommentBadWord(accepted, comment)
 196   })
 197
 198   // ---------------------------------------------------------------------------
 199
 200   registerHook({
 201     target: 'filter:api.video-threads.list.params',
 202     handler: obj => addToCount(obj)
 203   })
 204
 205   registerHook({
 206     target: 'filter:api.video-threads.list.result',
 207     handler: obj => addToTotal(obj)
 208   })
 209
 210   registerHook({
 211     target: 'filter:api.video-thread-comments.list.result',
 212     handler: obj => {
 213       obj.data.forEach(c => c.text += ' <3')
 214
 215       return obj
 216     }
 217   })
 218
 219   registerHook({
 220     target: 'filter:video.auto-blacklist.result',
 221     handler: (blacklisted, { video }) => {
 222       if (blacklisted) return true
 223       if (video.name.includes('please blacklist me')) return true
 224
 225       return false
 226     }
 227   })
 228
 229   registerHook({
 230     target: 'filter:api.user.signup.allowed.result',
 231     handler: (result, params) => {
 232       if (params && params.body && params.body.email && params.body.email.includes('jma')) {
 233         return { allowed: false, errorMessage: 'No jma' }
 234       }
 235
 236       return result
 237     }
 238   })
 239
 240   registerHook({
 241     target: 'filter:api.download.torrent.allowed.result',
 242     handler: (result, params) => {
 243       if (params && params.downloadName.includes('bad torrent')) {
 244         return { allowed: false, errorMessage: 'Liu Bei' }
 245       }
 246
 247       return result
 248     }
 249   })
 250
 251   registerHook({
 252     target: 'filter:api.download.video.allowed.result',
 253     handler: (result, params) => {
 254       if (params && !params.streamingPlaylist && params.video.name.includes('bad file')) {
 255         return { allowed: false, errorMessage: 'Cao Cao' }
 256       }
 257
 258       if (params && params.streamingPlaylist && params.video.name.includes('bad playlist file')) {
 259         return { allowed: false, errorMessage: 'Sun Jian' }
 260       }
 261
 262       return result
 263     }
 264   })
 265
 266   registerHook({
 267     target: 'filter:html.embed.video.allowed.result',
 268     handler: (result, params) => {
 269       return {
 270         allowed: false,
 271         html: 'Lu Bu'
 272       }
 273     }
 274   })
 275
 276   registerHook({
 277     target: 'filter:html.embed.video-playlist.allowed.result',
 278     handler: (result, params) => {
 279       return {
 280         allowed: false,
 281         html: 'Diao Chan'
 282       }
 283     }
 284   })
 285
 286   registerHook({
 287     target: 'filter:api.server.stats.get.result',
 288     handler: (result) => {
 289       return { ...result, customStats: 14 }
 290     }
 291   })
 292
 293   registerHook({
 294     target: 'filter:job-queue.process.params',
 295     handler: (object, context) => {
 296       if (context.type !== 'video-studio-edition') return object
 297
 298       object.data.tasks = [
 299         {
 300           name: 'cut',
 301           options: {
 302             start: 0,
 303             end: 1
 304           }
 305         }
 306       ]
 307
 308       return object
 309     }
 310   })
 311
 312   registerHook({
 313     target: 'filter:transcoding.auto.resolutions-to-transcode.result',
 314     handler: (object, context) => {
 315       if (context.video.name.includes('transcode-filter')) {
 316         object = [ 100 ]
 317       }
 318
 319       return object
 320     }
 321   })
 322
 323   // Upload/import/live attributes
 324   for (const target of [
 325     'filter:api.video.upload.video-attribute.result',
 326     'filter:api.video.import-url.video-attribute.result',
 327     'filter:api.video.import-torrent.video-attribute.result',
 328     'filter:api.video.live.video-attribute.result'
 329   ]) {
 330     registerHook({
 331       target,
 332       handler: (result) => {
 333         return { ...result, description: result.description + ' - ' + target }
 334       }
 335     })
 336   }
 337
 338   {
 339     const filterHooks = [
 340       'filter:api.search.videos.local.list.params',
 341       'filter:api.search.videos.local.list.result',
 342       'filter:api.search.videos.index.list.params',
 343       'filter:api.search.videos.index.list.result',
 344       'filter:api.search.video-channels.local.list.params',
 345       'filter:api.search.video-channels.local.list.result',
 346       'filter:api.search.video-channels.index.list.params',
 347       'filter:api.search.video-channels.index.list.result',
 348       'filter:api.search.video-playlists.local.list.params',
 349       'filter:api.search.video-playlists.local.list.result',
 350       'filter:api.search.video-playlists.index.list.params',
 351       'filter:api.search.video-playlists.index.list.result',
 352
 353       'filter:api.overviews.videos.list.params',
 354       'filter:api.overviews.videos.list.result',
 355
 356       'filter:job-queue.process.params',
 357       'filter:job-queue.process.result'
 358     ]
 359
 360     for (const h of filterHooks) {
 361       registerHook({
 362         target: h,
 363         handler: (obj) => {
 364           peertubeHelpers.logger.debug('Run hook %s.', h)
 365
 366           return obj
 367         }
 368       })
 369     }
 370   }
 371 }
 372
 373 async function unregister () {
 374   return
 375 }
 376
 377 module.exports = {
 378   register,
 379   unregister
 380 }
 381
 382 // ############################################################################
 383
 384 function addToCount (obj, amount = 1) {
 385   return Object.assign({}, obj, { count: obj.count + amount })
 386 }
 387
 388 function addToTotal (result, amount = 1) {
 389   return {
 390     data: result.data,
 391     total: result.total + amount
 392   }
 393 }
 394
 395 function checkCommentBadWord (accepted, commentBody) {
 396   if (!accepted) return { accepted: false }
 397   if (commentBody.text.indexOf('bad word') !== -1) return { accepted: false, errorMessage: 'bad word '}
 398
 399   return { accepted: true }
 400 }