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