server/initializers/constants.ts

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