server/initializers/constants.js

   1 'use strict'
   2
   3 const config = require('config')
   4 const path = require('path')
   5
   6 // API version of our pod
   7 const API_VERSION = 'v1'
   8
   9 const BCRYPT_SALT_SIZE = 10
  10
  11 const CONFIG = {
  12   DATABASE: {
  13     DBNAME: 'peertube' + config.get('database.suffix'),
  14     HOST: config.get('database.host'),
  15     PORT: config.get('database.port')
  16   },
  17   ELECTRON: {
  18     DEBUG: config.get('electron.debug')
  19   },
  20   STORAGE: {
  21     CERT_DIR: path.join(__dirname, '..', '..', config.get('storage.certs')),
  22     LOG_DIR: path.join(__dirname, '..', '..', config.get('storage.logs')),
  23     UPLOAD_DIR: path.join(__dirname, '..', '..', config.get('storage.uploads')),
  24     THUMBNAILS_DIR: path.join(__dirname, '..', '..', config.get('storage.thumbnails'))
  25   },
  26   WEBSERVER: {
  27     SCHEME: config.get('webserver.https') === true ? 'https' : 'http',
  28     HOST: config.get('webserver.host'),
  29     PORT: config.get('webserver.port')
  30   }
  31 }
  32 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOST + ':' + CONFIG.WEBSERVER.PORT
  33
  34 const CONSTRAINTS_FIELDS = {
  35   USERS: {
  36     USERNAME: { min: 3, max: 20 }, // Length
  37     PASSWORD: { min: 6, max: 255 } // Length
  38   },
  39   VIDEOS: {
  40     NAME: { min: 3, max: 50 }, // Length
  41     DESCRIPTION: { min: 3, max: 250 }, // Length
  42     MAGNET_URI: { min: 10 }, // Length
  43     DURATION: { min: 1, max: 7200 }, // Number
  44     TAGS: { min: 1, max: 3 }, // Number of total tags
  45     TAG: { min: 2, max: 10 }, // Length
  46     THUMBNAIL: { min: 2, max: 30 },
  47     THUMBNAIL64: { min: 0, max: 20000 } // Bytes
  48   }
  49 }
  50
  51 // Score a pod has when we create it as a friend
  52 const FRIEND_SCORE = {
  53   BASE: 100,
  54   MAX: 1000
  55 }
  56
  57 const MONGO_MIGRATION_SCRIPTS = [
  58   {
  59     script: '0005-create-application',
  60     version: 5
  61   },
  62   {
  63     script: '0010-users-password',
  64     version: 10
  65   },
  66   {
  67     script: '0015-admin-role',
  68     version: 15
  69   }
  70 ]
  71 const LAST_MONGO_SCHEMA_VERSION = 15
  72
  73 // Time to wait between requests to the friends (10 min)
  74 let REQUESTS_INTERVAL = 600000
  75
  76 const OAUTH_LIFETIME = {
  77   ACCESS_TOKEN: 3600 * 4, // 4 hours
  78   REFRESH_TOKEN: 1209600 // 2 weeks
  79 }
  80
  81 // Number of results by default for the pagination
  82 const PAGINATION_COUNT_DEFAULT = 15
  83
  84 // Number of points we add/remove from a friend after a successful/bad request
  85 const PODS_SCORE = {
  86   MALUS: -10,
  87   BONUS: 10
  88 }
  89
  90 // Number of requests in parallel we can make
  91 const REQUESTS_IN_PARALLEL = 10
  92
  93 // How many requests we put in request (request scheduler)
  94 const REQUESTS_LIMIT = 10
  95
  96 // Number of requests to retry for replay requests module
  97 const RETRY_REQUESTS = 5
  98
  99 // Sortable columns per schema
 100 const SEARCHABLE_COLUMNS = {
 101   VIDEOS: [ 'name', 'magnetUri', 'podUrl', 'author', 'tags' ]
 102 }
 103
 104 // Seeds in parallel we send to electron when "seed all"
 105 // Once a video is in seeding state we seed another video etc
 106 const SEEDS_IN_PARALLEL = 3
 107
 108 // Sortable columns per schema
 109 const SORTABLE_COLUMNS = {
 110   USERS: [ 'username', '-username', 'createdDate', '-createdDate' ],
 111   VIDEOS: [ 'name', '-name', 'duration', '-duration', 'createdDate', '-createdDate' ]
 112 }
 113
 114 // Videos thumbnail size
 115 const THUMBNAILS_SIZE = '200x110'
 116
 117 // Path for access to thumbnails with express router
 118 const THUMBNAILS_STATIC_PATH = '/static/thumbnails'
 119
 120 const USER_ROLES = {
 121   ADMIN: 'admin',
 122   USER: 'user'
 123 }
 124
 125 // Special constants for a test instance
 126 if (isTestInstance() === true) {
 127   FRIEND_SCORE.BASE = 20
 128   REQUESTS_INTERVAL = 10000
 129   CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
 130 }
 131
 132 // ---------------------------------------------------------------------------
 133
 134 module.exports = {
 135   API_VERSION: API_VERSION,
 136   BCRYPT_SALT_SIZE: BCRYPT_SALT_SIZE,
 137   CONFIG: CONFIG,
 138   CONSTRAINTS_FIELDS: CONSTRAINTS_FIELDS,
 139   FRIEND_SCORE: FRIEND_SCORE,
 140   LAST_MONGO_SCHEMA_VERSION: LAST_MONGO_SCHEMA_VERSION,
 141   MONGO_MIGRATION_SCRIPTS: MONGO_MIGRATION_SCRIPTS,
 142   OAUTH_LIFETIME: OAUTH_LIFETIME,
 143   PAGINATION_COUNT_DEFAULT: PAGINATION_COUNT_DEFAULT,
 144   PODS_SCORE: PODS_SCORE,
 145   REQUESTS_IN_PARALLEL: REQUESTS_IN_PARALLEL,
 146   REQUESTS_INTERVAL: REQUESTS_INTERVAL,
 147   REQUESTS_LIMIT: REQUESTS_LIMIT,
 148   RETRY_REQUESTS: RETRY_REQUESTS,
 149   SEARCHABLE_COLUMNS: SEARCHABLE_COLUMNS,
 150   SEEDS_IN_PARALLEL: SEEDS_IN_PARALLEL,
 151   SORTABLE_COLUMNS: SORTABLE_COLUMNS,
 152   THUMBNAILS_SIZE: THUMBNAILS_SIZE,
 153   THUMBNAILS_STATIC_PATH: THUMBNAILS_STATIC_PATH,
 154   USER_ROLES: USER_ROLES
 155 }
 156
 157 // ---------------------------------------------------------------------------
 158
 159 function isTestInstance () {
 160   return (process.env.NODE_ENV === 'test')
 161 }