]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
Create redundancy endpoint
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
CommitLineData
fd206f0b
C
1import { IConfig } from 'config'
2import { dirname, join } from 'path'
3f6b6a56 3import { JobType, VideoRateType, VideoState, VideosRedundancy } 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
0e5ff97f 8import { buildPath, isTestInstance, parseDuration, parseBytes, root, sanitizeHost, sanitizeUrl } 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'
c48e82b5 12import * as bytes from 'bytes'
fd206f0b
C
13
14// Use a variable to reload the configuration if we need
15let config: IConfig = require('config')
ee9e7b61 16
9f6bae3a
C
17// ---------------------------------------------------------------------------
18
5c6d985f 19const LAST_MIGRATION_VERSION = 290
5804c0db
C
20
21// ---------------------------------------------------------------------------
22
9f6bae3a 23// API version
f0f5567b 24const API_VERSION = 'v1'
9f10b292 25
1194e8b4
C
26const PAGINATION = {
27 COUNT: {
28 DEFAULT: 15,
29 MAX: 100
30 }
31}
9f6bae3a 32
9f6bae3a
C
33// Sortable columns per schema
34const SORTABLE_COLUMNS = {
9c2c18f3 35 USERS: [ 'id', 'username', 'createdAt' ],
06a05d5f 36 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
265ba139 37 ACCOUNTS: [ 'createdAt' ],
94a5ff8a 38 JOBS: [ 'createdAt' ],
26b7305a 39 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
72c7248b 40 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
ed31c059 41 VIDEO_IMPORTS: [ 'createdAt' ],
bf1f6508 42 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
7a7724e6
C
43 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
44 FOLLOWERS: [ 'createdAt' ],
57c36b27
C
45 FOLLOWING: [ 'createdAt' ],
46
9a629c6e
C
47 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
48
49 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
7ad9b984
C
50 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
51
52 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
53 SERVERS_BLOCKLIST: [ 'createdAt' ]
9f6bae3a 54}
9f10b292 55
2f372a86 56const OAUTH_LIFETIME = {
ff193d5e 57 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
2f372a86
C
58 REFRESH_TOKEN: 1209600 // 2 weeks
59}
60
fd4484f1 61const ROUTE_CACHE_LIFETIME = {
3f6d68d9
RK
62 FEEDS: '15 minutes',
63 ROBOTS: '2 hours',
5447516b 64 SECURITYTXT: '2 hours',
3f6d68d9 65 NODEINFO: '10 minutes',
aad0ec24 66 DNT_POLICY: '1 week',
2d3741d6
C
67 OVERVIEWS: {
68 VIDEOS: '1 hour'
69 },
fd4484f1 70 ACTIVITY_PUB: {
3f6d68d9 71 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
4b5384f6
C
72 },
73 STATS: '4 hours'
fd4484f1
C
74}
75
9f6bae3a 76// ---------------------------------------------------------------------------
26d7d31b 77
60650c77
C
78// Number of points we add/remove after a successful/bad request
79const ACTOR_FOLLOW_SCORE = {
225a89c2
C
80 PENALTY: -10,
81 BONUS: 10,
60650c77
C
82 BASE: 1000,
83 MAX: 10000
225a89c2
C
84}
85
86const FOLLOW_STATES: { [ id: string ]: FollowState } = {
87 PENDING: 'pending',
88 ACCEPTED: 'accepted'
89}
90
91const REMOTE_SCHEME = {
92 HTTP: 'https',
93 WS: 'wss'
94}
95
94a5ff8a
C
96const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
97 'activitypub-http-broadcast': 5,
98 'activitypub-http-unicast': 5,
99 'activitypub-http-fetcher': 5,
5350fd8e 100 'activitypub-follow': 5,
0138af92 101 'video-file-import': 1,
ecb4e35f 102 'video-file': 1,
fbad87b0 103 'video-import': 1,
6b616860 104 'email': 5,
04b8c3fb
C
105 'videos-views': 1,
106 'activitypub-refresher': 1
225a89c2 107}
94a5ff8a
C
108const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
109 'activitypub-http-broadcast': 1,
110 'activitypub-http-unicast': 5,
111 'activitypub-http-fetcher': 1,
5350fd8e 112 'activitypub-follow': 3,
0138af92 113 'video-file-import': 1,
ecb4e35f 114 'video-file': 1,
fbad87b0 115 'video-import': 1,
6b616860 116 'email': 5,
04b8c3fb
C
117 'videos-views': 1,
118 'activitypub-refresher': 1
225a89c2 119}
2b86fe72
C
120const JOB_TTL: { [ id in JobType ]: number } = {
121 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
122 'activitypub-http-unicast': 60000 * 10, // 10 minutes
123 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
124 'activitypub-follow': 60000 * 10, // 10 minutes
125 'video-file-import': 1000 * 3600, // 1 hour
126 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
cf9166cf 127 'video-import': 1000 * 3600 * 2, // hours
6b616860 128 'email': 60000 * 10, // 10 minutes
04b8c3fb
C
129 'videos-views': undefined, // Unlimited
130 'activitypub-refresher': 60000 * 10 // 10 minutes
2b86fe72 131}
6b616860
C
132const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
133 'videos-views': {
04b8c3fb 134 cron: '1 * * * *' // At 1 minute past the hour
6b616860
C
135 }
136}
137
71e3dfda 138const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
240085d0 139const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
71e3dfda 140const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
71e3dfda 141const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
cf9166cf 142const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
225a89c2 143
60650c77 144// 1 hour
2baea0c7
C
145let SCHEDULER_INTERVALS_MS = {
146 badActorFollow: 60000 * 60, // 1 hour
bbe0f064 147 removeOldJobs: 60000 * 60, // 1 hour
ce32426b 148 updateVideos: 60000, // 1 minute
f9f899b9 149 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
2baea0c7 150}
60650c77 151
225a89c2
C
152// ---------------------------------------------------------------------------
153
e861452f 154const CONFIG = {
fd206f0b 155 CUSTOM_FILE: getLocalConfigFilePath(),
d16b5172 156 LISTEN: {
cff8b272
PAT
157 PORT: config.get<number>('listen.port'),
158 HOSTNAME: config.get<string>('listen.hostname')
d16b5172 159 },
e861452f 160 DATABASE: {
65fcc311
C
161 DBNAME: 'peertube' + config.get<string>('database.suffix'),
162 HOSTNAME: config.get<string>('database.hostname'),
163 PORT: config.get<number>('database.port'),
164 USERNAME: config.get<string>('database.username'),
1c3386e8
RK
165 PASSWORD: config.get<string>('database.password'),
166 POOL: {
167 MAX: config.get<number>('database.pool.max')
168 }
e861452f 169 },
94a5ff8a 170 REDIS: {
19f7b248
RK
171 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
172 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
173 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
174 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
175 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
94a5ff8a 176 },
ecb4e35f
C
177 SMTP: {
178 HOSTNAME: config.get<string>('smtp.hostname'),
179 PORT: config.get<number>('smtp.port'),
180 USERNAME: config.get<string>('smtp.username'),
181 PASSWORD: config.get<string>('smtp.password'),
182 TLS: config.get<boolean>('smtp.tls'),
bebf2d89 183 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
ecb4e35f
C
184 CA_FILE: config.get<string>('smtp.ca_file'),
185 FROM_ADDRESS: config.get<string>('smtp.from_address')
186 },
e861452f 187 STORAGE: {
6040f87d 188 TMP_DIR: buildPath(config.get<string>('storage.tmp')),
0b4204f9
C
189 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
190 LOG_DIR: buildPath(config.get<string>('storage.logs')),
191 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
6040f87d 192 REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
0b4204f9
C
193 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
194 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
40e87e9e 195 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
0b4204f9
C
196 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
197 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
e861452f
C
198 },
199 WEBSERVER: {
65fcc311
C
200 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
201 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
202 HOSTNAME: config.get<string>('webserver.hostname'),
203 PORT: config.get<number>('webserver.port'),
204 URL: '',
205 HOST: ''
4793c343 206 },
490b595a 207 TRUST_PROXY: config.get<string[]>('trust_proxy'),
23e27dd5
C
208 LOG: {
209 LEVEL: config.get<string>('log.level')
210 },
1297eb5d
C
211 SEARCH: {
212 REMOTE_URI: {
213 USERS: config.get<boolean>('search.remote_uri.users'),
214 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
215 }
216 },
9a629c6e
C
217 TRENDING: {
218 VIDEOS: {
219 INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
220 }
221 },
c48e82b5 222 REDUNDANCY: {
d9bdd007 223 VIDEOS: {
f9f899b9 224 CHECK_INTERVAL: parseDuration(config.get<string>('redundancy.videos.check_interval')),
d9bdd007
C
225 STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
226 }
c48e82b5 227 },
4793c343 228 ADMIN: {
fd206f0b 229 get EMAIL () { return config.get<string>('admin.email') }
e22528ac
C
230 },
231 SIGNUP: {
fd206f0b 232 get ENABLED () { return config.get<boolean>('signup.enabled') },
ff2c1fe8 233 get LIMIT () { return config.get<number>('signup.limit') },
d9eaee39 234 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
ff2c1fe8
RK
235 FILTERS: {
236 CIDR: {
237 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
238 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
239 }
240 }
b0f9f39e
C
241 },
242 USER: {
0e5ff97f
BY
243 get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
244 get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
227d02fe
C
245 },
246 TRANSCODING: {
fd206f0b
C
247 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
248 get THREADS () { return config.get<number>('transcoding.threads') },
40298b02 249 RESOLUTIONS: {
fd206f0b
C
250 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
251 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
252 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
253 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
254 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
40298b02 255 }
f981dae8 256 },
5d08a6a7
C
257 IMPORT: {
258 VIDEOS: {
259 HTTP: {
260 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
a84b8fa5
C
261 },
262 TORRENT: {
263 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
5d08a6a7
C
264 }
265 }
266 },
f981dae8
C
267 CACHE: {
268 PREVIEWS: {
fd206f0b 269 get SIZE () { return config.get<number>('cache.previews.size') }
40e87e9e
C
270 },
271 VIDEO_CAPTIONS: {
272 get SIZE () { return config.get<number>('cache.captions.size') }
f981dae8 273 }
66b16caf
C
274 },
275 INSTANCE: {
276 get NAME () { return config.get<string>('instance.name') },
2e3a0215 277 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
66b16caf 278 get DESCRIPTION () { return config.get<string>('instance.description') },
00b5556c 279 get TERMS () { return config.get<string>('instance.terms') },
901637bb 280 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
81e504b3 281 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
00b5556c
C
282 CUSTOMIZATIONS: {
283 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
284 get CSS () { return config.get<string>('instance.customizations.css') }
ac235c37 285 },
5447516b
AH
286 get ROBOTS () { return config.get<string>('instance.robots') },
287 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
288 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
8be1afa1
C
289 },
290 SERVICES: {
291 TWITTER: {
292 get USERNAME () { return config.get<string>('services.twitter.username') },
293 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
294 }
e861452f
C
295 }
296}
e861452f 297
9f6bae3a
C
298// ---------------------------------------------------------------------------
299
e4c55619
C
300const CONSTRAINTS_FIELDS = {
301 USERS: {
ed56ad11 302 NAME: { min: 3, max: 120 }, // Length
d23e6a1c 303 DESCRIPTION: { min: 3, max: 1000 }, // Length
e4c55619 304 USERNAME: { min: 3, max: 20 }, // Length
b0f9f39e 305 PASSWORD: { min: 6, max: 255 }, // Length
eacb25c4 306 VIDEO_QUOTA: { min: -1 },
bee0abff 307 VIDEO_QUOTA_DAILY: { min: -1 },
eacb25c4 308 BLOCKED_REASON: { min: 3, max: 250 } // Length
e4c55619 309 },
55fa55a9 310 VIDEO_ABUSES: {
268eebed
C
311 REASON: { min: 2, max: 300 }, // Length
312 MODERATION_COMMENT: { min: 2, max: 300 } // Length
55fa55a9 313 },
26b7305a
C
314 VIDEO_BLACKLIST: {
315 REASON: { min: 2, max: 300 } // Length
316 },
72c7248b 317 VIDEO_CHANNELS: {
a265f7f3 318 NAME: { min: 3, max: 120 }, // Length
d23e6a1c
BY
319 DESCRIPTION: { min: 3, max: 1000 }, // Length
320 SUPPORT: { min: 3, max: 1000 }, // Length
e34c85e5 321 URL: { min: 3, max: 2000 } // Length
72c7248b 322 },
40e87e9e
C
323 VIDEO_CAPTIONS: {
324 CAPTION_FILE: {
f4001cf4 325 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e
C
326 FILE_SIZE: {
327 max: 2 * 1024 * 1024 // 2MB
328 }
329 }
330 },
fbad87b0 331 VIDEO_IMPORTS: {
ce33919c
C
332 URL: { min: 3, max: 2000 }, // Length
333 TORRENT_NAME: { min: 3, max: 255 }, // Length
990b6a0b
C
334 TORRENT_FILE: {
335 EXTNAME: [ '.torrent' ],
336 FILE_SIZE: {
337 max: 1024 * 200 // 200 KB
338 }
339 }
fbad87b0 340 },
c48e82b5
C
341 VIDEOS_REDUNDANCY: {
342 URL: { min: 3, max: 2000 } // Length
343 },
5c6d985f
C
344 VIDEO_RATES: {
345 URL: { min: 3, max: 2000 } // Length
346 },
e4c55619 347 VIDEOS: {
a265f7f3 348 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 349 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 350 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 351 DESCRIPTION: { min: 3, max: 10000 }, // Length
d23e6a1c 352 SUPPORT: { min: 3, max: 1000 }, // Length
ac81d1a0
C
353 IMAGE: {
354 EXTNAME: [ '.jpg', '.jpeg' ],
355 FILE_SIZE: {
356 max: 2 * 1024 * 1024 // 2MB
357 }
358 },
feb4bdfd 359 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
0e1dc3e7 360 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 361 DURATION: { min: 0 }, // Number
a265f7f3
C
362 TAGS: { min: 0, max: 5 }, // Number of total tags
363 TAG: { min: 2, max: 30 }, // Length
e4c55619 364 THUMBNAIL: { min: 2, max: 30 },
e4c87ec2
C
365 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
366 VIEWS: { min: 0 },
367 LIKES: { min: 0 },
93e1258c 368 DISLIKES: { min: 0 },
c60774b0 369 FILE_SIZE: { min: 10 },
e34c85e5
C
370 URL: { min: 3, max: 2000 } // Length
371 },
01de67b9 372 ACTORS: {
e34c85e5
C
373 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
374 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3
C
375 URL: { min: 3, max: 2000 }, // Length
376 AVATAR: {
01de67b9
C
377 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
378 FILE_SIZE: {
379 max: 2 * 1024 * 1024 // 2MB
380 }
c5911fd3 381 }
e4c87ec2
C
382 },
383 VIDEO_EVENTS: {
384 COUNT: { min: 0 }
6d852470 385 },
bf1f6508 386 VIDEO_COMMENTS: {
b32b7827 387 TEXT: { min: 1, max: 3000 }, // Length
6d852470 388 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
389 },
390 VIDEO_SHARE: {
391 URL: { min: 3, max: 2000 } // Length
e4c55619
C
392 }
393}
394
490b595a
C
395const RATES_LIMIT = {
396 LOGIN: {
397 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
09becad8 398 MAX: 15 // 15 attempts
288fe385
C
399 },
400 ASK_SEND_EMAIL: {
401 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
402 MAX: 3 // 3 attempts
490b595a
C
403 }
404}
405
b5c0e955 406let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
edb4ffc7 407const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
a7977280 408 MIN: 10,
3a6f351b
C
409 AVERAGE: 30,
410 MAX: 60,
411 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 412}
b5c0e955 413
ee9e7b61 414const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
415 LIKE: 'like',
416 DISLIKE: 'dislike'
417}
418
80bc88c1
J
419const FFMPEG_NICE: { [ id: string ]: number } = {
420 THUMBNAIL: 2, // 2 just for don't blocking servers
421 TRANSCODING: 15
422}
423
6e07c3de
C
424const VIDEO_CATEGORIES = {
425 1: 'Music',
426 2: 'Films',
427 3: 'Vehicles',
428 4: 'Art',
429 5: 'Sports',
430 6: 'Travels',
431 7: 'Gaming',
432 8: 'People',
433 9: 'Comedy',
434 10: 'Entertainment',
6f2ae7a1 435 11: 'News & Politics',
40298b02 436 12: 'How To',
6e07c3de
C
437 13: 'Education',
438 14: 'Activism',
439 15: 'Science & Technology',
440 16: 'Animals',
441 17: 'Kids',
442 18: 'Food'
443}
444
6f0c39e2
C
445// See https://creativecommons.org/licenses/?lang=en
446const VIDEO_LICENCES = {
447 1: 'Attribution',
448 2: 'Attribution - Share Alike',
449 3: 'Attribution - No Derivatives',
450 4: 'Attribution - Non Commercial',
451 5: 'Attribution - Non Commercial - Share Alike',
452 6: 'Attribution - Non Commercial - No Derivatives',
453 7: 'Public Domain Dedication'
454}
455
9d3ef9fe 456const VIDEO_LANGUAGES = buildLanguages()
3092476e 457
fd45e8f4
C
458const VIDEO_PRIVACIES = {
459 [VideoPrivacy.PUBLIC]: 'Public',
460 [VideoPrivacy.UNLISTED]: 'Unlisted',
461 [VideoPrivacy.PRIVATE]: 'Private'
462}
463
2186386c
C
464const VIDEO_STATES = {
465 [VideoState.PUBLISHED]: 'Published',
fbad87b0
C
466 [VideoState.TO_TRANSCODE]: 'To transcode',
467 [VideoState.TO_IMPORT]: 'To import'
468}
469
470const VIDEO_IMPORT_STATES = {
471 [VideoImportState.FAILED]: 'Failed',
472 [VideoImportState.PENDING]: 'Pending',
473 [VideoImportState.SUCCESS]: 'Success'
2186386c
C
474}
475
268eebed
C
476const VIDEO_ABUSE_STATES = {
477 [VideoAbuseState.PENDING]: 'Pending',
478 [VideoAbuseState.REJECTED]: 'Rejected',
479 [VideoAbuseState.ACCEPTED]: 'Accepted'
480}
481
0d0e8dd0 482const VIDEO_MIMETYPE_EXT = {
efc32059
C
483 'video/webm': '.webm',
484 'video/ogg': '.ogv',
485 'video/mp4': '.mp4'
0d0e8dd0 486}
28be8916 487const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
0d0e8dd0 488
ac81d1a0 489const IMAGE_MIMETYPE_EXT = {
c5911fd3
C
490 'image/png': '.png',
491 'image/jpg': '.jpg',
492 'image/jpeg': '.jpg'
493}
494
40e87e9e 495const VIDEO_CAPTIONS_MIMETYPE_EXT = {
f4001cf4
C
496 'text/vtt': '.vtt',
497 'application/x-subrip': '.srt'
40e87e9e
C
498}
499
990b6a0b
C
500const TORRENT_MIMETYPE_EXT = {
501 'application/x-bittorrent': '.torrent'
502}
503
9f6bae3a
C
504// ---------------------------------------------------------------------------
505
2d3741d6
C
506const OVERVIEWS = {
507 VIDEOS: {
1a471091 508 SAMPLE_THRESHOLD: 6,
2d3741d6
C
509 SAMPLES_COUNT: 2
510 }
511}
512
513// ---------------------------------------------------------------------------
514
50d6de9c 515const SERVER_ACTOR_NAME = 'peertube'
350e31d6 516
e4f97bab 517const ACTIVITY_PUB = {
1b5b10d1
C
518 POTENTIAL_ACCEPT_HEADERS: [
519 'application/activity+json',
9a8cbd82
C
520 'application/ld+json',
521 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 522 ],
1b5b10d1 523 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 524 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 525 COLLECTION_ITEMS_PER_PAGE: 10,
c986175d 526 FETCH_PAGE_LIMIT: 100,
20494f12 527 URL_MIME_TYPES: {
f05a1c30 528 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
20494f12
C
529 TORRENT: [ 'application/x-bittorrent' ],
530 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 531 },
2ccaeeb3 532 MAX_RECURSION_COMMENTS: 100,
1297eb5d
C
533 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
534 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
e4f97bab
C
535}
536
50d6de9c
C
537const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
538 GROUP: 'Group',
539 PERSON: 'Person',
540 APPLICATION: 'Application'
541}
542
41f2ebae
C
543const HTTP_SIGNATURE = {
544 HEADER_NAME: 'signature',
545 ALGORITHM: 'rsa-sha256',
df66d815 546 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
41f2ebae
C
547}
548
9f6bae3a
C
549// ---------------------------------------------------------------------------
550
04b8c3fb 551let PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 552
9f6bae3a
C
553// Password encryption
554const BCRYPT_SALT_SIZE = 10
a877d5ac 555
ecb4e35f
C
556const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
557
d9eaee39
JM
558const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
559
0883b324
C
560const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
561 DO_NOT_LIST: 'do_not_list',
562 BLUR: 'blur',
563 DISPLAY: 'display'
564}
565
bdfbd4f1
C
566// ---------------------------------------------------------------------------
567
052937db
C
568// Express static paths (router)
569const STATIC_PATHS = {
f285faa0
C
570 PREVIEWS: '/static/previews/',
571 THUMBNAILS: '/static/thumbnails/',
052937db 572 TORRENTS: '/static/torrents/',
c5911fd3 573 WEBSEED: '/static/webseed/',
b9fffa29 574 REDUNDANCY: '/static/redundancy/',
40e87e9e
C
575 AVATARS: '/static/avatars/',
576 VIDEO_CAPTIONS: '/static/video-captions/'
052937db 577}
02756fbd
C
578const STATIC_DOWNLOAD_PATHS = {
579 TORRENTS: '/download/torrents/',
580 VIDEOS: '/download/videos/'
581}
052937db 582
dc009132 583// Cache control
57a81ff6 584let STATIC_MAX_AGE = '2h'
dc009132 585
cbe2f7c3 586// Videos thumbnail size
d8755eed
C
587const THUMBNAILS_SIZE = {
588 width: 200,
589 height: 110
590}
591const PREVIEWS_SIZE = {
164174a6
C
592 width: 560,
593 height: 315
594}
e8e12200
C
595const AVATARS_SIZE = {
596 width: 120,
597 height: 120
598}
164174a6
C
599
600const EMBED_SIZE = {
601 width: 560,
602 height: 315
d8755eed 603}
cbe2f7c3 604
980246ea 605// Sub folders of cache directory
f981dae8 606const CACHE = {
f4001cf4
C
607 PREVIEWS: {
608 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
609 MAX_AGE: 1000 * 3600 * 3 // 3 hours
610 },
611 VIDEO_CAPTIONS: {
612 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
613 MAX_AGE: 1000 * 3600 * 3 // 3 hours
f981dae8
C
614 }
615}
616
7348b1fd
C
617const MEMOIZE_TTL = {
618 OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
619}
620
c48e82b5
C
621const REDUNDANCY = {
622 VIDEOS: {
c48e82b5
C
623 RANDOMIZED_FACTOR: 5
624 }
625}
626
e12a0092 627const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
4f491371 628
bdfbd4f1
C
629// ---------------------------------------------------------------------------
630
e032aec9
C
631const CUSTOM_HTML_TAG_COMMENTS = {
632 TITLE: '<!-- title tag -->',
633 DESCRIPTION: '<!-- description tag -->',
634 CUSTOM_CSS: '<!-- custom css tag -->',
635 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
636}
709756b8
C
637
638// ---------------------------------------------------------------------------
639
4195cd2b 640const FEEDS = {
fd4484f1 641 COUNT: 20
4195cd2b
C
642}
643
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
9b67da3d
C
649 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
650}
651
652// ---------------------------------------------------------------------------
653
9f10b292
C
654// Special constants for a test instance
655if (isTestInstance() === true) {
04b8c3fb
C
656 PRIVATE_RSA_KEY_SIZE = 1024
657
60650c77 658 ACTOR_FOLLOW_SCORE.BASE = 20
3cd0734f 659
f285faa0
C
660 REMOTE_SCHEME.HTTP = 'http'
661 REMOTE_SCHEME.WS = 'ws'
3cd0734f 662
65fcc311 663 STATIC_MAX_AGE = '0'
3cd0734f 664
c46edbc2 665 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
7bc29171 666 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1297eb5d 667 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
3cd0734f 668
01de67b9 669 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
3cd0734f 670
2baea0c7
C
671 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
672 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
673 SCHEDULER_INTERVALS_MS.updateVideos = 5000
6b616860 674 REPEAT_JOBS['videos-views'] = { every: 5000 }
2baea0c7 675
c48e82b5
C
676 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
677
b5c0e955 678 VIDEO_VIEW_LIFETIME = 1000 // 1 second
3cd0734f
C
679
680 JOB_ATTEMPTS['email'] = 1
f4001cf4
C
681
682 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
743164fe 683 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
c07b6041 684 ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
9f10b292
C
685}
686
fd206f0b 687updateWebserverConfig()
225a89c2 688
9f10b292
C
689// ---------------------------------------------------------------------------
690
65fcc311 691export {
9f6bae3a 692 API_VERSION,
40e87e9e 693 VIDEO_CAPTIONS_MIMETYPE_EXT,
e8e12200 694 AVATARS_SIZE,
4f491371 695 ACCEPT_HEADERS,
9f6bae3a 696 BCRYPT_SALT_SIZE,
9b67da3d 697 TRACKER_RATE_LIMITS,
f981dae8 698 CACHE,
9f6bae3a
C
699 CONFIG,
700 CONSTRAINTS_FIELDS,
164174a6 701 EMBED_SIZE,
c48e82b5 702 REDUNDANCY,
94a5ff8a
C
703 JOB_CONCURRENCY,
704 JOB_ATTEMPTS,
b769007f 705 LAST_MIGRATION_VERSION,
9f6bae3a 706 OAUTH_LIFETIME,
e032aec9 707 CUSTOM_HTML_TAG_COMMENTS,
f55e5a7b 708 BROADCAST_CONCURRENCY,
1194e8b4 709 PAGINATION,
60650c77 710 ACTOR_FOLLOW_SCORE,
f285faa0
C
711 PREVIEWS_SIZE,
712 REMOTE_SCHEME,
7a7724e6 713 FOLLOW_STATES,
50d6de9c 714 SERVER_ACTOR_NAME,
e4f97bab 715 PRIVATE_RSA_KEY_SIZE,
fd4484f1 716 ROUTE_CACHE_LIFETIME,
9f6bae3a 717 SORTABLE_COLUMNS,
4195cd2b 718 FEEDS,
2b86fe72 719 JOB_TTL,
0883b324 720 NSFW_POLICY_TYPES,
990b6a0b 721 TORRENT_MIMETYPE_EXT,
dc009132 722 STATIC_MAX_AGE,
a6375e69 723 STATIC_PATHS,
cf9166cf 724 VIDEO_IMPORT_TIMEOUT,
e4f97bab 725 ACTIVITY_PUB,
50d6de9c 726 ACTIVITY_PUB_ACTOR_TYPES,
9f6bae3a 727 THUMBNAILS_SIZE,
6e07c3de 728 VIDEO_CATEGORIES,
3092476e 729 VIDEO_LANGUAGES,
fd45e8f4 730 VIDEO_PRIVACIES,
6f0c39e2 731 VIDEO_LICENCES,
2186386c 732 VIDEO_STATES,
0d0e8dd0 733 VIDEO_RATE_TYPES,
c5911fd3 734 VIDEO_MIMETYPE_EXT,
a7977280 735 VIDEO_TRANSCODING_FPS,
80bc88c1 736 FFMPEG_NICE,
268eebed 737 VIDEO_ABUSE_STATES,
71e3dfda 738 JOB_REQUEST_TIMEOUT,
ecb4e35f 739 USER_PASSWORD_RESET_LIFETIME,
7348b1fd 740 MEMOIZE_TTL,
d9eaee39 741 USER_EMAIL_VERIFY_LIFETIME,
ac81d1a0 742 IMAGE_MIMETYPE_EXT,
2d3741d6 743 OVERVIEWS,
2baea0c7 744 SCHEDULER_INTERVALS_MS,
6b616860 745 REPEAT_JOBS,
02756fbd 746 STATIC_DOWNLOAD_PATHS,
490b595a 747 RATES_LIMIT,
28be8916 748 VIDEO_EXT_MIMETYPE,
f6eebcb3 749 CRAWL_REQUEST_CONCURRENCY,
b5c0e955 750 JOB_COMPLETED_LIFETIME,
41f2ebae 751 HTTP_SIGNATURE,
fbad87b0 752 VIDEO_IMPORT_STATES,
7ce44a74
C
753 VIDEO_VIEW_LIFETIME,
754 buildLanguages
9f10b292 755}
fd206f0b
C
756
757// ---------------------------------------------------------------------------
758
759function getLocalConfigFilePath () {
760 const configSources = config.util.getConfigSources()
761 if (configSources.length === 0) throw new Error('Invalid config source.')
762
763 let filename = 'local'
764 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
765 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
766
767 return join(dirname(configSources[ 0 ].name), filename + '.json')
768}
769
770function updateWebserverConfig () {
771 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
772 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
773}
774
e5565833 775function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
c48e82b5
C
776 if (!objs) return []
777
e5565833 778 return objs.map(obj => {
f9a971c6 779 return Object.assign({}, obj, {
e5565833
C
780 minLifetime: parseDuration(obj.min_lifetime),
781 size: bytes.parse(obj.size),
782 minViews: obj.min_views
783 })
784 })
c48e82b5
C
785}
786
9d3ef9fe
C
787function buildLanguages () {
788 const iso639 = require('iso-639-3')
789
790 const languages: { [ id: string ]: string } = {}
791
1d94c154
C
792 const additionalLanguages = {
793 'sgn': true, // Sign languages (macro language)
794 'ase': true, // American sign language
795 'sdl': true, // Arabian sign language
796 'bfi': true, // British sign language
797 'bzs': true, // Brazilian sign language
798 'csl': true, // Chinese sign language
799 'cse': true, // Czech sign language
800 'dsl': true, // Danish sign language
801 'fsl': true, // French sign language
802 'gsg': true, // German sign language
803 'pks': true, // Pakistan sign language
804 'jsl': true, // Japanese sign language
805 'sfs': true, // South African sign language
806 'swl': true, // Swedish sign language
807 'rsl': true, // Russian sign language: true
808
809 'epo': true, // Esperanto
810 'tlh': true, // Klingon
811 'jbo': true, // Lojban
812 'avk': true // Kotava
813 }
9d3ef9fe
C
814
815 // Only add ISO639-1 languages and some sign languages (ISO639-3)
816 iso639
817 .filter(l => {
818 return (l.iso6391 !== null && l.type === 'living') ||
1d94c154 819 additionalLanguages[l.iso6393] === true
9d3ef9fe
C
820 })
821 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
822
db6d617d
C
823 // Override Occitan label
824 languages['oc'] = 'Occitan'
825
9d3ef9fe
C
826 return languages
827}
828
fd206f0b
C
829export function reloadConfig () {
830
831 function directory () {
832 if (process.env.NODE_CONFIG_DIR) {
833 return process.env.NODE_CONFIG_DIR
834 }
835
836 return join(root(), 'config')
837 }
838
839 function purge () {
840 for (const fileName in require.cache) {
841 if (-1 === fileName.indexOf(directory())) {
842 continue
843 }
844
845 delete require.cache[fileName]
846 }
847
848 delete require.cache[require.resolve('config')]
849 }
850
851 purge()
852
853 config = require('config')
854
855 updateWebserverConfig()
856}