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