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 = 205
  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     USERNAME: { min: 3, max: 20 }, // Length
 184     PASSWORD: { min: 6, max: 255 }, // Length
 185     DESCRIPTION: { min: 3, max: 250 }, // Length
 186     VIDEO_QUOTA: { min: -1 }
 187   },
 188   VIDEO_ABUSES: {
 189     REASON: { min: 2, max: 300 } // Length
 190   },
 191   VIDEO_CHANNELS: {
 192     NAME: { min: 3, max: 120 }, // Length
 193     DESCRIPTION: { min: 3, max: 250 }, // Length
 194     SUPPORT: { min: 3, max: 300 }, // Length
 195     URL: { min: 3, max: 2000 } // Length
 196   },
 197   VIDEOS: {
 198     NAME: { min: 3, max: 120 }, // Length
 199     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 200     DESCRIPTION: { min: 3, max: 10000 }, // Length
 201     SUPPORT: { min: 3, max: 300 }, // Length
 202     IMAGE: {
 203       EXTNAME: [ '.jpg', '.jpeg' ],
 204       FILE_SIZE: {
 205         max: 2 * 1024 * 1024 // 2MB
 206       }
 207     },
 208     EXTNAME: [ '.mp4', '.ogv', '.webm' ],
 209     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 210     DURATION: { min: 1 }, // Number
 211     TAGS: { min: 0, max: 5 }, // Number of total tags
 212     TAG: { min: 2, max: 30 }, // Length
 213     THUMBNAIL: { min: 2, max: 30 },
 214     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 215     VIEWS: { min: 0 },
 216     LIKES: { min: 0 },
 217     DISLIKES: { min: 0 },
 218     FILE_SIZE: { min: 10 },
 219     URL: { min: 3, max: 2000 } // Length
 220   },
 221   ACTORS: {
 222     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 223     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 224     URL: { min: 3, max: 2000 }, // Length
 225     AVATAR: {
 226       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 227       FILE_SIZE: {
 228         max: 2 * 1024 * 1024 // 2MB
 229       }
 230     }
 231   },
 232   VIDEO_EVENTS: {
 233     COUNT: { min: 0 }
 234   },
 235   VIDEO_COMMENTS: {
 236     TEXT: { min: 1, max: 3000 }, // Length
 237     URL: { min: 3, max: 2000 } // Length
 238   },
 239   VIDEO_SHARE: {
 240     URL: { min: 3, max: 2000 } // Length
 241   }
 242 }
 243
 244 const RATES_LIMIT = {
 245   LOGIN: {
 246     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 247     MAX: 15 // 15 attempts
 248   }
 249 }
 250
 251 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 252 const VIDEO_TRANSCODING_FPS = {
 253   MIN: 10,
 254   MAX: 30
 255 }
 256
 257 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 258   LIKE: 'like',
 259   DISLIKE: 'dislike'
 260 }
 261
 262 const VIDEO_CATEGORIES = {
 263   1: 'Music',
 264   2: 'Films',
 265   3: 'Vehicles',
 266   4: 'Art',
 267   5: 'Sports',
 268   6: 'Travels',
 269   7: 'Gaming',
 270   8: 'People',
 271   9: 'Comedy',
 272   10: 'Entertainment',
 273   11: 'News',
 274   12: 'How To',
 275   13: 'Education',
 276   14: 'Activism',
 277   15: 'Science & Technology',
 278   16: 'Animals',
 279   17: 'Kids',
 280   18: 'Food'
 281 }
 282
 283 // See https://creativecommons.org/licenses/?lang=en
 284 const VIDEO_LICENCES = {
 285   1: 'Attribution',
 286   2: 'Attribution - Share Alike',
 287   3: 'Attribution - No Derivatives',
 288   4: 'Attribution - Non Commercial',
 289   5: 'Attribution - Non Commercial - Share Alike',
 290   6: 'Attribution - Non Commercial - No Derivatives',
 291   7: 'Public Domain Dedication'
 292 }
 293
 294 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
 295 const VIDEO_LANGUAGES = {
 296   1: 'English',
 297   2: 'Spanish',
 298   3: 'Mandarin',
 299   4: 'Hindi',
 300   5: 'Arabic',
 301   6: 'Portuguese',
 302   7: 'Bengali',
 303   8: 'Russian',
 304   9: 'Japanese',
 305   10: 'Punjabi',
 306   11: 'German',
 307   12: 'Korean',
 308   13: 'French',
 309   14: 'Italian',
 310   1000: 'Sign Language',
 311   1001: 'American Sign Language',
 312   1002: 'Arab Sign Language',
 313   1003: 'British Sign Language',
 314   1004: 'Brazilian Sign Language',
 315   1005: 'Chinese Sign Language',
 316   1006: 'Czech Sign Language',
 317   1007: 'Danish Sign Language',
 318   1008: 'French Sign Language',
 319   1009: 'German Sign Language',
 320   1010: 'Indo-Pakistani Sign Language',
 321   1011: 'Japanese Sign Language',
 322   1012: 'South African Sign Language',
 323   1013: 'Swedish Sign Language',
 324   1014: 'Russian Sign Language'
 325 }
 326
 327 const VIDEO_PRIVACIES = {
 328   [VideoPrivacy.PUBLIC]: 'Public',
 329   [VideoPrivacy.UNLISTED]: 'Unlisted',
 330   [VideoPrivacy.PRIVATE]: 'Private'
 331 }
 332
 333 const VIDEO_MIMETYPE_EXT = {
 334   'video/webm': '.webm',
 335   'video/ogg': '.ogv',
 336   'video/mp4': '.mp4'
 337 }
 338
 339 const IMAGE_MIMETYPE_EXT = {
 340   'image/png': '.png',
 341   'image/jpg': '.jpg',
 342   'image/jpeg': '.jpg'
 343 }
 344
 345 // ---------------------------------------------------------------------------
 346
 347 const SERVER_ACTOR_NAME = 'peertube'
 348
 349 const ACTIVITY_PUB = {
 350   POTENTIAL_ACCEPT_HEADERS: [
 351     'application/activity+json',
 352     'application/ld+json',
 353     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 354   ],
 355   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 356   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 357   COLLECTION_ITEMS_PER_PAGE: 10,
 358   FETCH_PAGE_LIMIT: 100,
 359   URL_MIME_TYPES: {
 360     VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
 361     TORRENT: [ 'application/x-bittorrent' ],
 362     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 363   },
 364   MAX_RECURSION_COMMENTS: 100,
 365   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 366 }
 367
 368 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 369   GROUP: 'Group',
 370   PERSON: 'Person',
 371   APPLICATION: 'Application'
 372 }
 373
 374 // ---------------------------------------------------------------------------
 375
 376 const PRIVATE_RSA_KEY_SIZE = 2048
 377
 378 // Password encryption
 379 const BCRYPT_SALT_SIZE = 10
 380
 381 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 382
 383 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
 384   DO_NOT_LIST: 'do_not_list',
 385   BLUR: 'blur',
 386   DISPLAY: 'display'
 387 }
 388
 389 // ---------------------------------------------------------------------------
 390
 391 // Express static paths (router)
 392 const STATIC_PATHS = {
 393   PREVIEWS: '/static/previews/',
 394   THUMBNAILS: '/static/thumbnails/',
 395   TORRENTS: '/static/torrents/',
 396   WEBSEED: '/static/webseed/',
 397   AVATARS: '/static/avatars/'
 398 }
 399
 400 // Cache control
 401 let STATIC_MAX_AGE = '30d'
 402
 403 // Videos thumbnail size
 404 const THUMBNAILS_SIZE = {
 405   width: 200,
 406   height: 110
 407 }
 408 const PREVIEWS_SIZE = {
 409   width: 560,
 410   height: 315
 411 }
 412 const AVATARS_SIZE = {
 413   width: 120,
 414   height: 120
 415 }
 416
 417 const EMBED_SIZE = {
 418   width: 560,
 419   height: 315
 420 }
 421
 422 // Sub folders of cache directory
 423 const CACHE = {
 424   DIRECTORIES: {
 425     PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
 426   }
 427 }
 428
 429 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 430
 431 // ---------------------------------------------------------------------------
 432
 433 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
 434
 435 // ---------------------------------------------------------------------------
 436
 437 const FEEDS = {
 438   COUNT: 20,
 439   CACHE_LIFETIME: 1000 * 60 * 15 // 15 minutes
 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   SORTABLE_COLUMNS,
 484   FEEDS,
 485   NSFW_POLICY_TYPES,
 486   STATIC_MAX_AGE,
 487   STATIC_PATHS,
 488   ACTIVITY_PUB,
 489   ACTIVITY_PUB_ACTOR_TYPES,
 490   THUMBNAILS_SIZE,
 491   VIDEO_CATEGORIES,
 492   VIDEO_LANGUAGES,
 493   VIDEO_PRIVACIES,
 494   VIDEO_LICENCES,
 495   VIDEO_RATE_TYPES,
 496   VIDEO_MIMETYPE_EXT,
 497   VIDEO_TRANSCODING_FPS,
 498   USER_PASSWORD_RESET_LIFETIME,
 499   IMAGE_MIMETYPE_EXT,
 500   SCHEDULER_INTERVAL,
 501   RATES_LIMIT,
 502   JOB_COMPLETED_LIFETIME,
 503   VIDEO_VIEW_LIFETIME
 504 }
 505
 506 // ---------------------------------------------------------------------------
 507
 508 function getLocalConfigFilePath () {
 509   const configSources = config.util.getConfigSources()
 510   if (configSources.length === 0) throw new Error('Invalid config source.')
 511
 512   let filename = 'local'
 513   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 514   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 515
 516   return join(dirname(configSources[ 0 ].name), filename + '.json')
 517 }
 518
 519 function updateWebserverConfig () {
 520   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 521   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 522 }
 523
 524 export function reloadConfig () {
 525
 526   function directory () {
 527     if (process.env.NODE_CONFIG_DIR) {
 528       return process.env.NODE_CONFIG_DIR
 529     }
 530
 531     return join(root(), 'config')
 532   }
 533
 534   function purge () {
 535     for (const fileName in require.cache) {
 536       if (-1 === fileName.indexOf(directory())) {
 537         continue
 538       }
 539
 540       delete require.cache[fileName]
 541     }
 542
 543     delete require.cache[require.resolve('config')]
 544   }
 545
 546   purge()
 547
 548   config = require('config')
 549
 550   updateWebserverConfig()
 551 }