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