]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/initializers/constants.js
Update roadmap
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.js
index ce9f8ad6c20605e04c675c629e57d477008240c4..8215808931aa19fba67bf14e6b41b903145e464d 100644 (file)
 const config = require('config')
 const path = require('path')
 
-// API version of our pod
+// ---------------------------------------------------------------------------
+
+const LAST_MIGRATION_VERSION = 10
+
+// ---------------------------------------------------------------------------
+
+// API version
 const API_VERSION = 'v1'
 
+// Number of results by default for the pagination
+const PAGINATION_COUNT_DEFAULT = 15
+
+// Sortable columns per schema
+const SEARCHABLE_COLUMNS = {
+  VIDEOS: [ 'name', 'magnetUri', 'host', 'author', 'tags' ]
+}
+
+// Sortable columns per schema
+const SORTABLE_COLUMNS = {
+  USERS: [ 'id', '-id', 'username', '-username', 'createdAt', '-createdAt' ],
+  VIDEO_ABUSES: [ 'id', '-id', 'createdAt', '-createdAt' ],
+  VIDEOS: [ 'name', '-name', 'duration', '-duration', 'createdAt', '-createdAt' ]
+}
+
+const OAUTH_LIFETIME = {
+  ACCESS_TOKEN: 3600 * 4, // 4 hours
+  REFRESH_TOKEN: 1209600 // 2 weeks
+}
+
+// ---------------------------------------------------------------------------
+
 const CONFIG = {
+  LISTEN: {
+    PORT: config.get('listen.port')
+  },
   DATABASE: {
     DBNAME: 'peertube' + config.get('database.suffix'),
-    HOST: config.get('database.host'),
-    PORT: config.get('database.port')
-  },
-  ELECTRON: {
-    DEBUG: config.get('electron.debug')
+    HOSTNAME: config.get('database.hostname'),
+    PORT: config.get('database.port'),
+    USERNAME: config.get('database.username'),
+    PASSWORD: config.get('database.password')
   },
   STORAGE: {
     CERT_DIR: path.join(__dirname, '..', '..', config.get('storage.certs')),
     LOG_DIR: path.join(__dirname, '..', '..', config.get('storage.logs')),
-    UPLOAD_DIR: path.join(__dirname, '..', '..', config.get('storage.uploads')),
-    THUMBNAILS_DIR: path.join(__dirname, '..', '..', config.get('storage.thumbnails'))
+    VIDEOS_DIR: path.join(__dirname, '..', '..', config.get('storage.videos')),
+    THUMBNAILS_DIR: path.join(__dirname, '..', '..', config.get('storage.thumbnails')),
+    PREVIEWS_DIR: path.join(__dirname, '..', '..', config.get('storage.previews')),
+    TORRENTS_DIR: path.join(__dirname, '..', '..', config.get('storage.torrents'))
   },
   WEBSERVER: {
     SCHEME: config.get('webserver.https') === true ? 'https' : 'http',
-    HOST: config.get('webserver.host'),
+    WS: config.get('webserver.https') === true ? 'wss' : 'ws',
+    HOSTNAME: config.get('webserver.hostname'),
     PORT: config.get('webserver.port')
+  },
+  ADMIN: {
+    EMAIL: config.get('admin.email')
   }
 }
-CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOST + ':' + CONFIG.WEBSERVER.PORT
+CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
+CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
+
+// ---------------------------------------------------------------------------
 
 const CONSTRAINTS_FIELDS = {
   USERS: {
     USERNAME: { min: 3, max: 20 }, // Length
     PASSWORD: { min: 6, max: 255 } // Length
   },
+  VIDEO_ABUSES: {
+    REASON: { min: 2, max: 300 } // Length
+  },
   VIDEOS: {
     NAME: { min: 3, max: 50 }, // Length
     DESCRIPTION: { min: 3, max: 250 }, // Length
-    MAGNET_URI: { min: 10 }, // Length
+    EXTNAME: [ '.mp4', '.ogv', '.webm' ],
+    INFO_HASH: { min: 40, max: 40 }, // Length, infohash is 20 bytes length but we represent it in hexa so 20 * 2
     DURATION: { min: 1, max: 7200 }, // Number
     TAGS: { min: 1, max: 3 }, // Number of total tags
     TAG: { min: 2, max: 10 }, // Length
     THUMBNAIL: { min: 2, max: 30 },
-    THUMBNAIL64: { min: 0, max: 20000 } // Bytes
+    THUMBNAIL_DATA: { min: 0, max: 20000 } // Bytes
   }
 }
 
+// ---------------------------------------------------------------------------
+
 // Score a pod has when we create it as a friend
 const FRIEND_SCORE = {
   BASE: 100,
   MAX: 1000
 }
 
