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