constants.ts 38 KB

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