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