]>
Commit | Line | Data |
---|---|---|
a8b666e9 C |
1 | // {hookType}:{api?}.{location}.{subLocation?}.{actionType}.{target} |
2 | ||
7663e55a | 3 | export const serverFilterHookObject = { |
5f189c9c C |
4 | // Filter params/result used to list videos for the REST API |
5 | // (used by the trending page, recently-added page, local page etc) | |
7663e55a C |
6 | 'filter:api.videos.list.params': true, |
7 | 'filter:api.videos.list.result': true, | |
c5ca7e1e | 8 | |
9 | // Filter params/result used to list a video playlists videos | |
10 | // for the REST API | |
11 | 'filter:api.video-playlist.videos.list.params': true, | |
12 | 'filter:api.video-playlist.videos.list.result': true, | |
38267c0c C |
13 | |
14 | // Filter params/result used to list account videos for the REST API | |
15 | 'filter:api.accounts.videos.list.params': true, | |
16 | 'filter:api.accounts.videos.list.result': true, | |
17 | ||
c0481610 | 18 | // Filter params/result used to list channel videos for the REST API |
38267c0c C |
19 | 'filter:api.video-channels.videos.list.params': true, |
20 | 'filter:api.video-channels.videos.list.result': true, | |
21 | ||
a4d2ca07 C |
22 | // Filter params/result used to list my user videos for the REST API |
23 | 'filter:api.user.me.videos.list.params': true, | |
24 | 'filter:api.user.me.videos.list.result': true, | |
25 | ||
64f9b91d MW |
26 | // Filter params/result used to list overview videos for the REST API |
27 | 'filter:api.overviews.videos.list.params': true, | |
28 | 'filter:api.overviews.videos.list.result': true, | |
29 | ||
74a4d531 C |
30 | // Filter params/results to search videos/channels in the DB or on the remote index |
31 | 'filter:api.search.videos.local.list.params': true, | |
32 | 'filter:api.search.videos.local.list.result': true, | |
33 | 'filter:api.search.videos.index.list.params': true, | |
34 | 'filter:api.search.videos.index.list.result': true, | |
35 | 'filter:api.search.video-channels.local.list.params': true, | |
36 | 'filter:api.search.video-channels.local.list.result': true, | |
37 | 'filter:api.search.video-channels.index.list.params': true, | |
38 | 'filter:api.search.video-channels.index.list.result': true, | |
37a44fc9 C |
39 | 'filter:api.search.video-playlists.local.list.params': true, |
40 | 'filter:api.search.video-playlists.local.list.result': true, | |
41 | 'filter:api.search.video-playlists.index.list.params': true, | |
42 | 'filter:api.search.video-playlists.index.list.result': true, | |
74a4d531 | 43 | |
5f189c9c C |
44 | // Filter the result of the get function |
45 | // Used to get detailed video information (video watch page for example) | |
7663e55a | 46 | 'filter:api.video.get.result': true, |
b4055e1c | 47 | |
0260dc8a C |
48 | // Filter params/results when listing video channels |
49 | 'filter:api.video-channels.list.params': true, | |
50 | 'filter:api.video-channels.list.result': true, | |
51 | ||
52 | // Filter the result when getting a video channel | |
53 | 'filter:api.video-channel.get.result': true, | |
54 | ||
3cabf353 | 55 | // Filter the result of the accept upload/live, import via torrent/url functions |
5f189c9c | 56 | // If this function returns false then the upload is aborted with an error |
7663e55a | 57 | 'filter:api.video.upload.accept.result': true, |
3cabf353 | 58 | 'filter:api.live-video.create.accept.result': true, |
2158ac90 RK |
59 | 'filter:api.video.pre-import-url.accept.result': true, |
60 | 'filter:api.video.pre-import-torrent.accept.result': true, | |
61 | 'filter:api.video.post-import-url.accept.result': true, | |
62 | 'filter:api.video.post-import-torrent.accept.result': true, | |
5f189c9c C |
63 | // Filter the result of the accept comment (thread or reply) functions |
64 | // If the functions return false then the user cannot post its comment | |
7663e55a C |
65 | 'filter:api.video-thread.create.accept.result': true, |
66 | 'filter:api.video-comment-reply.create.accept.result': true, | |
b4055e1c | 67 | |
d17d7430 C |
68 | // Filter attributes when creating video object |
69 | 'filter:api.video.upload.video-attribute.result': true, | |
70 | 'filter:api.video.import-url.video-attribute.result': true, | |
71 | 'filter:api.video.import-torrent.video-attribute.result': true, | |
72 | 'filter:api.video.live.video-attribute.result': true, | |
73 | ||
5f189c9c C |
74 | // Filter params/result used to list threads of a specific video |
75 | // (used by the video watch page) | |
7663e55a C |
76 | 'filter:api.video-threads.list.params': true, |
77 | 'filter:api.video-threads.list.result': true, | |
b4055e1c | 78 | |
5f189c9c C |
79 | // Filter params/result used to list replies of a specific thread |
80 | // (used by the video watch page when we click on the "View replies" button) | |
7663e55a C |
81 | 'filter:api.video-thread-comments.list.params': true, |
82 | 'filter:api.video-thread-comments.list.result': true, | |
6691c522 | 83 | |
65058050 C |
84 | // Filter get stats result |
85 | 'filter:api.server.stats.get.result': true, | |
86 | ||
5f189c9c C |
87 | // Filter result used to check if we need to auto blacklist a video |
88 | // (fired when a local or remote video is created or updated) | |
4ce7eb71 C |
89 | 'filter:video.auto-blacklist.result': true, |
90 | ||
91 | // Filter result used to check if a user can register on the instance | |
4bc45da3 C |
92 | 'filter:api.user.signup.allowed.result': true, |
93 | ||
94 | // Filter result used to check if video/torrent download is allowed | |
95 | 'filter:api.download.video.allowed.result': true, | |
eebd9838 C |
96 | 'filter:api.download.torrent.allowed.result': true, |
97 | ||
98 | // Filter result to check if the embed is allowed for a particular request | |
99 | 'filter:html.embed.video.allowed.result': true, | |
22df69fd C |
100 | 'filter:html.embed.video-playlist.allowed.result': true, |
101 | ||
102 | 'filter:job-queue.process.params': true, | |
ebb9e53a C |
103 | 'filter:job-queue.process.result': true, |
104 | ||
64fd6158 | 105 | 'filter:transcoding.manual.resolutions-to-transcode.result': true, |
b2a70e3c C |
106 | 'filter:transcoding.auto.resolutions-to-transcode.result': true, |
107 | ||
108 | 'filter:activity-pub.remote-video-comment.create.accept.result': true | |
7663e55a C |
109 | } |
110 | ||
111 | export type ServerFilterHookName = keyof typeof serverFilterHookObject | |
b4055e1c | 112 | |
7663e55a | 113 | export const serverActionHookObject = { |
5f189c9c | 114 | // Fired when the application has been loaded and is listening HTTP requests |
7663e55a | 115 | 'action:application.listening': true, |
b4055e1c | 116 | |
785f1897 C |
117 | // Fired when a new notification is created |
118 | 'action:notifier.notification.created': true, | |
119 | ||
7226e90f | 120 | // API actions hooks give access to the original express `req` and `res` parameters |
121 | ||
5f189c9c | 122 | // Fired when a local video is updated |
7663e55a | 123 | 'action:api.video.updated': true, |
5f189c9c | 124 | // Fired when a local video is deleted |
7663e55a | 125 | 'action:api.video.deleted': true, |
5f189c9c | 126 | // Fired when a local video is uploaded |
7663e55a | 127 | 'action:api.video.uploaded': true, |
5f189c9c | 128 | // Fired when a local video is viewed |
7663e55a C |
129 | 'action:api.video.viewed': true, |
130 | ||
0260dc8a C |
131 | // Fired when a video channel is created |
132 | 'action:api.video-channel.created': true, | |
133 | // Fired when a video channel is updated | |
134 | 'action:api.video-channel.updated': true, | |
135 | // Fired when a video channel is deleted | |
136 | 'action:api.video-channel.deleted': true, | |
137 | ||
3cabf353 C |
138 | // Fired when a live video is created |
139 | 'action:api.live-video.created': true, | |
140 | ||
5f189c9c | 141 | // Fired when a thread is created |
7663e55a | 142 | 'action:api.video-thread.created': true, |
5f189c9c | 143 | // Fired when a reply to a thread is created |
7663e55a | 144 | 'action:api.video-comment-reply.created': true, |
5f189c9c | 145 | // Fired when a comment (thread or reply) is deleted |
6f3fe96f C |
146 | 'action:api.video-comment.deleted': true, |
147 | ||
5e3d29ab | 148 | // Fired when a caption is created |
149 | 'action:api.video-caption.created': true, | |
150 | // Fired when a caption is deleted | |
151 | 'action:api.video-caption.deleted': true, | |
152 | ||
6f3fe96f C |
153 | // Fired when a user is blocked (banned) |
154 | 'action:api.user.blocked': true, | |
155 | // Fired when a user is unblocked (unbanned) | |
156 | 'action:api.user.unblocked': true, | |
157 | // Fired when a user registered on the instance | |
158 | 'action:api.user.registered': true, | |
159 | // Fired when an admin/moderator created a user | |
160 | 'action:api.user.created': true, | |
161 | // Fired when a user is removed by an admin/moderator | |
162 | 'action:api.user.deleted': true, | |
163 | // Fired when a user is updated by an admin/moderator | |
164 | 'action:api.user.updated': true, | |
165 | ||
a1587156 | 166 | // Fired when a user got a new oauth2 token |
e2e0b645 | 167 | 'action:api.user.oauth2-got-token': true, |
168 | ||
169 | // Fired when a video is added to a playlist | |
170 | 'action:api.video-playlist-element.created': true | |
7663e55a | 171 | } |
b4055e1c | 172 | |
7663e55a | 173 | export type ServerActionHookName = keyof typeof serverActionHookObject |
b4055e1c | 174 | |
7663e55a C |
175 | export const serverHookObject = Object.assign({}, serverFilterHookObject, serverActionHookObject) |
176 | export type ServerHookName = keyof typeof serverHookObject | |
b4055e1c C |
177 | |
178 | export interface ServerHook { | |
93cae479 | 179 | runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> |
b4055e1c | 180 | } |