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