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