constants.ts 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781
  1. import { join } from 'path'
  2. import { JobType, VideoRateType, VideoState } from '../../shared/models'
  3. import { ActivityPubActorType } from '../../shared/models/activitypub'
  4. import { FollowState } from '../../shared/models/actors'
  5. import { VideoAbuseState, VideoImportState, VideoPrivacy, VideoTranscodingFPS } from '../../shared/models/videos'
  6. // Do not use barrels, remain constants as independent as possible
  7. import { isTestInstance, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
  8. import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
  9. import { invert } from 'lodash'
  10. import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
  11. import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
  12. import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
  13. import { CONFIG, registerConfigChangedHandler } from './config'
  14. // ---------------------------------------------------------------------------
  15. const LAST_MIGRATION_VERSION = 360
  16. // ---------------------------------------------------------------------------
  17. // API version
  18. const API_VERSION = 'v1'
  19. const PAGINATION = {
  20. COUNT: {
  21. DEFAULT: 15,
  22. MAX: 100
  23. }
  24. }
  25. const WEBSERVER = {
  26. URL: '',
  27. HOST: '',
  28. SCHEME: '',
  29. WS: '',
  30. HOSTNAME: '',
  31. PORT: 0
  32. }
  33. // Sortable columns per schema
  34. const SORTABLE_COLUMNS = {
  35. USERS: [ 'id', 'username', 'createdAt' ],
  36. USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
  37. ACCOUNTS: [ 'createdAt' ],
  38. JOBS: [ 'createdAt' ],
  39. VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
  40. VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
  41. VIDEO_IMPORTS: [ 'createdAt' ],
  42. VIDEO_COMMENT_THREADS: [ 'createdAt' ],
  43. VIDEO_RATES: [ 'createdAt' ],
  44. BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
  45. FOLLOWERS: [ 'createdAt' ],
  46. FOLLOWING: [ 'createdAt' ],
  47. VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
  48. VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
  49. VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
  50. ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
  51. SERVERS_BLOCKLIST: [ 'createdAt' ],
  52. USER_NOTIFICATIONS: [ 'createdAt' ],
  53. VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ]
  54. }
  55. const OAUTH_LIFETIME = {
  56. ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
  57. REFRESH_TOKEN: 1209600 // 2 weeks
  58. }
  59. const ROUTE_CACHE_LIFETIME = {
  60. FEEDS: '15 minutes',
  61. ROBOTS: '2 hours',
  62. SITEMAP: '1 day',
  63. SECURITYTXT: '2 hours',
  64. NODEINFO: '10 minutes',
  65. DNT_POLICY: '1 week',
  66. OVERVIEWS: {
  67. VIDEOS: '1 hour'
  68. },
  69. ACTIVITY_PUB: {
  70. VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
  71. },
  72. STATS: '4 hours'
  73. }
  74. // ---------------------------------------------------------------------------
  75. // Number of points we add/remove after a successful/bad request
  76. const ACTOR_FOLLOW_SCORE = {
  77. PENALTY: -10,
  78. BONUS: 10,
  79. BASE: 1000,
  80. MAX: 10000
  81. }
  82. const FOLLOW_STATES: { [ id: string ]: FollowState } = {
  83. PENDING: 'pending',
  84. ACCEPTED: 'accepted'
  85. }
  86. const REMOTE_SCHEME = {
  87. HTTP: 'https',
  88. WS: 'wss'
  89. }
  90. // TODO: remove 'video-file'
  91. const JOB_ATTEMPTS: { [id in (JobType | 'video-file')]: number } = {
  92. 'activitypub-http-broadcast': 5,
  93. 'activitypub-http-unicast': 5,
  94. 'activitypub-http-fetcher': 5,
  95. 'activitypub-follow': 5,
  96. 'video-file-import': 1,
  97. 'video-transcoding': 1,
  98. 'video-file': 1,
  99. 'video-import': 1,
  100. 'email': 5,
  101. 'videos-views': 1,
  102. 'activitypub-refresher': 1
  103. }
  104. const JOB_CONCURRENCY: { [id in (JobType | 'video-file')]: number } = {
  105. 'activitypub-http-broadcast': 1,
  106. 'activitypub-http-unicast': 5,
  107. 'activitypub-http-fetcher': 1,
  108. 'activitypub-follow': 3,
  109. 'video-file-import': 1,
  110. 'video-transcoding': 1,
  111. 'video-file': 1,
  112. 'video-import': 1,
  113. 'email': 5,
  114. 'videos-views': 1,
  115. 'activitypub-refresher': 1
  116. }
  117. const JOB_TTL: { [id in (JobType | 'video-file')]: number } = {
  118. 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
  119. 'activitypub-http-unicast': 60000 * 10, // 10 minutes
  120. 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
  121. 'activitypub-follow': 60000 * 10, // 10 minutes
  122. 'video-file-import': 1000 * 3600, // 1 hour
  123. 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
  124. 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
  125. 'video-import': 1000 * 3600 * 2, // hours
  126. 'email': 60000 * 10, // 10 minutes
  127. 'videos-views': undefined, // Unlimited
  128. 'activitypub-refresher': 60000 * 10 // 10 minutes
  129. }
  130. const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
  131. 'videos-views': {
  132. cron: '1 * * * *' // At 1 minute past the hour
  133. }
  134. }
  135. const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
  136. const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
  137. const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
  138. const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
  139. const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
  140. const SCHEDULER_INTERVALS_MS = {
  141. actorFollowScores: 60000 * 60, // 1 hour
  142. removeOldJobs: 60000 * 60, // 1 hour
  143. updateVideos: 60000, // 1 minute
  144. youtubeDLUpdate: 60000 * 60 * 24, // 1 day
  145. removeOldHistory: 60000 * 60 * 24 // 1 day
  146. }
  147. // ---------------------------------------------------------------------------
  148. let CONSTRAINTS_FIELDS = {
  149. USERS: {
  150. NAME: { min: 1, max: 120 }, // Length
  151. DESCRIPTION: { min: 3, max: 1000 }, // Length
  152. USERNAME: { min: 1, max: 50 }, // Length
  153. PASSWORD: { min: 6, max: 255 }, // Length
  154. VIDEO_QUOTA: { min: -1 },
  155. VIDEO_QUOTA_DAILY: { min: -1 },
  156. BLOCKED_REASON: { min: 3, max: 250 } // Length
  157. },
  158. VIDEO_ABUSES: {
  159. REASON: { min: 2, max: 3000 }, // Length
  160. MODERATION_COMMENT: { min: 2, max: 3000 } // Length
  161. },
  162. VIDEO_BLACKLIST: {
  163. REASON: { min: 2, max: 300 } // Length
  164. },
  165. VIDEO_CHANNELS: {
  166. NAME: { min: 1, max: 120 }, // Length
  167. DESCRIPTION: { min: 3, max: 1000 }, // Length
  168. SUPPORT: { min: 3, max: 1000 }, // Length
  169. URL: { min: 3, max: 2000 } // Length
  170. },
  171. VIDEO_CAPTIONS: {
  172. CAPTION_FILE: {
  173. EXTNAME: [ '.vtt', '.srt' ],
  174. FILE_SIZE: {
  175. max: 2 * 1024 * 1024 // 2MB
  176. }
  177. }
  178. },
  179. VIDEO_IMPORTS: {
  180. URL: { min: 3, max: 2000 }, // Length
  181. TORRENT_NAME: { min: 3, max: 255 }, // Length
  182. TORRENT_FILE: {
  183. EXTNAME: [ '.torrent' ],
  184. FILE_SIZE: {
  185. max: 1024 * 200 // 200 KB
  186. }
  187. }
  188. },
  189. VIDEOS_REDUNDANCY: {
  190. URL: { min: 3, max: 2000 } // Length
  191. },
  192. VIDEO_RATES: {
  193. URL: { min: 3, max: 2000 } // Length
  194. },
  195. VIDEOS: {
  196. NAME: { min: 3, max: 120 }, // Length
  197. LANGUAGE: { min: 1, max: 10 }, // Length
  198. TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
  199. DESCRIPTION: { min: 3, max: 10000 }, // Length
  200. SUPPORT: { min: 3, max: 1000 }, // Length
  201. IMAGE: {
  202. EXTNAME: [ '.jpg', '.jpeg' ],
  203. FILE_SIZE: {
  204. max: 2 * 1024 * 1024 // 2MB
  205. }
  206. },
  207. EXTNAME: buildVideosExtname(),
  208. INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
  209. DURATION: { min: 0 }, // Number
  210. TAGS: { min: 0, max: 5 }, // Number of total tags
  211. TAG: { min: 2, max: 30 }, // Length
  212. THUMBNAIL: { min: 2, max: 30 },
  213. THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
  214. VIEWS: { min: 0 },
  215. LIKES: { min: 0 },
  216. DISLIKES: { min: 0 },
  217. FILE_SIZE: { min: 10 },
  218. URL: { min: 3, max: 2000 } // Length
  219. },
  220. VIDEO_PLAYLISTS: {
  221. NAME: { min: 1, max: 120 }, // Length
  222. DESCRIPTION: { min: 3, max: 1000 }, // Length
  223. URL: { min: 3, max: 2000 }, // Length
  224. IMAGE: {
  225. EXTNAME: [ '.jpg', '.jpeg' ],
  226. FILE_SIZE: {
  227. max: 2 * 1024 * 1024 // 2MB
  228. }
  229. }
  230. },
  231. ACTORS: {
  232. PUBLIC_KEY: { min: 10, max: 5000 }, // Length
  233. PRIVATE_KEY: { min: 10, max: 5000 }, // Length
  234. URL: { min: 3, max: 2000 }, // Length
  235. AVATAR: {
  236. EXTNAME: [ '.png', '.jpeg', '.jpg' ],
  237. FILE_SIZE: {
  238. max: 2 * 1024 * 1024 // 2MB
  239. }
  240. }
  241. },
  242. VIDEO_EVENTS: {
  243. COUNT: { min: 0 }
  244. },
  245. VIDEO_COMMENTS: {
  246. TEXT: { min: 1, max: 3000 }, // Length
  247. URL: { min: 3, max: 2000 } // Length
  248. },
  249. VIDEO_SHARE: {
  250. URL: { min: 3, max: 2000 } // Length
  251. },
  252. CONTACT_FORM: {
  253. FROM_NAME: { min: 1, max: 120 }, // Length
  254. BODY: { min: 3, max: 5000 } // Length
  255. }
  256. }
  257. const RATES_LIMIT = {
  258. LOGIN: {
  259. WINDOW_MS: 5 * 60 * 1000, // 5 minutes
  260. MAX: 15 // 15 attempts
  261. },
  262. ASK_SEND_EMAIL: {
  263. WINDOW_MS: 5 * 60 * 1000, // 5 minutes
  264. MAX: 3 // 3 attempts
  265. }
  266. }
  267. let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
  268. let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
  269. const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
  270. MIN: 10,
  271. AVERAGE: 30,
  272. MAX: 60,
  273. KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
  274. }
  275. const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
  276. LIKE: 'like',
  277. DISLIKE: 'dislike'
  278. }
  279. const FFMPEG_NICE: { [ id: string ]: number } = {
  280. THUMBNAIL: 2, // 2 just for don't blocking servers
  281. TRANSCODING: 15
  282. }
  283. const VIDEO_CATEGORIES = {
  284. 1: 'Music',
  285. 2: 'Films',
  286. 3: 'Vehicles',
  287. 4: 'Art',
  288. 5: 'Sports',
  289. 6: 'Travels',
  290. 7: 'Gaming',
  291. 8: 'People',
  292. 9: 'Comedy',
  293. 10: 'Entertainment',
  294. 11: 'News & Politics',
  295. 12: 'How To',
  296. 13: 'Education',
  297. 14: 'Activism',
  298. 15: 'Science & Technology',
  299. 16: 'Animals',
  300. 17: 'Kids',
  301. 18: 'Food'
  302. }
  303. // See https://creativecommons.org/licenses/?lang=en
  304. const VIDEO_LICENCES = {
  305. 1: 'Attribution',
  306. 2: 'Attribution - Share Alike',
  307. 3: 'Attribution - No Derivatives',
  308. 4: 'Attribution - Non Commercial',
  309. 5: 'Attribution - Non Commercial - Share Alike',
  310. 6: 'Attribution - Non Commercial - No Derivatives',
  311. 7: 'Public Domain Dedication'
  312. }
  313. let VIDEO_LANGUAGES: { [id: string]: string } = {}
  314. const VIDEO_PRIVACIES = {
  315. [ VideoPrivacy.PUBLIC ]: 'Public',
  316. [ VideoPrivacy.UNLISTED ]: 'Unlisted',
  317. [ VideoPrivacy.PRIVATE ]: 'Private'
  318. }
  319. const VIDEO_STATES = {
  320. [ VideoState.PUBLISHED ]: 'Published',
  321. [ VideoState.TO_TRANSCODE ]: 'To transcode',
  322. [ VideoState.TO_IMPORT ]: 'To import'
  323. }
  324. const VIDEO_IMPORT_STATES = {
  325. [ VideoImportState.FAILED ]: 'Failed',
  326. [ VideoImportState.PENDING ]: 'Pending',
  327. [ VideoImportState.SUCCESS ]: 'Success'
  328. }
  329. const VIDEO_ABUSE_STATES = {
  330. [ VideoAbuseState.PENDING ]: 'Pending',
  331. [ VideoAbuseState.REJECTED ]: 'Rejected',
  332. [ VideoAbuseState.ACCEPTED ]: 'Accepted'
  333. }
  334. const VIDEO_PLAYLIST_PRIVACIES = {
  335. [ VideoPlaylistPrivacy.PUBLIC ]: 'Public',
  336. [ VideoPlaylistPrivacy.UNLISTED ]: 'Unlisted',
  337. [ VideoPlaylistPrivacy.PRIVATE ]: 'Private'
  338. }
  339. const VIDEO_PLAYLIST_TYPES = {
  340. [ VideoPlaylistType.REGULAR ]: 'Regular',
  341. [ VideoPlaylistType.WATCH_LATER ]: 'Watch later'
  342. }
  343. const MIMETYPES = {
  344. VIDEO: {
  345. MIMETYPE_EXT: buildVideoMimetypeExt(),
  346. EXT_MIMETYPE: null as { [ id: string ]: string }
  347. },
  348. IMAGE: {
  349. MIMETYPE_EXT: {
  350. 'image/png': '.png',
  351. 'image/jpg': '.jpg',
  352. 'image/jpeg': '.jpg'
  353. }
  354. },
  355. VIDEO_CAPTIONS: {
  356. MIMETYPE_EXT: {
  357. 'text/vtt': '.vtt',
  358. 'application/x-subrip': '.srt'
  359. }
  360. },
  361. TORRENT: {
  362. MIMETYPE_EXT: {
  363. 'application/x-bittorrent': '.torrent'
  364. }
  365. }
  366. }
  367. MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
  368. // ---------------------------------------------------------------------------
  369. const OVERVIEWS = {
  370. VIDEOS: {
  371. SAMPLE_THRESHOLD: 6,
  372. SAMPLES_COUNT: 2
  373. }
  374. }
  375. // ---------------------------------------------------------------------------
  376. const SERVER_ACTOR_NAME = 'peertube'
  377. const ACTIVITY_PUB = {
  378. POTENTIAL_ACCEPT_HEADERS: [
  379. 'application/activity+json',
  380. 'application/ld+json',
  381. 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
  382. ],
  383. ACCEPT_HEADER: 'application/activity+json, application/ld+json',
  384. PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
  385. COLLECTION_ITEMS_PER_PAGE: 10,
  386. FETCH_PAGE_LIMIT: 100,
  387. URL_MIME_TYPES: {
  388. VIDEO: Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT),
  389. TORRENT: [ 'application/x-bittorrent' ],
  390. MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
  391. },
  392. MAX_RECURSION_COMMENTS: 100,
  393. ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
  394. VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
  395. VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
  396. }
  397. const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
  398. GROUP: 'Group',
  399. PERSON: 'Person',
  400. APPLICATION: 'Application'
  401. }
  402. const HTTP_SIGNATURE = {
  403. HEADER_NAME: 'signature',
  404. ALGORITHM: 'rsa-sha256',
  405. HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
  406. }
  407. // ---------------------------------------------------------------------------
  408. let PRIVATE_RSA_KEY_SIZE = 2048
  409. // Password encryption
  410. const BCRYPT_SALT_SIZE = 10
  411. const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
  412. const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
  413. const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
  414. DO_NOT_LIST: 'do_not_list',
  415. BLUR: 'blur',
  416. DISPLAY: 'display'
  417. }
  418. // ---------------------------------------------------------------------------
  419. // Express static paths (router)
  420. const STATIC_PATHS = {
  421. PREVIEWS: '/static/previews/',
  422. THUMBNAILS: '/static/thumbnails/',
  423. TORRENTS: '/static/torrents/',
  424. WEBSEED: '/static/webseed/',
  425. REDUNDANCY: '/static/redundancy/',
  426. STREAMING_PLAYLISTS: {
  427. HLS: '/static/streaming-playlists/hls'
  428. },
  429. AVATARS: '/static/avatars/',
  430. VIDEO_CAPTIONS: '/static/video-captions/'
  431. }
  432. const STATIC_DOWNLOAD_PATHS = {
  433. TORRENTS: '/download/torrents/',
  434. VIDEOS: '/download/videos/'
  435. }
  436. // Cache control
  437. let STATIC_MAX_AGE = '2h'
  438. // Videos thumbnail size
  439. const THUMBNAILS_SIZE = {
  440. width: 223,
  441. height: 122
  442. }
  443. const PREVIEWS_SIZE = {
  444. width: 560,
  445. height: 315
  446. }
  447. const AVATARS_SIZE = {
  448. width: 120,
  449. height: 120
  450. }
  451. const EMBED_SIZE = {
  452. width: 560,
  453. height: 315
  454. }
  455. // Sub folders of cache directory
  456. const FILES_CACHE = {
  457. PREVIEWS: {
  458. DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
  459. MAX_AGE: 1000 * 3600 * 3 // 3 hours
  460. },
  461. VIDEO_CAPTIONS: {
  462. DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
  463. MAX_AGE: 1000 * 3600 * 3 // 3 hours
  464. }
  465. }
  466. const CACHE = {
  467. USER_TOKENS: {
  468. MAX_SIZE: 10000
  469. }
  470. }
  471. const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
  472. const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
  473. const MEMOIZE_TTL = {
  474. OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
  475. }
  476. const REDUNDANCY = {
  477. VIDEOS: {
  478. RANDOMIZED_FACTOR: 5
  479. }
  480. }
  481. const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
  482. // ---------------------------------------------------------------------------
  483. const CUSTOM_HTML_TAG_COMMENTS = {
  484. TITLE: '<!-- title tag -->',
  485. DESCRIPTION: '<!-- description tag -->',
  486. CUSTOM_CSS: '<!-- custom css tag -->',
  487. META_TAGS: '<!-- meta tags -->'
  488. }
  489. // ---------------------------------------------------------------------------
  490. const FEEDS = {
  491. COUNT: 20
  492. }
  493. const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
  494. // ---------------------------------------------------------------------------
  495. const TRACKER_RATE_LIMITS = {
  496. INTERVAL: 60000 * 5, // 5 minutes
  497. ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
  498. ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
  499. }
  500. const P2P_MEDIA_LOADER_PEER_VERSION = 2
  501. // ---------------------------------------------------------------------------
  502. // Special constants for a test instance
  503. if (isTestInstance() === true) {
  504. PRIVATE_RSA_KEY_SIZE = 1024
  505. ACTOR_FOLLOW_SCORE.BASE = 20
  506. REMOTE_SCHEME.HTTP = 'http'
  507. REMOTE_SCHEME.WS = 'ws'
  508. STATIC_MAX_AGE = '0'
  509. ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
  510. ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  511. ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  512. ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  513. CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
  514. SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
  515. SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
  516. SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
  517. SCHEDULER_INTERVALS_MS.updateVideos = 5000
  518. REPEAT_JOBS[ 'videos-views' ] = { every: 5000 }
  519. REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
  520. VIDEO_VIEW_LIFETIME = 1000 // 1 second
  521. CONTACT_FORM_LIFETIME = 1000 // 1 second
  522. JOB_ATTEMPTS[ 'email' ] = 1
  523. FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
  524. MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
  525. ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
  526. RATES_LIMIT.LOGIN.MAX = 20
  527. }
  528. updateWebserverUrls()
  529. registerConfigChangedHandler(() => {
  530. updateWebserverUrls()
  531. updateWebserverConfig()
  532. })
  533. // ---------------------------------------------------------------------------
  534. export {
  535. WEBSERVER,
  536. API_VERSION,
  537. HLS_REDUNDANCY_DIRECTORY,
  538. P2P_MEDIA_LOADER_PEER_VERSION,
  539. AVATARS_SIZE,
  540. ACCEPT_HEADERS,
  541. BCRYPT_SALT_SIZE,
  542. TRACKER_RATE_LIMITS,
  543. FILES_CACHE,
  544. CONSTRAINTS_FIELDS,
  545. EMBED_SIZE,
  546. REDUNDANCY,
  547. JOB_CONCURRENCY,
  548. JOB_ATTEMPTS,
  549. LAST_MIGRATION_VERSION,
  550. OAUTH_LIFETIME,
  551. CUSTOM_HTML_TAG_COMMENTS,
  552. BROADCAST_CONCURRENCY,
  553. PAGINATION,
  554. ACTOR_FOLLOW_SCORE,
  555. PREVIEWS_SIZE,
  556. REMOTE_SCHEME,
  557. FOLLOW_STATES,
  558. SERVER_ACTOR_NAME,
  559. PRIVATE_RSA_KEY_SIZE,
  560. ROUTE_CACHE_LIFETIME,
  561. SORTABLE_COLUMNS,
  562. HLS_STREAMING_PLAYLIST_DIRECTORY,
  563. FEEDS,
  564. JOB_TTL,
  565. NSFW_POLICY_TYPES,
  566. STATIC_MAX_AGE,
  567. STATIC_PATHS,
  568. VIDEO_IMPORT_TIMEOUT,
  569. VIDEO_PLAYLIST_TYPES,
  570. MAX_LOGS_OUTPUT_CHARACTERS,
  571. ACTIVITY_PUB,
  572. ACTIVITY_PUB_ACTOR_TYPES,
  573. THUMBNAILS_SIZE,
  574. VIDEO_CATEGORIES,
  575. VIDEO_LANGUAGES,
  576. VIDEO_PRIVACIES,
  577. VIDEO_LICENCES,
  578. VIDEO_STATES,
  579. VIDEO_RATE_TYPES,
  580. VIDEO_TRANSCODING_FPS,
  581. FFMPEG_NICE,
  582. VIDEO_ABUSE_STATES,
  583. CACHE,
  584. JOB_REQUEST_TIMEOUT,
  585. USER_PASSWORD_RESET_LIFETIME,
  586. MEMOIZE_TTL,
  587. USER_EMAIL_VERIFY_LIFETIME,
  588. OVERVIEWS,
  589. SCHEDULER_INTERVALS_MS,
  590. REPEAT_JOBS,
  591. STATIC_DOWNLOAD_PATHS,
  592. RATES_LIMIT,
  593. MIMETYPES,
  594. CRAWL_REQUEST_CONCURRENCY,
  595. JOB_COMPLETED_LIFETIME,
  596. HTTP_SIGNATURE,
  597. VIDEO_IMPORT_STATES,
  598. VIDEO_VIEW_LIFETIME,
  599. CONTACT_FORM_LIFETIME,
  600. VIDEO_PLAYLIST_PRIVACIES,
  601. loadLanguages,
  602. buildLanguages
  603. }
  604. // ---------------------------------------------------------------------------
  605. function buildVideoMimetypeExt () {
  606. const data = {
  607. 'video/webm': '.webm',
  608. 'video/ogg': '.ogv',
  609. 'video/mp4': '.mp4'
  610. }
  611. if (CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
  612. Object.assign(data, {
  613. 'video/quicktime': '.mov',
  614. 'video/x-msvideo': '.avi',
  615. 'video/x-flv': '.flv',
  616. 'video/x-matroska': '.mkv',
  617. 'application/octet-stream': '.mkv',
  618. 'video/avi': '.avi'
  619. })
  620. }
  621. return data
  622. }
  623. function updateWebserverUrls () {
  624. WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
  625. WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
  626. WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
  627. WEBSERVER.WS = CONFIG.WEBSERVER.WS
  628. WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
  629. WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
  630. }
  631. function updateWebserverConfig () {
  632. CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
  633. MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
  634. MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
  635. }
  636. function buildVideosExtname () {
  637. return CONFIG.TRANSCODING.ENABLED && CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS
  638. ? [ '.mp4', '.ogv', '.webm', '.mkv', '.mov', '.avi', '.flv' ]
  639. : [ '.mp4', '.ogv', '.webm' ]
  640. }
  641. function loadLanguages () {
  642. Object.assign(VIDEO_LANGUAGES, buildLanguages())
  643. }
  644. function buildLanguages () {
  645. const iso639 = require('iso-639-3')
  646. const languages: { [ id: string ]: string } = {}
  647. const additionalLanguages = {
  648. 'sgn': true, // Sign languages (macro language)
  649. 'ase': true, // American sign language
  650. 'sdl': true, // Arabian sign language
  651. 'bfi': true, // British sign language
  652. 'bzs': true, // Brazilian sign language
  653. 'csl': true, // Chinese sign language
  654. 'cse': true, // Czech sign language
  655. 'dsl': true, // Danish sign language
  656. 'fsl': true, // French sign language
  657. 'gsg': true, // German sign language
  658. 'pks': true, // Pakistan sign language
  659. 'jsl': true, // Japanese sign language
  660. 'sfs': true, // South African sign language
  661. 'swl': true, // Swedish sign language
  662. 'rsl': true, // Russian sign language: true
  663. 'epo': true, // Esperanto
  664. 'tlh': true, // Klingon
  665. 'jbo': true, // Lojban
  666. 'avk': true // Kotava
  667. }
  668. // Only add ISO639-1 languages and some sign languages (ISO639-3)
  669. iso639
  670. .filter(l => {
  671. return (l.iso6391 !== null && l.type === 'living') ||
  672. additionalLanguages[ l.iso6393 ] === true
  673. })
  674. .forEach(l => languages[ l.iso6391 || l.iso6393 ] = l.name)
  675. // Override Occitan label
  676. languages[ 'oc' ] = 'Occitan'
  677. return languages
  678. }