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