server/initializers/constants.ts

   1 import { IConfig } from 'config'
   2 import { dirname, join } from 'path'
   3 import { JobType, VideoRateType, VideoState, VideosRedundancy } from '../../shared/models'
   4 import { ActivityPubActorType } from '../../shared/models/activitypub'
   5 import { FollowState } from '../../shared/models/actors'
   6 import { VideoAbuseState, VideoImportState, VideoPrivacy, VideoTranscodingFPS } from '../../shared/models/videos'
   7 // Do not use barrels, remain constants as independent as possible
   8 import { buildPath, isTestInstance, parseDuration, parseBytes, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
   9 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  10 import { invert } from 'lodash'
  11 import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
  12 import * as bytes from 'bytes'
  13 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
  14 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
  15
  16 // Use a variable to reload the configuration if we need
  17 let config: IConfig = require('config')
  18
  19 // ---------------------------------------------------------------------------
  20
  21 const LAST_MIGRATION_VERSION = 355
  22
  23 // ---------------------------------------------------------------------------
  24
  25 // API version
  26 const API_VERSION = 'v1'
  27
  28 const PAGINATION = {
  29   COUNT: {
  30     DEFAULT: 15,
  31     MAX: 100
  32   }
  33 }
  34
  35 // Sortable columns per schema
  36 const SORTABLE_COLUMNS = {
  37   USERS: [ 'id', 'username', 'createdAt' ],
  38   USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  39   ACCOUNTS: [ 'createdAt' ],
  40   JOBS: [ 'createdAt' ],
  41   VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
  42   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  43   VIDEO_IMPORTS: [ 'createdAt' ],
  44   VIDEO_COMMENT_THREADS: [ 'createdAt' ],
  45   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  46   FOLLOWERS: [ 'createdAt' ],
  47   FOLLOWING: [ 'createdAt' ],
  48
  49   VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
  50
  51   VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
  52   VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  53
  54   ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
  55   SERVERS_BLOCKLIST: [ 'createdAt' ],
  56
  57   USER_NOTIFICATIONS: [ 'createdAt' ],
  58
  59   VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ]
  60 }
  61
  62 const OAUTH_LIFETIME = {
  63   ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
  64   REFRESH_TOKEN: 1209600 // 2 weeks
  65 }
  66
  67 const ROUTE_CACHE_LIFETIME = {
  68   FEEDS: '15 minutes',
  69   ROBOTS: '2 hours',
  70   SITEMAP: '1 day',
  71   SECURITYTXT: '2 hours',
  72   NODEINFO: '10 minutes',
  73   DNT_POLICY: '1 week',
  74   OVERVIEWS: {
  75     VIDEOS: '1 hour'
  76   },
  77   ACTIVITY_PUB: {
  78     VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
  79   },
  80   STATS: '4 hours'
  81 }
  82
  83 // ---------------------------------------------------------------------------
  84
  85 // Number of points we add/remove after a successful/bad request
  86 const ACTOR_FOLLOW_SCORE = {
  87   PENALTY: -10,
  88   BONUS: 10,
  89   BASE: 1000,
  90   MAX: 10000
  91 }
  92
  93 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
  94   PENDING: 'pending',
  95   ACCEPTED: 'accepted'
  96 }
  97
  98 const REMOTE_SCHEME = {
  99   HTTP: 'https',
 100   WS: 'wss'
 101 }
 102
 103 // TODO: remove 'video-file'
 104 const JOB_ATTEMPTS: { [ id in (JobType | 'video-file') ]: number } = {
 105   'activitypub-http-broadcast': 5,
 106   'activitypub-http-unicast': 5,
 107   'activitypub-http-fetcher': 5,
 108   'activitypub-follow': 5,
 109   'video-file-import': 1,
 110   'video-transcoding': 1,
 111   'video-file': 1,
 112   'video-import': 1,
 113   'email': 5,
 114   'videos-views': 1,
 115   'activitypub-refresher': 1
 116 }
 117 const JOB_CONCURRENCY: { [ id in (JobType | 'video-file') ]: number } = {
 118   'activitypub-http-broadcast': 1,
 119   'activitypub-http-unicast': 5,
 120   'activitypub-http-fetcher': 1,
 121   'activitypub-follow': 3,
 122   'video-file-import': 1,
 123   'video-transcoding': 1,
 124   'video-file': 1,
 125   'video-import': 1,
 126   'email': 5,
 127   'videos-views': 1,
 128   'activitypub-refresher': 1
 129 }
 130 const JOB_TTL: { [ id in (JobType | 'video-file') ]: number } = {
 131   'activitypub-http-broadcast': 60000 * 10, // 10 minutes
 132   'activitypub-http-unicast': 60000 * 10, // 10 minutes
 133   'activitypub-http-fetcher': 60000 * 10, // 10 minutes
 134   'activitypub-follow': 60000 * 10, // 10 minutes
 135   'video-file-import': 1000 * 3600, // 1 hour
 136   'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
 137   'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
 138   'video-import': 1000 * 3600 * 2, //  hours
 139   'email': 60000 * 10, // 10 minutes
 140   'videos-views': undefined, // Unlimited
 141   'activitypub-refresher': 60000 * 10 // 10 minutes
 142 }
 143 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
 144   'videos-views': {
 145     cron: '1 * * * *' // At 1 minute past the hour
 146   }
 147 }
 148
 149 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
 150 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
 151 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
 152 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
 153 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
 154
 155 // 1 hour
 156 let SCHEDULER_INTERVALS_MS = {
 157   actorFollowScores: 60000 * 60, // 1 hour
 158   removeOldJobs: 60000 * 60, // 1 hour
 159   updateVideos: 60000, // 1 minute
 160   youtubeDLUpdate: 60000 * 60 * 24 // 1 day
 161 }
 162
 163 // ---------------------------------------------------------------------------
 164
 165 const CONFIG = {
 166   CUSTOM_FILE: getLocalConfigFilePath(),
 167   LISTEN: {
 168     PORT: config.get<number>('listen.port'),
 169     HOSTNAME: config.get<string>('listen.hostname')
 170   },
 171   DATABASE: {
 172     DBNAME: 'peertube' + config.get<string>('database.suffix'),
 173     HOSTNAME: config.get<string>('database.hostname'),
 174     PORT: config.get<number>('database.port'),
 175     USERNAME: config.get<string>('database.username'),
 176     PASSWORD: config.get<string>('database.password'),
 177     POOL: {
 178       MAX: config.get<number>('database.pool.max')
 179     }
 180   },
 181   REDIS: {
 182     HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
 183     PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
 184     SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
 185     AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
 186     DB: config.has('redis.db') ? config.get<number>('redis.db') : null
 187   },
 188   SMTP: {
 189     HOSTNAME: config.get<string>('smtp.hostname'),
 190     PORT: config.get<number>('smtp.port'),
 191     USERNAME: config.get<string>('smtp.username'),
 192     PASSWORD: config.get<string>('smtp.password'),
 193     TLS: config.get<boolean>('smtp.tls'),
 194     DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
 195     CA_FILE: config.get<string>('smtp.ca_file'),
 196     FROM_ADDRESS: config.get<string>('smtp.from_address')
 197   },
 198   STORAGE: {
 199     TMP_DIR: buildPath(config.get<string>('storage.tmp')),
 200     AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
 201     LOG_DIR: buildPath(config.get<string>('storage.logs')),
 202     VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
 203     STREAMING_PLAYLISTS_DIR: buildPath(config.get<string>('storage.streaming_playlists')),
 204     REDUNDANCY_DIR: buildPath(config.get<string>('storage.redundancy')),
 205     THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
 206     PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
 207     CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
 208     TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
 209     CACHE_DIR: buildPath(config.get<string>('storage.cache'))
 210   },
 211   WEBSERVER: {
 212     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
 213     WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
 214     HOSTNAME: config.get<string>('webserver.hostname'),
 215     PORT: config.get<number>('webserver.port'),
 216     URL: '',
 217     HOST: ''
 218   },
 219   TRUST_PROXY: config.get<string[]>('trust_proxy'),
 220   LOG: {
 221     LEVEL: config.get<string>('log.level')
 222   },
 223   SEARCH: {
 224     REMOTE_URI: {
 225       USERS: config.get<boolean>('search.remote_uri.users'),
 226       ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
 227     }
 228   },
 229   TRENDING: {
 230     VIDEOS: {
 231       INTERVAL_DAYS: config.get<number>('trending.videos.interval_days')
 232     }
 233   },
 234   REDUNDANCY: {
 235     VIDEOS: {
 236       CHECK_INTERVAL: parseDuration(config.get<string>('redundancy.videos.check_interval')),
 237       STRATEGIES: buildVideosRedundancy(config.get<any[]>('redundancy.videos.strategies'))
 238     }
 239   },
 240   CSP: {
 241     ENABLED: config.get<boolean>('csp.enabled'),
 242     REPORT_ONLY: config.get<boolean>('csp.report_only'),
 243     REPORT_URI: config.get<boolean>('csp.report_uri')
 244   },
 245   ADMIN: {
 246     get EMAIL () { return config.get<string>('admin.email') }
 247   },
 248   CONTACT_FORM: {
 249     get ENABLED () { return config.get<boolean>('contact_form.enabled') }
 250   },
 251   SIGNUP: {
 252     get ENABLED () { return config.get<boolean>('signup.enabled') },
 253     get LIMIT () { return config.get<number>('signup.limit') },
 254     get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
 255     FILTERS: {
 256       CIDR: {
 257         get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
 258         get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
 259       }
 260     }
 261   },
 262   USER: {
 263     get VIDEO_QUOTA () { return parseBytes(config.get<number>('user.video_quota')) },
 264     get VIDEO_QUOTA_DAILY () { return parseBytes(config.get<number>('user.video_quota_daily')) }
 265   },
 266   TRANSCODING: {
 267     get ENABLED () { return config.get<boolean>('transcoding.enabled') },
 268     get ALLOW_ADDITIONAL_EXTENSIONS () { return config.get<boolean>('transcoding.allow_additional_extensions') },
 269     get THREADS () { return config.get<number>('transcoding.threads') },
 270     RESOLUTIONS: {
 271       get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
 272       get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
 273       get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
 274       get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
 275       get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
 276     },
 277     HLS: {
 278       get ENABLED () { return config.get<boolean>('transcoding.hls.enabled') }
 279     }
 280   },
 281   IMPORT: {
 282     VIDEOS: {
 283       HTTP: {
 284         get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
 285       },
 286       TORRENT: {
 287         get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
 288       }
 289     }
 290   },
 291   AUTO_BLACKLIST: {
 292     VIDEOS: {
 293       OF_USERS: {
 294         get ENABLED () { return config.get<boolean>('auto_blacklist.videos.of_users.enabled') }
 295       }
 296     }
 297   },
 298   CACHE: {
 299     PREVIEWS: {
 300       get SIZE () { return config.get<number>('cache.previews.size') }
 301     },
 302     VIDEO_CAPTIONS: {
 303       get SIZE () { return config.get<number>('cache.captions.size') }
 304     }
 305   },
 306   INSTANCE: {
 307     get NAME () { return config.get<string>('instance.name') },
 308     get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
 309     get DESCRIPTION () { return config.get<string>('instance.description') },
 310     get TERMS () { return config.get<string>('instance.terms') },
 311     get IS_NSFW () { return config.get<boolean>('instance.is_nsfw') },
 312     get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
 313     get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
 314     CUSTOMIZATIONS: {
 315       get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
 316       get CSS () { return config.get<string>('instance.customizations.css') }
 317     },
 318     get ROBOTS () { return config.get<string>('instance.robots') },
 319     get SECURITYTXT () { return config.get<string>('instance.securitytxt') },
 320     get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') }
 321   },
 322   SERVICES: {
 323     TWITTER: {
 324       get USERNAME () { return config.get<string>('services.twitter.username') },
 325       get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
 326     }
 327   },
 328   FOLLOWERS: {
 329     INSTANCE: {
 330       get ENABLED () { return config.get<boolean>('followers.instance.enabled') },
 331       get MANUAL_APPROVAL () { return config.get<boolean>('followers.instance.manual_approval') }
 332     }
 333   }
 334 }
 335
 336 // ---------------------------------------------------------------------------
 337
 338 let CONSTRAINTS_FIELDS = {
 339   USERS: {
 340     NAME: { min: 1, max: 120 }, // Length
 341     DESCRIPTION: { min: 3, max: 1000 }, // Length
 342     USERNAME: { min: 1, max: 50 }, // Length
 343     PASSWORD: { min: 6, max: 255 }, // Length
 344     VIDEO_QUOTA: { min: -1 },
 345     VIDEO_QUOTA_DAILY: { min: -1 },
 346     BLOCKED_REASON: { min: 3, max: 250 } // Length
 347   },
 348   VIDEO_ABUSES: {
 349     REASON: { min: 2, max: 3000 }, // Length
 350     MODERATION_COMMENT: { min: 2, max: 3000 } // Length
 351   },
 352   VIDEO_BLACKLIST: {
 353     REASON: { min: 2, max: 300 } // Length
 354   },
 355   VIDEO_CHANNELS: {
 356     NAME: { min: 1, max: 120 }, // Length
 357     DESCRIPTION: { min: 3, max: 1000 }, // Length
 358     SUPPORT: { min: 3, max: 1000 }, // Length
 359     URL: { min: 3, max: 2000 } // Length
 360   },
 361   VIDEO_CAPTIONS: {
 362     CAPTION_FILE: {
 363       EXTNAME: [ '.vtt', '.srt' ],
 364       FILE_SIZE: {
 365         max: 2 * 1024 * 1024 // 2MB
 366       }
 367     }
 368   },
 369   VIDEO_IMPORTS: {
 370     URL: { min: 3, max: 2000 }, // Length
 371     TORRENT_NAME: { min: 3, max: 255 }, // Length
 372     TORRENT_FILE: {
 373       EXTNAME: [ '.torrent' ],
 374       FILE_SIZE: {
 375         max: 1024 * 200 // 200 KB
 376       }
 377     }
 378   },
 379   VIDEOS_REDUNDANCY: {
 380     URL: { min: 3, max: 2000 } // Length
 381   },
 382   VIDEO_RATES: {
 383     URL: { min: 3, max: 2000 } // Length
 384   },
 385   VIDEOS: {
 386     NAME: { min: 3, max: 120 }, // Length
 387     LANGUAGE: { min: 1, max: 10 }, // Length
 388     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
 389     DESCRIPTION: { min: 3, max: 10000 }, // Length
 390     SUPPORT: { min: 3, max: 1000 }, // Length
 391     IMAGE: {
 392       EXTNAME: [ '.jpg', '.jpeg' ],
 393       FILE_SIZE: {
 394         max: 2 * 1024 * 1024 // 2MB
 395       }
 396     },
 397     EXTNAME: buildVideosExtname(),
 398     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
 399     DURATION: { min: 0 }, // Number
 400     TAGS: { min: 0, max: 5 }, // Number of total tags
 401     TAG: { min: 2, max: 30 }, // Length
 402     THUMBNAIL: { min: 2, max: 30 },
 403     THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
 404     VIEWS: { min: 0 },
 405     LIKES: { min: 0 },
 406     DISLIKES: { min: 0 },
 407     FILE_SIZE: { min: 10 },
 408     URL: { min: 3, max: 2000 } // Length
 409   },
 410   VIDEO_PLAYLISTS: {
 411     NAME: { min: 1, max: 120 }, // Length
 412     DESCRIPTION: { min: 3, max: 1000 }, // Length
 413     URL: { min: 3, max: 2000 }, // Length
 414     IMAGE: {
 415       EXTNAME: [ '.jpg', '.jpeg' ],
 416       FILE_SIZE: {
 417         max: 2 * 1024 * 1024 // 2MB
 418       }
 419     }
 420   },
 421   ACTORS: {
 422     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
 423     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
 424     URL: { min: 3, max: 2000 }, // Length
 425     AVATAR: {
 426       EXTNAME: [ '.png', '.jpeg', '.jpg' ],
 427       FILE_SIZE: {
 428         max: 2 * 1024 * 1024 // 2MB
 429       }
 430     }
 431   },
 432   VIDEO_EVENTS: {
 433     COUNT: { min: 0 }
 434   },
 435   VIDEO_COMMENTS: {
 436     TEXT: { min: 1, max: 3000 }, // Length
 437     URL: { min: 3, max: 2000 } // Length
 438   },
 439   VIDEO_SHARE: {
 440     URL: { min: 3, max: 2000 } // Length
 441   },
 442   CONTACT_FORM: {
 443     FROM_NAME: { min: 1, max: 120 }, // Length
 444     BODY: { min: 3, max: 5000 } // Length
 445   }
 446 }
 447
 448 const RATES_LIMIT = {
 449   LOGIN: {
 450     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 451     MAX: 15 // 15 attempts
 452   },
 453   ASK_SEND_EMAIL: {
 454     WINDOW_MS: 5 * 60 * 1000, // 5 minutes
 455     MAX: 3 // 3 attempts
 456   }
 457 }
 458
 459 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
 460 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
 461
 462 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
 463   MIN: 10,
 464   AVERAGE: 30,
 465   MAX: 60,
 466   KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
 467 }
 468
 469 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
 470   LIKE: 'like',
 471   DISLIKE: 'dislike'
 472 }
 473
 474 const FFMPEG_NICE: { [ id: string ]: number } = {
 475   THUMBNAIL: 2, // 2 just for don't blocking servers
 476   TRANSCODING: 15
 477 }
 478
 479 const VIDEO_CATEGORIES = {
 480   1: 'Music',
 481   2: 'Films',
 482   3: 'Vehicles',
 483   4: 'Art',
 484   5: 'Sports',
 485   6: 'Travels',
 486   7: 'Gaming',
 487   8: 'People',
 488   9: 'Comedy',
 489   10: 'Entertainment',
 490   11: 'News & Politics',
 491   12: 'How To',
 492   13: 'Education',
 493   14: 'Activism',
 494   15: 'Science & Technology',
 495   16: 'Animals',
 496   17: 'Kids',
 497   18: 'Food'
 498 }
 499
 500 // See https://creativecommons.org/licenses/?lang=en
 501 const VIDEO_LICENCES = {
 502   1: 'Attribution',
 503   2: 'Attribution - Share Alike',
 504   3: 'Attribution - No Derivatives',
 505   4: 'Attribution - Non Commercial',
 506   5: 'Attribution - Non Commercial - Share Alike',
 507   6: 'Attribution - Non Commercial - No Derivatives',
 508   7: 'Public Domain Dedication'
 509 }
 510
 511 const VIDEO_LANGUAGES = buildLanguages()
 512
 513 const VIDEO_PRIVACIES = {
 514   [VideoPrivacy.PUBLIC]: 'Public',
 515   [VideoPrivacy.UNLISTED]: 'Unlisted',
 516   [VideoPrivacy.PRIVATE]: 'Private'
 517 }
 518
 519 const VIDEO_STATES = {
 520   [VideoState.PUBLISHED]: 'Published',
 521   [VideoState.TO_TRANSCODE]: 'To transcode',
 522   [VideoState.TO_IMPORT]: 'To import'
 523 }
 524
 525 const VIDEO_IMPORT_STATES = {
 526   [VideoImportState.FAILED]: 'Failed',
 527   [VideoImportState.PENDING]: 'Pending',
 528   [VideoImportState.SUCCESS]: 'Success'
 529 }
 530
 531 const VIDEO_ABUSE_STATES = {
 532   [VideoAbuseState.PENDING]: 'Pending',
 533   [VideoAbuseState.REJECTED]: 'Rejected',
 534   [VideoAbuseState.ACCEPTED]: 'Accepted'
 535 }
 536
 537 const VIDEO_PLAYLIST_PRIVACIES = {
 538   [VideoPlaylistPrivacy.PUBLIC]: 'Public',
 539   [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
 540   [VideoPlaylistPrivacy.PRIVATE]: 'Private'
 541 }
 542
 543 const VIDEO_PLAYLIST_TYPES = {
 544   [VideoPlaylistType.REGULAR]: 'Regular',
 545   [VideoPlaylistType.WATCH_LATER]: 'Watch later'
 546 }
 547
 548 const MIMETYPES = {
 549   VIDEO: {
 550     MIMETYPE_EXT: buildVideoMimetypeExt(),
 551     EXT_MIMETYPE: null as { [ id: string ]: string }
 552   },
 553   IMAGE: {
 554     MIMETYPE_EXT: {
 555       'image/png': '.png',
 556       'image/jpg': '.jpg',
 557       'image/jpeg': '.jpg'
 558     }
 559   },
 560   VIDEO_CAPTIONS: {
 561     MIMETYPE_EXT: {
 562       'text/vtt': '.vtt',
 563       'application/x-subrip': '.srt'
 564     }
 565   },
 566   TORRENT: {
 567     MIMETYPE_EXT: {
 568       'application/x-bittorrent': '.torrent'
 569     }
 570   }
 571 }
 572 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
 573
 574 // ---------------------------------------------------------------------------
 575
 576 const OVERVIEWS = {
 577   VIDEOS: {
 578     SAMPLE_THRESHOLD: 6,
 579     SAMPLES_COUNT: 2
 580   }
 581 }
 582
 583 // ---------------------------------------------------------------------------
 584
 585 const SERVER_ACTOR_NAME = 'peertube'
 586
 587 const ACTIVITY_PUB = {
 588   POTENTIAL_ACCEPT_HEADERS: [
 589     'application/activity+json',
 590     'application/ld+json',
 591     'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
 592   ],
 593   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
 594   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
 595   COLLECTION_ITEMS_PER_PAGE: 10,
 596   FETCH_PAGE_LIMIT: 100,
 597   URL_MIME_TYPES: {
 598     VIDEO: Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT),
 599     TORRENT: [ 'application/x-bittorrent' ],
 600     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
 601   },
 602   MAX_RECURSION_COMMENTS: 100,
 603   ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 604   VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
 605   VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
 606 }
 607
 608 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
 609   GROUP: 'Group',
 610   PERSON: 'Person',
 611   APPLICATION: 'Application'
 612 }
 613
 614 const HTTP_SIGNATURE = {
 615   HEADER_NAME: 'signature',
 616   ALGORITHM: 'rsa-sha256',
 617   HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
 618 }
 619
 620 // ---------------------------------------------------------------------------
 621
 622 let PRIVATE_RSA_KEY_SIZE = 2048
 623
 624 // Password encryption
 625 const BCRYPT_SALT_SIZE = 10
 626
 627 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
 628
 629 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
 630
 631 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
 632   DO_NOT_LIST: 'do_not_list',
 633   BLUR: 'blur',
 634   DISPLAY: 'display'
 635 }
 636
 637 // ---------------------------------------------------------------------------
 638
 639 // Express static paths (router)
 640 const STATIC_PATHS = {
 641   PREVIEWS: '/static/previews/',
 642   THUMBNAILS: '/static/thumbnails/',
 643   TORRENTS: '/static/torrents/',
 644   WEBSEED: '/static/webseed/',
 645   REDUNDANCY: '/static/redundancy/',
 646   STREAMING_PLAYLISTS: {
 647     HLS: '/static/streaming-playlists/hls'
 648   },
 649   AVATARS: '/static/avatars/',
 650   VIDEO_CAPTIONS: '/static/video-captions/'
 651 }
 652 const STATIC_DOWNLOAD_PATHS = {
 653   TORRENTS: '/download/torrents/',
 654   VIDEOS: '/download/videos/'
 655 }
 656
 657 // Cache control
 658 let STATIC_MAX_AGE = '2h'
 659
 660 // Videos thumbnail size
 661 const THUMBNAILS_SIZE = {
 662   width: 223,
 663   height: 122
 664 }
 665 const PREVIEWS_SIZE = {
 666   width: 560,
 667   height: 315
 668 }
 669 const AVATARS_SIZE = {
 670   width: 120,
 671   height: 120
 672 }
 673
 674 const EMBED_SIZE = {
 675   width: 560,
 676   height: 315
 677 }
 678
 679 // Sub folders of cache directory
 680 const FILES_CACHE = {
 681   PREVIEWS: {
 682     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
 683     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 684   },
 685   VIDEO_CAPTIONS: {
 686     DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
 687     MAX_AGE: 1000 * 3600 * 3 // 3 hours
 688   }
 689 }
 690
 691 const CACHE = {
 692   USER_TOKENS: {
 693     MAX_SIZE: 10000
 694   }
 695 }
 696
 697 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
 698 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
 699
 700 const MEMOIZE_TTL = {
 701   OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
 702 }
 703
 704 const REDUNDANCY = {
 705   VIDEOS: {
 706     RANDOMIZED_FACTOR: 5
 707   }
 708 }
 709
 710 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 711
 712 // ---------------------------------------------------------------------------
 713
 714 const CUSTOM_HTML_TAG_COMMENTS = {
 715   TITLE: '<!-- title tag -->',
 716   DESCRIPTION: '<!-- description tag -->',
 717   CUSTOM_CSS: '<!-- custom css tag -->',
 718   META_TAGS: '<!-- meta tags -->'
 719 }
 720
 721 // ---------------------------------------------------------------------------
 722
 723 const FEEDS = {
 724   COUNT: 20
 725 }
 726
 727 // ---------------------------------------------------------------------------
 728
 729 const TRACKER_RATE_LIMITS = {
 730   INTERVAL: 60000 * 5, // 5 minutes
 731   ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
 732   ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
 733 }
 734
 735 const P2P_MEDIA_LOADER_PEER_VERSION = 2
 736
 737 // ---------------------------------------------------------------------------
 738
 739 // Special constants for a test instance
 740 if (isTestInstance() === true) {
 741   PRIVATE_RSA_KEY_SIZE = 1024
 742
 743   ACTOR_FOLLOW_SCORE.BASE = 20
 744
 745   REMOTE_SCHEME.HTTP = 'http'
 746   REMOTE_SCHEME.WS = 'ws'
 747
 748   STATIC_MAX_AGE = '0'
 749
 750   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
 751   ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 752   ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 753   ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
 754
 755   CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
 756
 757   SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
 758   SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
 759   SCHEDULER_INTERVALS_MS.updateVideos = 5000
 760   REPEAT_JOBS['videos-views'] = { every: 5000 }
 761
 762   REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
 763
 764   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 765   CONTACT_FORM_LIFETIME = 1000 // 1 second
 766
 767   JOB_ATTEMPTS['email'] = 1
 768
 769   FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
 770   MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
 771   ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
 772
 773   RATES_LIMIT.LOGIN.MAX = 20
 774 }
 775
 776 updateWebserverUrls()
 777
 778 // ---------------------------------------------------------------------------
 779
 780 export {
 781   API_VERSION,
 782   HLS_REDUNDANCY_DIRECTORY,
 783   P2P_MEDIA_LOADER_PEER_VERSION,
 784   AVATARS_SIZE,
 785   ACCEPT_HEADERS,
 786   BCRYPT_SALT_SIZE,
 787   TRACKER_RATE_LIMITS,
 788   FILES_CACHE,
 789   CONFIG,
 790   CONSTRAINTS_FIELDS,
 791   EMBED_SIZE,
 792   REDUNDANCY,
 793   JOB_CONCURRENCY,
 794   JOB_ATTEMPTS,
 795   LAST_MIGRATION_VERSION,
 796   OAUTH_LIFETIME,
 797   CUSTOM_HTML_TAG_COMMENTS,
 798   BROADCAST_CONCURRENCY,
 799   PAGINATION,
 800   ACTOR_FOLLOW_SCORE,
 801   PREVIEWS_SIZE,
 802   REMOTE_SCHEME,
 803   FOLLOW_STATES,
 804   SERVER_ACTOR_NAME,
 805   PRIVATE_RSA_KEY_SIZE,
 806   ROUTE_CACHE_LIFETIME,
 807   SORTABLE_COLUMNS,
 808   HLS_STREAMING_PLAYLIST_DIRECTORY,
 809   FEEDS,
 810   JOB_TTL,
 811   NSFW_POLICY_TYPES,
 812   STATIC_MAX_AGE,
 813   STATIC_PATHS,
 814   VIDEO_IMPORT_TIMEOUT,
 815   VIDEO_PLAYLIST_TYPES,
 816   ACTIVITY_PUB,
 817   ACTIVITY_PUB_ACTOR_TYPES,
 818   THUMBNAILS_SIZE,
 819   VIDEO_CATEGORIES,
 820   VIDEO_LANGUAGES,
 821   VIDEO_PRIVACIES,
 822   VIDEO_LICENCES,
 823   VIDEO_STATES,
 824   VIDEO_RATE_TYPES,
 825   VIDEO_TRANSCODING_FPS,
 826   FFMPEG_NICE,
 827   VIDEO_ABUSE_STATES,
 828   CACHE,
 829   JOB_REQUEST_TIMEOUT,
 830   USER_PASSWORD_RESET_LIFETIME,
 831   MEMOIZE_TTL,
 832   USER_EMAIL_VERIFY_LIFETIME,
 833   OVERVIEWS,
 834   SCHEDULER_INTERVALS_MS,
 835   REPEAT_JOBS,
 836   STATIC_DOWNLOAD_PATHS,
 837   RATES_LIMIT,
 838   MIMETYPES,
 839   CRAWL_REQUEST_CONCURRENCY,
 840   JOB_COMPLETED_LIFETIME,
 841   HTTP_SIGNATURE,
 842   VIDEO_IMPORT_STATES,
 843   VIDEO_VIEW_LIFETIME,
 844   CONTACT_FORM_LIFETIME,
 845   VIDEO_PLAYLIST_PRIVACIES,
 846   buildLanguages
 847 }
 848
 849 // ---------------------------------------------------------------------------
 850
 851 function getLocalConfigFilePath () {
 852   const configSources = config.util.getConfigSources()
 853   if (configSources.length === 0) throw new Error('Invalid config source.')
 854
 855   let filename = 'local'
 856   if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
 857   if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
 858
 859   return join(dirname(configSources[ 0 ].name), filename + '.json')
 860 }
 861
 862 function buildVideoMimetypeExt () {
 863   const data = {
 864     'video/webm': '.webm',
 865     'video/ogg': '.ogv',
 866     'video/mp4': '.mp4'
 867   }
 868
 869   if (CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
 870     Object.assign(data, {
 871       'video/quicktime': '.mov',
 872       'video/x-msvideo': '.avi',
 873       'video/x-flv': '.flv',
 874       'video/x-matroska': '.mkv',
 875       'application/octet-stream': '.mkv',
 876       'video/avi': '.avi'
 877     })
 878   }
 879
 880   return data
 881 }
 882
 883 function updateWebserverUrls () {
 884   CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
 885   CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
 886 }
 887
 888 function updateWebserverConfig () {
 889   CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
 890
 891   MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
 892   MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
 893 }
 894
 895 function buildVideosExtname () {
 896   return CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS
 897     ? [ '.mp4', '.ogv', '.webm', '.mkv', '.mov', '.avi', '.flv' ]
 898     : [ '.mp4', '.ogv', '.webm' ]
 899 }
 900
 901 function buildVideosRedundancy (objs: any[]): VideosRedundancy[] {
 902   if (!objs) return []
 903
 904   if (!Array.isArray(objs)) return objs
 905
 906   return objs.map(obj => {
 907     return Object.assign({}, obj, {
 908       minLifetime: parseDuration(obj.min_lifetime),
 909       size: bytes.parse(obj.size),
 910       minViews: obj.min_views
 911     })
 912   })
 913 }
 914
 915 function buildLanguages () {
 916   const iso639 = require('iso-639-3')
 917
 918   const languages: { [ id: string ]: string } = {}
 919
 920   const additionalLanguages = {
 921     'sgn': true, // Sign languages (macro language)
 922     'ase': true, // American sign language
 923     'sdl': true, // Arabian sign language
 924     'bfi': true, // British sign language
 925     'bzs': true, // Brazilian sign language
 926     'csl': true, // Chinese sign language
 927     'cse': true, // Czech sign language
 928     'dsl': true, // Danish sign language
 929     'fsl': true, // French sign language
 930     'gsg': true, // German sign language
 931     'pks': true, // Pakistan sign language
 932     'jsl': true, // Japanese sign language
 933     'sfs': true, // South African sign language
 934     'swl': true, // Swedish sign language
 935     'rsl': true, // Russian sign language: true
 936
 937     'epo': true, // Esperanto
 938     'tlh': true, // Klingon
 939     'jbo': true, // Lojban
 940     'avk': true // Kotava
 941   }
 942
 943   // Only add ISO639-1 languages and some sign languages (ISO639-3)
 944   iso639
 945     .filter(l => {
 946       return (l.iso6391 !== null && l.type === 'living') ||
 947         additionalLanguages[l.iso6393] === true
 948     })
 949     .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
 950
 951   // Override Occitan label
 952   languages['oc'] = 'Occitan'
 953
 954   return languages
 955 }
 956
 957 export function reloadConfig () {
 958
 959   function directory () {
 960     if (process.env.NODE_CONFIG_DIR) {
 961       return process.env.NODE_CONFIG_DIR
 962     }
 963
 964     return join(root(), 'config')
 965   }
 966
 967   function purge () {
 968     for (const fileName in require.cache) {
 969       if (-1 === fileName.indexOf(directory())) {
 970         continue
 971       }
 972
 973       delete require.cache[fileName]
 974     }
 975
 976     delete require.cache[require.resolve('config')]
 977   }
 978
 979   purge()
 980
 981   config = require('config')
 982
 983   updateWebserverConfig()
 984   updateWebserverUrls()
 985 }