shared/models/plugins/server-hook.model.ts

   1 // {hookType}:{api?}.{location}.{subLocation?}.{actionType}.{target}
   2
   3 export const serverFilterHookObject = {
   4   // Filter params/result used to list videos for the REST API
   5   // (used by the trending page, recently-added page, local page etc)
   6   'filter:api.videos.list.params': true,
   7   'filter:api.videos.list.result': true,
   8
   9   // Filter params/result used to list account videos for the REST API
  10   'filter:api.accounts.videos.list.params': true,
  11   'filter:api.accounts.videos.list.result': true,
  12
  13   // Filter params/result used to list channel videos for the REST API
  14   'filter:api.video-channels.videos.list.params': true,
  15   'filter:api.video-channels.videos.list.result': true,
  16
  17   // Filter params/result used to list my user videos for the REST API
  18   'filter:api.user.me.videos.list.params': true,
  19   'filter:api.user.me.videos.list.result': true,
  20
  21   // Filter params/results to search videos/channels in the DB or on the remote index
  22   'filter:api.search.videos.local.list.params': true,
  23   'filter:api.search.videos.local.list.result': true,
  24   'filter:api.search.videos.index.list.params': true,
  25   'filter:api.search.videos.index.list.result': true,
  26   'filter:api.search.video-channels.local.list.params': true,
  27   'filter:api.search.video-channels.local.list.result': true,
  28   'filter:api.search.video-channels.index.list.params': true,
  29   'filter:api.search.video-channels.index.list.result': true,
  30
  31   // Filter the result of the get function
  32   // Used to get detailed video information (video watch page for example)
  33   'filter:api.video.get.result': true,
  34
  35   // Filter the result of the accept upload/live, import via torrent/url functions
  36   // If this function returns false then the upload is aborted with an error
  37   'filter:api.video.upload.accept.result': true,
  38   'filter:api.live-video.create.accept.result': true,
  39   'filter:api.video.pre-import-url.accept.result': true,
  40   'filter:api.video.pre-import-torrent.accept.result': true,
  41   'filter:api.video.post-import-url.accept.result': true,
  42   'filter:api.video.post-import-torrent.accept.result': true,
  43   // Filter the result of the accept comment (thread or reply) functions
  44   // If the functions return false then the user cannot post its comment
  45   'filter:api.video-thread.create.accept.result': true,
  46   'filter:api.video-comment-reply.create.accept.result': true,
  47
  48   // Filter params/result used to list threads of a specific video
  49   // (used by the video watch page)
  50   'filter:api.video-threads.list.params': true,
  51   'filter:api.video-threads.list.result': true,
  52
  53   // Filter params/result used to list replies of a specific thread
  54   // (used by the video watch page when we click on the "View replies" button)
  55   'filter:api.video-thread-comments.list.params': true,
  56   'filter:api.video-thread-comments.list.result': true,
  57
  58   // Filter result used to check if we need to auto blacklist a video
  59   // (fired when a local or remote video is created or updated)
  60   'filter:video.auto-blacklist.result': true,
  61
  62   // Filter result used to check if a user can register on the instance
  63   'filter:api.user.signup.allowed.result': true,
  64
  65   // Filter result used to check if video/torrent download is allowed
  66   'filter:api.download.video.allowed.result': true,
  67   'filter:api.download.torrent.allowed.result': true,
  68
  69   // Filter result to check if the embed is allowed for a particular request
  70   'filter:html.embed.video.allowed.result': true,
  71   'filter:html.embed.video-playlist.allowed.result': true
  72 }
  73
  74 export type ServerFilterHookName = keyof typeof serverFilterHookObject
  75
  76 export const serverActionHookObject = {
  77   // Fired when the application has been loaded and is listening HTTP requests
  78   'action:application.listening': true,
  79
  80   // Fired when a local video is updated
  81   'action:api.video.updated': true,
  82   // Fired when a local video is deleted
  83   'action:api.video.deleted': true,
  84   // Fired when a local video is uploaded
  85   'action:api.video.uploaded': true,
  86   // Fired when a local video is viewed
  87   'action:api.video.viewed': true,
  88
  89   // Fired when a live video is created
  90   'action:api.live-video.created': true,
  91
  92   // Fired when a thread is created
  93   'action:api.video-thread.created': true,
  94   // Fired when a reply to a thread is created
  95   'action:api.video-comment-reply.created': true,
  96   // Fired when a comment (thread or reply) is deleted
  97   'action:api.video-comment.deleted': true,
  98
  99   // Fired when a user is blocked (banned)
 100   'action:api.user.blocked': true,
 101   // Fired when a user is unblocked (unbanned)
 102   'action:api.user.unblocked': true,
 103   // Fired when a user registered on the instance
 104   'action:api.user.registered': true,
 105   // Fired when an admin/moderator created a user
 106   'action:api.user.created': true,
 107   // Fired when a user is removed by an admin/moderator
 108   'action:api.user.deleted': true,
 109   // Fired when a user is updated by an admin/moderator
 110   'action:api.user.updated': true,
 111
 112   // Fired when a user got a new oauth2 token
 113   'action:api.user.oauth2-got-token': true
 114 }
 115
 116 export type ServerActionHookName = keyof typeof serverActionHookObject
 117
 118 export const serverHookObject = Object.assign({}, serverFilterHookObject, serverActionHookObject)
 119 export type ServerHookName = keyof typeof serverHookObject
 120
 121 export interface ServerHook {
 122   runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T>
 123 }