]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
WIP plugins: add theme support
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
CommitLineData
6dd9de95 1import { join } from 'path'
536598cf 2import { JobType, VideoRateType, VideoResolution, VideoState } from '../../shared/models'
50d6de9c 3import { ActivityPubActorType } from '../../shared/models/activitypub'
225a89c2 4import { FollowState } from '../../shared/models/actors'
edb4ffc7 5import { VideoAbuseState, VideoImportState, VideoPrivacy, VideoTranscodingFPS } from '../../shared/models/videos'
e02643f3 6// Do not use barrels, remain constants as independent as possible
536598cf 7import { isTestInstance, sanitizeHost, sanitizeUrl, root } from '../helpers/core-utils'
0883b324 8import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
28be8916 9import { invert } from 'lodash'
6b616860 10import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
418d092a 11import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
df0b219d 12import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
6dd9de95 13import { CONFIG, registerConfigChangedHandler } from './config'
ee9e7b61 14
9f6bae3a
C
15// ---------------------------------------------------------------------------
16
7cd4d2ba 17const LAST_MIGRATION_VERSION = 400
5804c0db
C
18
19// ---------------------------------------------------------------------------
20
9f6bae3a 21// API version
f0f5567b 22const API_VERSION = 'v1'
9f10b292 23
1194e8b4
C
24const PAGINATION = {
25 COUNT: {
26 DEFAULT: 15,
27 MAX: 100
28 }
29}
9f6bae3a 30
6dd9de95
C
31const WEBSERVER = {
32 URL: '',
33 HOST: '',
34 SCHEME: '',
35 WS: '',
36 HOSTNAME: '',
37 PORT: 0
38}
39
9f6bae3a
C
40// Sortable columns per schema
41const SORTABLE_COLUMNS = {
9c2c18f3 42 USERS: [ 'id', 'username', 'createdAt' ],
06a05d5f 43 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
265ba139 44 ACCOUNTS: [ 'createdAt' ],
94a5ff8a 45 JOBS: [ 'createdAt' ],
26b7305a 46 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
72c7248b 47 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
ed31c059 48 VIDEO_IMPORTS: [ 'createdAt' ],
bf1f6508 49 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
c100a614 50 VIDEO_RATES: [ 'createdAt' ],
7a7724e6
C
51 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
52 FOLLOWERS: [ 'createdAt' ],
57c36b27
C
53 FOLLOWING: [ 'createdAt' ],
54
9a629c6e
C
55 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
56
57 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
7ad9b984
C
58 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
59
60 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
cef534ed
C
61 SERVERS_BLOCKLIST: [ 'createdAt' ],
62
418d092a
C
63 USER_NOTIFICATIONS: [ 'createdAt' ],
64
f0a39880 65 VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ]
9f6bae3a 66}
9f10b292 67
2f372a86 68const OAUTH_LIFETIME = {
ff193d5e 69 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
2f372a86
C
70 REFRESH_TOKEN: 1209600 // 2 weeks
71}
72
fd4484f1 73const ROUTE_CACHE_LIFETIME = {
3f6d68d9
RK
74 FEEDS: '15 minutes',
75 ROBOTS: '2 hours',
2feebf3e 76 SITEMAP: '1 day',
5447516b 77 SECURITYTXT: '2 hours',
3f6d68d9 78 NODEINFO: '10 minutes',
aad0ec24 79 DNT_POLICY: '1 week',
2d3741d6
C
80 OVERVIEWS: {
81 VIDEOS: '1 hour'
82 },
fd4484f1 83 ACTIVITY_PUB: {
3f6d68d9 84 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
4b5384f6
C
85 },
86 STATS: '4 hours'
fd4484f1
C
87}
88
9f6bae3a 89// ---------------------------------------------------------------------------
26d7d31b 90
60650c77
C
91// Number of points we add/remove after a successful/bad request
92const ACTOR_FOLLOW_SCORE = {
225a89c2
C
93 PENALTY: -10,
94 BONUS: 10,
60650c77
C
95 BASE: 1000,
96 MAX: 10000
225a89c2
C
97}
98
99const FOLLOW_STATES: { [ id: string ]: FollowState } = {
100 PENDING: 'pending',
101 ACCEPTED: 'accepted'
102}
103
104const REMOTE_SCHEME = {
105 HTTP: 'https',
106 WS: 'wss'
107}
108
a0327eed 109// TODO: remove 'video-file'
6dd9de95 110const JOB_ATTEMPTS: { [id in (JobType | 'video-file')]: number } = {
94a5ff8a
C
111 'activitypub-http-broadcast': 5,
112 'activitypub-http-unicast': 5,
113 'activitypub-http-fetcher': 5,
5350fd8e 114 'activitypub-follow': 5,
0138af92 115 'video-file-import': 1,
a0327eed 116 'video-transcoding': 1,
ecb4e35f 117 'video-file': 1,
fbad87b0 118 'video-import': 1,
6b616860 119 'email': 5,
04b8c3fb
C
120 'videos-views': 1,
121 'activitypub-refresher': 1
225a89c2 122}
6dd9de95 123const JOB_CONCURRENCY: { [id in (JobType | 'video-file')]: number } = {
94a5ff8a
C
124 'activitypub-http-broadcast': 1,
125 'activitypub-http-unicast': 5,
126 'activitypub-http-fetcher': 1,
5350fd8e 127 'activitypub-follow': 3,
0138af92 128 'video-file-import': 1,
a0327eed 129 'video-transcoding': 1,
ecb4e35f 130 'video-file': 1,
fbad87b0 131 'video-import': 1,
6b616860 132 'email': 5,
04b8c3fb
C
133 'videos-views': 1,
134 'activitypub-refresher': 1
225a89c2 135}
6dd9de95 136const JOB_TTL: { [id in (JobType | 'video-file')]: number } = {
2b86fe72
C
137 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
138 'activitypub-http-unicast': 60000 * 10, // 10 minutes
139 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
140 'activitypub-follow': 60000 * 10, // 10 minutes
141 'video-file-import': 1000 * 3600, // 1 hour
a0327eed 142 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
2b86fe72 143 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
cf9166cf 144 'video-import': 1000 * 3600 * 2, // hours
6b616860 145 'email': 60000 * 10, // 10 minutes
04b8c3fb
C
146 'videos-views': undefined, // Unlimited
147 'activitypub-refresher': 60000 * 10 // 10 minutes
2b86fe72 148}
6b616860
C
149const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
150 'videos-views': {
04b8c3fb 151 cron: '1 * * * *' // At 1 minute past the hour
6b616860
C
152 }
153}
154
71e3dfda 155const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
240085d0 156const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
71e3dfda 157const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
71e3dfda 158const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
cf9166cf 159const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
225a89c2 160
8f0bc73d 161const SCHEDULER_INTERVALS_MS = {
2f5c6b2f 162 actorFollowScores: 60000 * 60, // 1 hour
bbe0f064 163 removeOldJobs: 60000 * 60, // 1 hour
ce32426b 164 updateVideos: 60000, // 1 minute
8f0bc73d 165 youtubeDLUpdate: 60000 * 60 * 24, // 1 day
cda03765 166 removeOldViews: 60000 * 60 * 24, // 1 day
8f0bc73d 167 removeOldHistory: 60000 * 60 * 24 // 1 day
2baea0c7 168}
60650c77 169
225a89c2
C
170// ---------------------------------------------------------------------------
171
14e2014a 172let CONSTRAINTS_FIELDS = {
e4c55619 173 USERS: {
9f7a1953 174 NAME: { min: 1, max: 120 }, // Length
d23e6a1c 175 DESCRIPTION: { min: 3, max: 1000 }, // Length
d0ce42c1 176 USERNAME: { min: 1, max: 50 }, // Length
b0f9f39e 177 PASSWORD: { min: 6, max: 255 }, // Length
eacb25c4 178 VIDEO_QUOTA: { min: -1 },
bee0abff 179 VIDEO_QUOTA_DAILY: { min: -1 },
3caf77d3 180 VIDEO_LANGUAGES: { max: 500 }, // Array length
eacb25c4 181 BLOCKED_REASON: { min: 3, max: 250 } // Length
e4c55619 182 },
55fa55a9 183 VIDEO_ABUSES: {
1506307f
C
184 REASON: { min: 2, max: 3000 }, // Length
185 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
55fa55a9 186 },
26b7305a
C
187 VIDEO_BLACKLIST: {
188 REASON: { min: 2, max: 300 } // Length
189 },
72c7248b 190 VIDEO_CHANNELS: {
9f7a1953 191 NAME: { min: 1, max: 120 }, // Length
d23e6a1c
BY
192 DESCRIPTION: { min: 3, max: 1000 }, // Length
193 SUPPORT: { min: 3, max: 1000 }, // Length
e34c85e5 194 URL: { min: 3, max: 2000 } // Length
72c7248b 195 },
40e87e9e
C
196 VIDEO_CAPTIONS: {
197 CAPTION_FILE: {
f4001cf4 198 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e
C
199 FILE_SIZE: {
200 max: 2 * 1024 * 1024 // 2MB
201 }
202 }
203 },
fbad87b0 204 VIDEO_IMPORTS: {
ce33919c
C
205 URL: { min: 3, max: 2000 }, // Length
206 TORRENT_NAME: { min: 3, max: 255 }, // Length
990b6a0b
C
207 TORRENT_FILE: {
208 EXTNAME: [ '.torrent' ],
209 FILE_SIZE: {
210 max: 1024 * 200 // 200 KB
211 }
212 }
fbad87b0 213 },
c48e82b5
C
214 VIDEOS_REDUNDANCY: {
215 URL: { min: 3, max: 2000 } // Length
216 },
5c6d985f
C
217 VIDEO_RATES: {
218 URL: { min: 3, max: 2000 } // Length
219 },
e4c55619 220 VIDEOS: {
a265f7f3 221 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 222 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 223 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 224 DESCRIPTION: { min: 3, max: 10000 }, // Length
d23e6a1c 225 SUPPORT: { min: 3, max: 1000 }, // Length
ac81d1a0
C
226 IMAGE: {
227 EXTNAME: [ '.jpg', '.jpeg' ],
228 FILE_SIZE: {
229 max: 2 * 1024 * 1024 // 2MB
230 }
231 },
536598cf 232 EXTNAME: [] as string[],
0e1dc3e7 233 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 234 DURATION: { min: 0 }, // Number
a265f7f3
C
235 TAGS: { min: 0, max: 5 }, // Number of total tags
236 TAG: { min: 2, max: 30 }, // Length
e4c55619 237 THUMBNAIL: { min: 2, max: 30 },
e4c87ec2
C
238 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
239 VIEWS: { min: 0 },
240 LIKES: { min: 0 },
93e1258c 241 DISLIKES: { min: 0 },
c60774b0 242 FILE_SIZE: { min: 10 },
e34c85e5
C
243 URL: { min: 3, max: 2000 } // Length
244 },
418d092a
C
245 VIDEO_PLAYLISTS: {
246 NAME: { min: 1, max: 120 }, // Length
247 DESCRIPTION: { min: 3, max: 1000 }, // Length
248 URL: { min: 3, max: 2000 }, // Length
249 IMAGE: {
250 EXTNAME: [ '.jpg', '.jpeg' ],
251 FILE_SIZE: {
252 max: 2 * 1024 * 1024 // 2MB
253 }
254 }
255 },
01de67b9 256 ACTORS: {
e34c85e5
C
257 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
258 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3
C
259 URL: { min: 3, max: 2000 }, // Length
260 AVATAR: {
01de67b9
C
261 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
262 FILE_SIZE: {
263 max: 2 * 1024 * 1024 // 2MB
264 }
c5911fd3 265 }
e4c87ec2
C
266 },
267 VIDEO_EVENTS: {
268 COUNT: { min: 0 }
6d852470 269 },
bf1f6508 270 VIDEO_COMMENTS: {
b32b7827 271 TEXT: { min: 1, max: 3000 }, // Length
6d852470 272 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
273 },
274 VIDEO_SHARE: {
275 URL: { min: 3, max: 2000 } // Length
a4101923
C
276 },
277 CONTACT_FORM: {
278 FROM_NAME: { min: 1, max: 120 }, // Length
279 BODY: { min: 3, max: 5000 } // Length
345da516
C
280 },
281 PLUGINS: {
282 NAME: { min: 1, max: 214 }, // Length
283 DESCRIPTION: { min: 1, max: 20000 } // Length
e4c55619
C
284 }
285}
286
b5c0e955 287let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
a4101923
C
288let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
289
edb4ffc7 290const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
a7977280 291 MIN: 10,
3a6f351b
C
292 AVERAGE: 30,
293 MAX: 60,
294 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 295}
b5c0e955 296
536598cf
C
297const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
298
ee9e7b61 299const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
300 LIKE: 'like',
301 DISLIKE: 'dislike'
302}
303
80bc88c1
J
304const FFMPEG_NICE: { [ id: string ]: number } = {
305 THUMBNAIL: 2, // 2 just for don't blocking servers
306 TRANSCODING: 15
307}
308
6e07c3de
C
309const VIDEO_CATEGORIES = {
310 1: 'Music',
311 2: 'Films',
312 3: 'Vehicles',
313 4: 'Art',
314 5: 'Sports',
315 6: 'Travels',
316 7: 'Gaming',
317 8: 'People',
318 9: 'Comedy',
319 10: 'Entertainment',
6f2ae7a1 320 11: 'News & Politics',
40298b02 321 12: 'How To',
6e07c3de
C
322 13: 'Education',
323 14: 'Activism',
324 15: 'Science & Technology',
325 16: 'Animals',
326 17: 'Kids',
327 18: 'Food'
328}
329
6f0c39e2
C
330// See https://creativecommons.org/licenses/?lang=en
331const VIDEO_LICENCES = {
332 1: 'Attribution',
333 2: 'Attribution - Share Alike',
334 3: 'Attribution - No Derivatives',
335 4: 'Attribution - Non Commercial',
336 5: 'Attribution - Non Commercial - Share Alike',
337 6: 'Attribution - Non Commercial - No Derivatives',
338 7: 'Public Domain Dedication'
339}
340
74dc3bca 341let VIDEO_LANGUAGES: { [id: string]: string } = {}
3092476e 342
fd45e8f4 343const VIDEO_PRIVACIES = {
6dd9de95
C
344 [ VideoPrivacy.PUBLIC ]: 'Public',
345 [ VideoPrivacy.UNLISTED ]: 'Unlisted',
346 [ VideoPrivacy.PRIVATE ]: 'Private'
fd45e8f4
C
347}
348
2186386c 349const VIDEO_STATES = {
6dd9de95
C
350 [ VideoState.PUBLISHED ]: 'Published',
351 [ VideoState.TO_TRANSCODE ]: 'To transcode',
352 [ VideoState.TO_IMPORT ]: 'To import'
fbad87b0
C
353}
354
355const VIDEO_IMPORT_STATES = {
6dd9de95
C
356 [ VideoImportState.FAILED ]: 'Failed',
357 [ VideoImportState.PENDING ]: 'Pending',
358 [ VideoImportState.SUCCESS ]: 'Success'
2186386c
C
359}
360
268eebed 361const VIDEO_ABUSE_STATES = {
6dd9de95
C
362 [ VideoAbuseState.PENDING ]: 'Pending',
363 [ VideoAbuseState.REJECTED ]: 'Rejected',
364 [ VideoAbuseState.ACCEPTED ]: 'Accepted'
268eebed
C
365}
366
418d092a 367const VIDEO_PLAYLIST_PRIVACIES = {
6dd9de95
C
368 [ VideoPlaylistPrivacy.PUBLIC ]: 'Public',
369 [ VideoPlaylistPrivacy.UNLISTED ]: 'Unlisted',
370 [ VideoPlaylistPrivacy.PRIVATE ]: 'Private'
418d092a
C
371}
372
df0b219d 373const VIDEO_PLAYLIST_TYPES = {
6dd9de95
C
374 [ VideoPlaylistType.REGULAR ]: 'Regular',
375 [ VideoPlaylistType.WATCH_LATER ]: 'Watch later'
df0b219d
C
376}
377
14e2014a 378const MIMETYPES = {
536598cf
C
379 AUDIO: {
380 MIMETYPE_EXT: {
381 'audio/mpeg': '.mp3',
382 'audio/mp3': '.mp3',
383 'application/ogg': '.ogg',
384 'audio/ogg': '.ogg',
385 'audio/flac': '.flac'
386 },
387 EXT_MIMETYPE: null as { [ id: string ]: string }
388 },
14e2014a 389 VIDEO: {
536598cf 390 MIMETYPE_EXT: null as { [ id: string ]: string },
14e2014a
C
391 EXT_MIMETYPE: null as { [ id: string ]: string }
392 },
393 IMAGE: {
394 MIMETYPE_EXT: {
395 'image/png': '.png',
396 'image/jpg': '.jpg',
397 'image/jpeg': '.jpg'
398 }
399 },
400 VIDEO_CAPTIONS: {
401 MIMETYPE_EXT: {
402 'text/vtt': '.vtt',
403 'application/x-subrip': '.srt'
404 }
405 },
406 TORRENT: {
407 MIMETYPE_EXT: {
408 'application/x-bittorrent': '.torrent'
409 }
410 }
990b6a0b 411}
536598cf 412MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
990b6a0b 413
9f6bae3a
C
414// ---------------------------------------------------------------------------
415
2d3741d6
C
416const OVERVIEWS = {
417 VIDEOS: {
1a471091 418 SAMPLE_THRESHOLD: 6,
2d3741d6
C
419 SAMPLES_COUNT: 2
420 }
421}
422
423// ---------------------------------------------------------------------------
424
50d6de9c 425const SERVER_ACTOR_NAME = 'peertube'
350e31d6 426
e4f97bab 427const ACTIVITY_PUB = {
1b5b10d1
C
428 POTENTIAL_ACCEPT_HEADERS: [
429 'application/activity+json',
9a8cbd82
C
430 'application/ld+json',
431 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 432 ],
1b5b10d1 433 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 434 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 435 COLLECTION_ITEMS_PER_PAGE: 10,
c986175d 436 FETCH_PAGE_LIMIT: 100,
20494f12 437 URL_MIME_TYPES: {
536598cf 438 VIDEO: [] as string[],
20494f12
C
439 TORRENT: [ 'application/x-bittorrent' ],
440 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 441 },
2ccaeeb3 442 MAX_RECURSION_COMMENTS: 100,
0e0c745b 443 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
9f79ade6
C
444 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
445 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
e4f97bab
C
446}
447
50d6de9c
C
448const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
449 GROUP: 'Group',
450 PERSON: 'Person',
451 APPLICATION: 'Application'
452}
453
41f2ebae
C
454const HTTP_SIGNATURE = {
455 HEADER_NAME: 'signature',
456 ALGORITHM: 'rsa-sha256',
df66d815 457 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
41f2ebae
C
458}
459
9f6bae3a
C
460// ---------------------------------------------------------------------------
461
04b8c3fb 462let PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 463
9f6bae3a
C
464// Password encryption
465const BCRYPT_SALT_SIZE = 10
a877d5ac 466
ecb4e35f
C
467const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
468
d9eaee39
JM
469const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
470
6dd9de95 471const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
0883b324
C
472 DO_NOT_LIST: 'do_not_list',
473 BLUR: 'blur',
474 DISPLAY: 'display'
475}
476
bdfbd4f1
C
477// ---------------------------------------------------------------------------
478
052937db
C
479// Express static paths (router)
480const STATIC_PATHS = {
f285faa0
C
481 PREVIEWS: '/static/previews/',
482 THUMBNAILS: '/static/thumbnails/',
052937db 483 TORRENTS: '/static/torrents/',
c5911fd3 484 WEBSEED: '/static/webseed/',
b9fffa29 485 REDUNDANCY: '/static/redundancy/',
9c6ca37f
C
486 STREAMING_PLAYLISTS: {
487 HLS: '/static/streaming-playlists/hls'
09209296 488 },
40e87e9e
C
489 AVATARS: '/static/avatars/',
490 VIDEO_CAPTIONS: '/static/video-captions/'
052937db 491}
02756fbd
C
492const STATIC_DOWNLOAD_PATHS = {
493 TORRENTS: '/download/torrents/',
494 VIDEOS: '/download/videos/'
495}
052937db 496
dc009132 497// Cache control
57a81ff6 498let STATIC_MAX_AGE = '2h'
dc009132 499
cbe2f7c3 500// Videos thumbnail size
d8755eed 501const THUMBNAILS_SIZE = {
e5fc7811 502 width: 223,
830b4faf 503 height: 122
d8755eed
C
504}
505const PREVIEWS_SIZE = {
b345a804
C
506 width: 850,
507 height: 480
164174a6 508}
e8e12200
C
509const AVATARS_SIZE = {
510 width: 120,
511 height: 120
512}
164174a6
C
513
514const EMBED_SIZE = {
515 width: 560,
516 height: 315
d8755eed 517}
cbe2f7c3 518
980246ea 519// Sub folders of cache directory
d74d29ad 520const FILES_CACHE = {
f4001cf4
C
521 PREVIEWS: {
522 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
523 MAX_AGE: 1000 * 3600 * 3 // 3 hours
524 },
525 VIDEO_CAPTIONS: {
526 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
527 MAX_AGE: 1000 * 3600 * 3 // 3 hours
f981dae8
C
528 }
529}
530
d74d29ad
C
531const CACHE = {
532 USER_TOKENS: {
533 MAX_SIZE: 10000
534 }
535}
536
9c6ca37f 537const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
09209296
C
538const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
539
7348b1fd
C
540const MEMOIZE_TTL = {
541 OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
542}
543
c48e82b5
C
544const REDUNDANCY = {
545 VIDEOS: {
c48e82b5
C
546 RANDOMIZED_FACTOR: 5
547 }
548}
549
e12a0092 550const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
4f491371 551
536598cf
C
552const ASSETS_PATH = {
553 DEFAULT_AUDIO_BACKGROUND: join(root(), 'server', 'assets', 'default-audio-background.jpg')
554}
555
bdfbd4f1
C
556// ---------------------------------------------------------------------------
557
e032aec9
C
558const CUSTOM_HTML_TAG_COMMENTS = {
559 TITLE: '<!-- title tag -->',
560 DESCRIPTION: '<!-- description tag -->',
561 CUSTOM_CSS: '<!-- custom css tag -->',
92bf2f62 562 META_TAGS: '<!-- meta tags -->'
e032aec9 563}
709756b8
C
564
565// ---------------------------------------------------------------------------
566
4195cd2b 567const FEEDS = {
fd4484f1 568 COUNT: 20
4195cd2b
C
569}
570
fd8710b8
C
571const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
572
4195cd2b
C
573// ---------------------------------------------------------------------------
574
9b67da3d
C
575const TRACKER_RATE_LIMITS = {
576 INTERVAL: 60000 * 5, // 5 minutes
8244c85a 577 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
9b67da3d
C
578 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
579}
580
ae9bbed4
C
581const P2P_MEDIA_LOADER_PEER_VERSION = 2
582
9b67da3d
C
583// ---------------------------------------------------------------------------
584
345da516
C
585const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
586const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
587
7cd4d2ba
C
588const DEFAULT_THEME = 'default'
589
345da516
C
590// ---------------------------------------------------------------------------
591
9f10b292
C
592// Special constants for a test instance
593if (isTestInstance() === true) {
04b8c3fb
C
594 PRIVATE_RSA_KEY_SIZE = 1024
595
60650c77 596 ACTOR_FOLLOW_SCORE.BASE = 20
3cd0734f 597
f285faa0
C
598 REMOTE_SCHEME.HTTP = 'http'
599 REMOTE_SCHEME.WS = 'ws'
3cd0734f 600
65fcc311 601 STATIC_MAX_AGE = '0'
3cd0734f 602
c46edbc2 603 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
7bc29171 604 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1297eb5d 605 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
9f79ade6 606 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
3cd0734f 607
01de67b9 608 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
3cd0734f 609
2f5c6b2f 610 SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
2baea0c7 611 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
8f0bc73d 612 SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
cda03765 613 SCHEDULER_INTERVALS_MS.removeOldViews = 5000
2baea0c7 614 SCHEDULER_INTERVALS_MS.updateVideos = 5000
6dd9de95 615 REPEAT_JOBS[ 'videos-views' ] = { every: 5000 }
2baea0c7 616
c48e82b5
C
617 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
618
b5c0e955 619 VIDEO_VIEW_LIFETIME = 1000 // 1 second
a4101923 620 CONTACT_FORM_LIFETIME = 1000 // 1 second
3cd0734f 621
6dd9de95 622 JOB_ATTEMPTS[ 'email' ] = 1
f4001cf4 623
d74d29ad 624 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
743164fe 625 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
c07b6041 626 ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
9f10b292
C
627}
628
14e2014a 629updateWebserverUrls()
536598cf 630updateWebserverConfig()
225a89c2 631
6dd9de95
C
632registerConfigChangedHandler(() => {
633 updateWebserverUrls()
634 updateWebserverConfig()
635})
636
9f10b292
C
637// ---------------------------------------------------------------------------
638
65fcc311 639export {
6dd9de95 640 WEBSERVER,
9f6bae3a 641 API_VERSION,
09209296 642 HLS_REDUNDANCY_DIRECTORY,
ae9bbed4 643 P2P_MEDIA_LOADER_PEER_VERSION,
e8e12200 644 AVATARS_SIZE,
4f491371 645 ACCEPT_HEADERS,
9f6bae3a 646 BCRYPT_SALT_SIZE,
9b67da3d 647 TRACKER_RATE_LIMITS,
d74d29ad 648 FILES_CACHE,
9f6bae3a 649 CONSTRAINTS_FIELDS,
164174a6 650 EMBED_SIZE,
c48e82b5 651 REDUNDANCY,
94a5ff8a
C
652 JOB_CONCURRENCY,
653 JOB_ATTEMPTS,
b769007f 654 LAST_MIGRATION_VERSION,
9f6bae3a 655 OAUTH_LIFETIME,
e032aec9 656 CUSTOM_HTML_TAG_COMMENTS,
f55e5a7b 657 BROADCAST_CONCURRENCY,
1194e8b4 658 PAGINATION,
60650c77 659 ACTOR_FOLLOW_SCORE,
f285faa0
C
660 PREVIEWS_SIZE,
661 REMOTE_SCHEME,
7a7724e6 662 FOLLOW_STATES,
50d6de9c 663 SERVER_ACTOR_NAME,
345da516
C
664 PLUGIN_GLOBAL_CSS_FILE_NAME,
665 PLUGIN_GLOBAL_CSS_PATH,
e4f97bab 666 PRIVATE_RSA_KEY_SIZE,
fd4484f1 667 ROUTE_CACHE_LIFETIME,
9f6bae3a 668 SORTABLE_COLUMNS,
9c6ca37f 669 HLS_STREAMING_PLAYLIST_DIRECTORY,
4195cd2b 670 FEEDS,
2b86fe72 671 JOB_TTL,
7cd4d2ba 672 DEFAULT_THEME,
0883b324 673 NSFW_POLICY_TYPES,
dc009132 674 STATIC_MAX_AGE,
a6375e69 675 STATIC_PATHS,
cf9166cf 676 VIDEO_IMPORT_TIMEOUT,
df0b219d 677 VIDEO_PLAYLIST_TYPES,
fd8710b8 678 MAX_LOGS_OUTPUT_CHARACTERS,
e4f97bab 679 ACTIVITY_PUB,
50d6de9c 680 ACTIVITY_PUB_ACTOR_TYPES,
9f6bae3a 681 THUMBNAILS_SIZE,
6e07c3de 682 VIDEO_CATEGORIES,
3092476e 683 VIDEO_LANGUAGES,
fd45e8f4 684 VIDEO_PRIVACIES,
6f0c39e2 685 VIDEO_LICENCES,
2186386c 686 VIDEO_STATES,
0d0e8dd0 687 VIDEO_RATE_TYPES,
a7977280 688 VIDEO_TRANSCODING_FPS,
80bc88c1 689 FFMPEG_NICE,
268eebed 690 VIDEO_ABUSE_STATES,
d74d29ad 691 CACHE,
71e3dfda 692 JOB_REQUEST_TIMEOUT,
ecb4e35f 693 USER_PASSWORD_RESET_LIFETIME,
7348b1fd 694 MEMOIZE_TTL,
d9eaee39 695 USER_EMAIL_VERIFY_LIFETIME,
2d3741d6 696 OVERVIEWS,
2baea0c7 697 SCHEDULER_INTERVALS_MS,
6b616860 698 REPEAT_JOBS,
02756fbd 699 STATIC_DOWNLOAD_PATHS,
14e2014a 700 MIMETYPES,
f6eebcb3 701 CRAWL_REQUEST_CONCURRENCY,
536598cf 702 DEFAULT_AUDIO_RESOLUTION,
b5c0e955 703 JOB_COMPLETED_LIFETIME,
41f2ebae 704 HTTP_SIGNATURE,
fbad87b0 705 VIDEO_IMPORT_STATES,
7ce44a74 706 VIDEO_VIEW_LIFETIME,
a4101923 707 CONTACT_FORM_LIFETIME,
418d092a 708 VIDEO_PLAYLIST_PRIVACIES,
536598cf 709 ASSETS_PATH,
74dc3bca 710 loadLanguages,
7ce44a74 711 buildLanguages
9f10b292 712}
fd206f0b
C
713
714// ---------------------------------------------------------------------------
715
14e2014a
C
716function buildVideoMimetypeExt () {
717 const data = {
718 'video/webm': '.webm',
719 'video/ogg': '.ogv',
720 'video/mp4': '.mp4'
721 }
722
536598cf
C
723 if (CONFIG.TRANSCODING.ENABLED) {
724 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
725 Object.assign(data, {
726 'video/quicktime': '.mov',
727 'video/x-msvideo': '.avi',
728 'video/x-flv': '.flv',
729 'video/x-matroska': '.mkv',
730 'application/octet-stream': '.mkv',
731 'video/avi': '.avi'
732 })
733 }
734
735 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
736 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
737 }
14e2014a
C
738 }
739
740 return data
741}
742
743function updateWebserverUrls () {
6dd9de95
C
744 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
745 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
746 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
747 WEBSERVER.WS = CONFIG.WEBSERVER.WS
748 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
749 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
fd206f0b
C
750}
751
14e2014a 752function updateWebserverConfig () {
14e2014a
C
753 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
754 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
536598cf
C
755 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
756
757 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
14e2014a
C
758}
759
760function buildVideosExtname () {
536598cf 761 return Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
14e2014a
C
762}
763
74dc3bca 764function loadLanguages () {
8f0bc73d 765 Object.assign(VIDEO_LANGUAGES, buildLanguages())
74dc3bca
C
766}
767
9d3ef9fe
C
768function buildLanguages () {
769 const iso639 = require('iso-639-3')
770
771 const languages: { [ id: string ]: string } = {}
772
1d94c154
C
773 const additionalLanguages = {
774 'sgn': true, // Sign languages (macro language)
775 'ase': true, // American sign language
776 'sdl': true, // Arabian sign language
777 'bfi': true, // British sign language
778 'bzs': true, // Brazilian sign language
779 'csl': true, // Chinese sign language
780 'cse': true, // Czech sign language
781 'dsl': true, // Danish sign language
782 'fsl': true, // French sign language
783 'gsg': true, // German sign language
784 'pks': true, // Pakistan sign language
785 'jsl': true, // Japanese sign language
786 'sfs': true, // South African sign language
787 'swl': true, // Swedish sign language
788 'rsl': true, // Russian sign language: true
789
790 'epo': true, // Esperanto
791 'tlh': true, // Klingon
792 'jbo': true, // Lojban
793 'avk': true // Kotava
794 }
9d3ef9fe
C
795
796 // Only add ISO639-1 languages and some sign languages (ISO639-3)
797 iso639
798 .filter(l => {
799 return (l.iso6391 !== null && l.type === 'living') ||
6dd9de95 800 additionalLanguages[ l.iso6393 ] === true
9d3ef9fe 801 })
6dd9de95 802 .forEach(l => languages[ l.iso6391 || l.iso6393 ] = l.name)
9d3ef9fe 803
db6d617d 804 // Override Occitan label
6dd9de95 805 languages[ 'oc' ] = 'Occitan'
d8cfccfb 806 languages[ 'el' ] = 'Greek'
db6d617d 807
9d3ef9fe
C
808 return languages
809}