-// Time to wait between requests to the friends (10 min)
-let INTERVAL = 600000
-
-const OAUTH_LIFETIME = {
-  ACCESS_TOKEN: 3600 * 4, // 4 hours
-  REFRESH_TOKEN: 1209600 // 2 weeks
-}
-
-// Number of results by default for the pagination
-const PAGINATION_COUNT_DEFAULT = 15
+// ---------------------------------------------------------------------------
 
 // Number of points we add/remove from a friend after a successful/bad request
 const PODS_SCORE = {
@@ -69,72 +105,118 @@ const PODS_SCORE = {
   BONUS: 10
 }
 
+// Time to wait between requests to the friends (10 min)
+let REQUESTS_INTERVAL = 600000
+
 // Number of requests in parallel we can make
 const REQUESTS_IN_PARALLEL = 10
 
-// How many requests we put in request (request scheduler)
-const REQUESTS_LIMIT = 10
+// To how many pods we send requests
+const REQUESTS_LIMIT_PODS = 10
+// How many requests we send to a pod per interval
+const REQUESTS_LIMIT_PER_POD = 5
 
 // Number of requests to retry for replay requests module
 const RETRY_REQUESTS = 5
 
-// Sortable columns per schema
-const SEARCHABLE_COLUMNS = {
-  VIDEOS: [ 'name', 'magnetUri', 'podUrl', 'author', 'tags' ]
+const REQUEST_ENDPOINTS = {
+  VIDEOS: 'videos'
+}
+const REQUEST_ENDPOINT_ACTIONS = {}
+REQUEST_ENDPOINT_ACTIONS[REQUEST_ENDPOINTS.VIDEOS] = {
+  ADD: 'add',
+  UPDATE: 'update',
+  REMOVE: 'remove',
+  REPORT_ABUSE: 'report-abuse'
 }
 
-// Seeds in parallel we send to electron when "seed all"
-// Once a video is in seeding state we seed another video etc
-const SEEDS_IN_PARALLEL = 3
+const REMOTE_SCHEME = {
+  HTTP: 'https',
+  WS: 'wss'
+}
 
-// Sortable columns per schema
-const SORTABLE_COLUMNS = {
-  USERS: [ 'username', '-username', 'createdDate', '-createdDate' ],
-  VIDEOS: [ 'name', '-name', 'duration', '-duration', 'createdDate', '-createdDate' ]
+// ---------------------------------------------------------------------------
+
+const PRIVATE_CERT_NAME = 'peertube.key.pem'
+const PUBLIC_CERT_NAME = 'peertube.pub'
+const SIGNATURE_ALGORITHM = 'RSA-SHA256'
+const SIGNATURE_ENCODING = 'hex'
+
+// Password encryption
+const BCRYPT_SALT_SIZE = 10
+
+// ---------------------------------------------------------------------------
+
+// Express static paths (router)
+const STATIC_PATHS = {
+  PREVIEWS: '/static/previews/',
+  THUMBNAILS: '/static/thumbnails/',
+  TORRENTS: '/static/torrents/',
+  WEBSEED: '/static/webseed/'
 }
 
+// Cache control
+let STATIC_MAX_AGE = '30d'
+
 // Videos thumbnail size
 const THUMBNAILS_SIZE = '200x110'
+const PREVIEWS_SIZE = '640x480'
 
-// Path for access to thumbnails with express router
-const THUMBNAILS_STATIC_PATH = '/static/thumbnails'
+// ---------------------------------------------------------------------------
 
 const USER_ROLES = {
   ADMIN: 'admin',
   USER: 'user'
 }
 
+// ---------------------------------------------------------------------------
+
 // Special constants for a test instance
 if (isTestInstance() === true) {
-  FRIEND_SCORE.BASE = 20
-  INTERVAL = 10000
   CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
+  FRIEND_SCORE.BASE = 20
+  REQUESTS_INTERVAL = 10000
+  REMOTE_SCHEME.HTTP = 'http'
+  REMOTE_SCHEME.WS = 'ws'
+  STATIC_MAX_AGE = 0
 }
 
 // ---------------------------------------------------------------------------
 
 module.exports = {
-  API_VERSION: API_VERSION,
-  CONFIG: CONFIG,
-  CONSTRAINTS_FIELDS: CONSTRAINTS_FIELDS,
-  FRIEND_SCORE: FRIEND_SCORE,
-  INTERVAL: INTERVAL,
-  OAUTH_LIFETIME: OAUTH_LIFETIME,
-  PAGINATION_COUNT_DEFAULT: PAGINATION_COUNT_DEFAULT,
-  PODS_SCORE: PODS_SCORE,
-  REQUESTS_IN_PARALLEL: REQUESTS_IN_PARALLEL,
-  REQUESTS_LIMIT: REQUESTS_LIMIT,
-  RETRY_REQUESTS: RETRY_REQUESTS,
-  SEARCHABLE_COLUMNS: SEARCHABLE_COLUMNS,
-  SEEDS_IN_PARALLEL: SEEDS_IN_PARALLEL,
-  SORTABLE_COLUMNS: SORTABLE_COLUMNS,
-  THUMBNAILS_SIZE: THUMBNAILS_SIZE,
-  THUMBNAILS_STATIC_PATH: THUMBNAILS_STATIC_PATH,
-  USER_ROLES: USER_ROLES
+  API_VERSION,
+  BCRYPT_SALT_SIZE,
+  CONFIG,
+  CONSTRAINTS_FIELDS,
+  FRIEND_SCORE,
+  LAST_MIGRATION_VERSION,
+  OAUTH_LIFETIME,
+  PAGINATION_COUNT_DEFAULT,
+  PODS_SCORE,
+  PREVIEWS_SIZE,
+  PRIVATE_CERT_NAME,
+  PUBLIC_CERT_NAME,
+  REMOTE_SCHEME,
+  REQUEST_ENDPOINT_ACTIONS,
+  REQUEST_ENDPOINTS,
+  REQUESTS_IN_PARALLEL,
+  REQUESTS_INTERVAL,
+  REQUESTS_LIMIT_PER_POD,
+  REQUESTS_LIMIT_PODS,
+  RETRY_REQUESTS,
+  SEARCHABLE_COLUMNS,
+  SIGNATURE_ALGORITHM,
+  SIGNATURE_ENCODING,
+  SORTABLE_COLUMNS,
+  STATIC_MAX_AGE,
+  STATIC_PATHS,
+  THUMBNAILS_SIZE,
+  USER_ROLES
 }
 
 // ---------------------------------------------------------------------------
 
+// This method exists in utils module but we want to let the constants module independent
 function isTestInstance () {
   return (process.env.NODE_ENV === 'test')
 }