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 VIDEO_TRANSCODING_FPS = {
 238   MIN: 10,
 239   MAX: 30
 240 }
 241
 242 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 243   LIKE: 'like',
 244   DISLIKE: 'dislike'
 245 }
 246
 247 const VIDEO_CATEGORIES = {
 248   1: 'Music',
 249   2: 'Films',
 250   3: 'Vehicles',
 251   4: 'Art',
 252   5: 'Sports',
 253   6: 'Travels',
 254   7: 'Gaming',
 255   8: 'People',
 256   9: 'Comedy',
 257   10: 'Entertainment',
 258   11: 'News',
 259   12: 'How To',
 260   13: 'Education',
 261   14: 'Activism',
 262   15: 'Science & Technology',
 263   16: 'Animals',
 264   17: 'Kids',
 265   18: 'Food'
 266 }
 267
 268 // See https://creativecommons.org/licenses/?lang=en
 269 const VIDEO_LICENCES = {
 270   1: 'Attribution',
 271   2: 'Attribution - Share Alike',
 272   3: 'Attribution - No Derivatives',
 273   4: 'Attribution - Non Commercial',
 274   5: 'Attribution - Non Commercial - Share Alike',
 275   6: 'Attribution - Non Commercial - No Derivatives',
 276   7: 'Public Domain Dedication'
 277 }
 278
 279 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
 280 const VIDEO_LANGUAGES = {
 281   1: 'English',
 282   2: 'Spanish',
 283   3: 'Mandarin',
 284   4: 'Hindi',
 285   5: 'Arabic',
 286   6: 'Portuguese',
 287   7: 'Bengali',
 288   8: 'Russian',
 289   9: 'Japanese',
 290   10: 'Punjabi',
 291   11: 'German',
 292   12: 'Korean',
 293   13: 'French',
 294   14: 'Italian'
 295 }
 296
 297 const VIDEO_PRIVACIES = {
 298   [VideoPrivacy.PUBLIC]: 'Public',
 299   [VideoPrivacy.UNLISTED]: 'Unlisted',
 300   [VideoPrivacy.PRIVATE]: 'Private'
 301 }
 302
 303 const VIDEO_MIMETYPE_EXT = {
 304   'video/webm': '.webm',
 305   'video/ogg': '.ogv',
 306   'video/mp4': '.mp4'
 307 }
 308
 309 const IMAGE_MIMETYPE_EXT = {
 310   'image/png': '.png',
 311   'image/jpg': '.jpg',
 312   'image/jpeg': '.jpg'
 313 }
 314
 315 // ---------------------------------------------------------------------------
 316
 317 const SERVER_ACTOR_NAME = 'peertube'
 318
 319 const ACTIVITY_PUB = {
 320   POTENTIAL_ACCEPT_HEADERS: [
 321     'application/activity+json',
 322     'application/ld+json',
 323     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 324   ],
 325   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 326   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 327   COLLECTION_ITEMS_PER_PAGE: 10,
 328   FETCH_PAGE_LIMIT: 100,
 329   URL_MIME_TYPES: {
 330     VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
 331     TORRENT: [ 'application/x-bittorrent' ],
 332     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 333   },
 334   MAX_RECURSION_COMMENTS: 100,
 335   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 336 }
 337
 338 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 339   GROUP: 'Group',
 340   PERSON: 'Person',
 341   APPLICATION: 'Application'
 342 }
 343
 344 // ---------------------------------------------------------------------------
 345
 346 const PRIVATE_RSA_KEY_SIZE = 2048
 347
 348 // Password encryption
 349 const BCRYPT_SALT_SIZE = 10
 350
 351 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 352
 353 // ---------------------------------------------------------------------------
 354
 355 // Express static paths (router)
 356 const STATIC_PATHS = {
 357   PREVIEWS: '/static/previews/',
 358   THUMBNAILS: '/static/thumbnails/',
 359   TORRENTS: '/static/torrents/',
 360   WEBSEED: '/static/webseed/',
 361   AVATARS: '/static/avatars/'
 362 }
 363
 364 // Cache control
 365 let STATIC_MAX_AGE = '30d'
 366
 367 // Videos thumbnail size
 368 const THUMBNAILS_SIZE = {
 369   width: 200,
 370   height: 110
 371 }
 372 const PREVIEWS_SIZE = {
 373   width: 560,
 374   height: 315
 375 }
 376 const AVATARS_SIZE = {
 377   width: 120,
 378   height: 120
 379 }
 380
 381 const EMBED_SIZE = {
 382   width: 560,
 383   height: 315
 384 }
 385
 386 // Sub folders of cache directory
 387 const CACHE = {
 388   DIRECTORIES: {
 389     PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
 390   }
 391 }
 392
 393 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 394
 395 // ---------------------------------------------------------------------------
 396
 397 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
 398
 399 // ---------------------------------------------------------------------------
 400
 401 // Special constants for a test instance
 402 if (isTestInstance() === true) {
 403   ACTOR_FOLLOW_SCORE.BASE = 20
 404   REMOTE_SCHEME.HTTP = 'http'
 405   REMOTE_SCHEME.WS = 'ws'
 406   STATIC_MAX_AGE = '0'
 407   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 408   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 409   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 410   SCHEDULER_INTERVAL = 10000
 411   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 412 }
 413
 414 updateWebserverConfig()
 415
 416 // ---------------------------------------------------------------------------
 417
 418 export {
 419   API_VERSION,
 420   AVATARS_SIZE,
 421   ACCEPT_HEADERS,
 422   BCRYPT_SALT_SIZE,
 423   CACHE,
 424   CONFIG,
 425   CONSTRAINTS_FIELDS,
 426   EMBED_SIZE,
 427   JOB_CONCURRENCY,
 428   JOB_ATTEMPTS,
 429   LAST_MIGRATION_VERSION,
 430   OAUTH_LIFETIME,
 431   OPENGRAPH_AND_OEMBED_COMMENT,
 432   PAGINATION_COUNT_DEFAULT,
 433   ACTOR_FOLLOW_SCORE,
 434   PREVIEWS_SIZE,
 435   REMOTE_SCHEME,
 436   FOLLOW_STATES,
 437   SERVER_ACTOR_NAME,
 438   PRIVATE_RSA_KEY_SIZE,
 439   SORTABLE_COLUMNS,
 440   STATIC_MAX_AGE,
 441   STATIC_PATHS,
 442   ACTIVITY_PUB,
 443   ACTIVITY_PUB_ACTOR_TYPES,
 444   THUMBNAILS_SIZE,
 445   VIDEO_CATEGORIES,
 446   VIDEO_LANGUAGES,
 447   VIDEO_PRIVACIES,
 448   VIDEO_LICENCES,
 449   VIDEO_RATE_TYPES,
 450   VIDEO_MIMETYPE_EXT,
 451   VIDEO_TRANSCODING_FPS,
 452   USER_PASSWORD_RESET_LIFETIME,
 453   IMAGE_MIMETYPE_EXT,
 454   SCHEDULER_INTERVAL,
 455   JOB_COMPLETED_LIFETIME,
 456   VIDEO_VIEW_LIFETIME
 457 }
 458
 459 // ---------------------------------------------------------------------------
 460
 461 function getLocalConfigFilePath () {
 462   const configSources = config.util.getConfigSources()
 463   if (configSources.length === 0) throw new Error('Invalid config source.')
 464
 465   let filename = 'local'
 466   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 467   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 468
 469   return join(dirname(configSources[ 0 ].name), filename + '.json')
 470 }
 471
 472 function updateWebserverConfig () {
 473   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 474   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 475 }
 476
 477 export function reloadConfig () {
 478
 479   function directory () {
 480     if (process.env.NODE_CONFIG_DIR) {
 481       return process.env.NODE_CONFIG_DIR
 482     }
 483
 484     return join(root(), 'config')
 485   }
 486
 487   function purge () {
 488     for (const fileName in require.cache) {
 489       if (-1 === fileName.indexOf(directory())) {
 490         continue
 491       }
 492
 493       delete require.cache[fileName]
 494     }
 495
 496     delete require.cache[require.resolve('config')]
 497   }
 498
 499   purge()
 500
 501   config = require('config')
 502
 503   updateWebserverConfig()
 504 }