server/initializers/constants.ts

   1 import * as config from 'config'
   2 import { join } from 'path'
   3 import { JobCategory, JobState, VideoRateType } from '../../shared/models'
   4 import { FollowState } from '../../shared/models/accounts'
   5 import { VideoPrivacy } from '../../shared/models/videos'
   6 // Do not use barrels, remain constants as independent as possible
   7 import { isTestInstance, root } from '../helpers/core-utils'
   8
   9 // ---------------------------------------------------------------------------
  10
  11 const LAST_MIGRATION_VERSION = 130
  12
  13 // ---------------------------------------------------------------------------
  14
  15 // API version
  16 const API_VERSION = 'v1'
  17
  18 // Number of results by default for the pagination
  19 const PAGINATION_COUNT_DEFAULT = 15
  20
  21 // Sortable columns per schema
  22 const SORTABLE_COLUMNS = {
  23   USERS: [ 'id', 'username', 'createdAt' ],
  24   JOBS: [ 'id', 'createdAt' ],
  25   VIDEO_ABUSES: [ 'id', 'createdAt' ],
  26   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  27   VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
  28   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  29   FOLLOWERS: [ 'createdAt' ],
  30   FOLLOWING: [ 'createdAt' ]
  31 }
  32
  33 const OAUTH_LIFETIME = {
  34   ACCESS_TOKEN: 3600 * 4, // 4 hours
  35   REFRESH_TOKEN: 1209600 // 2 weeks
  36 }
  37
  38 // ---------------------------------------------------------------------------
  39
  40 const CONFIG = {
  41   LISTEN: {
  42     PORT: config.get<number>('listen.port')
  43   },
  44   DATABASE: {
  45     DBNAME: 'peertube' + config.get<string>('database.suffix'),
  46     HOSTNAME: config.get<string>('database.hostname'),
  47     PORT: config.get<number>('database.port'),
  48     USERNAME: config.get<string>('database.username'),
  49     PASSWORD: config.get<string>('database.password')
  50   },
  51   STORAGE: {
  52     AVATARS_DIR: join(root(), config.get<string>('storage.avatars')),
  53     LOG_DIR: join(root(), config.get<string>('storage.logs')),
  54     VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
  55     THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
  56     PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
  57     TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
  58     CACHE_DIR: join(root(), config.get<string>('storage.cache'))
  59   },
  60   WEBSERVER: {
  61     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
  62     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
  63     HOSTNAME: config.get<string>('webserver.hostname'),
  64     PORT: config.get<number>('webserver.port'),
  65     URL: '',
  66     HOST: ''
  67   },
  68   ADMIN: {
  69     EMAIL: config.get<string>('admin.email')
  70   },
  71   SIGNUP: {
  72     ENABLED: config.get<boolean>('signup.enabled'),
  73     LIMIT: config.get<number>('signup.limit')
  74   },
  75   USER: {
  76     VIDEO_QUOTA: config.get<number>('user.video_quota')
  77   },
  78   TRANSCODING: {
  79     ENABLED: config.get<boolean>('transcoding.enabled'),
  80     THREADS: config.get<number>('transcoding.threads'),
  81     RESOLUTIONS: {
  82       '240' : config.get<boolean>('transcoding.resolutions.240p'),
  83       '360': config.get<boolean>('transcoding.resolutions.360p'),
  84       '480': config.get<boolean>('transcoding.resolutions.480p'),
  85       '720': config.get<boolean>('transcoding.resolutions.720p'),
  86       '1080': config.get<boolean>('transcoding.resolutions.1080p')
  87     }
  88   },
  89   CACHE: {
  90     PREVIEWS: {
  91       SIZE: config.get<number>('cache.previews.size')
  92     }
  93   }
  94 }
  95 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
  96 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
  97
  98 const AVATARS_DIR = {
  99   ACCOUNT: join(CONFIG.STORAGE.AVATARS_DIR, 'account')
 100 }
 101 // ---------------------------------------------------------------------------
 102
 103 const CONSTRAINTS_FIELDS = {
 104   USERS: {
 105     USERNAME: { min: 3, max: 20 }, // Length
 106     PASSWORD: { min: 6, max: 255 }, // Length
 107     VIDEO_QUOTA: { min: -1 }
 108   },
 109   VIDEO_ABUSES: {
 110     REASON: { min: 2, max: 300 } // Length
 111   },
 112   VIDEO_CHANNELS: {
 113     NAME: { min: 3, max: 120 }, // Length
 114     DESCRIPTION: { min: 3, max: 250 }, // Length
 115     URL: { min: 3, max: 2000 } // Length
 116   },
 117   VIDEOS: {
 118     NAME: { min: 3, max: 120 }, // Length
 119     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 120     DESCRIPTION: { min: 3, max: 3000 }, // 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 }, // Number
 124     TAGS: { min: 0, max: 5 }, // Number of total tags
 125     TAG: { min: 2, max: 30 }, // 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 },
 132     URL: { min: 3, max: 2000 } // Length
 133   },
 134   ACTOR: {
 135     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 136     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 137     URL: { min: 3, max: 2000 } // Length
 138   },
 139   VIDEO_EVENTS: {
 140     COUNT: { min: 0 }
 141   }
 142 }
 143
 144 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 145   LIKE: 'like',
 146   DISLIKE: 'dislike'
 147 }
 148
 149 const VIDEO_CATEGORIES = {
 150   1: 'Music',
 151   2: 'Films',
 152   3: 'Vehicles',
 153   4: 'Art',
 154   5: 'Sports',
 155   6: 'Travels',
 156   7: 'Gaming',
 157   8: 'People',
 158   9: 'Comedy',
 159   10: 'Entertainment',
 160   11: 'News',
 161   12: 'How To',
 162   13: 'Education',
 163   14: 'Activism',
 164   15: 'Science & Technology',
 165   16: 'Animals',
 166   17: 'Kids',
 167   18: 'Food'
 168 }
 169
 170 // See https://creativecommons.org/licenses/?lang=en
 171 const VIDEO_LICENCES = {
 172   1: 'Attribution',
 173   2: 'Attribution - Share Alike',
 174   3: 'Attribution - No Derivatives',
 175   4: 'Attribution - Non Commercial',
 176   5: 'Attribution - Non Commercial - Share Alike',
 177   6: 'Attribution - Non Commercial - No Derivatives',
 178   7: 'Public Domain Dedication'
 179 }
 180
 181 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
 182 const VIDEO_LANGUAGES = {
 183   1: 'English',
 184   2: 'Spanish',
 185   3: 'Mandarin',
 186   4: 'Hindi',
 187   5: 'Arabic',
 188   6: 'Portuguese',
 189   7: 'Bengali',
 190   8: 'Russian',
 191   9: 'Japanese',
 192   10: 'Punjabi',
 193   11: 'German',
 194   12: 'Korean',
 195   13: 'French',
 196   14: 'Italian'
 197 }
 198
 199 const VIDEO_PRIVACIES = {
 200   [VideoPrivacy.PUBLIC]: 'Public',
 201   [VideoPrivacy.UNLISTED]: 'Unlisted',
 202   [VideoPrivacy.PRIVATE]: 'Private'
 203 }
 204
 205 const VIDEO_MIMETYPE_EXT = {
 206   'video/webm': '.webm',
 207   'video/ogg': '.ogv',
 208   'video/mp4': '.mp4'
 209 }
 210
 211 // ---------------------------------------------------------------------------
 212
 213 const SERVER_ACCOUNT_NAME = 'peertube'
 214
 215 const ACTIVITY_PUB = {
 216   POTENTIAL_ACCEPT_HEADERS: [
 217     'application/activity+json',
 218     'application/ld+json'
 219   ],
 220   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 221   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 222   COLLECTION_ITEMS_PER_PAGE: 10,
 223   FETCH_PAGE_LIMIT: 100,
 224   MAX_HTTP_ATTEMPT: 5,
 225   URL_MIME_TYPES: {
 226     VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT
 227     TORRENT: [ 'application/x-bittorrent' ],
 228     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 229   }
 230 }
 231
 232 // ---------------------------------------------------------------------------
 233
 234 // Number of points we add/remove from a friend after a successful/bad request
 235 const SERVERS_SCORE = {
 236   PENALTY: -10,
 237   BONUS: 10,
 238   BASE: 100,
 239   MAX: 1000
 240 }
 241
 242 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
 243   PENDING: 'pending',
 244   ACCEPTED: 'accepted'
 245 }
 246
 247 const REMOTE_SCHEME = {
 248   HTTP: 'https',
 249   WS: 'wss'
 250 }
 251
 252 const JOB_STATES: { [ id: string ]: JobState } = {
 253   PENDING: 'pending',
 254   PROCESSING: 'processing',
 255   ERROR: 'error',
 256   SUCCESS: 'success'
 257 }
 258 const JOB_CATEGORIES: { [ id: string ]: JobCategory } = {
 259   TRANSCODING: 'transcoding',
 260   ACTIVITYPUB_HTTP: 'activitypub-http'
 261 }
 262 // How many maximum jobs we fetch from the database per cycle
 263 const JOBS_FETCH_LIMIT_PER_CYCLE = {
 264   transcoding: 10,
 265   httpRequest: 20
 266 }
 267 // 1 minutes
 268 let JOBS_FETCHING_INTERVAL = 60000
 269
 270 // ---------------------------------------------------------------------------
 271
 272 const PRIVATE_RSA_KEY_SIZE = 2048
 273
 274 // Password encryption
 275 const BCRYPT_SALT_SIZE = 10
 276
 277 // ---------------------------------------------------------------------------
 278
 279 // Express static paths (router)
 280 const STATIC_PATHS = {
 281   PREVIEWS: '/static/previews/',
 282   THUMBNAILS: '/static/thumbnails/',
 283   TORRENTS: '/static/torrents/',
 284   WEBSEED: '/static/webseed/'
 285 }
 286
 287 // Cache control
 288 let STATIC_MAX_AGE = '30d'
 289
 290 // Videos thumbnail size
 291 const THUMBNAILS_SIZE = {
 292   width: 200,
 293   height: 110
 294 }
 295 const PREVIEWS_SIZE = {
 296   width: 560,
 297   height: 315
 298 }
 299
 300 const EMBED_SIZE = {
 301   width: 560,
 302   height: 315
 303 }
 304
 305 // Sub folders of cache directory
 306 const CACHE = {
 307   DIRECTORIES: {
 308     PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
 309   }
 310 }
 311
 312 const ACCEPT_HEADERS = ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS.concat('html', 'application/json')
 313
 314 // ---------------------------------------------------------------------------
 315
 316 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
 317
 318 // ---------------------------------------------------------------------------
 319
 320 // Special constants for a test instance
 321 if (isTestInstance() === true) {
 322   SERVERS_SCORE.BASE = 20
 323   JOBS_FETCHING_INTERVAL = 1000
 324   REMOTE_SCHEME.HTTP = 'http'
 325   REMOTE_SCHEME.WS = 'ws'
 326   STATIC_MAX_AGE = '0'
 327   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 328 }
 329
 330 // ---------------------------------------------------------------------------
 331
 332 export {
 333   API_VERSION,
 334   ACCEPT_HEADERS,
 335   BCRYPT_SALT_SIZE,
 336   CACHE,
 337   CONFIG,
 338   CONSTRAINTS_FIELDS,
 339   EMBED_SIZE,
 340   JOB_STATES,
 341   JOBS_FETCH_LIMIT_PER_CYCLE,
 342   JOBS_FETCHING_INTERVAL,
 343   JOB_CATEGORIES,
 344   LAST_MIGRATION_VERSION,
 345   OAUTH_LIFETIME,
 346   OPENGRAPH_AND_OEMBED_COMMENT,
 347   PAGINATION_COUNT_DEFAULT,
 348   SERVERS_SCORE,
 349   PREVIEWS_SIZE,
 350   REMOTE_SCHEME,
 351   FOLLOW_STATES,
 352   AVATARS_DIR,
 353   SERVER_ACCOUNT_NAME,
 354   PRIVATE_RSA_KEY_SIZE,
 355   SORTABLE_COLUMNS,
 356   STATIC_MAX_AGE,
 357   STATIC_PATHS,
 358   ACTIVITY_PUB,
 359   THUMBNAILS_SIZE,
 360   VIDEO_CATEGORIES,
 361   VIDEO_LANGUAGES,
 362   VIDEO_PRIVACIES,
 363   VIDEO_LICENCES,
 364   VIDEO_RATE_TYPES,
 365   VIDEO_MIMETYPE_EXT
 366 }