]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - server/initializers/constants.ts
8dbc1b060805f96887cd49c2ec767986794793cb
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
1 import { IConfig } from 'config'
2 import { dirname, join } from 'path'
3 import { JobType, VideoRateType, VideoState } from '../../shared/models'
4 import { ActivityPubActorType } from '../../shared/models/activitypub'
5 import { FollowState } from '../../shared/models/actors'
6 import { VideoPrivacy } from '../../shared/models/videos'
7 // Do not use barrels, remain constants as independent as possible
8 import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
9 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
10 import { invert } from 'lodash'
11
12 // Use a variable to reload the configuration if we need
13 let config: IConfig = require('config')
14
15 // ---------------------------------------------------------------------------
16
17 const LAST_MIGRATION_VERSION = 220
18
19 // ---------------------------------------------------------------------------
20
21 // API version
22 const API_VERSION = 'v1'
23
24 // Number of results by default for the pagination
25 const PAGINATION_COUNT_DEFAULT = 15
26
27 // Sortable columns per schema
28 const SORTABLE_COLUMNS = {
29 USERS: [ 'id', 'username', 'createdAt' ],
30 ACCOUNTS: [ 'createdAt' ],
31 JOBS: [ 'createdAt' ],
32 VIDEO_ABUSES: [ 'id', 'createdAt' ],
33 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
34 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
35 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
36 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
37 FOLLOWERS: [ 'createdAt' ],
38 FOLLOWING: [ 'createdAt' ]
39 }
40
41 const OAUTH_LIFETIME = {
42 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
43 REFRESH_TOKEN: 1209600 // 2 weeks
44 }
45
46 const ROUTE_CACHE_LIFETIME = {
47 FEEDS: 1000 * 60 * 15, // 15 minutes
48 ACTIVITY_PUB: {
49 VIDEOS: 1000 // 1 second, cache concurrent requests after a broadcast for example
50 }
51 }
52
53 // ---------------------------------------------------------------------------
54
55 // Number of points we add/remove after a successful/bad request
56 const ACTOR_FOLLOW_SCORE = {
57 PENALTY: -10,
58 BONUS: 10,
59 BASE: 1000,
60 MAX: 10000
61 }
62
63 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
64 PENDING: 'pending',
65 ACCEPTED: 'accepted'
66 }
67
68 const REMOTE_SCHEME = {
69 HTTP: 'https',
70 WS: 'wss'
71 }
72
73 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
74 'activitypub-http-broadcast': 5,
75 'activitypub-http-unicast': 5,
76 'activitypub-http-fetcher': 5,
77 'activitypub-follow': 5,
78 'video-file-import': 1,
79 'video-file': 1,
80 'email': 5
81 }
82 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
83 'activitypub-http-broadcast': 1,
84 'activitypub-http-unicast': 5,
85 'activitypub-http-fetcher': 1,
86 'activitypub-follow': 3,
87 'video-file-import': 1,
88 'video-file': 1,
89 'email': 5
90 }
91 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
92 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
93 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
94 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
95
96 // 1 hour
97 let SCHEDULER_INTERVAL = 60000 * 60
98
99 // ---------------------------------------------------------------------------
100
101 const CONFIG = {
102 CUSTOM_FILE: getLocalConfigFilePath(),
103 LISTEN: {
104 PORT: config.get<number>('listen.port'),
105 HOSTNAME: config.get<string>('listen.hostname')
106 },
107 DATABASE: {
108 DBNAME: 'peertube' + config.get<string>('database.suffix'),
109 HOSTNAME: config.get<string>('database.hostname'),
110 PORT: config.get<number>('database.port'),
111 USERNAME: config.get<string>('database.username'),
112 PASSWORD: config.get<string>('database.password')
113 },
114 REDIS: {
115 HOSTNAME: config.get<string>('redis.hostname'),
116 PORT: config.get<number>('redis.port'),
117 AUTH: config.get<string>('redis.auth'),
118 DB: config.get<number>('redis.db')
119 },
120 SMTP: {
121 HOSTNAME: config.get<string>('smtp.hostname'),
122 PORT: config.get<number>('smtp.port'),
123 USERNAME: config.get<string>('smtp.username'),
124 PASSWORD: config.get<string>('smtp.password'),
125 TLS: config.get<boolean>('smtp.tls'),
126 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
127 CA_FILE: config.get<string>('smtp.ca_file'),
128 FROM_ADDRESS: config.get<string>('smtp.from_address')
129 },
130 STORAGE: {
131 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
132 LOG_DIR: buildPath(config.get<string>('storage.logs')),
133 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
134 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
135 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
136 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
137 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
138 },
139 WEBSERVER: {
140 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
141 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
142 HOSTNAME: config.get<string>('webserver.hostname'),
143 PORT: config.get<number>('webserver.port'),
144 URL: '',
145 HOST: ''
146 },
147 TRUST_PROXY: config.get<string[]>('trust_proxy'),
148 LOG: {
149 LEVEL: config.get<string>('log.level')
150 },
151 ADMIN: {
152 get EMAIL () { return config.get<string>('admin.email') }
153 },
154 SIGNUP: {
155 get ENABLED () { return config.get<boolean>('signup.enabled') },
156 get LIMIT () { return config.get<number>('signup.limit') },
157 FILTERS: {
158 CIDR: {
159 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
160 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
161 }
162 }
163 },
164 USER: {
165 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
166 },
167 TRANSCODING: {
168 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
169 get THREADS () { return config.get<number>('transcoding.threads') },
170 RESOLUTIONS: {
171 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
172 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
173 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
174 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
175 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
176 }
177 },
178 CACHE: {
179 PREVIEWS: {
180 get SIZE () { return config.get<number>('cache.previews.size') }
181 }
182 },
183 INSTANCE: {
184 get NAME () { return config.get<string>('instance.name') },
185 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
186 get DESCRIPTION () { return config.get<string>('instance.description') },
187 get TERMS () { return config.get<string>('instance.terms') },
188 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
189 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
190 CUSTOMIZATIONS: {
191 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
192 get CSS () { return config.get<string>('instance.customizations.css') }
193 },
194 get ROBOTS () { return config.get<string>('instance.robots') }
195 },
196 SERVICES: {
197 TWITTER: {
198 get USERNAME () { return config.get<string>('services.twitter.username') },
199 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
200 }
201 }
202 }
203
204 // ---------------------------------------------------------------------------
205
206 const CONSTRAINTS_FIELDS = {
207 USERS: {
208 NAME: { min: 3, max: 120 }, // Length
209 DESCRIPTION: { min: 3, max: 250 }, // Length
210 USERNAME: { min: 3, max: 20 }, // Length
211 PASSWORD: { min: 6, max: 255 }, // Length
212 VIDEO_QUOTA: { min: -1 }
213 },
214 VIDEO_ABUSES: {
215 REASON: { min: 2, max: 300 } // Length
216 },
217 VIDEO_CHANNELS: {
218 NAME: { min: 3, max: 120 }, // Length
219 DESCRIPTION: { min: 3, max: 500 }, // Length
220 SUPPORT: { min: 3, max: 500 }, // Length
221 URL: { min: 3, max: 2000 } // Length
222 },
223 VIDEOS: {
224 NAME: { min: 3, max: 120 }, // Length
225 LANGUAGE: { min: 1, max: 10 }, // Length
226 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
227 DESCRIPTION: { min: 3, max: 10000 }, // Length
228 SUPPORT: { min: 3, max: 500 }, // Length
229 IMAGE: {
230 EXTNAME: [ '.jpg', '.jpeg' ],
231 FILE_SIZE: {
232 max: 2 * 1024 * 1024 // 2MB
233 }
234 },
235 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
236 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
237 DURATION: { min: 1 }, // Number
238 TAGS: { min: 0, max: 5 }, // Number of total tags
239 TAG: { min: 2, max: 30 }, // Length
240 THUMBNAIL: { min: 2, max: 30 },
241 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
242 VIEWS: { min: 0 },
243 LIKES: { min: 0 },
244 DISLIKES: { min: 0 },
245 FILE_SIZE: { min: 10 },
246 URL: { min: 3, max: 2000 } // Length
247 },
248 ACTORS: {
249 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
250 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
251 URL: { min: 3, max: 2000 }, // Length
252 AVATAR: {
253 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
254 FILE_SIZE: {
255 max: 2 * 1024 * 1024 // 2MB
256 }
257 }
258 },
259 VIDEO_EVENTS: {
260 COUNT: { min: 0 }
261 },
262 VIDEO_COMMENTS: {
263 TEXT: { min: 1, max: 3000 }, // Length
264 URL: { min: 3, max: 2000 } // Length
265 },
266 VIDEO_SHARE: {
267 URL: { min: 3, max: 2000 } // Length
268 }
269 }
270
271 const RATES_LIMIT = {
272 LOGIN: {
273 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
274 MAX: 15 // 15 attempts
275 }
276 }
277
278 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
279 const VIDEO_TRANSCODING_FPS = {
280 MIN: 10,
281 MAX: 30
282 }
283
284 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
285 LIKE: 'like',
286 DISLIKE: 'dislike'
287 }
288
289 const VIDEO_CATEGORIES = {
290 1: 'Music',
291 2: 'Films',
292 3: 'Vehicles',
293 4: 'Art',
294 5: 'Sports',
295 6: 'Travels',
296 7: 'Gaming',
297 8: 'People',
298 9: 'Comedy',
299 10: 'Entertainment',
300 11: 'News',
301 12: 'How To',
302 13: 'Education',
303 14: 'Activism',
304 15: 'Science & Technology',
305 16: 'Animals',
306 17: 'Kids',
307 18: 'Food'
308 }
309
310 // See https://creativecommons.org/licenses/?lang=en
311 const VIDEO_LICENCES = {
312 1: 'Attribution',
313 2: 'Attribution - Share Alike',
314 3: 'Attribution - No Derivatives',
315 4: 'Attribution - Non Commercial',
316 5: 'Attribution - Non Commercial - Share Alike',
317 6: 'Attribution - Non Commercial - No Derivatives',
318 7: 'Public Domain Dedication'
319 }
320
321 const VIDEO_LANGUAGES = buildLanguages()
322
323 const VIDEO_PRIVACIES = {
324 [VideoPrivacy.PUBLIC]: 'Public',
325 [VideoPrivacy.UNLISTED]: 'Unlisted',
326 [VideoPrivacy.PRIVATE]: 'Private'
327 }
328
329 const VIDEO_STATES = {
330 [VideoState.PUBLISHED]: 'Published',
331 [VideoState.TO_TRANSCODE]: 'To transcode'
332 }
333
334 const VIDEO_MIMETYPE_EXT = {
335 'video/webm': '.webm',
336 'video/ogg': '.ogv',
337 'video/mp4': '.mp4'
338 }
339 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
340
341 const IMAGE_MIMETYPE_EXT = {
342 'image/png': '.png',
343 'image/jpg': '.jpg',
344 'image/jpeg': '.jpg'
345 }
346
347 // ---------------------------------------------------------------------------
348
349 const SERVER_ACTOR_NAME = 'peertube'
350
351 const ACTIVITY_PUB = {
352 POTENTIAL_ACCEPT_HEADERS: [
353 'application/activity+json',
354 'application/ld+json',
355 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
356 ],
357 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
358 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
359 COLLECTION_ITEMS_PER_PAGE: 10,
360 FETCH_PAGE_LIMIT: 100,
361 URL_MIME_TYPES: {
362 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
363 TORRENT: [ 'application/x-bittorrent' ],
364 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
365 },
366 MAX_RECURSION_COMMENTS: 100,
367 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
368 }
369
370 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
371 GROUP: 'Group',
372 PERSON: 'Person',
373 APPLICATION: 'Application'
374 }
375
376 // ---------------------------------------------------------------------------
377
378 const PRIVATE_RSA_KEY_SIZE = 2048
379
380 // Password encryption
381 const BCRYPT_SALT_SIZE = 10
382
383 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
384
385 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
386 DO_NOT_LIST: 'do_not_list',
387 BLUR: 'blur',
388 DISPLAY: 'display'
389 }
390
391 // ---------------------------------------------------------------------------
392
393 // Express static paths (router)
394 const STATIC_PATHS = {
395 PREVIEWS: '/static/previews/',
396 THUMBNAILS: '/static/thumbnails/',
397 TORRENTS: '/static/torrents/',
398 WEBSEED: '/static/webseed/',
399 AVATARS: '/static/avatars/'
400 }
401 const STATIC_DOWNLOAD_PATHS = {
402 TORRENTS: '/download/torrents/',
403 VIDEOS: '/download/videos/'
404 }
405
406 // Cache control
407 let STATIC_MAX_AGE = '30d'
408
409 // Videos thumbnail size
410 const THUMBNAILS_SIZE = {
411 width: 200,
412 height: 110
413 }
414 const PREVIEWS_SIZE = {
415 width: 560,
416 height: 315
417 }
418 const AVATARS_SIZE = {
419 width: 120,
420 height: 120
421 }
422
423 const EMBED_SIZE = {
424 width: 560,
425 height: 315
426 }
427
428 // Sub folders of cache directory
429 const CACHE = {
430 DIRECTORIES: {
431 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
432 }
433 }
434
435 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
436
437 // ---------------------------------------------------------------------------
438
439 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
440
441 // ---------------------------------------------------------------------------
442
443 const FEEDS = {
444 COUNT: 20
445 }
446
447 // ---------------------------------------------------------------------------
448
449 // Special constants for a test instance
450 if (isTestInstance() === true) {
451 ACTOR_FOLLOW_SCORE.BASE = 20
452 REMOTE_SCHEME.HTTP = 'http'
453 REMOTE_SCHEME.WS = 'ws'
454 STATIC_MAX_AGE = '0'
455 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
456 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
457 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
458 SCHEDULER_INTERVAL = 10000
459 VIDEO_VIEW_LIFETIME = 1000 // 1 second
460 }
461
462 updateWebserverConfig()
463
464 // ---------------------------------------------------------------------------
465
466 export {
467 API_VERSION,
468 AVATARS_SIZE,
469 ACCEPT_HEADERS,
470 BCRYPT_SALT_SIZE,
471 CACHE,
472 CONFIG,
473 CONSTRAINTS_FIELDS,
474 EMBED_SIZE,
475 JOB_CONCURRENCY,
476 JOB_ATTEMPTS,
477 LAST_MIGRATION_VERSION,
478 OAUTH_LIFETIME,
479 OPENGRAPH_AND_OEMBED_COMMENT,
480 BROADCAST_CONCURRENCY,
481 PAGINATION_COUNT_DEFAULT,
482 ACTOR_FOLLOW_SCORE,
483 PREVIEWS_SIZE,
484 REMOTE_SCHEME,
485 FOLLOW_STATES,
486 SERVER_ACTOR_NAME,
487 PRIVATE_RSA_KEY_SIZE,
488 ROUTE_CACHE_LIFETIME,
489 SORTABLE_COLUMNS,
490 FEEDS,
491 NSFW_POLICY_TYPES,
492 STATIC_MAX_AGE,
493 STATIC_PATHS,
494 ACTIVITY_PUB,
495 ACTIVITY_PUB_ACTOR_TYPES,
496 THUMBNAILS_SIZE,
497 VIDEO_CATEGORIES,
498 VIDEO_LANGUAGES,
499 VIDEO_PRIVACIES,
500 VIDEO_LICENCES,
501 VIDEO_STATES,
502 VIDEO_RATE_TYPES,
503 VIDEO_MIMETYPE_EXT,
504 VIDEO_TRANSCODING_FPS,
505 JOB_REQUEST_TIMEOUT,
506 JOB_REQUEST_TTL,
507 USER_PASSWORD_RESET_LIFETIME,
508 IMAGE_MIMETYPE_EXT,
509 SCHEDULER_INTERVAL,
510 STATIC_DOWNLOAD_PATHS,
511 RATES_LIMIT,
512 VIDEO_EXT_MIMETYPE,
513 JOB_COMPLETED_LIFETIME,
514 VIDEO_VIEW_LIFETIME,
515 buildLanguages
516 }
517
518 // ---------------------------------------------------------------------------
519
520 function getLocalConfigFilePath () {
521 const configSources = config.util.getConfigSources()
522 if (configSources.length === 0) throw new Error('Invalid config source.')
523
524 let filename = 'local'
525 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
526 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
527
528 return join(dirname(configSources[ 0 ].name), filename + '.json')
529 }
530
531 function updateWebserverConfig () {
532 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
533 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
534 }
535
536 function buildLanguages () {
537 const iso639 = require('iso-639-3')
538
539 const languages: { [ id: string ]: string } = {}
540
541 const signLanguages = [
542 'sgn', // Sign languages (macro language)
543 'ase', // American
544 'sdl', // Arabian
545 'bfi', // British
546 'bzs', // Brazilian
547 'csl', // Chinese
548 'cse', // Czech
549 'dsl', // Danish
550 'fsl', // French
551 'gsg', // German
552 'pks', // Pakistan
553 'jsl', // Japanese
554 'sfs', // South African
555 'swl', // Swedish
556 'rsl' // Russian
557 ]
558
559 // Only add ISO639-1 languages and some sign languages (ISO639-3)
560 iso639
561 .filter(l => {
562 return (l.iso6391 !== null && l.type === 'living') ||
563 signLanguages.indexOf(l.iso6393) !== -1
564 })
565 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
566
567 return languages
568 }
569
570 export function reloadConfig () {
571
572 function directory () {
573 if (process.env.NODE_CONFIG_DIR) {
574 return process.env.NODE_CONFIG_DIR
575 }
576
577 return join(root(), 'config')
578 }
579
580 function purge () {
581 for (const fileName in require.cache) {
582 if (-1 === fileName.indexOf(directory())) {
583 continue
584 }
585
586 delete require.cache[fileName]
587 }
588
589 delete require.cache[require.resolve('config')]
590 }
591
592 purge()
593
594 config = require('config')
595
596 updateWebserverConfig()
597 }