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