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