server/initializers/constants.js

   1 'use strict'
   2
   3 const config = require('config')
   4 const maxBy = require('lodash/maxBy')
   5 const path = require('path')
   6
   7 // ---------------------------------------------------------------------------
   8
   9 // API version
  10 const API_VERSION = 'v1'
  11
  12 // Number of results by default for the pagination
  13 const PAGINATION_COUNT_DEFAULT = 15
  14
  15 // Sortable columns per schema
  16 const SEARCHABLE_COLUMNS = {
  17   VIDEOS: [ 'name', 'magnetUri', 'podHost', 'author', 'tags' ]
  18 }
  19
  20 // Sortable columns per schema
  21 const SORTABLE_COLUMNS = {
  22   USERS: [ 'username', '-username', 'createdDate', '-createdDate' ],
  23   VIDEOS: [ 'name', '-name', 'duration', '-duration', 'createdDate', '-createdDate' ]
  24 }
  25
  26 const OAUTH_LIFETIME = {
  27   ACCESS_TOKEN: 3600 * 4, // 4 hours
  28   REFRESH_TOKEN: 1209600 // 2 weeks
  29 }
  30
  31 // ---------------------------------------------------------------------------
  32
  33 const CONFIG = {
  34   LISTEN: {
  35     PORT: config.get('listen.port')
  36   },
  37   DATABASE: {
  38     DBNAME: 'peertube' + config.get('database.suffix'),
  39     HOSTNAME: config.get('database.hostname'),
  40     PORT: config.get('database.port')
  41   },
  42   STORAGE: {
  43     CERT_DIR: path.join(__dirname, '..', '..', config.get('storage.certs')),
  44     LOG_DIR: path.join(__dirname, '..', '..', config.get('storage.logs')),
  45     VIDEOS_DIR: path.join(__dirname, '..', '..', config.get('storage.videos')),
  46     THUMBNAILS_DIR: path.join(__dirname, '..', '..', config.get('storage.thumbnails')),
  47     PREVIEWS_DIR: path.join(__dirname, '..', '..', config.get('storage.previews')),
  48     TORRENTS_DIR: path.join(__dirname, '..', '..', config.get('storage.torrents'))
  49   },
  50   WEBSERVER: {
  51     SCHEME: config.get('webserver.https') === true ? 'https' : 'http',
  52     WS: config.get('webserver.https') === true ? 'wss' : 'ws',
  53     HOSTNAME: config.get('webserver.hostname'),
  54     PORT: config.get('webserver.port')
  55   }
  56 }
  57 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
  58 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
  59
  60 // ---------------------------------------------------------------------------
  61
  62 const CONSTRAINTS_FIELDS = {
  63   USERS: {
  64     USERNAME: { min: 3, max: 20 }, // Length
  65     PASSWORD: { min: 6, max: 255 } // Length
  66   },
  67   VIDEOS: {
  68     NAME: { min: 3, max: 50 }, // Length
  69     DESCRIPTION: { min: 3, max: 250 }, // Length
  70     MAGNET: {
  71       INFO_HASH: { min: 10, max: 50 } // Length
  72     },
  73     DURATION: { min: 1, max: 7200 }, // Number
  74     TAGS: { min: 1, max: 3 }, // Number of total tags
  75     TAG: { min: 2, max: 10 }, // Length
  76     THUMBNAIL: { min: 2, max: 30 },
  77     THUMBNAIL64: { min: 0, max: 20000 } // Bytes
  78   }
  79 }
  80
  81 // ---------------------------------------------------------------------------
  82
  83 // Score a pod has when we create it as a friend
  84 const FRIEND_SCORE = {
  85   BASE: 100,
  86   MAX: 1000
  87 }
  88
  89 // ---------------------------------------------------------------------------
  90
  91 const MONGO_MIGRATION_SCRIPTS = [
  92   {
  93     script: '0005-create-application',
  94     version: 5
  95   },
  96   {
  97     script: '0010-users-password',
  98     version: 10
  99   },
 100   {
 101     script: '0015-admin-role',
 102     version: 15
 103   },
 104   {
 105     script: '0020-requests-endpoint',
 106     version: 20
 107   },
 108   {
 109     script: '0025-video-filenames',
 110     version: 25
 111   },
 112   {
 113     script: '0030-video-magnet',
 114     version: 30
 115   },
 116   {
 117     script: '0035-url-to-host',
 118     version: 35
 119   },
 120   {
 121     script: '0040-video-remote-id',
 122     version: 40
 123   }
 124 ]
 125 const LAST_MONGO_SCHEMA_VERSION = (maxBy(MONGO_MIGRATION_SCRIPTS, 'version'))['version']
 126
 127 // ---------------------------------------------------------------------------
 128
 129 // Number of points we add/remove from a friend after a successful/bad request
 130 const PODS_SCORE = {
 131   MALUS: -10,
 132   BONUS: 10
 133 }
 134
 135 // Time to wait between requests to the friends (10 min)
 136 let REQUESTS_INTERVAL = 600000
 137
 138 // Number of requests in parallel we can make
 139 const REQUESTS_IN_PARALLEL = 10
 140
 141 // How many requests we put in request
 142 const REQUESTS_LIMIT = 10
 143
 144 // Number of requests to retry for replay requests module
 145 const RETRY_REQUESTS = 5
 146
 147 const REQUEST_ENDPOINTS = {
 148   VIDEOS: 'videos'
 149 }
 150
 151 // ---------------------------------------------------------------------------
 152
 153 const REMOTE_SCHEME = {
 154   HTTP: 'https',
 155   WS: 'wss'
 156 }
 157
 158 // Password encryption
 159 const BCRYPT_SALT_SIZE = 10
 160
 161 // Express static paths (router)
 162 const STATIC_PATHS = {
 163   PREVIEWS: '/static/previews/',
 164   THUMBNAILS: '/static/thumbnails/',
 165   TORRENTS: '/static/torrents/',
 166   WEBSEED: '/static/webseed/'
 167 }
 168
 169 // Cache control
 170 let STATIC_MAX_AGE = '30d'
 171
 172 // Videos thumbnail size
 173 const THUMBNAILS_SIZE = '200x110'
 174 const PREVIEWS_SIZE = '640x480'
 175
 176 const USER_ROLES = {
 177   ADMIN: 'admin',
 178   USER: 'user'
 179 }
 180
 181 // ---------------------------------------------------------------------------
 182
 183 // Special constants for a test instance
 184 if (isTestInstance() === true) {
 185   CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
 186   FRIEND_SCORE.BASE = 20
 187   REQUESTS_INTERVAL = 10000
 188   REMOTE_SCHEME.HTTP = 'http'
 189   REMOTE_SCHEME.WS = 'ws'
 190   STATIC_MAX_AGE = 0
 191 }
 192
 193 // ---------------------------------------------------------------------------
 194
 195 module.exports = {
 196   API_VERSION,
 197   BCRYPT_SALT_SIZE,
 198   CONFIG,
 199   CONSTRAINTS_FIELDS,
 200   FRIEND_SCORE,
 201   LAST_MONGO_SCHEMA_VERSION,
 202   MONGO_MIGRATION_SCRIPTS,
 203   OAUTH_LIFETIME,
 204   PAGINATION_COUNT_DEFAULT,
 205   PODS_SCORE,
 206   PREVIEWS_SIZE,
 207   REMOTE_SCHEME,
 208   REQUEST_ENDPOINTS,
 209   REQUESTS_IN_PARALLEL,
 210   REQUESTS_INTERVAL,
 211   REQUESTS_LIMIT,
 212   RETRY_REQUESTS,
 213   SEARCHABLE_COLUMNS,
 214   SORTABLE_COLUMNS,
 215   STATIC_MAX_AGE,
 216   STATIC_PATHS,
 217   THUMBNAILS_SIZE,
 218   USER_ROLES
 219 }
 220
 221 // ---------------------------------------------------------------------------
 222
 223 // This method exists in utils module but we want to let the constants module independent
 224 function isTestInstance () {
 225   return (process.env.NODE_ENV === 'test')
 226 }