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