server/initializers/constants.js

   1 'use strict'
   2
   3 const config = require('config')
   4 const path = require('path')
   5
   6 // ---------------------------------------------------------------------------
   7
   8 const LAST_MIGRATION_VERSION = 50
   9
  10 // ---------------------------------------------------------------------------
  11
  12 // API version
  13 const API_VERSION = 'v1'
  14
  15 // Number of results by default for the pagination
  16 const PAGINATION_COUNT_DEFAULT = 15
  17
  18 // Sortable columns per schema
  19 const SEARCHABLE_COLUMNS = {
  20   VIDEOS: [ 'name', 'magnetUri', 'host', 'author', 'tags' ]
  21 }
  22
  23 // Sortable columns per schema
  24 const SORTABLE_COLUMNS = {
  25   USERS: [ 'id', 'username', 'createdAt' ],
  26   VIDEO_ABUSES: [ 'id', 'createdAt' ],
  27   VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ]
  28 }
  29
  30 const OAUTH_LIFETIME = {
  31   ACCESS_TOKEN: 3600 * 4, // 4 hours
  32   REFRESH_TOKEN: 1209600 // 2 weeks
  33 }
  34
  35 // ---------------------------------------------------------------------------
  36
  37 const CONFIG = {
  38   LISTEN: {
  39     PORT: config.get('listen.port')
  40   },
  41   DATABASE: {
  42     DBNAME: 'peertube' + config.get('database.suffix'),
  43     HOSTNAME: config.get('database.hostname'),
  44     PORT: config.get('database.port'),
  45     USERNAME: config.get('database.username'),
  46     PASSWORD: config.get('database.password')
  47   },
  48   STORAGE: {
  49     CERT_DIR: path.join(__dirname, '..', '..', config.get('storage.certs')),
  50     LOG_DIR: path.join(__dirname, '..', '..', config.get('storage.logs')),
  51     VIDEOS_DIR: path.join(__dirname, '..', '..', config.get('storage.videos')),
  52     THUMBNAILS_DIR: path.join(__dirname, '..', '..', config.get('storage.thumbnails')),
  53     PREVIEWS_DIR: path.join(__dirname, '..', '..', config.get('storage.previews')),
  54     TORRENTS_DIR: path.join(__dirname, '..', '..', config.get('storage.torrents'))
  55   },
  56   WEBSERVER: {
  57     SCHEME: config.get('webserver.https') === true ? 'https' : 'http',
  58     WS: config.get('webserver.https') === true ? 'wss' : 'ws',
  59     HOSTNAME: config.get('webserver.hostname'),
  60     PORT: config.get('webserver.port')
  61   },
  62   ADMIN: {
  63     EMAIL: config.get('admin.email')
  64   },
  65   SIGNUP: {
  66     ENABLED: config.get('signup.enabled')
  67   }
  68 }
  69 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
  70 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
  71
  72 // ---------------------------------------------------------------------------
  73
  74 const CONSTRAINTS_FIELDS = {
  75   USERS: {
  76     USERNAME: { min: 3, max: 20 }, // Length
  77     PASSWORD: { min: 6, max: 255 } // Length
  78   },
  79   VIDEO_ABUSES: {
  80     REASON: { min: 2, max: 300 } // Length
  81   },
  82   VIDEOS: {
  83     NAME: { min: 3, max: 50 }, // Length
  84     DESCRIPTION: { min: 3, max: 250 }, // Length
  85     EXTNAME: [ '.mp4', '.ogv', '.webm' ],
  86     INFO_HASH: { min: 40, max: 40 }, // Length, infohash is 20 bytes length but we represent it in hexa so 20 * 2
  87     DURATION: { min: 1, max: 7200 }, // Number
  88     TAGS: { min: 0, max: 3 }, // Number of total tags
  89     TAG: { min: 2, max: 10 }, // Length
  90     THUMBNAIL: { min: 2, max: 30 },
  91     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
  92     VIEWS: { min: 0 },
  93     LIKES: { min: 0 },
  94     DISLIKES: { min: 0 }
  95   },
  96   VIDEO_EVENTS: {
  97     COUNT: { min: 0 }
  98   }
  99 }
 100
 101 const VIDEO_RATE_TYPES = {
 102   LIKE: 'like',
 103   DISLIKE: 'dislike'
 104 }
 105
 106 const VIDEO_CATEGORIES = {
 107   1: 'Music',
 108   2: 'Films',
 109   3: 'Vehicles',
 110   4: 'Art',
 111   5: 'Sports',
 112   6: 'Travels',
 113   7: 'Gaming',
 114   8: 'People',
 115   9: 'Comedy',
 116   10: 'Entertainment',
 117   11: 'News',
 118   12: 'Howto',
 119   13: 'Education',
 120   14: 'Activism',
 121   15: 'Science & Technology',
 122   16: 'Animals',
 123   17: 'Kids',
 124   18: 'Food'
 125 }
 126
 127 // See https://creativecommons.org/licenses/?lang=en
 128 const VIDEO_LICENCES = {
 129   1: 'Attribution',
 130   2: 'Attribution - Share Alike',
 131   3: 'Attribution - No Derivatives',
 132   4: 'Attribution - Non Commercial',
 133   5: 'Attribution - Non Commercial - Share Alike',
 134   6: 'Attribution - Non Commercial - No Derivatives',
 135   7: 'Public Domain Dedication'
 136 }
 137
 138 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
 139 const VIDEO_LANGUAGES = {
 140   1: 'English',
 141   2: 'Spanish',
 142   3: 'Mandarin',
 143   4: 'Hindi',
 144   5: 'Arabic',
 145   6: 'Portuguese',
 146   7: 'Bengali',
 147   8: 'Russian',
 148   9: 'Japanese',
 149   10: 'Punjabi',
 150   11: 'German',
 151   12: 'Korean',
 152   13: 'French',
 153   14: 'Italien'
 154 }
 155
 156 // ---------------------------------------------------------------------------
 157
 158 // Score a pod has when we create it as a friend
 159 const FRIEND_SCORE = {
 160   BASE: 100,
 161   MAX: 1000
 162 }
 163
 164 // ---------------------------------------------------------------------------
 165
 166 // Number of points we add/remove from a friend after a successful/bad request
 167 const PODS_SCORE = {
 168   MALUS: -10,
 169   BONUS: 10
 170 }
 171
 172 // Time to wait between requests to the friends (10 min)
 173 let REQUESTS_INTERVAL = 600000
 174
 175 // Number of requests in parallel we can make
 176 const REQUESTS_IN_PARALLEL = 10
 177
 178 // To how many pods we send requests
 179 const REQUESTS_LIMIT_PODS = 10
 180 // How many requests we send to a pod per interval
 181 const REQUESTS_LIMIT_PER_POD = 5
 182
 183 const REQUESTS_VIDEO_QADU_LIMIT_PODS = 10
 184 // The QADU requests are not big
 185 const REQUESTS_VIDEO_QADU_LIMIT_PER_POD = 50
 186
 187 const REQUESTS_VIDEO_EVENT_LIMIT_PODS = 10
 188 // The EVENTS requests are not big
 189 const REQUESTS_VIDEO_EVENT_LIMIT_PER_POD = 50
 190
 191 // Number of requests to retry for replay requests module
 192 const RETRY_REQUESTS = 5
 193
 194 const REQUEST_ENDPOINTS = {
 195   VIDEOS: 'videos'
 196 }
 197
 198 const REQUEST_ENDPOINT_ACTIONS = {}
 199 REQUEST_ENDPOINT_ACTIONS[REQUEST_ENDPOINTS.VIDEOS] = {
 200   ADD: 'add',
 201   UPDATE: 'update',
 202   REMOVE: 'remove',
 203   REPORT_ABUSE: 'report-abuse'
 204 }
 205
 206 const REQUEST_VIDEO_QADU_ENDPOINT = 'videos/qadu'
 207 const REQUEST_VIDEO_EVENT_ENDPOINT = 'videos/events'
 208
 209 const REQUEST_VIDEO_QADU_TYPES = {
 210   LIKES: 'likes',
 211   DISLIKES: 'dislikes',
 212   VIEWS: 'views'
 213 }
 214
 215 const REQUEST_VIDEO_EVENT_TYPES = {
 216   LIKES: 'likes',
 217   DISLIKES: 'dislikes',
 218   VIEWS: 'views'
 219 }
 220
 221 const REMOTE_SCHEME = {
 222   HTTP: 'https',
 223   WS: 'wss'
 224 }
 225
 226 // ---------------------------------------------------------------------------
 227
 228 const PRIVATE_CERT_NAME = 'peertube.key.pem'
 229 const PUBLIC_CERT_NAME = 'peertube.pub'
 230 const SIGNATURE_ALGORITHM = 'RSA-SHA256'
 231 const SIGNATURE_ENCODING = 'hex'
 232
 233 // Password encryption
 234 const BCRYPT_SALT_SIZE = 10
 235
 236 // ---------------------------------------------------------------------------
 237
 238 // Express static paths (router)
 239 const STATIC_PATHS = {
 240   PREVIEWS: '/static/previews/',
 241   THUMBNAILS: '/static/thumbnails/',
 242   TORRENTS: '/static/torrents/',
 243   WEBSEED: '/static/webseed/'
 244 }
 245
 246 // Cache control
 247 let STATIC_MAX_AGE = '30d'
 248
 249 // Videos thumbnail size
 250 const THUMBNAILS_SIZE = '200x110'
 251 const PREVIEWS_SIZE = '640x480'
 252
 253 // ---------------------------------------------------------------------------
 254
 255 const USER_ROLES = {
 256   ADMIN: 'admin',
 257   USER: 'user'
 258 }
 259
 260 // ---------------------------------------------------------------------------
 261
 262 // Special constants for a test instance
 263 if (isTestInstance() === true) {
 264   CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
 265   FRIEND_SCORE.BASE = 20
 266   REQUESTS_INTERVAL = 10000
 267   REMOTE_SCHEME.HTTP = 'http'
 268   REMOTE_SCHEME.WS = 'ws'
 269   STATIC_MAX_AGE = 0
 270 }
 271
 272 // ---------------------------------------------------------------------------
 273
 274 module.exports = {
 275   API_VERSION,
 276   BCRYPT_SALT_SIZE,
 277   CONFIG,
 278   CONSTRAINTS_FIELDS,
 279   FRIEND_SCORE,
 280   LAST_MIGRATION_VERSION,
 281   OAUTH_LIFETIME,
 282   PAGINATION_COUNT_DEFAULT,
 283   PODS_SCORE,
 284   PREVIEWS_SIZE,
 285   PRIVATE_CERT_NAME,
 286   PUBLIC_CERT_NAME,
 287   REMOTE_SCHEME,
 288   REQUEST_ENDPOINT_ACTIONS,
 289   REQUEST_ENDPOINTS,
 290   REQUEST_VIDEO_EVENT_ENDPOINT,
 291   REQUEST_VIDEO_EVENT_TYPES,
 292   REQUEST_VIDEO_QADU_ENDPOINT,
 293   REQUEST_VIDEO_QADU_TYPES,
 294   REQUESTS_IN_PARALLEL,
 295   REQUESTS_INTERVAL,
 296   REQUESTS_LIMIT_PER_POD,
 297   REQUESTS_LIMIT_PODS,
 298   REQUESTS_VIDEO_EVENT_LIMIT_PER_POD,
 299   REQUESTS_VIDEO_EVENT_LIMIT_PODS,
 300   REQUESTS_VIDEO_QADU_LIMIT_PER_POD,
 301   REQUESTS_VIDEO_QADU_LIMIT_PODS,
 302   RETRY_REQUESTS,
 303   SEARCHABLE_COLUMNS,
 304   SIGNATURE_ALGORITHM,
 305   SIGNATURE_ENCODING,
 306   SORTABLE_COLUMNS,
 307   STATIC_MAX_AGE,
 308   STATIC_PATHS,
 309   THUMBNAILS_SIZE,
 310   USER_ROLES,
 311   VIDEO_CATEGORIES,
 312   VIDEO_LANGUAGES,
 313   VIDEO_LICENCES,
 314   VIDEO_RATE_TYPES
 315 }
 316
 317 // ---------------------------------------------------------------------------
 318
 319 // This method exists in utils module but we want to let the constants module independent
 320 function isTestInstance () {
 321   return (process.env.NODE_ENV === 'test')
 322 }