Increase access_token lifetime
[oweals/peertube.git] / server / initializers / constants.ts
1 import { IConfig } from 'config'
2 import { dirname, join } from 'path'
3 import { JobType, VideoRateType } 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 = 215
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_MIMETYPE_EXT = {
330   'video/webm': '.webm',
331   'video/ogg': '.ogv',
332   'video/mp4': '.mp4'
333 }
334 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
335
336 const IMAGE_MIMETYPE_EXT = {
337   'image/png': '.png',
338   'image/jpg': '.jpg',
339   'image/jpeg': '.jpg'
340 }
341
342 // ---------------------------------------------------------------------------
343
344 const SERVER_ACTOR_NAME = 'peertube'
345
346 const ACTIVITY_PUB = {
347   POTENTIAL_ACCEPT_HEADERS: [
348     'application/activity+json',
349     'application/ld+json',
350     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
351   ],
352   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
353   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
354   COLLECTION_ITEMS_PER_PAGE: 10,
355   FETCH_PAGE_LIMIT: 100,
356   URL_MIME_TYPES: {
357     VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
358     TORRENT: [ 'application/x-bittorrent' ],
359     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
360   },
361   MAX_RECURSION_COMMENTS: 100,
362   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
363 }
364
365 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
366   GROUP: 'Group',
367   PERSON: 'Person',
368   APPLICATION: 'Application'
369 }
370
371 // ---------------------------------------------------------------------------
372
373 const PRIVATE_RSA_KEY_SIZE = 2048
374
375 // Password encryption
376 const BCRYPT_SALT_SIZE = 10
377
378 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
379
380 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
381   DO_NOT_LIST: 'do_not_list',
382   BLUR: 'blur',
383   DISPLAY: 'display'
384 }
385
386 // ---------------------------------------------------------------------------
387
388 // Express static paths (router)
389 const STATIC_PATHS = {
390   PREVIEWS: '/static/previews/',
391   THUMBNAILS: '/static/thumbnails/',
392   TORRENTS: '/static/torrents/',
393   WEBSEED: '/static/webseed/',
394   AVATARS: '/static/avatars/'
395 }
396 const STATIC_DOWNLOAD_PATHS = {
397   TORRENTS: '/download/torrents/',
398   VIDEOS: '/download/videos/'
399 }
400
401 // Cache control
402 let STATIC_MAX_AGE = '30d'
403
404 // Videos thumbnail size
405 const THUMBNAILS_SIZE = {
406   width: 200,
407   height: 110
408 }
409 const PREVIEWS_SIZE = {
410   width: 560,
411   height: 315
412 }
413 const AVATARS_SIZE = {
414   width: 120,
415   height: 120
416 }
417
418 const EMBED_SIZE = {
419   width: 560,
420   height: 315
421 }
422
423 // Sub folders of cache directory
424 const CACHE = {
425   DIRECTORIES: {
426     PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
427   }
428 }
429
430 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
431
432 // ---------------------------------------------------------------------------
433
434 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
435
436 // ---------------------------------------------------------------------------
437
438 const FEEDS = {
439   COUNT: 20
440 }
441
442 // ---------------------------------------------------------------------------
443
444 // Special constants for a test instance
445 if (isTestInstance() === true) {
446   ACTOR_FOLLOW_SCORE.BASE = 20
447   REMOTE_SCHEME.HTTP = 'http'
448   REMOTE_SCHEME.WS = 'ws'
449   STATIC_MAX_AGE = '0'
450   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
451   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
452   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
453   SCHEDULER_INTERVAL = 10000
454   VIDEO_VIEW_LIFETIME = 1000 // 1 second
455 }
456
457 updateWebserverConfig()
458
459 // ---------------------------------------------------------------------------
460
461 export {
462   API_VERSION,
463   AVATARS_SIZE,
464   ACCEPT_HEADERS,
465   BCRYPT_SALT_SIZE,
466   CACHE,
467   CONFIG,
468   CONSTRAINTS_FIELDS,
469   EMBED_SIZE,
470   JOB_CONCURRENCY,
471   JOB_ATTEMPTS,
472   LAST_MIGRATION_VERSION,
473   OAUTH_LIFETIME,
474   OPENGRAPH_AND_OEMBED_COMMENT,
475   BROADCAST_CONCURRENCY,
476   PAGINATION_COUNT_DEFAULT,
477   ACTOR_FOLLOW_SCORE,
478   PREVIEWS_SIZE,
479   REMOTE_SCHEME,
480   FOLLOW_STATES,
481   SERVER_ACTOR_NAME,
482   PRIVATE_RSA_KEY_SIZE,
483   ROUTE_CACHE_LIFETIME,
484   SORTABLE_COLUMNS,
485   FEEDS,
486   NSFW_POLICY_TYPES,
487   STATIC_MAX_AGE,
488   STATIC_PATHS,
489   ACTIVITY_PUB,
490   ACTIVITY_PUB_ACTOR_TYPES,
491   THUMBNAILS_SIZE,
492   VIDEO_CATEGORIES,
493   VIDEO_LANGUAGES,
494   VIDEO_PRIVACIES,
495   VIDEO_LICENCES,
496   VIDEO_RATE_TYPES,
497   VIDEO_MIMETYPE_EXT,
498   VIDEO_TRANSCODING_FPS,
499   JOB_REQUEST_TIMEOUT,
500   JOB_REQUEST_TTL,
501   USER_PASSWORD_RESET_LIFETIME,
502   IMAGE_MIMETYPE_EXT,
503   SCHEDULER_INTERVAL,
504   STATIC_DOWNLOAD_PATHS,
505   RATES_LIMIT,
506   VIDEO_EXT_MIMETYPE,
507   JOB_COMPLETED_LIFETIME,
508   VIDEO_VIEW_LIFETIME,
509   buildLanguages
510 }
511
512 // ---------------------------------------------------------------------------
513
514 function getLocalConfigFilePath () {
515   const configSources = config.util.getConfigSources()
516   if (configSources.length === 0) throw new Error('Invalid config source.')
517
518   let filename = 'local'
519   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
520   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
521
522   return join(dirname(configSources[ 0 ].name), filename + '.json')
523 }
524
525 function updateWebserverConfig () {
526   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
527   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
528 }
529
530 function buildLanguages () {
531   const iso639 = require('iso-639-3')
532
533   const languages: { [ id: string ]: string } = {}
534
535   const signLanguages = [
536     'sgn', // Sign languages (macro language)
537     'ase', // American
538     'sdl', // Arabian
539     'bfi', // British
540     'bzs', // Brazilian
541     'csl', // Chinese
542     'cse', // Czech
543     'dsl', // Danish
544     'fsl', // French
545     'gsg', // German
546     'pks', // Pakistan
547     'jsl', // Japanese
548     'sfs', // South African
549     'swl', // Swedish
550     'rsl' // Russian
551   ]
552
553   // Only add ISO639-1 languages and some sign languages (ISO639-3)
554   iso639
555     .filter(l => {
556       return (l.iso6391 !== null && l.type === 'living') ||
557         signLanguages.indexOf(l.iso6393) !== -1
558     })
559     .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
560
561   return languages
562 }
563
564 export function reloadConfig () {
565
566   function directory () {
567     if (process.env.NODE_CONFIG_DIR) {
568       return process.env.NODE_CONFIG_DIR
569     }
570
571     return join(root(), 'config')
572   }
573
574   function purge () {
575     for (const fileName in require.cache) {
576       if (-1 === fileName.indexOf(directory())) {
577         continue
578       }
579
580       delete require.cache[fileName]
581     }
582
583     delete require.cache[require.resolve('config')]
584   }
585
586   purge()
587
588   config = require('config')
589
590   updateWebserverConfig()
591 }