1 import { join } from 'path'
2 import { JobType, VideoRateType, VideoState } from '../../shared/models'
3 import { ActivityPubActorType } from '../../shared/models/activitypub'
4 import { FollowState } from '../../shared/models/actors'
5 import { VideoAbuseState, VideoImportState, VideoPrivacy, VideoTranscodingFPS } from '../../shared/models/videos'
6 // Do not use barrels, remain constants as independent as possible
7 import { isTestInstance, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
8 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
9 import { invert } from 'lodash'
10 import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
11 import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
12 import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
13 import { CONFIG, registerConfigChangedHandler } from './config'
15 // ---------------------------------------------------------------------------
17 const LAST_MIGRATION_VERSION = 360
19 // ---------------------------------------------------------------------------
22 const API_VERSION = 'v1'
40 // Sortable columns per schema
41 const SORTABLE_COLUMNS = {
42 USERS: [ 'id', 'username', 'createdAt' ],
43 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
44 ACCOUNTS: [ 'createdAt' ],
45 JOBS: [ 'createdAt' ],
46 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
47 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
48 VIDEO_IMPORTS: [ 'createdAt' ],
49 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
50 VIDEO_RATES: [ 'createdAt' ],
51 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
52 FOLLOWERS: [ 'createdAt' ],
53 FOLLOWING: [ 'createdAt' ],
55 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
57 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
58 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
60 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
61 SERVERS_BLOCKLIST: [ 'createdAt' ],
63 USER_NOTIFICATIONS: [ 'createdAt' ],
65 VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ]
68 const OAUTH_LIFETIME = {
69 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
70 REFRESH_TOKEN: 1209600 // 2 weeks
73 const ROUTE_CACHE_LIFETIME = {
77 SECURITYTXT: '2 hours',
78 NODEINFO: '10 minutes',
84 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
89 // ---------------------------------------------------------------------------
91 // Number of points we add/remove after a successful/bad request
92 const ACTOR_FOLLOW_SCORE = {
99 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
104 const REMOTE_SCHEME = {
109 // TODO: remove 'video-file'
110 const JOB_ATTEMPTS: { [id in (JobType | 'video-file')]: number } = {
111 'activitypub-http-broadcast': 5,
112 'activitypub-http-unicast': 5,
113 'activitypub-http-fetcher': 5,
114 'activitypub-follow': 5,
115 'video-file-import': 1,
116 'video-transcoding': 1,
121 'activitypub-refresher': 1
123 const JOB_CONCURRENCY: { [id in (JobType | 'video-file')]: number } = {
124 'activitypub-http-broadcast': 1,
125 'activitypub-http-unicast': 5,
126 'activitypub-http-fetcher': 1,
127 'activitypub-follow': 3,
128 'video-file-import': 1,
129 'video-transcoding': 1,
134 'activitypub-refresher': 1
136 const JOB_TTL: { [id in (JobType | 'video-file')]: number } = {
137 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
138 'activitypub-http-unicast': 60000 * 10, // 10 minutes
139 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
140 'activitypub-follow': 60000 * 10, // 10 minutes
141 'video-file-import': 1000 * 3600, // 1 hour
142 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
143 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
144 'video-import': 1000 * 3600 * 2, // hours
145 'email': 60000 * 10, // 10 minutes
146 'videos-views': undefined, // Unlimited
147 'activitypub-refresher': 60000 * 10 // 10 minutes
149 const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
151 cron: '1 * * * *' // At 1 minute past the hour
155 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
156 const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
157 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
158 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
159 const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
161 const SCHEDULER_INTERVALS_MS = {
162 actorFollowScores: 60000 * 60, // 1 hour
163 removeOldJobs: 60000 * 60, // 1 hour
164 updateVideos: 60000, // 1 minute
165 youtubeDLUpdate: 60000 * 60 * 24, // 1 day
166 removeOldHistory: 60000 * 60 * 24 // 1 day
169 // ---------------------------------------------------------------------------
171 let CONSTRAINTS_FIELDS = {
173 NAME: { min: 1, max: 120 }, // Length
174 DESCRIPTION: { min: 3, max: 1000 }, // Length
175 USERNAME: { min: 1, max: 50 }, // Length
176 PASSWORD: { min: 6, max: 255 }, // Length
177 VIDEO_QUOTA: { min: -1 },
178 VIDEO_QUOTA_DAILY: { min: -1 },
179 BLOCKED_REASON: { min: 3, max: 250 } // Length
182 REASON: { min: 2, max: 3000 }, // Length
183 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
186 REASON: { min: 2, max: 300 } // Length
189 NAME: { min: 1, max: 120 }, // Length
190 DESCRIPTION: { min: 3, max: 1000 }, // Length
191 SUPPORT: { min: 3, max: 1000 }, // Length
192 URL: { min: 3, max: 2000 } // Length
196 EXTNAME: [ '.vtt', '.srt' ],
198 max: 2 * 1024 * 1024 // 2MB
203 URL: { min: 3, max: 2000 }, // Length
204 TORRENT_NAME: { min: 3, max: 255 }, // Length
206 EXTNAME: [ '.torrent' ],
208 max: 1024 * 200 // 200 KB
213 URL: { min: 3, max: 2000 } // Length
216 URL: { min: 3, max: 2000 } // Length
219 NAME: { min: 3, max: 120 }, // Length
220 LANGUAGE: { min: 1, max: 10 }, // Length
221 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
222 DESCRIPTION: { min: 3, max: 10000 }, // Length
223 SUPPORT: { min: 3, max: 1000 }, // Length
225 EXTNAME: [ '.jpg', '.jpeg' ],
227 max: 2 * 1024 * 1024 // 2MB
230 EXTNAME: buildVideosExtname(),
231 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
232 DURATION: { min: 0 }, // Number
233 TAGS: { min: 0, max: 5 }, // Number of total tags
234 TAG: { min: 2, max: 30 }, // Length
235 THUMBNAIL: { min: 2, max: 30 },
236 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
239 DISLIKES: { min: 0 },
240 FILE_SIZE: { min: 10 },
241 URL: { min: 3, max: 2000 } // Length
244 NAME: { min: 1, max: 120 }, // Length
245 DESCRIPTION: { min: 3, max: 1000 }, // Length
246 URL: { min: 3, max: 2000 }, // Length
248 EXTNAME: [ '.jpg', '.jpeg' ],
250 max: 2 * 1024 * 1024 // 2MB
255 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
256 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
257 URL: { min: 3, max: 2000 }, // Length
259 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
261 max: 2 * 1024 * 1024 // 2MB
269 TEXT: { min: 1, max: 3000 }, // Length
270 URL: { min: 3, max: 2000 } // Length
273 URL: { min: 3, max: 2000 } // Length
276 FROM_NAME: { min: 1, max: 120 }, // Length
277 BODY: { min: 3, max: 5000 } // Length
281 const RATES_LIMIT = {
283 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
284 MAX: 15 // 15 attempts
287 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
292 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
293 let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
295 const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
299 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
302 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
307 const FFMPEG_NICE: { [ id: string ]: number } = {
308 THUMBNAIL: 2, // 2 just for don't blocking servers
312 const VIDEO_CATEGORIES = {
323 11: 'News & Politics',
327 15: 'Science & Technology',
333 // See https://creativecommons.org/licenses/?lang=en
334 const VIDEO_LICENCES = {
336 2: 'Attribution - Share Alike',
337 3: 'Attribution - No Derivatives',
338 4: 'Attribution - Non Commercial',
339 5: 'Attribution - Non Commercial - Share Alike',
340 6: 'Attribution - Non Commercial - No Derivatives',
341 7: 'Public Domain Dedication'
344 let VIDEO_LANGUAGES: { [id: string]: string } = {}
346 const VIDEO_PRIVACIES = {
347 [ VideoPrivacy.PUBLIC ]: 'Public',
348 [ VideoPrivacy.UNLISTED ]: 'Unlisted',
349 [ VideoPrivacy.PRIVATE ]: 'Private'
352 const VIDEO_STATES = {
353 [ VideoState.PUBLISHED ]: 'Published',
354 [ VideoState.TO_TRANSCODE ]: 'To transcode',
355 [ VideoState.TO_IMPORT ]: 'To import'
358 const VIDEO_IMPORT_STATES = {
359 [ VideoImportState.FAILED ]: 'Failed',
360 [ VideoImportState.PENDING ]: 'Pending',
361 [ VideoImportState.SUCCESS ]: 'Success'
364 const VIDEO_ABUSE_STATES = {
365 [ VideoAbuseState.PENDING ]: 'Pending',
366 [ VideoAbuseState.REJECTED ]: 'Rejected',
367 [ VideoAbuseState.ACCEPTED ]: 'Accepted'
370 const VIDEO_PLAYLIST_PRIVACIES = {
371 [ VideoPlaylistPrivacy.PUBLIC ]: 'Public',
372 [ VideoPlaylistPrivacy.UNLISTED ]: 'Unlisted',
373 [ VideoPlaylistPrivacy.PRIVATE ]: 'Private'
376 const VIDEO_PLAYLIST_TYPES = {
377 [ VideoPlaylistType.REGULAR ]: 'Regular',
378 [ VideoPlaylistType.WATCH_LATER ]: 'Watch later'
383 MIMETYPE_EXT: buildVideoMimetypeExt(),
384 EXT_MIMETYPE: null as { [ id: string ]: string }
396 'application/x-subrip': '.srt'
401 'application/x-bittorrent': '.torrent'
405 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
407 // ---------------------------------------------------------------------------
416 // ---------------------------------------------------------------------------
418 const SERVER_ACTOR_NAME = 'peertube'
420 const ACTIVITY_PUB = {
421 POTENTIAL_ACCEPT_HEADERS: [
422 'application/activity+json',
423 'application/ld+json',
424 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
426 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
427 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
428 COLLECTION_ITEMS_PER_PAGE: 10,
429 FETCH_PAGE_LIMIT: 100,
431 VIDEO: Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT),
432 TORRENT: [ 'application/x-bittorrent' ],
433 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
435 MAX_RECURSION_COMMENTS: 100,
436 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
437 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
438 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
441 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
444 APPLICATION: 'Application'
447 const HTTP_SIGNATURE = {
448 HEADER_NAME: 'signature',
449 ALGORITHM: 'rsa-sha256',
450 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
453 // ---------------------------------------------------------------------------
455 let PRIVATE_RSA_KEY_SIZE = 2048
457 // Password encryption
458 const BCRYPT_SALT_SIZE = 10
460 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
462 const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
464 const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
465 DO_NOT_LIST: 'do_not_list',
470 // ---------------------------------------------------------------------------
472 // Express static paths (router)
473 const STATIC_PATHS = {
474 PREVIEWS: '/static/previews/',
475 THUMBNAILS: '/static/thumbnails/',
476 TORRENTS: '/static/torrents/',
477 WEBSEED: '/static/webseed/',
478 REDUNDANCY: '/static/redundancy/',
479 STREAMING_PLAYLISTS: {
480 HLS: '/static/streaming-playlists/hls'
482 AVATARS: '/static/avatars/',
483 VIDEO_CAPTIONS: '/static/video-captions/'
485 const STATIC_DOWNLOAD_PATHS = {
486 TORRENTS: '/download/torrents/',
487 VIDEOS: '/download/videos/'
491 let STATIC_MAX_AGE = '2h'
493 // Videos thumbnail size
494 const THUMBNAILS_SIZE = {
498 const PREVIEWS_SIZE = {
502 const AVATARS_SIZE = {
512 // Sub folders of cache directory
513 const FILES_CACHE = {
515 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
516 MAX_AGE: 1000 * 3600 * 3 // 3 hours
519 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
520 MAX_AGE: 1000 * 3600 * 3 // 3 hours
530 const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
531 const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
533 const MEMOIZE_TTL = {
534 OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
543 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
545 // ---------------------------------------------------------------------------
547 const CUSTOM_HTML_TAG_COMMENTS = {
548 TITLE: '<!-- title tag -->',
549 DESCRIPTION: '<!-- description tag -->',
550 CUSTOM_CSS: '<!-- custom css tag -->',
551 META_TAGS: '<!-- meta tags -->'
554 // ---------------------------------------------------------------------------
560 const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
562 // ---------------------------------------------------------------------------
564 const TRACKER_RATE_LIMITS = {
565 INTERVAL: 60000 * 5, // 5 minutes
566 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
567 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
570 const P2P_MEDIA_LOADER_PEER_VERSION = 2
572 // ---------------------------------------------------------------------------
574 // Special constants for a test instance
575 if (isTestInstance() === true) {
576 PRIVATE_RSA_KEY_SIZE = 1024
578 ACTOR_FOLLOW_SCORE.BASE = 20
580 REMOTE_SCHEME.HTTP = 'http'
581 REMOTE_SCHEME.WS = 'ws'
585 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
586 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
587 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
588 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
590 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
592 SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
593 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
594 SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
595 SCHEDULER_INTERVALS_MS.updateVideos = 5000
596 REPEAT_JOBS[ 'videos-views' ] = { every: 5000 }
598 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
600 VIDEO_VIEW_LIFETIME = 1000 // 1 second
601 CONTACT_FORM_LIFETIME = 1000 // 1 second
603 JOB_ATTEMPTS[ 'email' ] = 1
605 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
606 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
607 ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
609 RATES_LIMIT.LOGIN.MAX = 20
612 updateWebserverUrls()
614 registerConfigChangedHandler(() => {
615 updateWebserverUrls()
616 updateWebserverConfig()
619 // ---------------------------------------------------------------------------
624 HLS_REDUNDANCY_DIRECTORY,
625 P2P_MEDIA_LOADER_PEER_VERSION,
636 LAST_MIGRATION_VERSION,
638 CUSTOM_HTML_TAG_COMMENTS,
639 BROADCAST_CONCURRENCY,
646 PRIVATE_RSA_KEY_SIZE,
647 ROUTE_CACHE_LIFETIME,
649 HLS_STREAMING_PLAYLIST_DIRECTORY,
655 VIDEO_IMPORT_TIMEOUT,
656 VIDEO_PLAYLIST_TYPES,
657 MAX_LOGS_OUTPUT_CHARACTERS,
659 ACTIVITY_PUB_ACTOR_TYPES,
667 VIDEO_TRANSCODING_FPS,
672 USER_PASSWORD_RESET_LIFETIME,
674 USER_EMAIL_VERIFY_LIFETIME,
676 SCHEDULER_INTERVALS_MS,
678 STATIC_DOWNLOAD_PATHS,
681 CRAWL_REQUEST_CONCURRENCY,
682 JOB_COMPLETED_LIFETIME,
686 CONTACT_FORM_LIFETIME,
687 VIDEO_PLAYLIST_PRIVACIES,
692 // ---------------------------------------------------------------------------
694 function buildVideoMimetypeExt () {
696 'video/webm': '.webm',
701 if (CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
702 Object.assign(data, {
703 'video/quicktime': '.mov',
704 'video/x-msvideo': '.avi',
705 'video/x-flv': '.flv',
706 'video/x-matroska': '.mkv',
707 'application/octet-stream': '.mkv',
715 function updateWebserverUrls () {
716 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
717 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
718 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
719 WEBSERVER.WS = CONFIG.WEBSERVER.WS
720 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
721 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
724 function updateWebserverConfig () {
725 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
727 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
728 MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
731 function buildVideosExtname () {
732 return CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS
733 ? [ '.mp4', '.ogv', '.webm', '.mkv', '.mov', '.avi', '.flv' ]
734 : [ '.mp4', '.ogv', '.webm' ]
737 function loadLanguages () {
738 Object.assign(VIDEO_LANGUAGES, buildLanguages())
741 function buildLanguages () {
742 const iso639 = require('iso-639-3')
744 const languages: { [ id: string ]: string } = {}
746 const additionalLanguages = {
747 'sgn': true, // Sign languages (macro language)
748 'ase': true, // American sign language
749 'sdl': true, // Arabian sign language
750 'bfi': true, // British sign language
751 'bzs': true, // Brazilian sign language
752 'csl': true, // Chinese sign language
753 'cse': true, // Czech sign language
754 'dsl': true, // Danish sign language
755 'fsl': true, // French sign language
756 'gsg': true, // German sign language
757 'pks': true, // Pakistan sign language
758 'jsl': true, // Japanese sign language
759 'sfs': true, // South African sign language
760 'swl': true, // Swedish sign language
761 'rsl': true, // Russian sign language: true
763 'epo': true, // Esperanto
764 'tlh': true, // Klingon
765 'jbo': true, // Lojban
766 'avk': true // Kotava
769 // Only add ISO639-1 languages and some sign languages (ISO639-3)
772 return (l.iso6391 !== null && l.type === 'living') ||
773 additionalLanguages[ l.iso6393 ] === true
775 .forEach(l => languages[ l.iso6391 || l.iso6393 ] = l.name)
777 // Override Occitan label
778 languages[ 'oc' ] = 'Occitan'