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