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