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     CUSTOMIZATIONS: {
 163       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 164       get CSS () { return config.get<string>('instance.customizations.css') }
 165     }
 166   }
 167 }
 168
 169 // ---------------------------------------------------------------------------
 170
 171 const CONSTRAINTS_FIELDS = {
 172   USERS: {
 173     USERNAME: { min: 3, max: 20 }, // Length
 174     PASSWORD: { min: 6, max: 255 }, // Length
 175     DESCRIPTION: { min: 3, max: 250 }, // Length
 176     VIDEO_QUOTA: { min: -1 }
 177   },
 178   VIDEO_ABUSES: {
 179     REASON: { min: 2, max: 300 } // Length
 180   },
 181   VIDEO_CHANNELS: {
 182     NAME: { min: 3, max: 120 }, // Length
 183     DESCRIPTION: { min: 3, max: 250 }, // Length
 184     SUPPORT: { min: 3, max: 300 }, // Length
 185     URL: { min: 3, max: 2000 } // Length
 186   },
 187   VIDEOS: {
 188     NAME: { min: 3, max: 120 }, // Length
 189     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 190     DESCRIPTION: { min: 3, max: 10000 }, // Length
 191     SUPPORT: { min: 3, max: 300 }, // Length
 192     IMAGE: {
 193       EXTNAME: [ '.jpg', '.jpeg' ],
 194       FILE_SIZE: {
 195         max: 2 * 1024 * 1024 // 2MB
 196       }
 197     },
 198     EXTNAME: [ '.mp4', '.ogv', '.webm' ],
 199     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 200     DURATION: { min: 1 }, // Number
 201     TAGS: { min: 0, max: 5 }, // Number of total tags
 202     TAG: { min: 2, max: 30 }, // Length
 203     THUMBNAIL: { min: 2, max: 30 },
 204     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 205     VIEWS: { min: 0 },
 206     LIKES: { min: 0 },
 207     DISLIKES: { min: 0 },
 208     FILE_SIZE: { min: 10 },
 209     URL: { min: 3, max: 2000 } // Length
 210   },
 211   ACTORS: {
 212     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 213     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 214     URL: { min: 3, max: 2000 }, // Length
 215     AVATAR: {
 216       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 217       FILE_SIZE: {
 218         max: 2 * 1024 * 1024 // 2MB
 219       }
 220     }
 221   },
 222   VIDEO_EVENTS: {
 223     COUNT: { min: 0 }
 224   },
 225   VIDEO_COMMENTS: {
 226     TEXT: { min: 2, max: 3000 }, // Length
 227     URL: { min: 3, max: 2000 } // Length
 228   },
 229   VIDEO_SHARE: {
 230     URL: { min: 3, max: 2000 } // Length
 231   }
 232 }
 233
 234 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 235   LIKE: 'like',
 236   DISLIKE: 'dislike'
 237 }
 238
 239 const VIDEO_CATEGORIES = {
 240   1: 'Music',
 241   2: 'Films',
 242   3: 'Vehicles',
 243   4: 'Art',
 244   5: 'Sports',
 245   6: 'Travels',
 246   7: 'Gaming',
 247   8: 'People',
 248   9: 'Comedy',
 249   10: 'Entertainment',
 250   11: 'News',
 251   12: 'How To',
 252   13: 'Education',
 253   14: 'Activism',
 254   15: 'Science & Technology',
 255   16: 'Animals',
 256   17: 'Kids',
 257   18: 'Food'
 258 }
 259
 260 // See https://creativecommons.org/licenses/?lang=en
 261 const VIDEO_LICENCES = {
 262   1: 'Attribution',
 263   2: 'Attribution - Share Alike',
 264   3: 'Attribution - No Derivatives',
 265   4: 'Attribution - Non Commercial',
 266   5: 'Attribution - Non Commercial - Share Alike',
 267   6: 'Attribution - Non Commercial - No Derivatives',
 268   7: 'Public Domain Dedication'
 269 }
 270
 271 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
 272 const VIDEO_LANGUAGES = {
 273   1: 'English',
 274   2: 'Spanish',
 275   3: 'Mandarin',
 276   4: 'Hindi',
 277   5: 'Arabic',
 278   6: 'Portuguese',
 279   7: 'Bengali',
 280   8: 'Russian',
 281   9: 'Japanese',
 282   10: 'Punjabi',
 283   11: 'German',
 284   12: 'Korean',
 285   13: 'French',
 286   14: 'Italian'
 287 }
 288
 289 const VIDEO_PRIVACIES = {
 290   [VideoPrivacy.PUBLIC]: 'Public',
 291   [VideoPrivacy.UNLISTED]: 'Unlisted',
 292   [VideoPrivacy.PRIVATE]: 'Private'
 293 }
 294
 295 const VIDEO_MIMETYPE_EXT = {
 296   'video/webm': '.webm',
 297   'video/ogg': '.ogv',
 298   'video/mp4': '.mp4'
 299 }
 300
 301 const IMAGE_MIMETYPE_EXT = {
 302   'image/png': '.png',
 303   'image/jpg': '.jpg',
 304   'image/jpeg': '.jpg'
 305 }
 306
 307 // ---------------------------------------------------------------------------
 308
 309 const SERVER_ACTOR_NAME = 'peertube'
 310
 311 const ACTIVITY_PUB = {
 312   POTENTIAL_ACCEPT_HEADERS: [
 313     'application/activity+json',
 314     'application/ld+json',
 315     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 316   ],
 317   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 318   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 319   COLLECTION_ITEMS_PER_PAGE: 10,
 320   FETCH_PAGE_LIMIT: 100,
 321   URL_MIME_TYPES: {
 322     VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
 323     TORRENT: [ 'application/x-bittorrent' ],
 324     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 325   },
 326   MAX_RECURSION_COMMENTS: 100,
 327   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 328 }
 329
 330 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 331   GROUP: 'Group',
 332   PERSON: 'Person',
 333   APPLICATION: 'Application'
 334 }
 335
 336 // ---------------------------------------------------------------------------
 337
 338 const PRIVATE_RSA_KEY_SIZE = 2048
 339
 340 // Password encryption
 341 const BCRYPT_SALT_SIZE = 10
 342
 343 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 344
 345 // ---------------------------------------------------------------------------
 346
 347 // Express static paths (router)
 348 const STATIC_PATHS = {
 349   PREVIEWS: '/static/previews/',
 350   THUMBNAILS: '/static/thumbnails/',
 351   TORRENTS: '/static/torrents/',
 352   WEBSEED: '/static/webseed/',
 353   AVATARS: '/static/avatars/'
 354 }
 355
 356 // Cache control
 357 let STATIC_MAX_AGE = '30d'
 358
 359 // Videos thumbnail size
 360 const THUMBNAILS_SIZE = {
 361   width: 200,
 362   height: 110
 363 }
 364 const PREVIEWS_SIZE = {
 365   width: 560,
 366   height: 315
 367 }
 368 const AVATARS_SIZE = {
 369   width: 120,
 370   height: 120
 371 }
 372
 373 const EMBED_SIZE = {
 374   width: 560,
 375   height: 315
 376 }
 377
 378 // Sub folders of cache directory
 379 const CACHE = {
 380   DIRECTORIES: {
 381     PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
 382   }
 383 }
 384
 385 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 386
 387 // ---------------------------------------------------------------------------
 388
 389 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
 390
 391 // ---------------------------------------------------------------------------
 392
 393 // Special constants for a test instance
 394 if (isTestInstance() === true) {
 395   ACTOR_FOLLOW_SCORE.BASE = 20
 396   REMOTE_SCHEME.HTTP = 'http'
 397   REMOTE_SCHEME.WS = 'ws'
 398   STATIC_MAX_AGE = '0'
 399   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 400   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 401   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 402   SCHEDULER_INTERVAL = 10000
 403 }
 404
 405 updateWebserverConfig()
 406
 407 // ---------------------------------------------------------------------------
 408
 409 export {
 410   API_VERSION,
 411   AVATARS_SIZE,
 412   ACCEPT_HEADERS,
 413   BCRYPT_SALT_SIZE,
 414   CACHE,
 415   CONFIG,
 416   CONSTRAINTS_FIELDS,
 417   EMBED_SIZE,
 418   JOB_CONCURRENCY,
 419   JOB_ATTEMPTS,
 420   LAST_MIGRATION_VERSION,
 421   OAUTH_LIFETIME,
 422   OPENGRAPH_AND_OEMBED_COMMENT,
 423   PAGINATION_COUNT_DEFAULT,
 424   ACTOR_FOLLOW_SCORE,
 425   PREVIEWS_SIZE,
 426   REMOTE_SCHEME,
 427   FOLLOW_STATES,
 428   SERVER_ACTOR_NAME,
 429   PRIVATE_RSA_KEY_SIZE,
 430   SORTABLE_COLUMNS,
 431   STATIC_MAX_AGE,
 432   STATIC_PATHS,
 433   ACTIVITY_PUB,
 434   ACTIVITY_PUB_ACTOR_TYPES,
 435   THUMBNAILS_SIZE,
 436   VIDEO_CATEGORIES,
 437   VIDEO_LANGUAGES,
 438   VIDEO_PRIVACIES,
 439   VIDEO_LICENCES,
 440   VIDEO_RATE_TYPES,
 441   VIDEO_MIMETYPE_EXT,
 442   USER_PASSWORD_RESET_LIFETIME,
 443   IMAGE_MIMETYPE_EXT,
 444   SCHEDULER_INTERVAL,
 445   JOB_COMPLETED_LIFETIME
 446 }
 447
 448 // ---------------------------------------------------------------------------
 449
 450 function getLocalConfigFilePath () {
 451   const configSources = config.util.getConfigSources()
 452   if (configSources.length === 0) throw new Error('Invalid config source.')
 453
 454   let filename = 'local'
 455   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 456   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 457
 458   return join(dirname(configSources[ 0 ].name), filename + '.json')
 459 }
 460
 461 function updateWebserverConfig () {
 462   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 463   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 464 }
 465
 466 export function reloadConfig () {
 467
 468   function directory () {
 469     if (process.env.NODE_CONFIG_DIR) {
 470       return process.env.NODE_CONFIG_DIR
 471     }
 472
 473     return join(root(), 'config')
 474   }
 475
 476   function purge () {
 477     for (const fileName in require.cache) {
 478       if (-1 === fileName.indexOf(directory())) {
 479         continue
 480       }
 481
 482       delete require.cache[fileName]
 483     }
 484
 485     delete require.cache[require.resolve('config')]
 486   }
 487
 488   purge()
 489
 490   config = require('config')
 491
 492   updateWebserverConfig()
 493 }