constants.ts 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981
  1. import { join } from 'path'
  2. import { randomBytes } from 'crypto'
  3. import { ActivityPubActorType } from '../../shared/models/activitypub'
  4. import { FollowState } from '../../shared/models/actors'
  5. import {
  6. AbuseState,
  7. VideoImportState,
  8. VideoPrivacy,
  9. VideoTranscodingFPS,
  10. JobType,
  11. VideoRateType,
  12. VideoResolution,
  13. VideoState
  14. } from '../../shared/models'
  15. // Do not use barrels, remain constants as independent as possible
  16. import { isTestInstance, sanitizeHost, sanitizeUrl, root } from '../helpers/core-utils'
  17. import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  18. import { invert } from 'lodash'
  19. import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
  20. import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
  21. import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
  22. import { CONFIG, registerConfigChangedHandler } from './config'
  23. // ---------------------------------------------------------------------------
  24. const LAST_MIGRATION_VERSION = 525
  25. // ---------------------------------------------------------------------------
  26. const API_VERSION = 'v1'
  27. const PEERTUBE_VERSION = require(join(root(), 'package.json')).version
  28. const PAGINATION = {
  29. GLOBAL: {
  30. COUNT: {
  31. DEFAULT: 15,
  32. MAX: 100
  33. }
  34. },
  35. OUTBOX: {
  36. COUNT: {
  37. MAX: 50
  38. }
  39. }
  40. }
  41. const WEBSERVER = {
  42. URL: '',
  43. HOST: '',
  44. SCHEME: '',
  45. WS: '',
  46. HOSTNAME: '',
  47. PORT: 0
  48. }
  49. // Sortable columns per schema
  50. const SORTABLE_COLUMNS = {
  51. USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
  52. USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  53. ACCOUNTS: [ 'createdAt' ],
  54. JOBS: [ 'createdAt' ],
  55. VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  56. VIDEO_IMPORTS: [ 'createdAt' ],
  57. VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
  58. VIDEO_RATES: [ 'createdAt' ],
  59. BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  60. FOLLOWERS: [ 'createdAt', 'state', 'score' ],
  61. FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
  62. VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending' ],
  63. // Don't forget to update peertube-search-index with the same values
  64. VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
  65. VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  66. ABUSES: [ 'id', 'createdAt', 'state' ],
  67. ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
  68. SERVERS_BLOCKLIST: [ 'createdAt' ],
  69. USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
  70. VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ],
  71. PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
  72. AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
  73. VIDEO_REDUNDANCIES: [ 'name' ]
  74. }
  75. const OAUTH_LIFETIME = {
  76. ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
  77. REFRESH_TOKEN: 1209600 // 2 weeks
  78. }
  79. const ROUTE_CACHE_LIFETIME = {
  80. FEEDS: '15 minutes',
  81. ROBOTS: '2 hours',
  82. SITEMAP: '1 day',
  83. SECURITYTXT: '2 hours',
  84. NODEINFO: '10 minutes',
  85. DNT_POLICY: '1 week',
  86. ACTIVITY_PUB: {
  87. VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
  88. },
  89. STATS: '4 hours'
  90. }
  91. // ---------------------------------------------------------------------------
  92. // Number of points we add/remove after a successful/bad request
  93. const ACTOR_FOLLOW_SCORE = {
  94. PENALTY: -10,
  95. BONUS: 10,
  96. BASE: 1000,
  97. MAX: 10000
  98. }
  99. const FOLLOW_STATES: { [ id: string ]: FollowState } = {
  100. PENDING: 'pending',
  101. ACCEPTED: 'accepted'
  102. }
  103. const REMOTE_SCHEME = {
  104. HTTP: 'https',
  105. WS: 'wss'
  106. }
  107. const JOB_ATTEMPTS: { [id in JobType]: number } = {
  108. 'activitypub-http-broadcast': 5,
  109. 'activitypub-http-unicast': 5,
  110. 'activitypub-http-fetcher': 5,
  111. 'activitypub-follow': 5,
  112. 'video-file-import': 1,
  113. 'video-transcoding': 1,
  114. 'video-import': 1,
  115. 'email': 5,
  116. 'videos-views': 1,
  117. 'activitypub-refresher': 1,
  118. 'video-redundancy': 1
  119. }
  120. const JOB_CONCURRENCY: { [id in JobType]: number } = {
  121. 'activitypub-http-broadcast': 1,
  122. 'activitypub-http-unicast': 5,
  123. 'activitypub-http-fetcher': 1,
  124. 'activitypub-follow': 1,
  125. 'video-file-import': 1,
  126. 'video-transcoding': 1,
  127. 'video-import': 1,
  128. 'email': 5,
  129. 'videos-views': 1,
  130. 'activitypub-refresher': 1,
  131. 'video-redundancy': 1
  132. }
  133. const JOB_TTL: { [id in JobType]: number } = {
  134. 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
  135. 'activitypub-http-unicast': 60000 * 10, // 10 minutes
  136. 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
  137. 'activitypub-follow': 60000 * 10, // 10 minutes
  138. 'video-file-import': 1000 * 3600, // 1 hour
  139. 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
  140. 'video-import': 1000 * 3600 * 2, // 2 hours
  141. 'email': 60000 * 10, // 10 minutes
  142. 'videos-views': undefined, // Unlimited
  143. 'activitypub-refresher': 60000 * 10, // 10 minutes
  144. 'video-redundancy': 1000 * 3600 * 3 // 3 hours
  145. }
  146. const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
  147. 'videos-views': {
  148. cron: '1 * * * *' // At 1 minute past the hour
  149. }
  150. }
  151. const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
  152. const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
  153. const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
  154. const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
  155. const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
  156. const SCHEDULER_INTERVALS_MS = {
  157. actorFollowScores: 60000 * 60, // 1 hour
  158. removeOldJobs: 60000 * 60, // 1 hour
  159. updateVideos: 60000, // 1 minute
  160. youtubeDLUpdate: 60000 * 60 * 24, // 1 day
  161. checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
  162. autoFollowIndexInstances: 60000 * 60 * 24, // 1 day
  163. removeOldViews: 60000 * 60 * 24, // 1 day
  164. removeOldHistory: 60000 * 60 * 24 // 1 day
  165. }
  166. // ---------------------------------------------------------------------------
  167. const CONSTRAINTS_FIELDS = {
  168. USERS: {
  169. NAME: { min: 1, max: 120 }, // Length
  170. DESCRIPTION: { min: 3, max: 1000 }, // Length
  171. USERNAME: { min: 1, max: 50 }, // Length
  172. PASSWORD: { min: 6, max: 255 }, // Length
  173. VIDEO_QUOTA: { min: -1 },
  174. VIDEO_QUOTA_DAILY: { min: -1 },
  175. VIDEO_LANGUAGES: { max: 500 }, // Array length
  176. BLOCKED_REASON: { min: 3, max: 250 } // Length
  177. },
  178. ABUSES: {
  179. REASON: { min: 2, max: 3000 }, // Length
  180. MODERATION_COMMENT: { min: 2, max: 3000 } // Length
  181. },
  182. ABUSE_MESSAGES: {
  183. MESSAGE: { min: 2, max: 3000 } // Length
  184. },
  185. VIDEO_BLACKLIST: {
  186. REASON: { min: 2, max: 300 } // Length
  187. },
  188. VIDEO_CHANNELS: {
  189. NAME: { min: 1, max: 120 }, // Length
  190. DESCRIPTION: { min: 3, max: 1000 }, // Length
  191. SUPPORT: { min: 3, max: 1000 }, // Length
  192. URL: { min: 3, max: 2000 } // Length
  193. },
  194. VIDEO_CAPTIONS: {
  195. CAPTION_FILE: {
  196. EXTNAME: [ '.vtt', '.srt' ],
  197. FILE_SIZE: {
  198. max: 2 * 1024 * 1024 // 2MB
  199. }
  200. }
  201. },
  202. VIDEO_IMPORTS: {
  203. URL: { min: 3, max: 2000 }, // Length
  204. TORRENT_NAME: { min: 3, max: 255 }, // Length
  205. TORRENT_FILE: {
  206. EXTNAME: [ '.torrent' ],
  207. FILE_SIZE: {
  208. max: 1024 * 200 // 200 KB
  209. }
  210. }
  211. },
  212. VIDEOS_REDUNDANCY: {
  213. URL: { min: 3, max: 2000 } // Length
  214. },
  215. VIDEO_RATES: {
  216. URL: { min: 3, max: 2000 } // Length
  217. },
  218. VIDEOS: {
  219. NAME: { min: 3, max: 120 }, // Length
  220. LANGUAGE: { min: 1, max: 10 }, // Length
  221. TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
  222. DESCRIPTION: { min: 3, max: 10000 }, // Length
  223. SUPPORT: { min: 3, max: 1000 }, // Length
  224. IMAGE: {
  225. EXTNAME: [ '.jpg', '.jpeg' ],
  226. FILE_SIZE: {
  227. max: 2 * 1024 * 1024 // 2MB
  228. }
  229. },
  230. EXTNAME: [] as string[],
  231. INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
  232. DURATION: { min: 0 }, // Number
  233. TAGS: { min: 0, max: 5 }, // Number of total tags
  234. TAG: { min: 2, max: 30 }, // Length
  235. THUMBNAIL: { min: 2, max: 30 },
  236. THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
  237. VIEWS: { min: 0 },
  238. LIKES: { min: 0 },
  239. DISLIKES: { min: 0 },
  240. FILE_SIZE: { min: 10 },
  241. URL: { min: 3, max: 2000 } // Length
  242. },
  243. VIDEO_PLAYLISTS: {
  244. NAME: { min: 1, max: 120 }, // Length
  245. DESCRIPTION: { min: 3, max: 1000 }, // Length
  246. URL: { min: 3, max: 2000 }, // Length
  247. IMAGE: {
  248. EXTNAME: [ '.jpg', '.jpeg' ],
  249. FILE_SIZE: {
  250. max: 2 * 1024 * 1024 // 2MB
  251. }
  252. }
  253. },
  254. ACTORS: {
  255. PUBLIC_KEY: { min: 10, max: 5000 }, // Length
  256. PRIVATE_KEY: { min: 10, max: 5000 }, // Length
  257. URL: { min: 3, max: 2000 }, // Length
  258. AVATAR: {
  259. EXTNAME: [ '.png', '.jpeg', '.jpg' ],
  260. FILE_SIZE: {
  261. max: 2 * 1024 * 1024 // 2MB
  262. }
  263. }
  264. },
  265. VIDEO_EVENTS: {
  266. COUNT: { min: 0 }
  267. },
  268. VIDEO_COMMENTS: {
  269. TEXT: { min: 1, max: 10000 }, // Length
  270. URL: { min: 3, max: 2000 } // Length
  271. },
  272. VIDEO_SHARE: {
  273. URL: { min: 3, max: 2000 } // Length
  274. },
  275. CONTACT_FORM: {
  276. FROM_NAME: { min: 1, max: 120 }, // Length
  277. BODY: { min: 3, max: 5000 } // Length
  278. },
  279. PLUGINS: {
  280. NAME: { min: 1, max: 214 }, // Length
  281. DESCRIPTION: { min: 1, max: 20000 } // Length
  282. },
  283. COMMONS: {
  284. URL: { min: 5, max: 2000 } // Length
  285. }
  286. }
  287. let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
  288. let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
  289. const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
  290. MIN: 10,
  291. STANDARD: [ 24, 25, 30 ],
  292. HD_STANDARD: [ 50, 60 ],
  293. AVERAGE: 30,
  294. MAX: 60,
  295. KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
  296. }
  297. const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
  298. const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
  299. LIKE: 'like',
  300. DISLIKE: 'dislike'
  301. }
  302. const FFMPEG_NICE: { [ id: string ]: number } = {
  303. THUMBNAIL: 2, // 2 just for don't blocking servers
  304. TRANSCODING: 15
  305. }
  306. const VIDEO_CATEGORIES = {
  307. 1: 'Music',
  308. 2: 'Films',
  309. 3: 'Vehicles',
  310. 4: 'Art',
  311. 5: 'Sports',
  312. 6: 'Travels',
  313. 7: 'Gaming',
  314. 8: 'People',
  315. 9: 'Comedy',
  316. 10: 'Entertainment',
  317. 11: 'News & Politics',
  318. 12: 'How To',
  319. 13: 'Education',
  320. 14: 'Activism',
  321. 15: 'Science & Technology',
  322. 16: 'Animals',
  323. 17: 'Kids',
  324. 18: 'Food'
  325. }
  326. // See https://creativecommons.org/licenses/?lang=en
  327. const VIDEO_LICENCES = {
  328. 1: 'Attribution',
  329. 2: 'Attribution - Share Alike',
  330. 3: 'Attribution - No Derivatives',
  331. 4: 'Attribution - Non Commercial',
  332. 5: 'Attribution - Non Commercial - Share Alike',
  333. 6: 'Attribution - Non Commercial - No Derivatives',
  334. 7: 'Public Domain Dedication'
  335. }
  336. const VIDEO_LANGUAGES: { [id: string]: string } = {}
  337. const VIDEO_PRIVACIES = {
  338. [VideoPrivacy.PUBLIC]: 'Public',
  339. [VideoPrivacy.UNLISTED]: 'Unlisted',
  340. [VideoPrivacy.PRIVATE]: 'Private',
  341. [VideoPrivacy.INTERNAL]: 'Internal'
  342. }
  343. const VIDEO_STATES = {
  344. [VideoState.PUBLISHED]: 'Published',
  345. [VideoState.TO_TRANSCODE]: 'To transcode',
  346. [VideoState.TO_IMPORT]: 'To import'
  347. }
  348. const VIDEO_IMPORT_STATES = {
  349. [VideoImportState.FAILED]: 'Failed',
  350. [VideoImportState.PENDING]: 'Pending',
  351. [VideoImportState.SUCCESS]: 'Success',
  352. [VideoImportState.REJECTED]: 'Rejected'
  353. }
  354. const ABUSE_STATES = {
  355. [AbuseState.PENDING]: 'Pending',
  356. [AbuseState.REJECTED]: 'Rejected',
  357. [AbuseState.ACCEPTED]: 'Accepted'
  358. }
  359. const VIDEO_PLAYLIST_PRIVACIES = {
  360. [VideoPlaylistPrivacy.PUBLIC]: 'Public',
  361. [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
  362. [VideoPlaylistPrivacy.PRIVATE]: 'Private'
  363. }
  364. const VIDEO_PLAYLIST_TYPES = {
  365. [VideoPlaylistType.REGULAR]: 'Regular',
  366. [VideoPlaylistType.WATCH_LATER]: 'Watch later'
  367. }
  368. const MIMETYPES = {
  369. AUDIO: {
  370. MIMETYPE_EXT: {
  371. 'audio/mpeg': '.mp3',
  372. 'audio/mp3': '.mp3',
  373. 'application/ogg': '.ogg',
  374. 'audio/ogg': '.ogg',
  375. 'audio/x-ms-wma': '.wma',
  376. 'audio/wav': '.wav',
  377. 'audio/x-flac': '.flac',
  378. 'audio/flac': '.flac'
  379. },
  380. EXT_MIMETYPE: null as { [ id: string ]: string }
  381. },
  382. VIDEO: {
  383. MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
  384. MIMETYPES_REGEX: null as string,
  385. EXT_MIMETYPE: null as { [ id: string ]: string }
  386. },
  387. IMAGE: {
  388. MIMETYPE_EXT: {
  389. 'image/png': '.png',
  390. 'image/jpg': '.jpg',
  391. 'image/jpeg': '.jpg'
  392. },
  393. EXT_MIMETYPE: null as { [ id: string ]: string }
  394. },
  395. VIDEO_CAPTIONS: {
  396. MIMETYPE_EXT: {
  397. 'text/vtt': '.vtt',
  398. 'application/x-subrip': '.srt',
  399. 'text/plain': '.srt'
  400. }
  401. },
  402. TORRENT: {
  403. MIMETYPE_EXT: {
  404. 'application/x-bittorrent': '.torrent'
  405. }
  406. }
  407. }
  408. MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
  409. MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
  410. // ---------------------------------------------------------------------------
  411. const OVERVIEWS = {
  412. VIDEOS: {
  413. SAMPLE_THRESHOLD: 6,
  414. SAMPLES_COUNT: 20
  415. }
  416. }
  417. const VIDEO_CHANNELS = {
  418. MAX_PER_USER: 20
  419. }
  420. // ---------------------------------------------------------------------------
  421. const SERVER_ACTOR_NAME = 'peertube'
  422. const ACTIVITY_PUB = {
  423. POTENTIAL_ACCEPT_HEADERS: [
  424. 'application/activity+json',
  425. 'application/ld+json',
  426. 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
  427. ],
  428. ACCEPT_HEADER: 'application/activity+json, application/ld+json',
  429. PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
  430. COLLECTION_ITEMS_PER_PAGE: 10,
  431. FETCH_PAGE_LIMIT: 2000,
  432. URL_MIME_TYPES: {
  433. VIDEO: [] as string[],
  434. TORRENT: [ 'application/x-bittorrent' ],
  435. MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
  436. },
  437. MAX_RECURSION_COMMENTS: 100,
  438. ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
  439. VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
  440. VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
  441. }
  442. const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
  443. GROUP: 'Group',
  444. PERSON: 'Person',
  445. APPLICATION: 'Application',
  446. ORGANIZATION: 'Organization',
  447. SERVICE: 'Service'
  448. }
  449. const HTTP_SIGNATURE = {
  450. HEADER_NAME: 'signature',
  451. ALGORITHM: 'rsa-sha256',
  452. HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
  453. CLOCK_SKEW_SECONDS: 1800
  454. }
  455. // ---------------------------------------------------------------------------
  456. let PRIVATE_RSA_KEY_SIZE = 2048
  457. // Password encryption
  458. const BCRYPT_SALT_SIZE = 10
  459. const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
  460. const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
  461. const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
  462. const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
  463. DO_NOT_LIST: 'do_not_list',
  464. BLUR: 'blur',
  465. DISPLAY: 'display'
  466. }
  467. // ---------------------------------------------------------------------------
  468. // Express static paths (router)
  469. const STATIC_PATHS = {
  470. PREVIEWS: '/static/previews/',
  471. THUMBNAILS: '/static/thumbnails/',
  472. TORRENTS: '/static/torrents/',
  473. WEBSEED: '/static/webseed/',
  474. REDUNDANCY: '/static/redundancy/',
  475. STREAMING_PLAYLISTS: {
  476. HLS: '/static/streaming-playlists/hls'
  477. },
  478. AVATARS: '/static/avatars/',
  479. VIDEO_CAPTIONS: '/static/video-captions/'
  480. }
  481. const STATIC_DOWNLOAD_PATHS = {
  482. TORRENTS: '/download/torrents/',
  483. VIDEOS: '/download/videos/',
  484. HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
  485. }
  486. const LAZY_STATIC_PATHS = {
  487. AVATARS: '/lazy-static/avatars/',
  488. PREVIEWS: '/static/previews/',
  489. VIDEO_CAPTIONS: '/static/video-captions/'
  490. }
  491. // Cache control
  492. const STATIC_MAX_AGE = {
  493. SERVER: '2h',
  494. CLIENT: '30d'
  495. }
  496. // Videos thumbnail size
  497. const THUMBNAILS_SIZE = {
  498. width: 223,
  499. height: 122,
  500. minWidth: 150
  501. }
  502. const PREVIEWS_SIZE = {
  503. width: 850,
  504. height: 480,
  505. minWidth: 400
  506. }
  507. const AVATARS_SIZE = {
  508. width: 120,
  509. height: 120
  510. }
  511. const EMBED_SIZE = {
  512. width: 560,
  513. height: 315
  514. }
  515. // Sub folders of cache directory
  516. const FILES_CACHE = {
  517. PREVIEWS: {
  518. DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
  519. MAX_AGE: 1000 * 3600 * 3 // 3 hours
  520. },
  521. VIDEO_CAPTIONS: {
  522. DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
  523. MAX_AGE: 1000 * 3600 * 3 // 3 hours
  524. }
  525. }
  526. const LRU_CACHE = {
  527. USER_TOKENS: {
  528. MAX_SIZE: 1000
  529. },
  530. AVATAR_STATIC: {
  531. MAX_SIZE: 500
  532. }
  533. }
  534. const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
  535. const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
  536. const MEMOIZE_TTL = {
  537. OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
  538. INFO_HASH_EXISTS: 1000 * 3600 * 12 // 12 hours
  539. }
  540. const MEMOIZE_LENGTH = {
  541. INFO_HASH_EXISTS: 200
  542. }
  543. const QUEUE_CONCURRENCY = {
  544. AVATAR_PROCESS_IMAGE: 3
  545. }
  546. const REDUNDANCY = {
  547. VIDEOS: {
  548. RANDOMIZED_FACTOR: 5
  549. }
  550. }
  551. const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
  552. const ASSETS_PATH = {
  553. DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg')
  554. }
  555. // ---------------------------------------------------------------------------
  556. const CUSTOM_HTML_TAG_COMMENTS = {
  557. TITLE: '<!-- title tag -->',
  558. DESCRIPTION: '<!-- description tag -->',
  559. CUSTOM_CSS: '<!-- custom css tag -->',
  560. META_TAGS: '<!-- meta tags -->'
  561. }
  562. // ---------------------------------------------------------------------------
  563. const FEEDS = {
  564. COUNT: 20
  565. }
  566. const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
  567. const LOG_FILENAME = 'peertube.log'
  568. const AUDIT_LOG_FILENAME = 'peertube-audit.log'
  569. // ---------------------------------------------------------------------------
  570. const TRACKER_RATE_LIMITS = {
  571. INTERVAL: 60000 * 5, // 5 minutes
  572. ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
  573. ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
  574. BLOCK_IP_LIFETIME: 60000 * 10 // 10 minutes
  575. }
  576. const P2P_MEDIA_LOADER_PEER_VERSION = 2
  577. // ---------------------------------------------------------------------------
  578. const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
  579. const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
  580. let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
  581. const DEFAULT_THEME_NAME = 'default'
  582. const DEFAULT_USER_THEME_NAME = 'instance-default'
  583. // ---------------------------------------------------------------------------
  584. const SEARCH_INDEX = {
  585. ROUTES: {
  586. VIDEOS: '/api/v1/search/videos',
  587. VIDEO_CHANNELS: '/api/v1/search/video-channels'
  588. }
  589. }
  590. // ---------------------------------------------------------------------------
  591. // Special constants for a test instance
  592. if (isTestInstance() === true) {
  593. PRIVATE_RSA_KEY_SIZE = 1024
  594. ACTOR_FOLLOW_SCORE.BASE = 20
  595. REMOTE_SCHEME.HTTP = 'http'
  596. REMOTE_SCHEME.WS = 'ws'
  597. STATIC_MAX_AGE.SERVER = '0'
  598. ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
  599. ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  600. ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  601. ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  602. CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
  603. SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
  604. SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
  605. SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
  606. SCHEDULER_INTERVALS_MS.removeOldViews = 5000
  607. SCHEDULER_INTERVALS_MS.updateVideos = 5000
  608. SCHEDULER_INTERVALS_MS.autoFollowIndexInstances = 5000
  609. REPEAT_JOBS['videos-views'] = { every: 5000 }
  610. REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
  611. VIDEO_VIEW_LIFETIME = 1000 // 1 second
  612. CONTACT_FORM_LIFETIME = 1000 // 1 second
  613. JOB_ATTEMPTS['email'] = 1
  614. FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
  615. MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
  616. OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
  617. PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
  618. }
  619. updateWebserverUrls()
  620. updateWebserverConfig()
  621. registerConfigChangedHandler(() => {
  622. updateWebserverUrls()
  623. updateWebserverConfig()
  624. })
  625. // ---------------------------------------------------------------------------
  626. const FILES_CONTENT_HASH = {
  627. MANIFEST: generateContentHash(),
  628. FAVICON: generateContentHash(),
  629. LOGO: generateContentHash()
  630. }
  631. // ---------------------------------------------------------------------------
  632. export {
  633. WEBSERVER,
  634. API_VERSION,
  635. PEERTUBE_VERSION,
  636. LAZY_STATIC_PATHS,
  637. SEARCH_INDEX,
  638. HLS_REDUNDANCY_DIRECTORY,
  639. P2P_MEDIA_LOADER_PEER_VERSION,
  640. AVATARS_SIZE,
  641. ACCEPT_HEADERS,
  642. BCRYPT_SALT_SIZE,
  643. TRACKER_RATE_LIMITS,
  644. FILES_CACHE,
  645. LOG_FILENAME,
  646. CONSTRAINTS_FIELDS,
  647. EMBED_SIZE,
  648. REDUNDANCY,
  649. JOB_CONCURRENCY,
  650. JOB_ATTEMPTS,
  651. LAST_MIGRATION_VERSION,
  652. OAUTH_LIFETIME,
  653. CUSTOM_HTML_TAG_COMMENTS,
  654. BROADCAST_CONCURRENCY,
  655. AUDIT_LOG_FILENAME,
  656. PAGINATION,
  657. ACTOR_FOLLOW_SCORE,
  658. PREVIEWS_SIZE,
  659. REMOTE_SCHEME,
  660. FOLLOW_STATES,
  661. DEFAULT_USER_THEME_NAME,
  662. SERVER_ACTOR_NAME,
  663. PLUGIN_GLOBAL_CSS_FILE_NAME,
  664. PLUGIN_GLOBAL_CSS_PATH,
  665. PRIVATE_RSA_KEY_SIZE,
  666. ROUTE_CACHE_LIFETIME,
  667. SORTABLE_COLUMNS,
  668. HLS_STREAMING_PLAYLIST_DIRECTORY,
  669. FEEDS,
  670. JOB_TTL,
  671. DEFAULT_THEME_NAME,
  672. NSFW_POLICY_TYPES,
  673. STATIC_MAX_AGE,
  674. STATIC_PATHS,
  675. VIDEO_IMPORT_TIMEOUT,
  676. VIDEO_PLAYLIST_TYPES,
  677. MAX_LOGS_OUTPUT_CHARACTERS,
  678. ACTIVITY_PUB,
  679. ACTIVITY_PUB_ACTOR_TYPES,
  680. THUMBNAILS_SIZE,
  681. VIDEO_CATEGORIES,
  682. MEMOIZE_LENGTH,
  683. VIDEO_LANGUAGES,
  684. VIDEO_PRIVACIES,
  685. VIDEO_LICENCES,
  686. VIDEO_STATES,
  687. QUEUE_CONCURRENCY,
  688. VIDEO_RATE_TYPES,
  689. VIDEO_TRANSCODING_FPS,
  690. FFMPEG_NICE,
  691. ABUSE_STATES,
  692. VIDEO_CHANNELS,
  693. LRU_CACHE,
  694. JOB_REQUEST_TIMEOUT,
  695. USER_PASSWORD_RESET_LIFETIME,
  696. USER_PASSWORD_CREATE_LIFETIME,
  697. MEMOIZE_TTL,
  698. USER_EMAIL_VERIFY_LIFETIME,
  699. OVERVIEWS,
  700. SCHEDULER_INTERVALS_MS,
  701. REPEAT_JOBS,
  702. STATIC_DOWNLOAD_PATHS,
  703. MIMETYPES,
  704. CRAWL_REQUEST_CONCURRENCY,
  705. DEFAULT_AUDIO_RESOLUTION,
  706. JOB_COMPLETED_LIFETIME,
  707. HTTP_SIGNATURE,
  708. VIDEO_IMPORT_STATES,
  709. VIDEO_VIEW_LIFETIME,
  710. CONTACT_FORM_LIFETIME,
  711. VIDEO_PLAYLIST_PRIVACIES,
  712. PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
  713. ASSETS_PATH,
  714. FILES_CONTENT_HASH,
  715. loadLanguages,
  716. buildLanguages,
  717. generateContentHash
  718. }
  719. // ---------------------------------------------------------------------------
  720. function buildVideoMimetypeExt () {
  721. const data = {
  722. // streamable formats that warrant cross-browser compatibility
  723. 'video/webm': '.webm',
  724. // We'll add .ogg if additional extensions are enabled
  725. // We could add .ogg here but since it could be an audio file,
  726. // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
  727. 'video/ogg': [ '.ogv' ],
  728. 'video/mp4': '.mp4'
  729. }
  730. if (CONFIG.TRANSCODING.ENABLED) {
  731. if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
  732. data['video/ogg'].push('.ogg')
  733. Object.assign(data, {
  734. 'video/x-matroska': '.mkv',
  735. // Developed by Apple
  736. 'video/quicktime': '.mov', // often used as output format by editing software
  737. 'video/x-m4v': '.m4v',
  738. 'video/m4v': '.m4v',
  739. // Developed by the Adobe Flash Platform
  740. 'video/x-flv': '.flv',
  741. 'video/x-f4v': '.f4v', // replacement for flv
  742. // Developed by Microsoft
  743. 'video/x-ms-wmv': '.wmv',
  744. 'video/x-msvideo': '.avi',
  745. 'video/avi': '.avi',
  746. // Developed by 3GPP
  747. // common video formats for cell phones
  748. 'video/3gpp': '.3gp',
  749. 'video/3gpp2': '.3g2',
  750. // Developed by FFmpeg/Mplayer
  751. 'application/x-nut': '.nut',
  752. // The standard video format used by many Sony and Panasonic HD camcorders.
  753. // It is also used for storing high definition video on Blu-ray discs.
  754. 'video/mp2t': '.mts',
  755. 'video/m2ts': '.m2ts',
  756. // Old formats reliant on MPEG-1/MPEG-2
  757. 'video/mpv': '.mpv',
  758. 'video/mpeg2': '.m2v',
  759. 'video/mpeg': '.mpeg',
  760. // Could be anything
  761. 'application/octet-stream': null,
  762. 'application/mxf': '.mxf' // often used as exchange format by editing software
  763. })
  764. }
  765. if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
  766. Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
  767. }
  768. }
  769. return data
  770. }
  771. function updateWebserverUrls () {
  772. WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
  773. WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
  774. WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
  775. WEBSERVER.WS = CONFIG.WEBSERVER.WS
  776. WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
  777. WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
  778. }
  779. function updateWebserverConfig () {
  780. MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
  781. MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
  782. ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
  783. MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
  784. CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
  785. }
  786. function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
  787. const result: { [id: string]: string } = {}
  788. for (const mimetype of Object.keys(obj)) {
  789. const value = obj[mimetype]
  790. if (!value) continue
  791. const extensions = Array.isArray(value) ? value : [ value ]
  792. for (const extension of extensions) {
  793. result[extension] = mimetype
  794. }
  795. }
  796. return result
  797. }
  798. function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
  799. return Object.keys(obj)
  800. .map(m => `(${m})`)
  801. .join('|')
  802. }
  803. function loadLanguages () {
  804. Object.assign(VIDEO_LANGUAGES, buildLanguages())
  805. }
  806. function buildLanguages () {
  807. const iso639 = require('iso-639-3')
  808. const languages: { [id: string]: string } = {}
  809. const additionalLanguages = {
  810. sgn: true, // Sign languages (macro language)
  811. ase: true, // American sign language
  812. sdl: true, // Arabian sign language
  813. bfi: true, // British sign language
  814. bzs: true, // Brazilian sign language
  815. csl: true, // Chinese sign language
  816. cse: true, // Czech sign language
  817. dsl: true, // Danish sign language
  818. fsl: true, // French sign language
  819. gsg: true, // German sign language
  820. pks: true, // Pakistan sign language
  821. jsl: true, // Japanese sign language
  822. sfs: true, // South African sign language
  823. swl: true, // Swedish sign language
  824. rsl: true, // Russian sign language: true
  825. epo: true, // Esperanto
  826. tlh: true, // Klingon
  827. jbo: true, // Lojban
  828. avk: true // Kotava
  829. }
  830. // Only add ISO639-1 languages and some sign languages (ISO639-3)
  831. iso639
  832. .filter(l => {
  833. return (l.iso6391 !== undefined && l.type === 'living') ||
  834. additionalLanguages[l.iso6393] === true
  835. })
  836. .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
  837. // Override Occitan label
  838. languages['oc'] = 'Occitan'
  839. languages['el'] = 'Greek'
  840. return languages
  841. }
  842. function generateContentHash () {
  843. return randomBytes(20).toString('hex')
  844. }