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