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