constants.ts 36 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303
  1. import { RepeatOptions } from 'bullmq'
  2. import { Encoding, randomBytes } from 'crypto'
  3. import { invert } from 'lodash'
  4. import { join } from 'path'
  5. import { randomInt, root } from '@shared/core-utils'
  6. import {
  7. AbuseState,
  8. JobType,
  9. UserRegistrationState,
  10. VideoChannelSyncState,
  11. VideoImportState,
  12. VideoPrivacy,
  13. VideoRateType,
  14. VideoResolution,
  15. VideoState,
  16. VideoTranscodingFPS
  17. } from '../../shared/models'
  18. import { ActivityPubActorType } from '../../shared/models/activitypub'
  19. import { ActorImageType, FollowState } from '../../shared/models/actors'
  20. import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  21. import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
  22. import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
  23. // Do not use barrels, remain constants as independent as possible
  24. import { isTestInstance, isTestOrDevInstance, parseDurationToMs, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
  25. import { CONFIG, registerConfigChangedHandler } from './config'
  26. // ---------------------------------------------------------------------------
  27. const LAST_MIGRATION_VERSION = 755
  28. // ---------------------------------------------------------------------------
  29. const API_VERSION = 'v1'
  30. const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version
  31. const PAGINATION = {
  32. GLOBAL: {
  33. COUNT: {
  34. DEFAULT: 15,
  35. MAX: 100
  36. }
  37. },
  38. OUTBOX: {
  39. COUNT: {
  40. MAX: 50
  41. }
  42. }
  43. }
  44. const WEBSERVER = {
  45. URL: '',
  46. HOST: '',
  47. SCHEME: '',
  48. WS: '',
  49. HOSTNAME: '',
  50. PORT: 0,
  51. RTMP_URL: '',
  52. RTMPS_URL: ''
  53. }
  54. // Sortable columns per schema
  55. const SORTABLE_COLUMNS = {
  56. ADMIN_USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
  57. USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  58. ACCOUNTS: [ 'createdAt' ],
  59. JOBS: [ 'createdAt' ],
  60. VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  61. VIDEO_IMPORTS: [ 'createdAt' ],
  62. VIDEO_CHANNEL_SYNCS: [ 'externalChannelUrl', 'videoChannel', 'createdAt', 'lastSyncAt', 'state' ],
  63. VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
  64. VIDEO_COMMENTS: [ 'createdAt' ],
  65. VIDEO_RATES: [ 'createdAt' ],
  66. BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  67. INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ],
  68. INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
  69. ACCOUNT_FOLLOWERS: [ 'createdAt' ],
  70. CHANNEL_FOLLOWERS: [ 'createdAt' ],
  71. USER_REGISTRATIONS: [ 'createdAt', 'state' ],
  72. VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ],
  73. // Don't forget to update peertube-search-index with the same values
  74. VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
  75. VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  76. VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  77. ABUSES: [ 'id', 'createdAt', 'state' ],
  78. ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
  79. SERVERS_BLOCKLIST: [ 'createdAt' ],
  80. USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
  81. VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
  82. PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
  83. AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
  84. VIDEO_REDUNDANCIES: [ 'name' ]
  85. }
  86. const ROUTE_CACHE_LIFETIME = {
  87. FEEDS: '15 minutes',
  88. ROBOTS: '2 hours',
  89. SITEMAP: '1 day',
  90. SECURITYTXT: '2 hours',
  91. NODEINFO: '10 minutes',
  92. DNT_POLICY: '1 week',
  93. ACTIVITY_PUB: {
  94. VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
  95. },
  96. STATS: '4 hours',
  97. WELL_KNOWN: '1 day'
  98. }
  99. // ---------------------------------------------------------------------------
  100. // Number of points we add/remove after a successful/bad request
  101. const ACTOR_FOLLOW_SCORE = {
  102. PENALTY: -10,
  103. BONUS: 10,
  104. BASE: 1000,
  105. MAX: 10000
  106. }
  107. const FOLLOW_STATES: { [ id: string ]: FollowState } = {
  108. PENDING: 'pending',
  109. ACCEPTED: 'accepted',
  110. REJECTED: 'rejected'
  111. }
  112. const REMOTE_SCHEME = {
  113. HTTP: 'https',
  114. WS: 'wss'
  115. }
  116. const JOB_ATTEMPTS: { [id in JobType]: number } = {
  117. 'activitypub-http-broadcast': 1,
  118. 'activitypub-http-broadcast-parallel': 1,
  119. 'activitypub-http-unicast': 1,
  120. 'activitypub-http-fetcher': 2,
  121. 'activitypub-follow': 5,
  122. 'activitypub-cleaner': 1,
  123. 'video-file-import': 1,
  124. 'video-transcoding': 1,
  125. 'video-import': 1,
  126. 'email': 5,
  127. 'actor-keys': 3,
  128. 'videos-views-stats': 1,
  129. 'activitypub-refresher': 1,
  130. 'video-redundancy': 1,
  131. 'video-live-ending': 1,
  132. 'video-studio-edition': 1,
  133. 'manage-video-torrent': 1,
  134. 'video-channel-import': 1,
  135. 'after-video-channel-import': 1,
  136. 'move-to-object-storage': 3,
  137. 'notify': 1,
  138. 'federate-video': 1
  139. }
  140. // Excluded keys are jobs that can be configured by admins
  141. const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = {
  142. 'activitypub-http-broadcast': 1,
  143. 'activitypub-http-broadcast-parallel': 30,
  144. 'activitypub-http-unicast': 30,
  145. 'activitypub-http-fetcher': 3,
  146. 'activitypub-cleaner': 1,
  147. 'activitypub-follow': 1,
  148. 'video-file-import': 1,
  149. 'email': 5,
  150. 'actor-keys': 1,
  151. 'videos-views-stats': 1,
  152. 'activitypub-refresher': 1,
  153. 'video-redundancy': 1,
  154. 'video-live-ending': 10,
  155. 'video-studio-edition': 1,
  156. 'manage-video-torrent': 1,
  157. 'move-to-object-storage': 1,
  158. 'video-channel-import': 1,
  159. 'after-video-channel-import': 1,
  160. 'notify': 5,
  161. 'federate-video': 3
  162. }
  163. const JOB_TTL: { [id in JobType]: number } = {
  164. 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
  165. 'activitypub-http-broadcast-parallel': 60000 * 10, // 10 minutes
  166. 'activitypub-http-unicast': 60000 * 10, // 10 minutes
  167. 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
  168. 'activitypub-follow': 60000 * 10, // 10 minutes
  169. 'activitypub-cleaner': 1000 * 3600, // 1 hour
  170. 'video-file-import': 1000 * 3600, // 1 hour
  171. 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
  172. 'video-studio-edition': 1000 * 3600 * 10, // 10 hours
  173. 'video-import': CONFIG.IMPORT.VIDEOS.TIMEOUT,
  174. 'email': 60000 * 10, // 10 minutes
  175. 'actor-keys': 60000 * 20, // 20 minutes
  176. 'videos-views-stats': undefined, // Unlimited
  177. 'activitypub-refresher': 60000 * 10, // 10 minutes
  178. 'video-redundancy': 1000 * 3600 * 3, // 3 hours
  179. 'video-live-ending': 1000 * 60 * 10, // 10 minutes
  180. 'manage-video-torrent': 1000 * 3600 * 3, // 3 hours
  181. 'move-to-object-storage': 1000 * 60 * 60 * 3, // 3 hours
  182. 'video-channel-import': 1000 * 60 * 60 * 4, // 4 hours
  183. 'after-video-channel-import': 60000 * 5, // 5 minutes
  184. 'notify': 60000 * 5, // 5 minutes
  185. 'federate-video': 60000 * 5 // 5 minutes
  186. }
  187. const REPEAT_JOBS: { [ id in JobType ]?: RepeatOptions } = {
  188. 'videos-views-stats': {
  189. cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
  190. },
  191. 'activitypub-cleaner': {
  192. cron: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM
  193. }
  194. }
  195. const JOB_PRIORITY = {
  196. TRANSCODING: 100
  197. }
  198. const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job
  199. const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
  200. const AP_CLEANER = {
  201. CONCURRENCY: 10, // How many requests in parallel we do in activitypub-cleaner job
  202. UNAVAILABLE_TRESHOLD: 3, // How many attempts we do before removing an unavailable remote resource
  203. PERIOD: parseDurationToMs('1 week') // /!\ Has to be sync with REPEAT_JOBS
  204. }
  205. const REQUEST_TIMEOUTS = {
  206. DEFAULT: 7000, // 7 seconds
  207. FILE: 30000, // 30 seconds
  208. REDUNDANCY: JOB_TTL['video-redundancy']
  209. }
  210. const JOB_REMOVAL_OPTIONS = {
  211. COUNT: 10000, // Max jobs to store
  212. SUCCESS: { // Success jobs
  213. 'DEFAULT': parseDurationToMs('2 days'),
  214. 'activitypub-http-broadcast-parallel': parseDurationToMs('10 minutes'),
  215. 'activitypub-http-unicast': parseDurationToMs('1 hour'),
  216. 'videos-views-stats': parseDurationToMs('3 hours'),
  217. 'activitypub-refresher': parseDurationToMs('10 hours')
  218. },
  219. FAILURE: { // Failed job
  220. DEFAULT: parseDurationToMs('7 days')
  221. }
  222. }
  223. const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9)
  224. const SCHEDULER_INTERVALS_MS = {
  225. ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour
  226. REMOVE_OLD_JOBS: 60000 * 60, // 1 hour
  227. UPDATE_VIDEOS: 60000, // 1 minute
  228. YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day
  229. GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day
  230. VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL,
  231. CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
  232. CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day
  233. AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day
  234. REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day
  235. REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day
  236. UPDATE_INBOX_STATS: 1000 * 60, // 1 minute
  237. REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60, // 1 hour
  238. CHANNEL_SYNC_CHECK_INTERVAL: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.CHECK_INTERVAL
  239. }
  240. // ---------------------------------------------------------------------------
  241. const CONSTRAINTS_FIELDS = {
  242. USERS: {
  243. NAME: { min: 1, max: 120 }, // Length
  244. DESCRIPTION: { min: 3, max: 1000 }, // Length
  245. USERNAME: { min: 1, max: 50 }, // Length
  246. PASSWORD: { min: 6, max: 255 }, // Length
  247. VIDEO_QUOTA: { min: -1 },
  248. VIDEO_QUOTA_DAILY: { min: -1 },
  249. VIDEO_LANGUAGES: { max: 500 }, // Array length
  250. BLOCKED_REASON: { min: 3, max: 250 } // Length
  251. },
  252. ABUSES: {
  253. REASON: { min: 2, max: 3000 }, // Length
  254. MODERATION_COMMENT: { min: 2, max: 3000 } // Length
  255. },
  256. ABUSE_MESSAGES: {
  257. MESSAGE: { min: 2, max: 3000 } // Length
  258. },
  259. USER_REGISTRATIONS: {
  260. REASON_MESSAGE: { min: 2, max: 3000 }, // Length
  261. MODERATOR_MESSAGE: { min: 2, max: 3000 } // Length
  262. },
  263. VIDEO_BLACKLIST: {
  264. REASON: { min: 2, max: 300 } // Length
  265. },
  266. VIDEO_CHANNELS: {
  267. NAME: { min: 1, max: 120 }, // Length
  268. DESCRIPTION: { min: 3, max: 1000 }, // Length
  269. SUPPORT: { min: 3, max: 1000 }, // Length
  270. EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 }, // Length
  271. URL: { min: 3, max: 2000 } // Length
  272. },
  273. VIDEO_CHANNEL_SYNCS: {
  274. EXTERNAL_CHANNEL_URL: { min: 3, max: 2000 } // Length
  275. },
  276. VIDEO_CAPTIONS: {
  277. CAPTION_FILE: {
  278. EXTNAME: [ '.vtt', '.srt' ],
  279. FILE_SIZE: {
  280. max: 20 * 1024 * 1024 // 20MB
  281. }
  282. }
  283. },
  284. VIDEO_IMPORTS: {
  285. URL: { min: 3, max: 2000 }, // Length
  286. TORRENT_NAME: { min: 3, max: 255 }, // Length
  287. TORRENT_FILE: {
  288. EXTNAME: [ '.torrent' ],
  289. FILE_SIZE: {
  290. max: 1024 * 200 // 200 KB
  291. }
  292. }
  293. },
  294. VIDEOS_REDUNDANCY: {
  295. URL: { min: 3, max: 2000 } // Length
  296. },
  297. VIDEO_RATES: {
  298. URL: { min: 3, max: 2000 } // Length
  299. },
  300. VIDEOS: {
  301. NAME: { min: 3, max: 120 }, // Length
  302. LANGUAGE: { min: 1, max: 10 }, // Length
  303. TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
  304. DESCRIPTION: { min: 3, max: 10000 }, // Length
  305. SUPPORT: { min: 3, max: 1000 }, // Length
  306. IMAGE: {
  307. EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
  308. FILE_SIZE: {
  309. max: 4 * 1024 * 1024 // 4MB
  310. }
  311. },
  312. EXTNAME: [] as string[],
  313. INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
  314. DURATION: { min: 0 }, // Number
  315. TAGS: { min: 0, max: 5 }, // Number of total tags
  316. TAG: { min: 2, max: 30 }, // Length
  317. VIEWS: { min: 0 },
  318. LIKES: { min: 0 },
  319. DISLIKES: { min: 0 },
  320. FILE_SIZE: { min: -1 },
  321. PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB
  322. URL: { min: 3, max: 2000 } // Length
  323. },
  324. VIDEO_PLAYLISTS: {
  325. NAME: { min: 1, max: 120 }, // Length
  326. DESCRIPTION: { min: 3, max: 1000 }, // Length
  327. URL: { min: 3, max: 2000 }, // Length
  328. IMAGE: {
  329. EXTNAME: [ '.jpg', '.jpeg' ],
  330. FILE_SIZE: {
  331. max: 4 * 1024 * 1024 // 4MB
  332. }
  333. }
  334. },
  335. ACTORS: {
  336. PUBLIC_KEY: { min: 10, max: 5000 }, // Length
  337. PRIVATE_KEY: { min: 10, max: 5000 }, // Length
  338. URL: { min: 3, max: 2000 }, // Length
  339. IMAGE: {
  340. EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
  341. FILE_SIZE: {
  342. max: 4 * 1024 * 1024 // 4MB
  343. }
  344. }
  345. },
  346. VIDEO_EVENTS: {
  347. COUNT: { min: 0 }
  348. },
  349. VIDEO_COMMENTS: {
  350. TEXT: { min: 1, max: 10000 }, // Length
  351. URL: { min: 3, max: 2000 } // Length
  352. },
  353. VIDEO_SHARE: {
  354. URL: { min: 3, max: 2000 } // Length
  355. },
  356. CONTACT_FORM: {
  357. FROM_NAME: { min: 1, max: 120 }, // Length
  358. BODY: { min: 3, max: 5000 } // Length
  359. },
  360. PLUGINS: {
  361. NAME: { min: 1, max: 214 }, // Length
  362. DESCRIPTION: { min: 1, max: 20000 } // Length
  363. },
  364. COMMONS: {
  365. URL: { min: 5, max: 2000 } // Length
  366. },
  367. VIDEO_STUDIO: {
  368. TASKS: { min: 1, max: 10 }, // Number of tasks
  369. CUT_TIME: { min: 0 } // Value
  370. },
  371. LOGS: {
  372. CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length
  373. CLIENT_STACK_TRACE: { min: 1, max: 15000 }, // Length
  374. CLIENT_META: { min: 1, max: 5000 }, // Length
  375. CLIENT_USER_AGENT: { min: 1, max: 200 } // Length
  376. }
  377. }
  378. const VIEW_LIFETIME = {
  379. VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION,
  380. VIEWER_COUNTER: 60000 * 2, // 2 minutes
  381. VIEWER_STATS: 60000 * 60 // 1 hour
  382. }
  383. const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100
  384. let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
  385. const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
  386. MIN: 1,
  387. STANDARD: [ 24, 25, 30 ],
  388. HD_STANDARD: [ 50, 60 ],
  389. AUDIO_MERGE: 25,
  390. AVERAGE: 30,
  391. MAX: 60,
  392. KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
  393. }
  394. const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
  395. const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
  396. LIKE: 'like',
  397. DISLIKE: 'dislike'
  398. }
  399. const FFMPEG_NICE: { [ id: string ]: number } = {
  400. // parent process defaults to niceness = 0
  401. // reminder: lower = higher priority, max value is 19, lowest is -20
  402. LIVE: 5, // prioritize over VOD and THUMBNAIL
  403. THUMBNAIL: 10,
  404. VOD: 15
  405. }
  406. const VIDEO_CATEGORIES = {
  407. 1: 'Music',
  408. 2: 'Films',
  409. 3: 'Vehicles',
  410. 4: 'Art',
  411. 5: 'Sports',
  412. 6: 'Travels',
  413. 7: 'Gaming',
  414. 8: 'People',
  415. 9: 'Comedy',
  416. 10: 'Entertainment',
  417. 11: 'News & Politics',
  418. 12: 'How To',
  419. 13: 'Education',
  420. 14: 'Activism',
  421. 15: 'Science & Technology',
  422. 16: 'Animals',
  423. 17: 'Kids',
  424. 18: 'Food'
  425. }
  426. // See https://creativecommons.org/licenses/?lang=en
  427. const VIDEO_LICENCES = {
  428. 1: 'Attribution',
  429. 2: 'Attribution - Share Alike',
  430. 3: 'Attribution - No Derivatives',
  431. 4: 'Attribution - Non Commercial',
  432. 5: 'Attribution - Non Commercial - Share Alike',
  433. 6: 'Attribution - Non Commercial - No Derivatives',
  434. 7: 'Public Domain Dedication'
  435. }
  436. const VIDEO_LANGUAGES: { [id: string]: string } = {}
  437. const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
  438. [VideoPrivacy.PUBLIC]: 'Public',
  439. [VideoPrivacy.UNLISTED]: 'Unlisted',
  440. [VideoPrivacy.PRIVATE]: 'Private',
  441. [VideoPrivacy.INTERNAL]: 'Internal'
  442. }
  443. const VIDEO_STATES: { [ id in VideoState ]: string } = {
  444. [VideoState.PUBLISHED]: 'Published',
  445. [VideoState.TO_TRANSCODE]: 'To transcode',
  446. [VideoState.TO_IMPORT]: 'To import',
  447. [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
  448. [VideoState.LIVE_ENDED]: 'Livestream ended',
  449. [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage',
  450. [VideoState.TRANSCODING_FAILED]: 'Transcoding failed',
  451. [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed',
  452. [VideoState.TO_EDIT]: 'To edit*'
  453. }
  454. const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
  455. [VideoImportState.FAILED]: 'Failed',
  456. [VideoImportState.PENDING]: 'Pending',
  457. [VideoImportState.SUCCESS]: 'Success',
  458. [VideoImportState.REJECTED]: 'Rejected',
  459. [VideoImportState.CANCELLED]: 'Cancelled',
  460. [VideoImportState.PROCESSING]: 'Processing'
  461. }
  462. const VIDEO_CHANNEL_SYNC_STATE: { [ id in VideoChannelSyncState ]: string } = {
  463. [VideoChannelSyncState.FAILED]: 'Failed',
  464. [VideoChannelSyncState.SYNCED]: 'Synchronized',
  465. [VideoChannelSyncState.PROCESSING]: 'Processing',
  466. [VideoChannelSyncState.WAITING_FIRST_RUN]: 'Waiting first run'
  467. }
  468. const ABUSE_STATES: { [ id in AbuseState ]: string } = {
  469. [AbuseState.PENDING]: 'Pending',
  470. [AbuseState.REJECTED]: 'Rejected',
  471. [AbuseState.ACCEPTED]: 'Accepted'
  472. }
  473. const USER_REGISTRATION_STATES: { [ id in UserRegistrationState ]: string } = {
  474. [UserRegistrationState.PENDING]: 'Pending',
  475. [UserRegistrationState.REJECTED]: 'Rejected',
  476. [UserRegistrationState.ACCEPTED]: 'Accepted'
  477. }
  478. const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
  479. [VideoPlaylistPrivacy.PUBLIC]: 'Public',
  480. [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
  481. [VideoPlaylistPrivacy.PRIVATE]: 'Private'
  482. }
  483. const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
  484. [VideoPlaylistType.REGULAR]: 'Regular',
  485. [VideoPlaylistType.WATCH_LATER]: 'Watch later'
  486. }
  487. const MIMETYPES = {
  488. AUDIO: {
  489. MIMETYPE_EXT: {
  490. 'audio/mpeg': '.mp3',
  491. 'audio/mp3': '.mp3',
  492. 'application/ogg': '.ogg',
  493. 'audio/ogg': '.ogg',
  494. 'audio/x-ms-wma': '.wma',
  495. 'audio/wav': '.wav',
  496. 'audio/x-wav': '.wav',
  497. 'audio/x-flac': '.flac',
  498. 'audio/flac': '.flac',
  499. 'audio/vnd.dlna.adts': '.aac',
  500. 'audio/aac': '.aac',
  501. 'audio/m4a': '.m4a',
  502. 'audio/mp4': '.m4a',
  503. 'audio/x-m4a': '.m4a',
  504. 'audio/vnd.dolby.dd-raw': '.ac3',
  505. 'audio/ac3': '.ac3'
  506. },
  507. EXT_MIMETYPE: null as { [ id: string ]: string }
  508. },
  509. VIDEO: {
  510. MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
  511. MIMETYPES_REGEX: null as string,
  512. EXT_MIMETYPE: null as { [ id: string ]: string }
  513. },
  514. IMAGE: {
  515. MIMETYPE_EXT: {
  516. 'image/png': '.png',
  517. 'image/gif': '.gif',
  518. 'image/webp': '.webp',
  519. 'image/jpg': '.jpg',
  520. 'image/jpeg': '.jpg'
  521. },
  522. EXT_MIMETYPE: null as { [ id: string ]: string }
  523. },
  524. VIDEO_CAPTIONS: {
  525. MIMETYPE_EXT: {
  526. 'text/vtt': '.vtt',
  527. 'application/x-subrip': '.srt',
  528. 'text/plain': '.srt'
  529. }
  530. },
  531. TORRENT: {
  532. MIMETYPE_EXT: {
  533. 'application/x-bittorrent': '.torrent'
  534. }
  535. }
  536. }
  537. MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
  538. MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
  539. const BINARY_CONTENT_TYPES = new Set([
  540. 'binary/octet-stream',
  541. 'application/octet-stream',
  542. 'application/x-binary'
  543. ])
  544. // ---------------------------------------------------------------------------
  545. const OVERVIEWS = {
  546. VIDEOS: {
  547. SAMPLE_THRESHOLD: 6,
  548. SAMPLES_COUNT: 20
  549. }
  550. }
  551. // ---------------------------------------------------------------------------
  552. const SERVER_ACTOR_NAME = 'peertube'
  553. const ACTIVITY_PUB = {
  554. POTENTIAL_ACCEPT_HEADERS: [
  555. 'application/activity+json',
  556. 'application/ld+json',
  557. 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
  558. ],
  559. ACCEPT_HEADER: 'application/activity+json, application/ld+json',
  560. PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
  561. COLLECTION_ITEMS_PER_PAGE: 10,
  562. FETCH_PAGE_LIMIT: 2000,
  563. URL_MIME_TYPES: {
  564. VIDEO: [] as string[],
  565. TORRENT: [ 'application/x-bittorrent' ],
  566. MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
  567. },
  568. MAX_RECURSION_COMMENTS: 100,
  569. ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
  570. VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
  571. VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
  572. }
  573. const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
  574. GROUP: 'Group',
  575. PERSON: 'Person',
  576. APPLICATION: 'Application',
  577. ORGANIZATION: 'Organization',
  578. SERVICE: 'Service'
  579. }
  580. const HTTP_SIGNATURE = {
  581. HEADER_NAME: 'signature',
  582. ALGORITHM: 'rsa-sha256',
  583. HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
  584. CLOCK_SKEW_SECONDS: 1800
  585. }
  586. // ---------------------------------------------------------------------------
  587. let PRIVATE_RSA_KEY_SIZE = 2048
  588. // Password encryption
  589. const BCRYPT_SALT_SIZE = 10
  590. const ENCRYPTION = {
  591. ALGORITHM: 'aes-256-cbc',
  592. IV: 16,
  593. SALT: 'peertube',
  594. ENCODING: 'hex' as Encoding
  595. }
  596. const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
  597. const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
  598. const TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME = 60000 * 10 // 10 minutes
  599. const EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
  600. const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
  601. DO_NOT_LIST: 'do_not_list',
  602. BLUR: 'blur',
  603. DISPLAY: 'display'
  604. }
  605. // ---------------------------------------------------------------------------
  606. // Express static paths (router)
  607. const STATIC_PATHS = {
  608. THUMBNAILS: '/static/thumbnails/',
  609. WEBSEED: '/static/webseed/',
  610. PRIVATE_WEBSEED: '/static/webseed/private/',
  611. REDUNDANCY: '/static/redundancy/',
  612. STREAMING_PLAYLISTS: {
  613. HLS: '/static/streaming-playlists/hls',
  614. PRIVATE_HLS: '/static/streaming-playlists/hls/private/'
  615. }
  616. }
  617. const STATIC_DOWNLOAD_PATHS = {
  618. TORRENTS: '/download/torrents/',
  619. VIDEOS: '/download/videos/',
  620. HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
  621. }
  622. const LAZY_STATIC_PATHS = {
  623. BANNERS: '/lazy-static/banners/',
  624. AVATARS: '/lazy-static/avatars/',
  625. PREVIEWS: '/lazy-static/previews/',
  626. VIDEO_CAPTIONS: '/lazy-static/video-captions/',
  627. TORRENTS: '/lazy-static/torrents/'
  628. }
  629. const OBJECT_STORAGE_PROXY_PATHS = {
  630. PRIVATE_WEBSEED: '/object-storage-proxy/webseed/private/',
  631. STREAMING_PLAYLISTS: {
  632. PRIVATE_HLS: '/object-storage-proxy/streaming-playlists/hls/private/'
  633. }
  634. }
  635. // Cache control
  636. const STATIC_MAX_AGE = {
  637. SERVER: '2h',
  638. LAZY_SERVER: '2d',
  639. CLIENT: '30d'
  640. }
  641. // Videos thumbnail size
  642. const THUMBNAILS_SIZE = {
  643. width: 280,
  644. height: 157,
  645. minWidth: 150
  646. }
  647. const PREVIEWS_SIZE = {
  648. width: 850,
  649. height: 480,
  650. minWidth: 400
  651. }
  652. const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[] } = {
  653. [ActorImageType.AVATAR]: [
  654. {
  655. width: 120,
  656. height: 120
  657. },
  658. {
  659. width: 48,
  660. height: 48
  661. }
  662. ],
  663. [ActorImageType.BANNER]: [
  664. {
  665. width: 1920,
  666. height: 317 // 6/1 ratio
  667. }
  668. ]
  669. }
  670. const EMBED_SIZE = {
  671. width: 560,
  672. height: 315
  673. }
  674. // Sub folders of cache directory
  675. const FILES_CACHE = {
  676. PREVIEWS: {
  677. DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
  678. MAX_AGE: 1000 * 3600 * 3 // 3 hours
  679. },
  680. VIDEO_CAPTIONS: {
  681. DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
  682. MAX_AGE: 1000 * 3600 * 3 // 3 hours
  683. },
  684. TORRENTS: {
  685. DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'),
  686. MAX_AGE: 1000 * 3600 * 3 // 3 hours
  687. }
  688. }
  689. const LRU_CACHE = {
  690. USER_TOKENS: {
  691. MAX_SIZE: 1000
  692. },
  693. ACTOR_IMAGE_STATIC: {
  694. MAX_SIZE: 500
  695. },
  696. STATIC_VIDEO_FILES_RIGHTS_CHECK: {
  697. MAX_SIZE: 5000,
  698. TTL: parseDurationToMs('10 seconds')
  699. },
  700. VIDEO_TOKENS: {
  701. MAX_SIZE: 100_000,
  702. TTL: parseDurationToMs('8 hours')
  703. },
  704. TRACKER_IPS: {
  705. MAX_SIZE: 100_000
  706. }
  707. }
  708. const DIRECTORIES = {
  709. RESUMABLE_UPLOAD: join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads'),
  710. HLS_STREAMING_PLAYLIST: {
  711. PUBLIC: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls'),
  712. PRIVATE: join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls', 'private')
  713. },
  714. VIDEOS: {
  715. PUBLIC: CONFIG.STORAGE.VIDEOS_DIR,
  716. PRIVATE: join(CONFIG.STORAGE.VIDEOS_DIR, 'private')
  717. },
  718. HLS_REDUNDANCY: join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
  719. }
  720. const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS
  721. const VIDEO_LIVE = {
  722. EXTENSION: '.ts',
  723. CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
  724. SEGMENT_TIME_SECONDS: {
  725. DEFAULT_LATENCY: 4, // 4 seconds
  726. SMALL_LATENCY: 2 // 2 seconds
  727. },
  728. SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
  729. REPLAY_DIRECTORY: 'replay',
  730. EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
  731. MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
  732. RTMP: {
  733. CHUNK_SIZE: 60000,
  734. GOP_CACHE: true,
  735. PING: 60,
  736. PING_TIMEOUT: 30,
  737. BASE_PATH: 'live'
  738. }
  739. }
  740. const MEMOIZE_TTL = {
  741. OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
  742. INFO_HASH_EXISTS: 1000 * 60, // 1 minute
  743. VIDEO_DURATION: 1000 * 10, // 10 seconds
  744. LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
  745. LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute
  746. GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute
  747. }
  748. const MEMOIZE_LENGTH = {
  749. INFO_HASH_EXISTS: 200,
  750. VIDEO_DURATION: 200
  751. }
  752. const WORKER_THREADS = {
  753. DOWNLOAD_IMAGE: {
  754. CONCURRENCY: 3,
  755. MAX_THREADS: 1
  756. },
  757. PROCESS_IMAGE: {
  758. CONCURRENCY: 1,
  759. MAX_THREADS: 5
  760. }
  761. }
  762. const REDUNDANCY = {
  763. VIDEOS: {
  764. RANDOMIZED_FACTOR: 5
  765. }
  766. }
  767. const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
  768. const OTP = {
  769. HEADER_NAME: 'x-peertube-otp',
  770. HEADER_REQUIRED_VALUE: 'required; app'
  771. }
  772. const ASSETS_PATH = {
  773. DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
  774. DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
  775. }
  776. // ---------------------------------------------------------------------------
  777. const CUSTOM_HTML_TAG_COMMENTS = {
  778. TITLE: '<!-- title tag -->',
  779. DESCRIPTION: '<!-- description tag -->',
  780. CUSTOM_CSS: '<!-- custom css tag -->',
  781. META_TAGS: '<!-- meta tags -->',
  782. SERVER_CONFIG: '<!-- server config -->'
  783. }
  784. const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
  785. const LOG_FILENAME = 'peertube.log'
  786. const AUDIT_LOG_FILENAME = 'peertube-audit.log'
  787. // ---------------------------------------------------------------------------
  788. const TRACKER_RATE_LIMITS = {
  789. INTERVAL: 60000 * 5, // 5 minutes
  790. ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
  791. ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
  792. BLOCK_IP_LIFETIME: parseDurationToMs('3 minutes')
  793. }
  794. const P2P_MEDIA_LOADER_PEER_VERSION = 2
  795. // ---------------------------------------------------------------------------
  796. const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
  797. const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
  798. let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
  799. const DEFAULT_THEME_NAME = 'default'
  800. const DEFAULT_USER_THEME_NAME = 'instance-default'
  801. // ---------------------------------------------------------------------------
  802. const SEARCH_INDEX = {
  803. ROUTES: {
  804. VIDEOS: '/api/v1/search/videos',
  805. VIDEO_CHANNELS: '/api/v1/search/video-channels'
  806. }
  807. }
  808. // ---------------------------------------------------------------------------
  809. const STATS_TIMESERIE = {
  810. MAX_DAYS: 365 * 10 // Around 10 years
  811. }
  812. // ---------------------------------------------------------------------------
  813. // Special constants for a test instance
  814. if (process.env.PRODUCTION_CONSTANTS !== 'true') {
  815. if (isTestOrDevInstance()) {
  816. PRIVATE_RSA_KEY_SIZE = 1024
  817. ACTOR_FOLLOW_SCORE.BASE = 20
  818. REMOTE_SCHEME.HTTP = 'http'
  819. REMOTE_SCHEME.WS = 'ws'
  820. STATIC_MAX_AGE.SERVER = '0'
  821. SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000
  822. SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000
  823. SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000
  824. SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000
  825. SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000
  826. SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000
  827. SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000
  828. SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000
  829. REPEAT_JOBS['videos-views-stats'] = { every: 5000 }
  830. REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 }
  831. AP_CLEANER.PERIOD = 5000
  832. REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
  833. CONTACT_FORM_LIFETIME = 1000 // 1 second
  834. JOB_ATTEMPTS['email'] = 1
  835. FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
  836. MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
  837. MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
  838. OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
  839. PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
  840. JOB_REMOVAL_OPTIONS.SUCCESS['videos-views-stats'] = 10000
  841. }
  842. if (isTestInstance()) {
  843. ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
  844. ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  845. ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  846. ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  847. CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB
  848. CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
  849. VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second
  850. VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second
  851. VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000
  852. VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2
  853. VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1
  854. VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
  855. }
  856. }
  857. updateWebserverUrls()
  858. updateWebserverConfig()
  859. registerConfigChangedHandler(() => {
  860. updateWebserverUrls()
  861. updateWebserverConfig()
  862. })
  863. // ---------------------------------------------------------------------------
  864. const FILES_CONTENT_HASH = {
  865. MANIFEST: generateContentHash(),
  866. FAVICON: generateContentHash(),
  867. LOGO: generateContentHash()
  868. }
  869. // ---------------------------------------------------------------------------
  870. const VIDEO_FILTERS = {
  871. WATERMARK: {
  872. SIZE_RATIO: 1 / 10,
  873. HORIZONTAL_MARGIN_RATIO: 1 / 20,
  874. VERTICAL_MARGIN_RATIO: 1 / 20
  875. }
  876. }
  877. // ---------------------------------------------------------------------------
  878. export {
  879. WEBSERVER,
  880. API_VERSION,
  881. ENCRYPTION,
  882. VIDEO_LIVE,
  883. PEERTUBE_VERSION,
  884. LAZY_STATIC_PATHS,
  885. OBJECT_STORAGE_PROXY_PATHS,
  886. SEARCH_INDEX,
  887. DIRECTORIES,
  888. RESUMABLE_UPLOAD_SESSION_LIFETIME,
  889. P2P_MEDIA_LOADER_PEER_VERSION,
  890. ACTOR_IMAGES_SIZE,
  891. ACCEPT_HEADERS,
  892. BCRYPT_SALT_SIZE,
  893. TRACKER_RATE_LIMITS,
  894. FILES_CACHE,
  895. LOG_FILENAME,
  896. CONSTRAINTS_FIELDS,
  897. EMBED_SIZE,
  898. REDUNDANCY,
  899. JOB_CONCURRENCY,
  900. JOB_ATTEMPTS,
  901. AP_CLEANER,
  902. LAST_MIGRATION_VERSION,
  903. CUSTOM_HTML_TAG_COMMENTS,
  904. STATS_TIMESERIE,
  905. BROADCAST_CONCURRENCY,
  906. AUDIT_LOG_FILENAME,
  907. PAGINATION,
  908. ACTOR_FOLLOW_SCORE,
  909. PREVIEWS_SIZE,
  910. REMOTE_SCHEME,
  911. FOLLOW_STATES,
  912. DEFAULT_USER_THEME_NAME,
  913. SERVER_ACTOR_NAME,
  914. TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME,
  915. PLUGIN_GLOBAL_CSS_FILE_NAME,
  916. PLUGIN_GLOBAL_CSS_PATH,
  917. PRIVATE_RSA_KEY_SIZE,
  918. VIDEO_FILTERS,
  919. ROUTE_CACHE_LIFETIME,
  920. SORTABLE_COLUMNS,
  921. JOB_TTL,
  922. DEFAULT_THEME_NAME,
  923. NSFW_POLICY_TYPES,
  924. STATIC_MAX_AGE,
  925. STATIC_PATHS,
  926. VIDEO_IMPORT_TIMEOUT,
  927. VIDEO_PLAYLIST_TYPES,
  928. MAX_LOGS_OUTPUT_CHARACTERS,
  929. ACTIVITY_PUB,
  930. ACTIVITY_PUB_ACTOR_TYPES,
  931. THUMBNAILS_SIZE,
  932. VIDEO_CATEGORIES,
  933. MEMOIZE_LENGTH,
  934. VIDEO_LANGUAGES,
  935. VIDEO_PRIVACIES,
  936. VIDEO_LICENCES,
  937. VIDEO_STATES,
  938. WORKER_THREADS,
  939. VIDEO_RATE_TYPES,
  940. JOB_PRIORITY,
  941. VIDEO_TRANSCODING_FPS,
  942. FFMPEG_NICE,
  943. ABUSE_STATES,
  944. USER_REGISTRATION_STATES,
  945. LRU_CACHE,
  946. REQUEST_TIMEOUTS,
  947. MAX_LOCAL_VIEWER_WATCH_SECTIONS,
  948. USER_PASSWORD_RESET_LIFETIME,
  949. USER_PASSWORD_CREATE_LIFETIME,
  950. MEMOIZE_TTL,
  951. EMAIL_VERIFY_LIFETIME,
  952. OVERVIEWS,
  953. SCHEDULER_INTERVALS_MS,
  954. REPEAT_JOBS,
  955. STATIC_DOWNLOAD_PATHS,
  956. MIMETYPES,
  957. CRAWL_REQUEST_CONCURRENCY,
  958. DEFAULT_AUDIO_RESOLUTION,
  959. BINARY_CONTENT_TYPES,
  960. JOB_REMOVAL_OPTIONS,
  961. HTTP_SIGNATURE,
  962. VIDEO_IMPORT_STATES,
  963. VIDEO_CHANNEL_SYNC_STATE,
  964. VIEW_LIFETIME,
  965. CONTACT_FORM_LIFETIME,
  966. VIDEO_PLAYLIST_PRIVACIES,
  967. PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
  968. ASSETS_PATH,
  969. FILES_CONTENT_HASH,
  970. OTP,
  971. loadLanguages,
  972. buildLanguages,
  973. generateContentHash
  974. }
  975. // ---------------------------------------------------------------------------
  976. function buildVideoMimetypeExt () {
  977. const data = {
  978. // streamable formats that warrant cross-browser compatibility
  979. 'video/webm': '.webm',
  980. // We'll add .ogg if additional extensions are enabled
  981. // We could add .ogg here but since it could be an audio file,
  982. // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
  983. 'video/ogg': [ '.ogv' ],
  984. 'video/mp4': '.mp4'
  985. }
  986. if (CONFIG.TRANSCODING.ENABLED) {
  987. if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
  988. data['video/ogg'].push('.ogg')
  989. Object.assign(data, {
  990. 'video/x-matroska': '.mkv',
  991. // Developed by Apple
  992. 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
  993. 'video/x-m4v': '.m4v',
  994. 'video/m4v': '.m4v',
  995. // Developed by the Adobe Flash Platform
  996. 'video/x-flv': '.flv',
  997. 'video/x-f4v': '.f4v', // replacement for flv
  998. // Developed by Microsoft
  999. 'video/x-ms-wmv': '.wmv',
  1000. 'video/x-msvideo': '.avi',
  1001. 'video/avi': '.avi',
  1002. // Developed by 3GPP
  1003. // common video formats for cell phones
  1004. 'video/3gpp': [ '.3gp', '.3gpp' ],
  1005. 'video/3gpp2': [ '.3g2', '.3gpp2' ],
  1006. // Developed by FFmpeg/Mplayer
  1007. 'application/x-nut': '.nut',
  1008. // The standard video format used by many Sony and Panasonic HD camcorders.
  1009. // It is also used for storing high definition video on Blu-ray discs.
  1010. 'video/mp2t': '.mts',
  1011. 'video/vnd.dlna.mpeg-tts': '.mts',
  1012. 'video/m2ts': '.m2ts',
  1013. // Old formats reliant on MPEG-1/MPEG-2
  1014. 'video/mpv': '.mpv',
  1015. 'video/mpeg2': '.m2v',
  1016. 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
  1017. 'video/dvd': '.vob',
  1018. // Could be anything
  1019. 'application/octet-stream': null,
  1020. 'application/mxf': '.mxf' // often used as exchange format by editing software
  1021. })
  1022. }
  1023. if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
  1024. Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
  1025. }
  1026. }
  1027. return data
  1028. }
  1029. function updateWebserverUrls () {
  1030. WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
  1031. WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
  1032. WEBSERVER.WS = CONFIG.WEBSERVER.WS
  1033. WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
  1034. WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
  1035. WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
  1036. const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
  1037. const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME
  1038. WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
  1039. WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
  1040. }
  1041. function updateWebserverConfig () {
  1042. MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
  1043. MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
  1044. ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
  1045. MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
  1046. CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
  1047. }
  1048. function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
  1049. const result: { [id: string]: string } = {}
  1050. for (const mimetype of Object.keys(obj)) {
  1051. const value = obj[mimetype]
  1052. if (!value) continue
  1053. const extensions = Array.isArray(value) ? value : [ value ]
  1054. for (const extension of extensions) {
  1055. result[extension] = mimetype
  1056. }
  1057. }
  1058. return result
  1059. }
  1060. function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
  1061. return Object.keys(obj)
  1062. .map(m => `(${m})`)
  1063. .join('|')
  1064. }
  1065. function loadLanguages () {
  1066. Object.assign(VIDEO_LANGUAGES, buildLanguages())
  1067. }
  1068. function buildLanguages () {
  1069. const iso639 = require('iso-639-3')
  1070. const languages: { [id: string]: string } = {}
  1071. const additionalLanguages = {
  1072. sgn: true, // Sign languages (macro language)
  1073. ase: true, // American sign language
  1074. asq: true, // Austrian sign language
  1075. sdl: true, // Arabian sign language
  1076. bfi: true, // British sign language
  1077. bzs: true, // Brazilian sign language
  1078. csl: true, // Chinese sign language
  1079. cse: true, // Czech sign language
  1080. dsl: true, // Danish sign language
  1081. fsl: true, // French sign language
  1082. gsg: true, // German sign language
  1083. pks: true, // Pakistan sign language
  1084. jsl: true, // Japanese sign language
  1085. sfs: true, // South African sign language
  1086. swl: true, // Swedish sign language
  1087. rsl: true, // Russian sign language
  1088. kab: true, // Kabyle
  1089. lat: true, // Latin
  1090. epo: true, // Esperanto
  1091. tlh: true, // Klingon
  1092. jbo: true, // Lojban
  1093. avk: true, // Kotava
  1094. zxx: true // No linguistic content (ISO-639-2)
  1095. }
  1096. // Only add ISO639-1 languages and some sign languages (ISO639-3)
  1097. iso639
  1098. .filter(l => {
  1099. return (l.iso6391 !== undefined && l.type === 'living') ||
  1100. additionalLanguages[l.iso6393] === true
  1101. })
  1102. .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
  1103. // Override Occitan label
  1104. languages['oc'] = 'Occitan'
  1105. languages['el'] = 'Greek'
  1106. languages['tok'] = 'Toki Pona'
  1107. // Chinese languages
  1108. languages['zh-Hans'] = 'Simplified Chinese'
  1109. languages['zh-Hant'] = 'Traditional Chinese'
  1110. return languages
  1111. }
  1112. function generateContentHash () {
  1113. return randomBytes(20).toString('hex')
  1114. }
  1115. function getIntEnv (path: string) {
  1116. if (process.env[path]) return parseInt(process.env[path])
  1117. return undefined
  1118. }