]>
Commit | Line | Data |
---|---|---|
4d4e5cd4 | 1 | import * as config from 'config' |
65fcc311 | 2 | import { join } from 'path' |
3fd3ab2d | 3 | import { JobCategory, JobState, VideoRateType } from '../../shared/models' |
50d6de9c | 4 | import { ActivityPubActorType } from '../../shared/models/activitypub' |
225a89c2 | 5 | import { FollowState } from '../../shared/models/actors' |
3fd3ab2d | 6 | import { VideoPrivacy } from '../../shared/models/videos' |
e02643f3 | 7 | // Do not use barrels, remain constants as independent as possible |
225a89c2 | 8 | import { isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils' |
ee9e7b61 | 9 | |
9f6bae3a C |
10 | // --------------------------------------------------------------------------- |
11 | ||
47564bbe | 12 | const LAST_MIGRATION_VERSION = 155 |
5804c0db C |
13 | |
14 | // --------------------------------------------------------------------------- | |
15 | ||
9f6bae3a | 16 | // API version |
f0f5567b | 17 | const API_VERSION = 'v1' |
9f10b292 | 18 | |
9f6bae3a C |
19 | // Number of results by default for the pagination |
20 | const PAGINATION_COUNT_DEFAULT = 15 | |
21 | ||
9f6bae3a C |
22 | // Sortable columns per schema |
23 | const SORTABLE_COLUMNS = { | |
9c2c18f3 | 24 | USERS: [ 'id', 'username', 'createdAt' ], |
265ba139 | 25 | ACCOUNTS: [ 'createdAt' ], |
5cd80545 | 26 | JOBS: [ 'id', 'createdAt' ], |
9c2c18f3 | 27 | VIDEO_ABUSES: [ 'id', 'createdAt' ], |
72c7248b | 28 | VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ], |
792dbaf0 | 29 | VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ], |
bf1f6508 | 30 | VIDEO_COMMENT_THREADS: [ 'createdAt' ], |
7a7724e6 C |
31 | BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ], |
32 | FOLLOWERS: [ 'createdAt' ], | |
33 | FOLLOWING: [ 'createdAt' ] | |
9f6bae3a | 34 | } |
9f10b292 | 35 | |
2f372a86 C |
36 | const OAUTH_LIFETIME = { |
37 | ACCESS_TOKEN: 3600 * 4, // 4 hours | |
38 | REFRESH_TOKEN: 1209600 // 2 weeks | |
39 | } | |
40 | ||
9f6bae3a | 41 | // --------------------------------------------------------------------------- |
26d7d31b | 42 | |
225a89c2 C |
43 | // Number of points we add/remove from a friend after a successful/bad request |
44 | const SERVERS_SCORE = { | |
45 | PENALTY: -10, | |
46 | BONUS: 10, | |
47 | BASE: 100, | |
48 | MAX: 1000 | |
49 | } | |
50 | ||
51 | const FOLLOW_STATES: { [ id: string ]: FollowState } = { | |
52 | PENDING: 'pending', | |
53 | ACCEPTED: 'accepted' | |
54 | } | |
55 | ||
56 | const REMOTE_SCHEME = { | |
57 | HTTP: 'https', | |
58 | WS: 'wss' | |
59 | } | |
60 | ||
61 | const JOB_STATES: { [ id: string ]: JobState } = { | |
62 | PENDING: 'pending', | |
63 | PROCESSING: 'processing', | |
64 | ERROR: 'error', | |
65 | SUCCESS: 'success' | |
66 | } | |
67 | const JOB_CATEGORIES: { [ id: string ]: JobCategory } = { | |
68 | TRANSCODING: 'transcoding', | |
69 | ACTIVITYPUB_HTTP: 'activitypub-http' | |
70 | } | |
71 | // How many maximum jobs we fetch from the database per cycle | |
72 | const JOBS_FETCH_LIMIT_PER_CYCLE = { | |
73 | transcoding: 10, | |
74 | httpRequest: 20 | |
75 | } | |
76 | // 1 minutes | |
77 | let JOBS_FETCHING_INTERVAL = 60000 | |
78 | ||
79 | // --------------------------------------------------------------------------- | |
80 | ||
e861452f | 81 | const CONFIG = { |
d16b5172 | 82 | LISTEN: { |
65fcc311 | 83 | PORT: config.get<number>('listen.port') |
d16b5172 | 84 | }, |
e861452f | 85 | DATABASE: { |
65fcc311 C |
86 | DBNAME: 'peertube' + config.get<string>('database.suffix'), |
87 | HOSTNAME: config.get<string>('database.hostname'), | |
88 | PORT: config.get<number>('database.port'), | |
89 | USERNAME: config.get<string>('database.username'), | |
90 | PASSWORD: config.get<string>('database.password') | |
e861452f | 91 | }, |
e861452f | 92 | STORAGE: { |
2295ce6c | 93 | AVATARS_DIR: join(root(), config.get<string>('storage.avatars')), |
e02643f3 C |
94 | LOG_DIR: join(root(), config.get<string>('storage.logs')), |
95 | VIDEOS_DIR: join(root(), config.get<string>('storage.videos')), | |
96 | THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')), | |
97 | PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')), | |
f981dae8 C |
98 | TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')), |
99 | CACHE_DIR: join(root(), config.get<string>('storage.cache')) | |
e861452f C |
100 | }, |
101 | WEBSERVER: { | |
65fcc311 C |
102 | SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http', |
103 | WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws', | |
104 | HOSTNAME: config.get<string>('webserver.hostname'), | |
105 | PORT: config.get<number>('webserver.port'), | |
106 | URL: '', | |
107 | HOST: '' | |
4793c343 C |
108 | }, |
109 | ADMIN: { | |
65fcc311 | 110 | EMAIL: config.get<string>('admin.email') |
e22528ac C |
111 | }, |
112 | SIGNUP: { | |
291e8d3e | 113 | ENABLED: config.get<boolean>('signup.enabled'), |
980246ea | 114 | LIMIT: config.get<number>('signup.limit') |
b0f9f39e C |
115 | }, |
116 | USER: { | |
117 | VIDEO_QUOTA: config.get<number>('user.video_quota') | |
227d02fe C |
118 | }, |
119 | TRANSCODING: { | |
65fcc311 | 120 | ENABLED: config.get<boolean>('transcoding.enabled'), |
40298b02 C |
121 | THREADS: config.get<number>('transcoding.threads'), |
122 | RESOLUTIONS: { | |
123 | '240' : config.get<boolean>('transcoding.resolutions.240p'), | |
124 | '360': config.get<boolean>('transcoding.resolutions.360p'), | |
125 | '480': config.get<boolean>('transcoding.resolutions.480p'), | |
126 | '720': config.get<boolean>('transcoding.resolutions.720p'), | |
127 | '1080': config.get<boolean>('transcoding.resolutions.1080p') | |
128 | } | |
f981dae8 C |
129 | }, |
130 | CACHE: { | |
131 | PREVIEWS: { | |
132 | SIZE: config.get<number>('cache.previews.size') | |
133 | } | |
e861452f C |
134 | } |
135 | } | |
e861452f | 136 | |
9f6bae3a C |
137 | // --------------------------------------------------------------------------- |
138 | ||
e4c55619 C |
139 | const CONSTRAINTS_FIELDS = { |
140 | USERS: { | |
141 | USERNAME: { min: 3, max: 20 }, // Length | |
b0f9f39e C |
142 | PASSWORD: { min: 6, max: 255 }, // Length |
143 | VIDEO_QUOTA: { min: -1 } | |
e4c55619 | 144 | }, |
55fa55a9 C |
145 | VIDEO_ABUSES: { |
146 | REASON: { min: 2, max: 300 } // Length | |
147 | }, | |
72c7248b | 148 | VIDEO_CHANNELS: { |
a265f7f3 | 149 | NAME: { min: 3, max: 120 }, // Length |
e34c85e5 C |
150 | DESCRIPTION: { min: 3, max: 250 }, // Length |
151 | URL: { min: 3, max: 2000 } // Length | |
72c7248b | 152 | }, |
e4c55619 | 153 | VIDEOS: { |
a265f7f3 | 154 | NAME: { min: 3, max: 120 }, // Length |
9567011b C |
155 | TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length |
156 | DESCRIPTION: { min: 3, max: 3000 }, // Length | |
feb4bdfd | 157 | EXTNAME: [ '.mp4', '.ogv', '.webm' ], |
0e1dc3e7 | 158 | INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2 |
c60774b0 | 159 | DURATION: { min: 1 }, // Number |
a265f7f3 C |
160 | TAGS: { min: 0, max: 5 }, // Number of total tags |
161 | TAG: { min: 2, max: 30 }, // Length | |
e4c55619 | 162 | THUMBNAIL: { min: 2, max: 30 }, |
e4c87ec2 C |
163 | THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes |
164 | VIEWS: { min: 0 }, | |
165 | LIKES: { min: 0 }, | |
93e1258c | 166 | DISLIKES: { min: 0 }, |
c60774b0 | 167 | FILE_SIZE: { min: 10 }, |
e34c85e5 C |
168 | URL: { min: 3, max: 2000 } // Length |
169 | }, | |
01de67b9 | 170 | ACTORS: { |
e34c85e5 C |
171 | PUBLIC_KEY: { min: 10, max: 5000 }, // Length |
172 | PRIVATE_KEY: { min: 10, max: 5000 }, // Length | |
c5911fd3 C |
173 | URL: { min: 3, max: 2000 }, // Length |
174 | AVATAR: { | |
01de67b9 C |
175 | EXTNAME: [ '.png', '.jpeg', '.jpg' ], |
176 | FILE_SIZE: { | |
177 | max: 2 * 1024 * 1024 // 2MB | |
178 | } | |
c5911fd3 | 179 | } |
e4c87ec2 C |
180 | }, |
181 | VIDEO_EVENTS: { | |
182 | COUNT: { min: 0 } | |
6d852470 | 183 | }, |
bf1f6508 C |
184 | VIDEO_COMMENTS: { |
185 | TEXT: { min: 2, max: 3000 }, // Length | |
6d852470 | 186 | URL: { min: 3, max: 2000 } // Length |
e4c55619 C |
187 | } |
188 | } | |
189 | ||
ee9e7b61 | 190 | const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = { |
d38b8281 C |
191 | LIKE: 'like', |
192 | DISLIKE: 'dislike' | |
193 | } | |
194 | ||
6e07c3de C |
195 | const VIDEO_CATEGORIES = { |
196 | 1: 'Music', | |
197 | 2: 'Films', | |
198 | 3: 'Vehicles', | |
199 | 4: 'Art', | |
200 | 5: 'Sports', | |
201 | 6: 'Travels', | |
202 | 7: 'Gaming', | |
203 | 8: 'People', | |
204 | 9: 'Comedy', | |
205 | 10: 'Entertainment', | |
206 | 11: 'News', | |
40298b02 | 207 | 12: 'How To', |
6e07c3de C |
208 | 13: 'Education', |
209 | 14: 'Activism', | |
210 | 15: 'Science & Technology', | |
211 | 16: 'Animals', | |
212 | 17: 'Kids', | |
213 | 18: 'Food' | |
214 | } | |
215 | ||
6f0c39e2 C |
216 | // See https://creativecommons.org/licenses/?lang=en |
217 | const VIDEO_LICENCES = { | |
218 | 1: 'Attribution', | |
219 | 2: 'Attribution - Share Alike', | |
220 | 3: 'Attribution - No Derivatives', | |
221 | 4: 'Attribution - Non Commercial', | |
222 | 5: 'Attribution - Non Commercial - Share Alike', | |
223 | 6: 'Attribution - Non Commercial - No Derivatives', | |
224 | 7: 'Public Domain Dedication' | |
225 | } | |
226 | ||
3092476e C |
227 | // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin |
228 | const VIDEO_LANGUAGES = { | |
229 | 1: 'English', | |
230 | 2: 'Spanish', | |
231 | 3: 'Mandarin', | |
232 | 4: 'Hindi', | |
233 | 5: 'Arabic', | |
234 | 6: 'Portuguese', | |
235 | 7: 'Bengali', | |
236 | 8: 'Russian', | |
237 | 9: 'Japanese', | |
238 | 10: 'Punjabi', | |
239 | 11: 'German', | |
240 | 12: 'Korean', | |
241 | 13: 'French', | |
40298b02 | 242 | 14: 'Italian' |
3092476e C |
243 | } |
244 | ||
fd45e8f4 C |
245 | const VIDEO_PRIVACIES = { |
246 | [VideoPrivacy.PUBLIC]: 'Public', | |
247 | [VideoPrivacy.UNLISTED]: 'Unlisted', | |
248 | [VideoPrivacy.PRIVATE]: 'Private' | |
249 | } | |
250 | ||
0d0e8dd0 | 251 | const VIDEO_MIMETYPE_EXT = { |
efc32059 C |
252 | 'video/webm': '.webm', |
253 | 'video/ogg': '.ogv', | |
254 | 'video/mp4': '.mp4' | |
0d0e8dd0 C |
255 | } |
256 | ||
c5911fd3 C |
257 | const AVATAR_MIMETYPE_EXT = { |
258 | 'image/png': '.png', | |
259 | 'image/jpg': '.jpg', | |
260 | 'image/jpeg': '.jpg' | |
261 | } | |
262 | ||
9f6bae3a C |
263 | // --------------------------------------------------------------------------- |
264 | ||
50d6de9c | 265 | const SERVER_ACTOR_NAME = 'peertube' |
350e31d6 | 266 | |
e4f97bab | 267 | const ACTIVITY_PUB = { |
1b5b10d1 C |
268 | POTENTIAL_ACCEPT_HEADERS: [ |
269 | 'application/activity+json', | |
270 | 'application/ld+json' | |
165cdc75 | 271 | ], |
1b5b10d1 | 272 | ACCEPT_HEADER: 'application/activity+json, application/ld+json', |
9a27cdc2 | 273 | PUBLIC: 'https://www.w3.org/ns/activitystreams#Public', |
0d0e8dd0 | 274 | COLLECTION_ITEMS_PER_PAGE: 10, |
c986175d | 275 | FETCH_PAGE_LIMIT: 100, |
0032ebe9 | 276 | MAX_HTTP_ATTEMPT: 5, |
20494f12 C |
277 | URL_MIME_TYPES: { |
278 | VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT | |
279 | TORRENT: [ 'application/x-bittorrent' ], | |
280 | MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ] | |
a5625b41 C |
281 | }, |
282 | ACTOR_REFRESH_INTERVAL: 3600 * 24 // 1 day | |
e4f97bab C |
283 | } |
284 | ||
50d6de9c C |
285 | const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = { |
286 | GROUP: 'Group', | |
287 | PERSON: 'Person', | |
288 | APPLICATION: 'Application' | |
289 | } | |
290 | ||
9f6bae3a C |
291 | // --------------------------------------------------------------------------- |
292 | ||
e4f97bab | 293 | const PRIVATE_RSA_KEY_SIZE = 2048 |
bdfbd4f1 | 294 | |
9f6bae3a C |
295 | // Password encryption |
296 | const BCRYPT_SALT_SIZE = 10 | |
a877d5ac | 297 | |
bdfbd4f1 C |
298 | // --------------------------------------------------------------------------- |
299 | ||
052937db C |
300 | // Express static paths (router) |
301 | const STATIC_PATHS = { | |
f285faa0 C |
302 | PREVIEWS: '/static/previews/', |
303 | THUMBNAILS: '/static/thumbnails/', | |
052937db | 304 | TORRENTS: '/static/torrents/', |
c5911fd3 C |
305 | WEBSEED: '/static/webseed/', |
306 | AVATARS: '/static/avatars/' | |
052937db C |
307 | } |
308 | ||
dc009132 C |
309 | // Cache control |
310 | let STATIC_MAX_AGE = '30d' | |
311 | ||
cbe2f7c3 | 312 | // Videos thumbnail size |
d8755eed C |
313 | const THUMBNAILS_SIZE = { |
314 | width: 200, | |
315 | height: 110 | |
316 | } | |
317 | const PREVIEWS_SIZE = { | |
164174a6 C |
318 | width: 560, |
319 | height: 315 | |
320 | } | |
e8e12200 C |
321 | const AVATARS_SIZE = { |
322 | width: 120, | |
323 | height: 120 | |
324 | } | |
164174a6 C |
325 | |
326 | const EMBED_SIZE = { | |
327 | width: 560, | |
328 | height: 315 | |
d8755eed | 329 | } |
cbe2f7c3 | 330 | |
980246ea | 331 | // Sub folders of cache directory |
f981dae8 C |
332 | const CACHE = { |
333 | DIRECTORIES: { | |
334 | PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews') | |
335 | } | |
336 | } | |
337 | ||
e12a0092 | 338 | const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS) |
4f491371 | 339 | |
bdfbd4f1 C |
340 | // --------------------------------------------------------------------------- |
341 | ||
d8755eed | 342 | const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->' |
709756b8 C |
343 | |
344 | // --------------------------------------------------------------------------- | |
345 | ||
9f10b292 C |
346 | // Special constants for a test instance |
347 | if (isTestInstance() === true) { | |
c60774b0 | 348 | SERVERS_SCORE.BASE = 20 |
0f91ae62 | 349 | JOBS_FETCHING_INTERVAL = 1000 |
f285faa0 C |
350 | REMOTE_SCHEME.HTTP = 'http' |
351 | REMOTE_SCHEME.WS = 'ws' | |
65fcc311 | 352 | STATIC_MAX_AGE = '0' |
c46edbc2 | 353 | ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2 |
a5625b41 | 354 | ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 60 // 1 minute |
01de67b9 | 355 | CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB |
9f10b292 C |
356 | } |
357 | ||
225a89c2 C |
358 | CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT) |
359 | CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP) | |
360 | ||
9f10b292 C |
361 | // --------------------------------------------------------------------------- |
362 | ||
65fcc311 | 363 | export { |
9f6bae3a | 364 | API_VERSION, |
e8e12200 | 365 | AVATARS_SIZE, |
4f491371 | 366 | ACCEPT_HEADERS, |
9f6bae3a | 367 | BCRYPT_SALT_SIZE, |
f981dae8 | 368 | CACHE, |
9f6bae3a C |
369 | CONFIG, |
370 | CONSTRAINTS_FIELDS, | |
164174a6 | 371 | EMBED_SIZE, |
227d02fe | 372 | JOB_STATES, |
227d02fe | 373 | JOBS_FETCH_LIMIT_PER_CYCLE, |
709756b8 | 374 | JOBS_FETCHING_INTERVAL, |
e4f97bab | 375 | JOB_CATEGORIES, |
b769007f | 376 | LAST_MIGRATION_VERSION, |
9f6bae3a | 377 | OAUTH_LIFETIME, |
d8755eed | 378 | OPENGRAPH_AND_OEMBED_COMMENT, |
9f6bae3a | 379 | PAGINATION_COUNT_DEFAULT, |
60862425 | 380 | SERVERS_SCORE, |
f285faa0 C |
381 | PREVIEWS_SIZE, |
382 | REMOTE_SCHEME, | |
7a7724e6 | 383 | FOLLOW_STATES, |
50d6de9c | 384 | SERVER_ACTOR_NAME, |
e4f97bab | 385 | PRIVATE_RSA_KEY_SIZE, |
9f6bae3a | 386 | SORTABLE_COLUMNS, |
dc009132 | 387 | STATIC_MAX_AGE, |
a6375e69 | 388 | STATIC_PATHS, |
e4f97bab | 389 | ACTIVITY_PUB, |
50d6de9c | 390 | ACTIVITY_PUB_ACTOR_TYPES, |
9f6bae3a | 391 | THUMBNAILS_SIZE, |
6e07c3de | 392 | VIDEO_CATEGORIES, |
3092476e | 393 | VIDEO_LANGUAGES, |
fd45e8f4 | 394 | VIDEO_PRIVACIES, |
6f0c39e2 | 395 | VIDEO_LICENCES, |
0d0e8dd0 | 396 | VIDEO_RATE_TYPES, |
c5911fd3 C |
397 | VIDEO_MIMETYPE_EXT, |
398 | AVATAR_MIMETYPE_EXT | |
9f10b292 | 399 | } |