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