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

151 lines
6.3 KiB
TypeScript
Raw Normal View History

2019-07-23 09:48:48 +02:00
// {hookType}:{api?}.{location}.{subLocation?}.{actionType}.{target}
2019-07-22 16:31:47 +02:00
export const serverFilterHookObject = {
2019-07-24 10:21:22 +02:00
// Filter params/result used to list videos for the REST API
// (used by the trending page, recently-added page, local page etc)
2019-07-22 16:31:47 +02:00
'filter:api.videos.list.params': true,
'filter:api.videos.list.result': true,
// Filter params/result used to list account videos for the REST API
'filter:api.accounts.videos.list.params': true,
'filter:api.accounts.videos.list.result': true,
2020-12-14 11:27:56 +01:00
// Filter params/result used to list channel videos for the REST API
'filter:api.video-channels.videos.list.params': true,
'filter:api.video-channels.videos.list.result': true,
2021-01-20 15:28:34 +01:00
// Filter params/result used to list my user videos for the REST API
'filter:api.user.me.videos.list.params': true,
'filter:api.user.me.videos.list.result': true,
// Filter params/result used to list overview videos for the REST API
'filter:api.overviews.videos.list.params': true,
'filter:api.overviews.videos.list.result': true,
2021-03-24 09:16:48 +01:00
// Filter params/results to search videos/channels in the DB or on the remote index
'filter:api.search.videos.local.list.params': true,
'filter:api.search.videos.local.list.result': true,
'filter:api.search.videos.index.list.params': true,
'filter:api.search.videos.index.list.result': true,
'filter:api.search.video-channels.local.list.params': true,
'filter:api.search.video-channels.local.list.result': true,
'filter:api.search.video-channels.index.list.params': true,
'filter:api.search.video-channels.index.list.result': true,
2021-06-17 16:02:38 +02:00
'filter:api.search.video-playlists.local.list.params': true,
'filter:api.search.video-playlists.local.list.result': true,
'filter:api.search.video-playlists.index.list.params': true,
'filter:api.search.video-playlists.index.list.result': true,
2021-03-24 09:16:48 +01:00
2019-07-24 10:21:22 +02:00
// Filter the result of the get function
// Used to get detailed video information (video watch page for example)
2019-07-22 16:31:47 +02:00
'filter:api.video.get.result': true,
2019-07-18 14:28:37 +02:00
2020-11-06 13:59:50 +01:00
// Filter the result of the accept upload/live, import via torrent/url functions
2019-07-24 10:21:22 +02:00
// If this function returns false then the upload is aborted with an error
2019-07-22 16:31:47 +02:00
'filter:api.video.upload.accept.result': true,
2020-11-06 13:59:50 +01:00
'filter:api.live-video.create.accept.result': true,
'filter:api.video.pre-import-url.accept.result': true,
'filter:api.video.pre-import-torrent.accept.result': true,
'filter:api.video.post-import-url.accept.result': true,
'filter:api.video.post-import-torrent.accept.result': true,
2019-07-24 10:21:22 +02:00
// Filter the result of the accept comment (thread or reply) functions
// If the functions return false then the user cannot post its comment
2019-07-22 16:31:47 +02:00
'filter:api.video-thread.create.accept.result': true,
'filter:api.video-comment-reply.create.accept.result': true,
2019-07-18 14:28:37 +02:00
// Filter attributes when creating video object
'filter:api.video.upload.video-attribute.result': true,
'filter:api.video.import-url.video-attribute.result': true,
'filter:api.video.import-torrent.video-attribute.result': true,
'filter:api.video.live.video-attribute.result': true,
2019-07-24 10:21:22 +02:00
// Filter params/result used to list threads of a specific video
// (used by the video watch page)
2019-07-22 16:31:47 +02:00
'filter:api.video-threads.list.params': true,
'filter:api.video-threads.list.result': true,
2019-07-18 14:28:37 +02:00
2019-07-24 10:21:22 +02:00
// Filter params/result used to list replies of a specific thread
// (used by the video watch page when we click on the "View replies" button)
2019-07-22 16:31:47 +02:00
'filter:api.video-thread-comments.list.params': true,
'filter:api.video-thread-comments.list.result': true,
2019-07-22 11:14:58 +02:00
// Filter get stats result
'filter:api.server.stats.get.result': true,
2019-07-24 10:21:22 +02:00
// Filter result used to check if we need to auto blacklist a video
// (fired when a local or remote video is created or updated)
2019-10-25 13:54:32 +02:00
'filter:video.auto-blacklist.result': true,
// Filter result used to check if a user can register on the instance
2021-03-23 11:54:08 +01:00
'filter:api.user.signup.allowed.result': true,
// Filter result used to check if video/torrent download is allowed
'filter:api.download.video.allowed.result': true,
2021-03-23 17:18:18 +01:00
'filter:api.download.torrent.allowed.result': true,
// Filter result to check if the embed is allowed for a particular request
'filter:html.embed.video.allowed.result': true,
'filter:html.embed.video-playlist.allowed.result': true
2019-07-22 16:31:47 +02:00
}
export type ServerFilterHookName = keyof typeof serverFilterHookObject
2019-07-18 14:28:37 +02:00
2019-07-22 16:31:47 +02:00
export const serverActionHookObject = {
2019-07-24 10:21:22 +02:00
// Fired when the application has been loaded and is listening HTTP requests
2019-07-22 16:31:47 +02:00
'action:application.listening': true,
2019-07-18 14:28:37 +02:00
// API actions hooks give access to the original express `req` and `res` parameters
2019-07-24 10:21:22 +02:00
// Fired when a local video is updated
2019-07-22 16:31:47 +02:00
'action:api.video.updated': true,
2019-07-24 10:21:22 +02:00
// Fired when a local video is deleted
2019-07-22 16:31:47 +02:00
'action:api.video.deleted': true,
2019-07-24 10:21:22 +02:00
// Fired when a local video is uploaded
2019-07-22 16:31:47 +02:00
'action:api.video.uploaded': true,
2019-07-24 10:21:22 +02:00
// Fired when a local video is viewed
2019-07-22 16:31:47 +02:00
'action:api.video.viewed': true,
2020-11-06 13:59:50 +01:00
// Fired when a live video is created
'action:api.live-video.created': true,
2019-07-24 10:21:22 +02:00
// Fired when a thread is created
2019-07-22 16:31:47 +02:00
'action:api.video-thread.created': true,
2019-07-24 10:21:22 +02:00
// Fired when a reply to a thread is created
2019-07-22 16:31:47 +02:00
'action:api.video-comment-reply.created': true,
2019-07-24 10:21:22 +02:00
// Fired when a comment (thread or reply) is deleted
2019-12-06 15:59:12 +01:00
'action:api.video-comment.deleted': true,
// Fired when a caption is created
'action:api.video-caption.created': true,
// Fired when a caption is deleted
'action:api.video-caption.deleted': true,
2019-12-06 15:59:12 +01:00
// Fired when a user is blocked (banned)
'action:api.user.blocked': true,
// Fired when a user is unblocked (unbanned)
'action:api.user.unblocked': true,
// Fired when a user registered on the instance
'action:api.user.registered': true,
// Fired when an admin/moderator created a user
'action:api.user.created': true,
// Fired when a user is removed by an admin/moderator
'action:api.user.deleted': true,
// Fired when a user is updated by an admin/moderator
'action:api.user.updated': true,
2020-01-31 16:56:52 +01:00
// Fired when a user got a new oauth2 token
'action:api.user.oauth2-got-token': true,
// Fired when a video is added to a playlist
'action:api.video-playlist-element.created': true
2019-07-22 16:31:47 +02:00
}
2019-07-18 14:28:37 +02:00
2019-07-22 16:31:47 +02:00
export type ServerActionHookName = keyof typeof serverActionHookObject
2019-07-18 14:28:37 +02:00
2019-07-22 16:31:47 +02:00
export const serverHookObject = Object.assign({}, serverFilterHookObject, serverActionHookObject)
export type ServerHookName = keyof typeof serverHookObject
2019-07-18 14:28:37 +02:00
export interface ServerHook {
2019-07-22 15:40:13 +02:00
runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T>
2019-07-18 14:28:37 +02:00
}