]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
Add ability to search video channels
[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
26b7305a 17const LAST_MIGRATION_VERSION = 255
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
C
46 VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
47 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName' ]
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: {
fd206f0b 205 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
227d02fe
C
206 },
207 TRANSCODING: {
fd206f0b
C
208 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
209 get THREADS () { return config.get<number>('transcoding.threads') },
40298b02 210 RESOLUTIONS: {
fd206f0b
C
211 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
212 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
213 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
214 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
215 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
40298b02 216 }
f981dae8 217 },
5d08a6a7
C
218 IMPORT: {
219 VIDEOS: {
220 HTTP: {
221 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
a84b8fa5
C
222 },
223 TORRENT: {
224 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
5d08a6a7
C
225 }
226 }
227 },
f981dae8
C
228 CACHE: {
229 PREVIEWS: {
fd206f0b 230 get SIZE () { return config.get<number>('cache.previews.size') }
40e87e9e
C
231 },
232 VIDEO_CAPTIONS: {
233 get SIZE () { return config.get<number>('cache.captions.size') }
f981dae8 234 }
66b16caf
C
235 },
236 INSTANCE: {
237 get NAME () { return config.get<string>('instance.name') },
2e3a0215 238 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
66b16caf 239 get DESCRIPTION () { return config.get<string>('instance.description') },
00b5556c 240 get TERMS () { return config.get<string>('instance.terms') },
901637bb 241 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
81e504b3 242 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
00b5556c
C
243 CUSTOMIZATIONS: {
244 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
245 get CSS () { return config.get<string>('instance.customizations.css') }
ac235c37
RK
246 },
247 get ROBOTS () { return config.get<string>('instance.robots') }
8be1afa1
C
248 },
249 SERVICES: {
250 TWITTER: {
251 get USERNAME () { return config.get<string>('services.twitter.username') },
252 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
253 }
e861452f
C
254 }
255}
e861452f 256
9f6bae3a
C
257// ---------------------------------------------------------------------------
258
e4c55619
C
259const CONSTRAINTS_FIELDS = {
260 USERS: {
ed56ad11
C
261 NAME: { min: 3, max: 120 }, // Length
262 DESCRIPTION: { min: 3, max: 250 }, // Length
e4c55619 263 USERNAME: { min: 3, max: 20 }, // Length
b0f9f39e 264 PASSWORD: { min: 6, max: 255 }, // Length
eacb25c4
C
265 VIDEO_QUOTA: { min: -1 },
266 BLOCKED_REASON: { min: 3, max: 250 } // Length
e4c55619 267 },
55fa55a9 268 VIDEO_ABUSES: {
268eebed
C
269 REASON: { min: 2, max: 300 }, // Length
270 MODERATION_COMMENT: { min: 2, max: 300 } // Length
55fa55a9 271 },
26b7305a
C
272 VIDEO_BLACKLIST: {
273 REASON: { min: 2, max: 300 } // Length
274 },
72c7248b 275 VIDEO_CHANNELS: {
a265f7f3 276 NAME: { min: 3, max: 120 }, // Length
a10fc78b
C
277 DESCRIPTION: { min: 3, max: 500 }, // Length
278 SUPPORT: { min: 3, max: 500 }, // Length
e34c85e5 279 URL: { min: 3, max: 2000 } // Length
72c7248b 280 },
40e87e9e
C
281 VIDEO_CAPTIONS: {
282 CAPTION_FILE: {
f4001cf4 283 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e
C
284 FILE_SIZE: {
285 max: 2 * 1024 * 1024 // 2MB
286 }
287 }
288 },
fbad87b0 289 VIDEO_IMPORTS: {
ce33919c
C
290 URL: { min: 3, max: 2000 }, // Length
291 TORRENT_NAME: { min: 3, max: 255 }, // Length
990b6a0b
C
292 TORRENT_FILE: {
293 EXTNAME: [ '.torrent' ],
294 FILE_SIZE: {
295 max: 1024 * 200 // 200 KB
296 }
297 }
fbad87b0 298 },
e4c55619 299 VIDEOS: {
a265f7f3 300 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 301 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 302 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 303 DESCRIPTION: { min: 3, max: 10000 }, // Length
a10fc78b 304 SUPPORT: { min: 3, max: 500 }, // Length
ac81d1a0
C
305 IMAGE: {
306 EXTNAME: [ '.jpg', '.jpeg' ],
307 FILE_SIZE: {
308 max: 2 * 1024 * 1024 // 2MB
309 }
310 },
feb4bdfd 311 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
0e1dc3e7 312 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 313 DURATION: { min: 0 }, // Number
a265f7f3
C
314 TAGS: { min: 0, max: 5 }, // Number of total tags
315 TAG: { min: 2, max: 30 }, // Length
e4c55619 316 THUMBNAIL: { min: 2, max: 30 },
e4c87ec2
C
317 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
318 VIEWS: { min: 0 },
319 LIKES: { min: 0 },
93e1258c 320 DISLIKES: { min: 0 },
c60774b0 321 FILE_SIZE: { min: 10 },
e34c85e5
C
322 URL: { min: 3, max: 2000 } // Length
323 },
01de67b9 324 ACTORS: {
e34c85e5
C
325 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
326 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3
C
327 URL: { min: 3, max: 2000 }, // Length
328 AVATAR: {
01de67b9
C
329 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
330 FILE_SIZE: {
331 max: 2 * 1024 * 1024 // 2MB
332 }
c5911fd3 333 }
e4c87ec2
C
334 },
335 VIDEO_EVENTS: {
336 COUNT: { min: 0 }
6d852470 337 },
bf1f6508 338 VIDEO_COMMENTS: {
b32b7827 339 TEXT: { min: 1, max: 3000 }, // Length
6d852470 340 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
341 },
342 VIDEO_SHARE: {
343 URL: { min: 3, max: 2000 } // Length
e4c55619
C
344 }
345}
346
490b595a
C
347const RATES_LIMIT = {
348 LOGIN: {
349 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
09becad8 350 MAX: 15 // 15 attempts
490b595a
C
351 }
352}
353
b5c0e955 354let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
a7977280
C
355const VIDEO_TRANSCODING_FPS = {
356 MIN: 10,
3a6f351b
C
357 AVERAGE: 30,
358 MAX: 60,
359 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 360}
b5c0e955 361
ee9e7b61 362const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
363 LIKE: 'like',
364 DISLIKE: 'dislike'
365}
366
80bc88c1
J
367const FFMPEG_NICE: { [ id: string ]: number } = {
368 THUMBNAIL: 2, // 2 just for don't blocking servers
369 TRANSCODING: 15
370}
371
6e07c3de
C
372const VIDEO_CATEGORIES = {
373 1: 'Music',
374 2: 'Films',
375 3: 'Vehicles',
376 4: 'Art',
377 5: 'Sports',
378 6: 'Travels',
379 7: 'Gaming',
380 8: 'People',
381 9: 'Comedy',
382 10: 'Entertainment',
383 11: 'News',
40298b02 384 12: 'How To',
6e07c3de
C
385 13: 'Education',
386 14: 'Activism',
387 15: 'Science & Technology',
388 16: 'Animals',
389 17: 'Kids',
390 18: 'Food'
391}
392
6f0c39e2
C
393// See https://creativecommons.org/licenses/?lang=en
394const VIDEO_LICENCES = {
395 1: 'Attribution',
396 2: 'Attribution - Share Alike',
397 3: 'Attribution - No Derivatives',
398 4: 'Attribution - Non Commercial',
399 5: 'Attribution - Non Commercial - Share Alike',
400 6: 'Attribution - Non Commercial - No Derivatives',
401 7: 'Public Domain Dedication'
402}
403
9d3ef9fe 404const VIDEO_LANGUAGES = buildLanguages()
3092476e 405
fd45e8f4
C
406const VIDEO_PRIVACIES = {
407 [VideoPrivacy.PUBLIC]: 'Public',
408 [VideoPrivacy.UNLISTED]: 'Unlisted',
409 [VideoPrivacy.PRIVATE]: 'Private'
410}
411
2186386c
C
412const VIDEO_STATES = {
413 [VideoState.PUBLISHED]: 'Published',
fbad87b0
C
414 [VideoState.TO_TRANSCODE]: 'To transcode',
415 [VideoState.TO_IMPORT]: 'To import'
416}
417
418const VIDEO_IMPORT_STATES = {
419 [VideoImportState.FAILED]: 'Failed',
420 [VideoImportState.PENDING]: 'Pending',
421 [VideoImportState.SUCCESS]: 'Success'
2186386c
C
422}
423
268eebed
C
424const VIDEO_ABUSE_STATES = {
425 [VideoAbuseState.PENDING]: 'Pending',
426 [VideoAbuseState.REJECTED]: 'Rejected',
427 [VideoAbuseState.ACCEPTED]: 'Accepted'
428}
429
0d0e8dd0 430const VIDEO_MIMETYPE_EXT = {
efc32059
C
431 'video/webm': '.webm',
432 'video/ogg': '.ogv',
433 'video/mp4': '.mp4'
0d0e8dd0 434}
28be8916 435const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
0d0e8dd0 436
ac81d1a0 437const IMAGE_MIMETYPE_EXT = {
c5911fd3
C
438 'image/png': '.png',
439 'image/jpg': '.jpg',
440 'image/jpeg': '.jpg'
441}
442
40e87e9e 443const VIDEO_CAPTIONS_MIMETYPE_EXT = {
f4001cf4
C
444 'text/vtt': '.vtt',
445 'application/x-subrip': '.srt'
40e87e9e
C
446}
447
990b6a0b
C
448const TORRENT_MIMETYPE_EXT = {
449 'application/x-bittorrent': '.torrent'
450}
451
9f6bae3a
C
452// ---------------------------------------------------------------------------
453
50d6de9c 454const SERVER_ACTOR_NAME = 'peertube'
350e31d6 455
e4f97bab 456const ACTIVITY_PUB = {
1b5b10d1
C
457 POTENTIAL_ACCEPT_HEADERS: [
458 'application/activity+json',
9a8cbd82
C
459 'application/ld+json',
460 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 461 ],
1b5b10d1 462 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 463 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 464 COLLECTION_ITEMS_PER_PAGE: 10,
c986175d 465 FETCH_PAGE_LIMIT: 100,
20494f12 466 URL_MIME_TYPES: {
f05a1c30 467 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
20494f12
C
468 TORRENT: [ 'application/x-bittorrent' ],
469 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 470 },
2ccaeeb3 471 MAX_RECURSION_COMMENTS: 100,
1297eb5d
C
472 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
473 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
e4f97bab
C
474}
475
50d6de9c
C
476const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
477 GROUP: 'Group',
478 PERSON: 'Person',
479 APPLICATION: 'Application'
480}
481
9f6bae3a
C
482// ---------------------------------------------------------------------------
483
e4f97bab 484const PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 485
9f6bae3a
C
486// Password encryption
487const BCRYPT_SALT_SIZE = 10
a877d5ac 488
ecb4e35f
C
489const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
490
0883b324
C
491const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
492 DO_NOT_LIST: 'do_not_list',
493 BLUR: 'blur',
494 DISPLAY: 'display'
495}
496
bdfbd4f1
C
497// ---------------------------------------------------------------------------
498
052937db
C
499// Express static paths (router)
500const STATIC_PATHS = {
f285faa0
C
501 PREVIEWS: '/static/previews/',
502 THUMBNAILS: '/static/thumbnails/',
052937db 503 TORRENTS: '/static/torrents/',
c5911fd3 504 WEBSEED: '/static/webseed/',
40e87e9e
C
505 AVATARS: '/static/avatars/',
506 VIDEO_CAPTIONS: '/static/video-captions/'
052937db 507}
02756fbd
C
508const STATIC_DOWNLOAD_PATHS = {
509 TORRENTS: '/download/torrents/',
510 VIDEOS: '/download/videos/'
511}
052937db 512
dc009132 513// Cache control
57a81ff6 514let STATIC_MAX_AGE = '2h'
dc009132 515
cbe2f7c3 516// Videos thumbnail size
d8755eed
C
517const THUMBNAILS_SIZE = {
518 width: 200,
519 height: 110
520}
521const PREVIEWS_SIZE = {
164174a6
C
522 width: 560,
523 height: 315
524}
e8e12200
C
525const AVATARS_SIZE = {
526 width: 120,
527 height: 120
528}
164174a6
C
529
530const EMBED_SIZE = {
531 width: 560,
532 height: 315
d8755eed 533}
cbe2f7c3 534
980246ea 535// Sub folders of cache directory
f981dae8 536const CACHE = {
f4001cf4
C
537 PREVIEWS: {
538 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
539 MAX_AGE: 1000 * 3600 * 3 // 3 hours
540 },
541 VIDEO_CAPTIONS: {
542 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
543 MAX_AGE: 1000 * 3600 * 3 // 3 hours
f981dae8
C
544 }
545}
546
e12a0092 547const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
4f491371 548
bdfbd4f1
C
549// ---------------------------------------------------------------------------
550
e032aec9
C
551const CUSTOM_HTML_TAG_COMMENTS = {
552 TITLE: '<!-- title tag -->',
553 DESCRIPTION: '<!-- description tag -->',
554 CUSTOM_CSS: '<!-- custom css tag -->',
555 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
556}
709756b8
C
557
558// ---------------------------------------------------------------------------
559
4195cd2b 560const FEEDS = {
fd4484f1 561 COUNT: 20
4195cd2b
C
562}
563
564// ---------------------------------------------------------------------------
565
9b67da3d
C
566const TRACKER_RATE_LIMITS = {
567 INTERVAL: 60000 * 5, // 5 minutes
8244c85a 568 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
9b67da3d
C
569 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
570}
571
572// ---------------------------------------------------------------------------
573
9f10b292
C
574// Special constants for a test instance
575if (isTestInstance() === true) {
60650c77 576 ACTOR_FOLLOW_SCORE.BASE = 20
3cd0734f 577
f285faa0
C
578 REMOTE_SCHEME.HTTP = 'http'
579 REMOTE_SCHEME.WS = 'ws'
3cd0734f 580
65fcc311 581 STATIC_MAX_AGE = '0'
3cd0734f 582
c46edbc2 583 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
7bc29171 584 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1297eb5d 585 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
3cd0734f 586
01de67b9 587 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
3cd0734f 588
2baea0c7
C
589 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
590 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
591 SCHEDULER_INTERVALS_MS.updateVideos = 5000
592
b5c0e955 593 VIDEO_VIEW_LIFETIME = 1000 // 1 second
3cd0734f
C
594
595 JOB_ATTEMPTS['email'] = 1
f4001cf4
C
596
597 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
9f10b292
C
598}
599
fd206f0b 600updateWebserverConfig()
225a89c2 601
9f10b292
C
602// ---------------------------------------------------------------------------
603
65fcc311 604export {
9f6bae3a 605 API_VERSION,
40e87e9e 606 VIDEO_CAPTIONS_MIMETYPE_EXT,
e8e12200 607 AVATARS_SIZE,
4f491371 608 ACCEPT_HEADERS,
9f6bae3a 609 BCRYPT_SALT_SIZE,
9b67da3d 610 TRACKER_RATE_LIMITS,
f981dae8 611 CACHE,
9f6bae3a
C
612 CONFIG,
613 CONSTRAINTS_FIELDS,
164174a6 614 EMBED_SIZE,
94a5ff8a
C
615 JOB_CONCURRENCY,
616 JOB_ATTEMPTS,
b769007f 617 LAST_MIGRATION_VERSION,
9f6bae3a 618 OAUTH_LIFETIME,
e032aec9 619 CUSTOM_HTML_TAG_COMMENTS,
f55e5a7b 620 BROADCAST_CONCURRENCY,
1194e8b4 621 PAGINATION,
60650c77 622 ACTOR_FOLLOW_SCORE,
f285faa0
C
623 PREVIEWS_SIZE,
624 REMOTE_SCHEME,
7a7724e6 625 FOLLOW_STATES,
50d6de9c 626 SERVER_ACTOR_NAME,
e4f97bab 627 PRIVATE_RSA_KEY_SIZE,
fd4484f1 628 ROUTE_CACHE_LIFETIME,
9f6bae3a 629 SORTABLE_COLUMNS,
4195cd2b 630 FEEDS,
2b86fe72 631 JOB_TTL,
0883b324 632 NSFW_POLICY_TYPES,
990b6a0b 633 TORRENT_MIMETYPE_EXT,
dc009132 634 STATIC_MAX_AGE,
a6375e69 635 STATIC_PATHS,
e4f97bab 636 ACTIVITY_PUB,
50d6de9c 637 ACTIVITY_PUB_ACTOR_TYPES,
9f6bae3a 638 THUMBNAILS_SIZE,
6e07c3de 639 VIDEO_CATEGORIES,
3092476e 640 VIDEO_LANGUAGES,
fd45e8f4 641 VIDEO_PRIVACIES,
6f0c39e2 642 VIDEO_LICENCES,
2186386c 643 VIDEO_STATES,
0d0e8dd0 644 VIDEO_RATE_TYPES,
c5911fd3 645 VIDEO_MIMETYPE_EXT,
a7977280 646 VIDEO_TRANSCODING_FPS,
80bc88c1 647 FFMPEG_NICE,
268eebed 648 VIDEO_ABUSE_STATES,
71e3dfda 649 JOB_REQUEST_TIMEOUT,
ecb4e35f 650 USER_PASSWORD_RESET_LIFETIME,
ac81d1a0 651 IMAGE_MIMETYPE_EXT,
2baea0c7 652 SCHEDULER_INTERVALS_MS,
02756fbd 653 STATIC_DOWNLOAD_PATHS,
490b595a 654 RATES_LIMIT,
28be8916 655 VIDEO_EXT_MIMETYPE,
f6eebcb3 656 CRAWL_REQUEST_CONCURRENCY,
b5c0e955 657 JOB_COMPLETED_LIFETIME,
fbad87b0 658 VIDEO_IMPORT_STATES,
7ce44a74
C
659 VIDEO_VIEW_LIFETIME,
660 buildLanguages
9f10b292 661}
fd206f0b
C
662
663// ---------------------------------------------------------------------------
664
665function getLocalConfigFilePath () {
666 const configSources = config.util.getConfigSources()
667 if (configSources.length === 0) throw new Error('Invalid config source.')
668
669 let filename = 'local'
670 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
671 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
672
673 return join(dirname(configSources[ 0 ].name), filename + '.json')
674}
675
676function updateWebserverConfig () {
677 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
678 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
679}
680
9d3ef9fe
C
681function buildLanguages () {
682 const iso639 = require('iso-639-3')
683
684 const languages: { [ id: string ]: string } = {}
685
1d94c154
C
686 const additionalLanguages = {
687 'sgn': true, // Sign languages (macro language)
688 'ase': true, // American sign language
689 'sdl': true, // Arabian sign language
690 'bfi': true, // British sign language
691 'bzs': true, // Brazilian sign language
692 'csl': true, // Chinese sign language
693 'cse': true, // Czech sign language
694 'dsl': true, // Danish sign language
695 'fsl': true, // French sign language
696 'gsg': true, // German sign language
697 'pks': true, // Pakistan sign language
698 'jsl': true, // Japanese sign language
699 'sfs': true, // South African sign language
700 'swl': true, // Swedish sign language
701 'rsl': true, // Russian sign language: true
702
703 'epo': true, // Esperanto
704 'tlh': true, // Klingon
705 'jbo': true, // Lojban
706 'avk': true // Kotava
707 }
9d3ef9fe
C
708
709 // Only add ISO639-1 languages and some sign languages (ISO639-3)
710 iso639
711 .filter(l => {
712 return (l.iso6391 !== null && l.type === 'living') ||
1d94c154 713 additionalLanguages[l.iso6393] === true
9d3ef9fe
C
714 })
715 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
716
717 return languages
718}
719
fd206f0b
C
720export function reloadConfig () {
721
722 function directory () {
723 if (process.env.NODE_CONFIG_DIR) {
724 return process.env.NODE_CONFIG_DIR
725 }
726
727 return join(root(), 'config')
728 }
729
730 function purge () {
731 for (const fileName in require.cache) {
732 if (-1 === fileName.indexOf(directory())) {
733 continue
734 }
735
736 delete require.cache[fileName]
737 }
738
739 delete require.cache[require.resolve('config')]
740 }
741
742 purge()
743
744 config = require('config')
745
746 updateWebserverConfig()
747}