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