]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
Rename video-file job to video-transcoding
[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
d4c9f45b 21const LAST_MIGRATION_VERSION = 345
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 },
f981dae8
C
291 CACHE: {
292 PREVIEWS: {
fd206f0b 293 get SIZE () { return config.get<number>('cache.previews.size') }
40e87e9e
C
294 },
295 VIDEO_CAPTIONS: {
296 get SIZE () { return config.get<number>('cache.captions.size') }
f981dae8 297 }
66b16caf
C
298 },
299 INSTANCE: {
300 get NAME () { return config.get<string>('instance.name') },
2e3a0215 301 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
66b16caf 302 get DESCRIPTION () { return config.get<string>('instance.description') },
00b5556c 303 get TERMS () { return config.get<string>('instance.terms') },
f8802489 304 get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
901637bb 305 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
81e504b3 306 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
00b5556c
C
307 CUSTOMIZATIONS: {
308 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
309 get CSS () { return config.get<string>('instance.customizations.css') }
ac235c37 310 },
5447516b
AH
311 get ROBOTS () { return config.get<string>('instance.robots') },
312 get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
313 get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
8be1afa1
C
314 },
315 SERVICES: {
316 TWITTER: {
317 get USERNAME () { return config.get<string>('services.twitter.username') },
318 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
319 }
e861452f
C
320 }
321}
e861452f 322
9f6bae3a
C
323// ---------------------------------------------------------------------------
324
14e2014a 325let CONSTRAINTS_FIELDS = {
e4c55619 326 USERS: {
9f7a1953 327 NAME: { min: 1, max: 120 }, // Length
d23e6a1c 328 DESCRIPTION: { min: 3, max: 1000 }, // Length
d0ce42c1 329 USERNAME: { min: 1, max: 50 }, // Length
b0f9f39e 330 PASSWORD: { min: 6, max: 255 }, // Length
eacb25c4 331 VIDEO_QUOTA: { min: -1 },
bee0abff 332 VIDEO_QUOTA_DAILY: { min: -1 },
eacb25c4 333 BLOCKED_REASON: { min: 3, max: 250 } // Length
e4c55619 334 },
55fa55a9 335 VIDEO_ABUSES: {
1506307f
C
336 REASON: { min: 2, max: 3000 }, // Length
337 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
55fa55a9 338 },
26b7305a
C
339 VIDEO_BLACKLIST: {
340 REASON: { min: 2, max: 300 } // Length
341 },
72c7248b 342 VIDEO_CHANNELS: {
9f7a1953 343 NAME: { min: 1, max: 120 }, // Length
d23e6a1c
BY
344 DESCRIPTION: { min: 3, max: 1000 }, // Length
345 SUPPORT: { min: 3, max: 1000 }, // Length
e34c85e5 346 URL: { min: 3, max: 2000 } // Length
72c7248b 347 },
40e87e9e
C
348 VIDEO_CAPTIONS: {
349 CAPTION_FILE: {
f4001cf4 350 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e
C
351 FILE_SIZE: {
352 max: 2 * 1024 * 1024 // 2MB
353 }
354 }
355 },
fbad87b0 356 VIDEO_IMPORTS: {
ce33919c
C
357 URL: { min: 3, max: 2000 }, // Length
358 TORRENT_NAME: { min: 3, max: 255 }, // Length
990b6a0b
C
359 TORRENT_FILE: {
360 EXTNAME: [ '.torrent' ],
361 FILE_SIZE: {
362 max: 1024 * 200 // 200 KB
363 }
364 }
fbad87b0 365 },
c48e82b5
C
366 VIDEOS_REDUNDANCY: {
367 URL: { min: 3, max: 2000 } // Length
368 },
5c6d985f
C
369 VIDEO_RATES: {
370 URL: { min: 3, max: 2000 } // Length
371 },
e4c55619 372 VIDEOS: {
a265f7f3 373 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 374 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 375 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 376 DESCRIPTION: { min: 3, max: 10000 }, // Length
d23e6a1c 377 SUPPORT: { min: 3, max: 1000 }, // Length
ac81d1a0
C
378 IMAGE: {
379 EXTNAME: [ '.jpg', '.jpeg' ],
380 FILE_SIZE: {
381 max: 2 * 1024 * 1024 // 2MB
382 }
383 },
14e2014a 384 EXTNAME: buildVideosExtname(),
0e1dc3e7 385 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 386 DURATION: { min: 0 }, // Number
a265f7f3
C
387 TAGS: { min: 0, max: 5 }, // Number of total tags
388 TAG: { min: 2, max: 30 }, // Length
e4c55619 389 THUMBNAIL: { min: 2, max: 30 },
e4c87ec2
C
390 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
391 VIEWS: { min: 0 },
392 LIKES: { min: 0 },
93e1258c 393 DISLIKES: { min: 0 },
c60774b0 394 FILE_SIZE: { min: 10 },
e34c85e5
C
395 URL: { min: 3, max: 2000 } // Length
396 },
418d092a
C
397 VIDEO_PLAYLISTS: {
398 NAME: { min: 1, max: 120 }, // Length
399 DESCRIPTION: { min: 3, max: 1000 }, // Length
400 URL: { min: 3, max: 2000 }, // Length
401 IMAGE: {
402 EXTNAME: [ '.jpg', '.jpeg' ],
403 FILE_SIZE: {
404 max: 2 * 1024 * 1024 // 2MB
405 }
406 }
407 },
01de67b9 408 ACTORS: {
e34c85e5
C
409 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
410 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3
C
411 URL: { min: 3, max: 2000 }, // Length
412 AVATAR: {
01de67b9
C
413 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
414 FILE_SIZE: {
415 max: 2 * 1024 * 1024 // 2MB
416 }
c5911fd3 417 }
e4c87ec2
C
418 },
419 VIDEO_EVENTS: {
420 COUNT: { min: 0 }
6d852470 421 },
bf1f6508 422 VIDEO_COMMENTS: {
b32b7827 423 TEXT: { min: 1, max: 3000 }, // Length
6d852470 424 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
425 },
426 VIDEO_SHARE: {
427 URL: { min: 3, max: 2000 } // Length
a4101923
C
428 },
429 CONTACT_FORM: {
430 FROM_NAME: { min: 1, max: 120 }, // Length
431 BODY: { min: 3, max: 5000 } // Length
e4c55619
C
432 }
433}
434
490b595a
C
435const RATES_LIMIT = {
436 LOGIN: {
437 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
09becad8 438 MAX: 15 // 15 attempts
288fe385
C
439 },
440 ASK_SEND_EMAIL: {
441 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
442 MAX: 3 // 3 attempts
490b595a
C
443 }
444}
445
b5c0e955 446let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
a4101923
C
447let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
448
edb4ffc7 449const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
a7977280 450 MIN: 10,
3a6f351b
C
451 AVERAGE: 30,
452 MAX: 60,
453 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 454}
b5c0e955 455
ee9e7b61 456const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
457 LIKE: 'like',
458 DISLIKE: 'dislike'
459}
460
80bc88c1
J
461const FFMPEG_NICE: { [ id: string ]: number } = {
462 THUMBNAIL: 2, // 2 just for don't blocking servers
463 TRANSCODING: 15
464}
465
6e07c3de
C
466const VIDEO_CATEGORIES = {
467 1: 'Music',
468 2: 'Films',
469 3: 'Vehicles',
470 4: 'Art',
471 5: 'Sports',
472 6: 'Travels',
473 7: 'Gaming',
474 8: 'People',
475 9: 'Comedy',
476 10: 'Entertainment',
6f2ae7a1 477 11: 'News & Politics',
40298b02 478 12: 'How To',
6e07c3de
C
479 13: 'Education',
480 14: 'Activism',
481 15: 'Science & Technology',
482 16: 'Animals',
483 17: 'Kids',
484 18: 'Food'
485}
486
6f0c39e2
C
487// See https://creativecommons.org/licenses/?lang=en
488const VIDEO_LICENCES = {
489 1: 'Attribution',
490 2: 'Attribution - Share Alike',
491 3: 'Attribution - No Derivatives',
492 4: 'Attribution - Non Commercial',
493 5: 'Attribution - Non Commercial - Share Alike',
494 6: 'Attribution - Non Commercial - No Derivatives',
495 7: 'Public Domain Dedication'
496}
497
9d3ef9fe 498const VIDEO_LANGUAGES = buildLanguages()
3092476e 499
fd45e8f4
C
500const VIDEO_PRIVACIES = {
501 [VideoPrivacy.PUBLIC]: 'Public',
502 [VideoPrivacy.UNLISTED]: 'Unlisted',
503 [VideoPrivacy.PRIVATE]: 'Private'
504}
505
2186386c
C
506const VIDEO_STATES = {
507 [VideoState.PUBLISHED]: 'Published',
fbad87b0
C
508 [VideoState.TO_TRANSCODE]: 'To transcode',
509 [VideoState.TO_IMPORT]: 'To import'
510}
511
512const VIDEO_IMPORT_STATES = {
513 [VideoImportState.FAILED]: 'Failed',
514 [VideoImportState.PENDING]: 'Pending',
515 [VideoImportState.SUCCESS]: 'Success'
2186386c
C
516}
517
268eebed
C
518const VIDEO_ABUSE_STATES = {
519 [VideoAbuseState.PENDING]: 'Pending',
520 [VideoAbuseState.REJECTED]: 'Rejected',
521 [VideoAbuseState.ACCEPTED]: 'Accepted'
522}
523
418d092a
C
524const VIDEO_PLAYLIST_PRIVACIES = {
525 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
526 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
527 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
528}
529
df0b219d
C
530const VIDEO_PLAYLIST_TYPES = {
531 [VideoPlaylistType.REGULAR]: 'Regular',
532 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
533}
534
14e2014a
C
535const MIMETYPES = {
536 VIDEO: {
537 MIMETYPE_EXT: buildVideoMimetypeExt(),
538 EXT_MIMETYPE: null as { [ id: string ]: string }
539 },
540 IMAGE: {
541 MIMETYPE_EXT: {
542 'image/png': '.png',
543 'image/jpg': '.jpg',
544 'image/jpeg': '.jpg'
545 }
546 },
547 VIDEO_CAPTIONS: {
548 MIMETYPE_EXT: {
549 'text/vtt': '.vtt',
550 'application/x-subrip': '.srt'
551 }
552 },
553 TORRENT: {
554 MIMETYPE_EXT: {
555 'application/x-bittorrent': '.torrent'
556 }
557 }
990b6a0b 558}
14e2014a 559MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
990b6a0b 560
9f6bae3a
C
561// ---------------------------------------------------------------------------
562
2d3741d6
C
563const OVERVIEWS = {
564 VIDEOS: {
1a471091 565 SAMPLE_THRESHOLD: 6,
2d3741d6
C
566 SAMPLES_COUNT: 2
567 }
568}
569
570// ---------------------------------------------------------------------------
571
50d6de9c 572const SERVER_ACTOR_NAME = 'peertube'
350e31d6 573
e4f97bab 574const ACTIVITY_PUB = {
1b5b10d1
C
575 POTENTIAL_ACCEPT_HEADERS: [
576 'application/activity+json',
9a8cbd82
C
577 'application/ld+json',
578 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 579 ],
1b5b10d1 580 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 581 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 582 COLLECTION_ITEMS_PER_PAGE: 10,
c986175d 583 FETCH_PAGE_LIMIT: 100,
20494f12 584 URL_MIME_TYPES: {
14e2014a 585 VIDEO: Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT),
20494f12
C
586 TORRENT: [ 'application/x-bittorrent' ],
587 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 588 },
2ccaeeb3 589 MAX_RECURSION_COMMENTS: 100,
0e0c745b 590 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
9f79ade6
C
591 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
592 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
e4f97bab
C
593}
594
50d6de9c
C
595const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
596 GROUP: 'Group',
597 PERSON: 'Person',
598 APPLICATION: 'Application'
599}
600
41f2ebae
C
601const HTTP_SIGNATURE = {
602 HEADER_NAME: 'signature',
603 ALGORITHM: 'rsa-sha256',
df66d815 604 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
41f2ebae
C
605}
606
9f6bae3a
C
607// ---------------------------------------------------------------------------
608
04b8c3fb 609let PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 610
9f6bae3a
C
611// Password encryption
612const BCRYPT_SALT_SIZE = 10
a877d5ac 613
ecb4e35f
C
614const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
615
d9eaee39
JM
616const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
617
0883b324
C
618const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
619 DO_NOT_LIST: 'do_not_list',
620 BLUR: 'blur',
621 DISPLAY: 'display'
622}
623
bdfbd4f1
C
624// ---------------------------------------------------------------------------
625
052937db
C
626// Express static paths (router)
627const STATIC_PATHS = {
f285faa0
C
628 PREVIEWS: '/static/previews/',
629 THUMBNAILS: '/static/thumbnails/',
052937db 630 TORRENTS: '/static/torrents/',
c5911fd3 631 WEBSEED: '/static/webseed/',
b9fffa29 632 REDUNDANCY: '/static/redundancy/',
9c6ca37f
C
633 STREAMING_PLAYLISTS: {
634 HLS: '/static/streaming-playlists/hls'
09209296 635 },
40e87e9e
C
636 AVATARS: '/static/avatars/',
637 VIDEO_CAPTIONS: '/static/video-captions/'
052937db 638}
02756fbd
C
639const STATIC_DOWNLOAD_PATHS = {
640 TORRENTS: '/download/torrents/',
641 VIDEOS: '/download/videos/'
642}
052937db 643
dc009132 644// Cache control
57a81ff6 645let STATIC_MAX_AGE = '2h'
dc009132 646
cbe2f7c3 647// Videos thumbnail size
d8755eed 648const THUMBNAILS_SIZE = {
e5fc7811 649 width: 223,
830b4faf 650 height: 122
d8755eed
C
651}
652const PREVIEWS_SIZE = {
164174a6
C
653 width: 560,
654 height: 315
655}
e8e12200
C
656const AVATARS_SIZE = {
657 width: 120,
658 height: 120
659}
164174a6
C
660
661const EMBED_SIZE = {
662 width: 560,
663 height: 315
d8755eed 664}
cbe2f7c3 665
980246ea 666// Sub folders of cache directory
d74d29ad 667const FILES_CACHE = {
f4001cf4
C
668 PREVIEWS: {
669 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
670 MAX_AGE: 1000 * 3600 * 3 // 3 hours
671 },
672 VIDEO_CAPTIONS: {
673 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
674 MAX_AGE: 1000 * 3600 * 3 // 3 hours
f981dae8
C
675 }
676}
677
d74d29ad
C
678const CACHE = {
679 USER_TOKENS: {
680 MAX_SIZE: 10000
681 }
682}
683
9c6ca37f 684const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
09209296
C
685const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
686
7348b1fd
C
687const MEMOIZE_TTL = {
688 OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
689}
690
c48e82b5
C
691const REDUNDANCY = {
692 VIDEOS: {
c48e82b5
C
693 RANDOMIZED_FACTOR: 5
694 }
695}
696
e12a0092 697const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
4f491371 698
bdfbd4f1
C
699// ---------------------------------------------------------------------------
700
e032aec9
C
701const CUSTOM_HTML_TAG_COMMENTS = {
702 TITLE: '<!-- title tag -->',
703 DESCRIPTION: '<!-- description tag -->',
704 CUSTOM_CSS: '<!-- custom css tag -->',
92bf2f62 705 META_TAGS: '<!-- meta tags -->'
e032aec9 706}
709756b8
C
707
708// ---------------------------------------------------------------------------
709
4195cd2b 710const FEEDS = {
fd4484f1 711 COUNT: 20
4195cd2b
C
712}
713
714// ---------------------------------------------------------------------------
715
9b67da3d
C
716const TRACKER_RATE_LIMITS = {
717 INTERVAL: 60000 * 5, // 5 minutes
8244c85a 718 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
9b67da3d
C
719 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
720}
721
722// ---------------------------------------------------------------------------
723
9f10b292
C
724// Special constants for a test instance
725if (isTestInstance() === true) {
04b8c3fb
C
726 PRIVATE_RSA_KEY_SIZE = 1024
727
60650c77 728 ACTOR_FOLLOW_SCORE.BASE = 20
3cd0734f 729
f285faa0
C
730 REMOTE_SCHEME.HTTP = 'http'
731 REMOTE_SCHEME.WS = 'ws'
3cd0734f 732
65fcc311 733 STATIC_MAX_AGE = '0'
3cd0734f 734
c46edbc2 735 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
7bc29171 736 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1297eb5d 737 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
9f79ade6 738 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
3cd0734f 739
01de67b9 740 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
3cd0734f 741
2f5c6b2f 742 SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
2baea0c7
C
743 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
744 SCHEDULER_INTERVALS_MS.updateVideos = 5000
6b616860 745 REPEAT_JOBS['videos-views'] = { every: 5000 }
2baea0c7 746
c48e82b5
C
747 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
748
b5c0e955 749 VIDEO_VIEW_LIFETIME = 1000 // 1 second
a4101923 750 CONTACT_FORM_LIFETIME = 1000 // 1 second
3cd0734f
C
751
752 JOB_ATTEMPTS['email'] = 1
f4001cf4 753
d74d29ad 754 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
743164fe 755 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
c07b6041 756 ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
b426edd4
C
757
758 RATES_LIMIT.LOGIN.MAX = 20
9f10b292
C
759}
760
14e2014a 761updateWebserverUrls()
225a89c2 762
9f10b292
C
763// ---------------------------------------------------------------------------
764
65fcc311 765export {
9f6bae3a 766 API_VERSION,
09209296 767 HLS_REDUNDANCY_DIRECTORY,
e8e12200 768 AVATARS_SIZE,
4f491371 769 ACCEPT_HEADERS,
9f6bae3a 770 BCRYPT_SALT_SIZE,
9b67da3d 771 TRACKER_RATE_LIMITS,
d74d29ad 772 FILES_CACHE,
9f6bae3a
C
773 CONFIG,
774 CONSTRAINTS_FIELDS,
164174a6 775 EMBED_SIZE,
c48e82b5 776 REDUNDANCY,
94a5ff8a
C
777 JOB_CONCURRENCY,
778 JOB_ATTEMPTS,
b769007f 779 LAST_MIGRATION_VERSION,
9f6bae3a 780 OAUTH_LIFETIME,
e032aec9 781 CUSTOM_HTML_TAG_COMMENTS,
f55e5a7b 782 BROADCAST_CONCURRENCY,
1194e8b4 783 PAGINATION,
60650c77 784 ACTOR_FOLLOW_SCORE,
f285faa0
C
785 PREVIEWS_SIZE,
786 REMOTE_SCHEME,
7a7724e6 787 FOLLOW_STATES,
50d6de9c 788 SERVER_ACTOR_NAME,
e4f97bab 789 PRIVATE_RSA_KEY_SIZE,
fd4484f1 790 ROUTE_CACHE_LIFETIME,
9f6bae3a 791 SORTABLE_COLUMNS,
9c6ca37f 792 HLS_STREAMING_PLAYLIST_DIRECTORY,
4195cd2b 793 FEEDS,
2b86fe72 794 JOB_TTL,
0883b324 795 NSFW_POLICY_TYPES,
dc009132 796 STATIC_MAX_AGE,
a6375e69 797 STATIC_PATHS,
cf9166cf 798 VIDEO_IMPORT_TIMEOUT,
df0b219d 799 VIDEO_PLAYLIST_TYPES,
e4f97bab 800 ACTIVITY_PUB,
50d6de9c 801 ACTIVITY_PUB_ACTOR_TYPES,
9f6bae3a 802 THUMBNAILS_SIZE,
6e07c3de 803 VIDEO_CATEGORIES,
3092476e 804 VIDEO_LANGUAGES,
fd45e8f4 805 VIDEO_PRIVACIES,
6f0c39e2 806 VIDEO_LICENCES,
2186386c 807 VIDEO_STATES,
0d0e8dd0 808 VIDEO_RATE_TYPES,
a7977280 809 VIDEO_TRANSCODING_FPS,
80bc88c1 810 FFMPEG_NICE,
268eebed 811 VIDEO_ABUSE_STATES,
d74d29ad 812 CACHE,
71e3dfda 813 JOB_REQUEST_TIMEOUT,
ecb4e35f 814 USER_PASSWORD_RESET_LIFETIME,
7348b1fd 815 MEMOIZE_TTL,
d9eaee39 816 USER_EMAIL_VERIFY_LIFETIME,
2d3741d6 817 OVERVIEWS,
2baea0c7 818 SCHEDULER_INTERVALS_MS,
6b616860 819 REPEAT_JOBS,
02756fbd 820 STATIC_DOWNLOAD_PATHS,
490b595a 821 RATES_LIMIT,
14e2014a 822 MIMETYPES,
f6eebcb3 823 CRAWL_REQUEST_CONCURRENCY,
b5c0e955 824 JOB_COMPLETED_LIFETIME,
41f2ebae 825 HTTP_SIGNATURE,
fbad87b0 826 VIDEO_IMPORT_STATES,
7ce44a74 827 VIDEO_VIEW_LIFETIME,
a4101923 828 CONTACT_FORM_LIFETIME,
418d092a 829 VIDEO_PLAYLIST_PRIVACIES,
7ce44a74 830 buildLanguages
9f10b292 831}
fd206f0b
C
832
833// ---------------------------------------------------------------------------
834
835function getLocalConfigFilePath () {
836 const configSources = config.util.getConfigSources()
837 if (configSources.length === 0) throw new Error('Invalid config source.')
838
839 let filename = 'local'
840 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
841 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
842
843 return join(dirname(configSources[ 0 ].name), filename + '.json')
844}
845
14e2014a
C
846function buildVideoMimetypeExt () {
847 const data = {
848 'video/webm': '.webm',
849 'video/ogg': '.ogv',
850 'video/mp4': '.mp4'
851 }
852
853 if (CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
854 Object.assign(data, {
855 'video/quicktime': '.mov',
856 'video/x-msvideo': '.avi',
857 'video/x-flv': '.flv',
307902e2
C
858 'video/x-matroska': '.mkv',
859 'application/octet-stream': '.mkv',
860 'video/avi': '.avi'
14e2014a
C
861 })
862 }
863
864 return data
865}
866
867function updateWebserverUrls () {
fd206f0b
C
868 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
869 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
870}
871
14e2014a
C
872function updateWebserverConfig () {
873 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
874
875 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
876 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
877}
878
879function buildVideosExtname () {
880 return CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS
881 ? [ '.mp4', '.ogv', '.webm', '.mkv', '.mov', '.avi', '.flv' ]
882 : [ '.mp4', '.ogv', '.webm' ]
883}
884
e5565833 885function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
c48e82b5
C
886 if (!objs) return []
887
d85798c4
C
888 if (!Array.isArray(objs)) return objs
889
e5565833 890 return objs.map(obj => {
f9a971c6 891 return Object.assign({}, obj, {
e5565833
C
892 minLifetime: parseDuration(obj.min_lifetime),
893 size: bytes.parse(obj.size),
894 minViews: obj.min_views
895 })
896 })
c48e82b5
C
897}
898
9d3ef9fe
C
899function buildLanguages () {
900 const iso639 = require('iso-639-3')
901
902 const languages: { [ id: string ]: string } = {}
903
1d94c154
C
904 const additionalLanguages = {
905 'sgn': true, // Sign languages (macro language)
906 'ase': true, // American sign language
907 'sdl': true, // Arabian sign language
908 'bfi': true, // British sign language
909 'bzs': true, // Brazilian sign language
910 'csl': true, // Chinese sign language
911 'cse': true, // Czech sign language
912 'dsl': true, // Danish sign language
913 'fsl': true, // French sign language
914 'gsg': true, // German sign language
915 'pks': true, // Pakistan sign language
916 'jsl': true, // Japanese sign language
917 'sfs': true, // South African sign language
918 'swl': true, // Swedish sign language
919 'rsl': true, // Russian sign language: true
920
921 'epo': true, // Esperanto
922 'tlh': true, // Klingon
923 'jbo': true, // Lojban
924 'avk': true // Kotava
925 }
9d3ef9fe
C
926
927 // Only add ISO639-1 languages and some sign languages (ISO639-3)
928 iso639
929 .filter(l => {
930 return (l.iso6391 !== null && l.type === 'living') ||
1d94c154 931 additionalLanguages[l.iso6393] === true
9d3ef9fe
C
932 })
933 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
934
db6d617d
C
935 // Override Occitan label
936 languages['oc'] = 'Occitan'
937
9d3ef9fe
C
938 return languages
939}
940
fd206f0b
C
941export function reloadConfig () {
942
943 function directory () {
944 if (process.env.NODE_CONFIG_DIR) {
945 return process.env.NODE_CONFIG_DIR
946 }
947
948 return join(root(), 'config')
949 }
950
951 function purge () {
952 for (const fileName in require.cache) {
953 if (-1 === fileName.indexOf(directory())) {
954 continue
955 }
956
957 delete require.cache[fileName]
958 }
959
960 delete require.cache[require.resolve('config')]
961 }
962
963 purge()
964
965 config = require('config')
966
967 updateWebserverConfig()
14e2014a 968 updateWebserverUrls()
fd206f0b 969}