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