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