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