shared/models/plugins/server/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/result used to list overview videos for the REST API
  22   'filter:api.overviews.videos.list.params': true,
  23   'filter:api.overviews.videos.list.result': true,
  24
  25   // Filter params/results to search videos/channels in the DB or on the remote index
  26   'filter:api.search.videos.local.list.params': true,
  27   'filter:api.search.videos.local.list.result': true,
  28   'filter:api.search.videos.index.list.params': true,
  29   'filter:api.search.videos.index.list.result': true,
  30   'filter:api.search.video-channels.local.list.params': true,
  31   'filter:api.search.video-channels.local.list.result': true,
  32   'filter:api.search.video-channels.index.list.params': true,
  33   'filter:api.search.video-channels.index.list.result': true,
  34   'filter:api.search.video-playlists.local.list.params': true,
  35   'filter:api.search.video-playlists.local.list.result': true,
  36   'filter:api.search.video-playlists.index.list.params': true,
  37   'filter:api.search.video-playlists.index.list.result': true,
  38
  39   // Filter the result of the get function
  40   // Used to get detailed video information (video watch page for example)
  41   'filter:api.video.get.result': true,
  42
  43   // Filter the result of the accept upload/live, import via torrent/url functions
  44   // If this function returns false then the upload is aborted with an error
  45   'filter:api.video.upload.accept.result': true,
  46   'filter:api.live-video.create.accept.result': true,
  47   'filter:api.video.pre-import-url.accept.result': true,
  48   'filter:api.video.pre-import-torrent.accept.result': true,
  49   'filter:api.video.post-import-url.accept.result': true,
  50   'filter:api.video.post-import-torrent.accept.result': true,
  51   // Filter the result of the accept comment (thread or reply) functions
  52   // If the functions return false then the user cannot post its comment
  53   'filter:api.video-thread.create.accept.result': true,
  54   'filter:api.video-comment-reply.create.accept.result': true,
  55
  56   // Filter params/result used to list threads of a specific video
  57   // (used by the video watch page)
  58   'filter:api.video-threads.list.params': true,
  59   'filter:api.video-threads.list.result': true,
  60
  61   // Filter params/result used to list replies of a specific thread
  62   // (used by the video watch page when we click on the "View replies" button)
  63   'filter:api.video-thread-comments.list.params': true,
  64   'filter:api.video-thread-comments.list.result': true,
  65
  66   // Filter get stats result
  67   'filter:api.server.stats.get.result': true,
  68
  69   // Filter result used to check if we need to auto blacklist a video
  70   // (fired when a local or remote video is created or updated)
  71   'filter:video.auto-blacklist.result': true,
  72
  73   // Filter result used to check if a user can register on the instance
  74   'filter:api.user.signup.allowed.result': true,
  75
  76   // Filter result used to check if video/torrent download is allowed
  77   'filter:api.download.video.allowed.result': true,
  78   'filter:api.download.torrent.allowed.result': true,
  79
  80   // Filter result to check if the embed is allowed for a particular request
  81   'filter:html.embed.video.allowed.result': true,
  82   'filter:html.embed.video-playlist.allowed.result': true
  83 }
  84
  85 export type ServerFilterHookName = keyof typeof serverFilterHookObject
  86
  87 export const serverActionHookObject = {
  88   // Fired when the application has been loaded and is listening HTTP requests
  89   'action:application.listening': true,
  90
  91   // API actions hooks give access to the original express `req` and `res` parameters
  92
  93   // Fired when a local video is updated
  94   'action:api.video.updated': true,
  95   // Fired when a local video is deleted
  96   'action:api.video.deleted': true,
  97   // Fired when a local video is uploaded
  98   'action:api.video.uploaded': true,
  99   // Fired when a local video is viewed
 100   'action:api.video.viewed': true,
 101
 102   // Fired when a live video is created
 103   'action:api.live-video.created': true,
 104
 105   // Fired when a thread is created
 106   'action:api.video-thread.created': true,
 107   // Fired when a reply to a thread is created
 108   'action:api.video-comment-reply.created': true,
 109   // Fired when a comment (thread or reply) is deleted
 110   'action:api.video-comment.deleted': true,
 111
 112   // Fired when a user is blocked (banned)
 113   'action:api.user.blocked': true,
 114   // Fired when a user is unblocked (unbanned)
 115   'action:api.user.unblocked': true,
 116   // Fired when a user registered on the instance
 117   'action:api.user.registered': true,
 118   // Fired when an admin/moderator created a user
 119   'action:api.user.created': true,
 120   // Fired when a user is removed by an admin/moderator
 121   'action:api.user.deleted': true,
 122   // Fired when a user is updated by an admin/moderator
 123   'action:api.user.updated': true,
 124
 125   // Fired when a user got a new oauth2 token
 126   'action:api.user.oauth2-got-token': true,
 127
 128   // Fired when a video is added to a playlist
 129   'action:api.video-playlist-element.created': true
 130 }
 131
 132 export type ServerActionHookName = keyof typeof serverActionHookObject
 133
 134 export const serverHookObject = Object.assign({}, serverFilterHookObject, serverActionHookObject)
 135 export type ServerHookName = keyof typeof serverHookObject
 136
 137 export interface ServerHook {
 138   runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T>
 139 }