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