constants.ts 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834
  1. import { join } from 'path'
  2. import { JobType, VideoRateType, VideoResolution, 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, root, parseDurationToMs } 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 = 420
  16. // ---------------------------------------------------------------------------
  17. const API_VERSION = 'v1'
  18. const PEERTUBE_VERSION = require(join(root(), 'package.json')).version
  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', 'videoQuotaUsed', '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. PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
  55. AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ]
  56. }
  57. const OAUTH_LIFETIME = {
  58. ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
  59. REFRESH_TOKEN: 1209600 // 2 weeks
  60. }
  61. const ROUTE_CACHE_LIFETIME = {
  62. FEEDS: '15 minutes',
  63. ROBOTS: '2 hours',
  64. SITEMAP: '1 day',
  65. SECURITYTXT: '2 hours',
  66. NODEINFO: '10 minutes',
  67. DNT_POLICY: '1 week',
  68. OVERVIEWS: {
  69. VIDEOS: '1 hour'
  70. },
  71. ACTIVITY_PUB: {
  72. VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
  73. },
  74. STATS: '4 hours'
  75. }
  76. // ---------------------------------------------------------------------------
  77. // Number of points we add/remove after a successful/bad request
  78. const ACTOR_FOLLOW_SCORE = {
  79. PENALTY: -10,
  80. BONUS: 10,
  81. BASE: 1000,
  82. MAX: 10000
  83. }
  84. const FOLLOW_STATES: { [ id: string ]: FollowState } = {
  85. PENDING: 'pending',
  86. ACCEPTED: 'accepted'
  87. }
  88. const REMOTE_SCHEME = {
  89. HTTP: 'https',
  90. WS: 'wss'
  91. }
  92. // TODO: remove 'video-file'
  93. const JOB_ATTEMPTS: { [id in (JobType | 'video-file')]: number } = {
  94. 'activitypub-http-broadcast': 5,
  95. 'activitypub-http-unicast': 5,
  96. 'activitypub-http-fetcher': 5,
  97. 'activitypub-follow': 5,
  98. 'video-file-import': 1,
  99. 'video-transcoding': 1,
  100. 'video-file': 1,
  101. 'video-import': 1,
  102. 'email': 5,
  103. 'videos-views': 1,
  104. 'activitypub-refresher': 1
  105. }
  106. const JOB_CONCURRENCY: { [id in (JobType | 'video-file')]: number } = {
  107. 'activitypub-http-broadcast': 1,
  108. 'activitypub-http-unicast': 5,
  109. 'activitypub-http-fetcher': 1,
  110. 'activitypub-follow': 3,
  111. 'video-file-import': 1,
  112. 'video-transcoding': 1,
  113. 'video-file': 1,
  114. 'video-import': 1,
  115. 'email': 5,
  116. 'videos-views': 1,
  117. 'activitypub-refresher': 1
  118. }
  119. const JOB_TTL: { [id in (JobType | 'video-file')]: number } = {
  120. 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
  121. 'activitypub-http-unicast': 60000 * 10, // 10 minutes
  122. 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
  123. 'activitypub-follow': 60000 * 10, // 10 minutes
  124. 'video-file-import': 1000 * 3600, // 1 hour
  125. 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
  126. 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
  127. 'video-import': 1000 * 3600 * 2, // hours
  128. 'email': 60000 * 10, // 10 minutes
  129. 'videos-views': undefined, // Unlimited
  130. 'activitypub-refresher': 60000 * 10 // 10 minutes
  131. }
  132. const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
  133. 'videos-views': {
  134. cron: '1 * * * *' // At 1 minute past the hour
  135. }
  136. }
  137. const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
  138. const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
  139. const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
  140. const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
  141. const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
  142. const SCHEDULER_INTERVALS_MS = {
  143. actorFollowScores: 60000 * 60, // 1 hour
  144. removeOldJobs: 60000 * 60, // 1 hour
  145. updateVideos: 60000, // 1 minute
  146. youtubeDLUpdate: 60000 * 60 * 24, // 1 day
  147. checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
  148. removeOldViews: 60000 * 60 * 24, // 1 day
  149. removeOldHistory: 60000 * 60 * 24 // 1 day
  150. }
  151. // ---------------------------------------------------------------------------
  152. const CONSTRAINTS_FIELDS = {
  153. USERS: {
  154. NAME: { min: 1, max: 120 }, // Length
  155. DESCRIPTION: { min: 3, max: 1000 }, // Length
  156. USERNAME: { min: 1, max: 50 }, // Length
  157. PASSWORD: { min: 6, max: 255 }, // Length
  158. VIDEO_QUOTA: { min: -1 },
  159. VIDEO_QUOTA_DAILY: { min: -1 },
  160. VIDEO_LANGUAGES: { max: 500 }, // Array length
  161. BLOCKED_REASON: { min: 3, max: 250 } // Length
  162. },
  163. VIDEO_ABUSES: {
  164. REASON: { min: 2, max: 3000 }, // Length
  165. MODERATION_COMMENT: { min: 2, max: 3000 } // Length
  166. },
  167. VIDEO_BLACKLIST: {
  168. REASON: { min: 2, max: 300 } // Length
  169. },
  170. VIDEO_CHANNELS: {
  171. NAME: { min: 1, max: 120 }, // Length
  172. DESCRIPTION: { min: 3, max: 1000 }, // Length
  173. SUPPORT: { min: 3, max: 1000 }, // Length
  174. URL: { min: 3, max: 2000 } // Length
  175. },
  176. VIDEO_CAPTIONS: {
  177. CAPTION_FILE: {
  178. EXTNAME: [ '.vtt', '.srt' ],
  179. FILE_SIZE: {
  180. max: 2 * 1024 * 1024 // 2MB
  181. }
  182. }
  183. },
  184. VIDEO_IMPORTS: {
  185. URL: { min: 3, max: 2000 }, // Length
  186. TORRENT_NAME: { min: 3, max: 255 }, // Length
  187. TORRENT_FILE: {
  188. EXTNAME: [ '.torrent' ],
  189. FILE_SIZE: {
  190. max: 1024 * 200 // 200 KB
  191. }
  192. }
  193. },
  194. VIDEOS_REDUNDANCY: {
  195. URL: { min: 3, max: 2000 } // Length
  196. },
  197. VIDEO_RATES: {
  198. URL: { min: 3, max: 2000 } // Length
  199. },
  200. VIDEOS: {
  201. NAME: { min: 3, max: 120 }, // Length
  202. LANGUAGE: { min: 1, max: 10 }, // Length
  203. TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
  204. DESCRIPTION: { min: 3, max: 10000 }, // Length
  205. SUPPORT: { min: 3, max: 1000 }, // Length
  206. IMAGE: {
  207. EXTNAME: [ '.jpg', '.jpeg' ],
  208. FILE_SIZE: {
  209. max: 2 * 1024 * 1024 // 2MB
  210. }
  211. },
  212. EXTNAME: [] as string[],
  213. INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
  214. DURATION: { min: 0 }, // Number
  215. TAGS: { min: 0, max: 5 }, // Number of total tags
  216. TAG: { min: 2, max: 30 }, // Length
  217. THUMBNAIL: { min: 2, max: 30 },
  218. THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
  219. VIEWS: { min: 0 },
  220. LIKES: { min: 0 },
  221. DISLIKES: { min: 0 },
  222. FILE_SIZE: { min: 10 },
  223. URL: { min: 3, max: 2000 } // Length
  224. },
  225. VIDEO_PLAYLISTS: {
  226. NAME: { min: 1, max: 120 }, // Length
  227. DESCRIPTION: { min: 3, max: 1000 }, // Length
  228. URL: { min: 3, max: 2000 }, // Length
  229. IMAGE: {
  230. EXTNAME: [ '.jpg', '.jpeg' ],
  231. FILE_SIZE: {
  232. max: 2 * 1024 * 1024 // 2MB
  233. }
  234. }
  235. },
  236. ACTORS: {
  237. PUBLIC_KEY: { min: 10, max: 5000 }, // Length
  238. PRIVATE_KEY: { min: 10, max: 5000 }, // Length
  239. URL: { min: 3, max: 2000 }, // Length
  240. AVATAR: {
  241. EXTNAME: [ '.png', '.jpeg', '.jpg' ],
  242. FILE_SIZE: {
  243. max: 2 * 1024 * 1024 // 2MB
  244. }
  245. }
  246. },
  247. VIDEO_EVENTS: {
  248. COUNT: { min: 0 }
  249. },
  250. VIDEO_COMMENTS: {
  251. TEXT: { min: 1, max: 3000 }, // Length
  252. URL: { min: 3, max: 2000 } // Length
  253. },
  254. VIDEO_SHARE: {
  255. URL: { min: 3, max: 2000 } // Length
  256. },
  257. CONTACT_FORM: {
  258. FROM_NAME: { min: 1, max: 120 }, // Length
  259. BODY: { min: 3, max: 5000 } // Length
  260. },
  261. PLUGINS: {
  262. NAME: { min: 1, max: 214 }, // Length
  263. DESCRIPTION: { min: 1, max: 20000 } // Length
  264. }
  265. }
  266. let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
  267. let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
  268. const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
  269. MIN: 10,
  270. AVERAGE: 30,
  271. MAX: 60,
  272. KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
  273. }
  274. const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
  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. AUDIO: {
  345. MIMETYPE_EXT: {
  346. 'audio/mpeg': '.mp3',
  347. 'audio/mp3': '.mp3',
  348. 'application/ogg': '.ogg',
  349. 'audio/ogg': '.ogg',
  350. 'audio/flac': '.flac'
  351. },
  352. EXT_MIMETYPE: null as { [ id: string ]: string }
  353. },
  354. VIDEO: {
  355. MIMETYPE_EXT: null as { [ id: string ]: string },
  356. EXT_MIMETYPE: null as { [ id: string ]: string }
  357. },
  358. IMAGE: {
  359. MIMETYPE_EXT: {
  360. 'image/png': '.png',
  361. 'image/jpg': '.jpg',
  362. 'image/jpeg': '.jpg'
  363. }
  364. },
  365. VIDEO_CAPTIONS: {
  366. MIMETYPE_EXT: {
  367. 'text/vtt': '.vtt',
  368. 'application/x-subrip': '.srt'
  369. }
  370. },
  371. TORRENT: {
  372. MIMETYPE_EXT: {
  373. 'application/x-bittorrent': '.torrent'
  374. }
  375. }
  376. }
  377. MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
  378. // ---------------------------------------------------------------------------
  379. const OVERVIEWS = {
  380. VIDEOS: {
  381. SAMPLE_THRESHOLD: 6,
  382. SAMPLES_COUNT: 2
  383. }
  384. }
  385. // ---------------------------------------------------------------------------
  386. const SERVER_ACTOR_NAME = 'peertube'
  387. const ACTIVITY_PUB = {
  388. POTENTIAL_ACCEPT_HEADERS: [
  389. 'application/activity+json',
  390. 'application/ld+json',
  391. 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
  392. ],
  393. ACCEPT_HEADER: 'application/activity+json, application/ld+json',
  394. PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
  395. COLLECTION_ITEMS_PER_PAGE: 10,
  396. FETCH_PAGE_LIMIT: 100,
  397. URL_MIME_TYPES: {
  398. VIDEO: [] as string[],
  399. TORRENT: [ 'application/x-bittorrent' ],
  400. MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
  401. },
  402. MAX_RECURSION_COMMENTS: 100,
  403. ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
  404. VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
  405. VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
  406. }
  407. const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
  408. GROUP: 'Group',
  409. PERSON: 'Person',
  410. APPLICATION: 'Application'
  411. }
  412. const HTTP_SIGNATURE = {
  413. HEADER_NAME: 'signature',
  414. ALGORITHM: 'rsa-sha256',
  415. HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
  416. }
  417. // ---------------------------------------------------------------------------
  418. let PRIVATE_RSA_KEY_SIZE = 2048
  419. // Password encryption
  420. const BCRYPT_SALT_SIZE = 10
  421. const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
  422. const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
  423. const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
  424. DO_NOT_LIST: 'do_not_list',
  425. BLUR: 'blur',
  426. DISPLAY: 'display'
  427. }
  428. // ---------------------------------------------------------------------------
  429. // Express static paths (router)
  430. const STATIC_PATHS = {
  431. PREVIEWS: '/static/previews/',
  432. THUMBNAILS: '/static/thumbnails/',
  433. TORRENTS: '/static/torrents/',
  434. WEBSEED: '/static/webseed/',
  435. REDUNDANCY: '/static/redundancy/',
  436. STREAMING_PLAYLISTS: {
  437. HLS: '/static/streaming-playlists/hls'
  438. },
  439. AVATARS: '/static/avatars/',
  440. VIDEO_CAPTIONS: '/static/video-captions/'
  441. }
  442. const STATIC_DOWNLOAD_PATHS = {
  443. TORRENTS: '/download/torrents/',
  444. VIDEOS: '/download/videos/'
  445. }
  446. const LAZY_STATIC_PATHS = {
  447. AVATARS: '/lazy-static/avatars/',
  448. PREVIEWS: '/static/previews/',
  449. VIDEO_CAPTIONS: '/static/video-captions/'
  450. }
  451. // Cache control
  452. let STATIC_MAX_AGE = {
  453. SERVER: '2h',
  454. CLIENT: '30d'
  455. }
  456. // Videos thumbnail size
  457. const THUMBNAILS_SIZE = {
  458. width: 223,
  459. height: 122
  460. }
  461. const PREVIEWS_SIZE = {
  462. width: 850,
  463. height: 480
  464. }
  465. const AVATARS_SIZE = {
  466. width: 120,
  467. height: 120
  468. }
  469. const EMBED_SIZE = {
  470. width: 560,
  471. height: 315
  472. }
  473. // Sub folders of cache directory
  474. const FILES_CACHE = {
  475. PREVIEWS: {
  476. DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
  477. MAX_AGE: 1000 * 3600 * 3 // 3 hours
  478. },
  479. VIDEO_CAPTIONS: {
  480. DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
  481. MAX_AGE: 1000 * 3600 * 3 // 3 hours
  482. }
  483. }
  484. const LRU_CACHE = {
  485. USER_TOKENS: {
  486. MAX_SIZE: 1000
  487. },
  488. AVATAR_STATIC: {
  489. MAX_SIZE: 500
  490. }
  491. }
  492. const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
  493. const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
  494. const MEMOIZE_TTL = {
  495. OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
  496. }
  497. const QUEUE_CONCURRENCY = {
  498. AVATAR_PROCESS_IMAGE: 3
  499. }
  500. const REDUNDANCY = {
  501. VIDEOS: {
  502. RANDOMIZED_FACTOR: 5
  503. }
  504. }
  505. const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
  506. const ASSETS_PATH = {
  507. DEFAULT_AUDIO_BACKGROUND: join(root(), 'server', 'assets', 'default-audio-background.jpg')
  508. }
  509. // ---------------------------------------------------------------------------
  510. const CUSTOM_HTML_TAG_COMMENTS = {
  511. TITLE: '<!-- title tag -->',
  512. DESCRIPTION: '<!-- description tag -->',
  513. CUSTOM_CSS: '<!-- custom css tag -->',
  514. META_TAGS: '<!-- meta tags -->'
  515. }
  516. // ---------------------------------------------------------------------------
  517. const FEEDS = {
  518. COUNT: 20
  519. }
  520. const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
  521. // ---------------------------------------------------------------------------
  522. const TRACKER_RATE_LIMITS = {
  523. INTERVAL: 60000 * 5, // 5 minutes
  524. ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
  525. ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
  526. }
  527. const P2P_MEDIA_LOADER_PEER_VERSION = 2
  528. // ---------------------------------------------------------------------------
  529. const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
  530. const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
  531. const DEFAULT_THEME_NAME = 'default'
  532. const DEFAULT_USER_THEME_NAME = 'instance-default'
  533. // ---------------------------------------------------------------------------
  534. // Special constants for a test instance
  535. if (isTestInstance() === true) {
  536. PRIVATE_RSA_KEY_SIZE = 1024
  537. ACTOR_FOLLOW_SCORE.BASE = 20
  538. REMOTE_SCHEME.HTTP = 'http'
  539. REMOTE_SCHEME.WS = 'ws'
  540. STATIC_MAX_AGE.SERVER = '0'
  541. ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
  542. ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  543. ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  544. ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
  545. CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
  546. SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
  547. SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
  548. SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
  549. SCHEDULER_INTERVALS_MS.removeOldViews = 5000
  550. SCHEDULER_INTERVALS_MS.updateVideos = 5000
  551. REPEAT_JOBS[ 'videos-views' ] = { every: 5000 }
  552. REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
  553. VIDEO_VIEW_LIFETIME = 1000 // 1 second
  554. CONTACT_FORM_LIFETIME = 1000 // 1 second
  555. JOB_ATTEMPTS[ 'email' ] = 1
  556. FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
  557. MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
  558. ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
  559. }
  560. updateWebserverUrls()
  561. updateWebserverConfig()
  562. registerConfigChangedHandler(() => {
  563. updateWebserverUrls()
  564. updateWebserverConfig()
  565. })
  566. // ---------------------------------------------------------------------------
  567. export {
  568. WEBSERVER,
  569. API_VERSION,
  570. PEERTUBE_VERSION,
  571. LAZY_STATIC_PATHS,
  572. HLS_REDUNDANCY_DIRECTORY,
  573. P2P_MEDIA_LOADER_PEER_VERSION,
  574. AVATARS_SIZE,
  575. ACCEPT_HEADERS,
  576. BCRYPT_SALT_SIZE,
  577. TRACKER_RATE_LIMITS,
  578. FILES_CACHE,
  579. CONSTRAINTS_FIELDS,
  580. EMBED_SIZE,
  581. REDUNDANCY,
  582. JOB_CONCURRENCY,
  583. JOB_ATTEMPTS,
  584. LAST_MIGRATION_VERSION,
  585. OAUTH_LIFETIME,
  586. CUSTOM_HTML_TAG_COMMENTS,
  587. BROADCAST_CONCURRENCY,
  588. PAGINATION,
  589. ACTOR_FOLLOW_SCORE,
  590. PREVIEWS_SIZE,
  591. REMOTE_SCHEME,
  592. FOLLOW_STATES,
  593. DEFAULT_USER_THEME_NAME,
  594. SERVER_ACTOR_NAME,
  595. PLUGIN_GLOBAL_CSS_FILE_NAME,
  596. PLUGIN_GLOBAL_CSS_PATH,
  597. PRIVATE_RSA_KEY_SIZE,
  598. ROUTE_CACHE_LIFETIME,
  599. SORTABLE_COLUMNS,
  600. HLS_STREAMING_PLAYLIST_DIRECTORY,
  601. FEEDS,
  602. JOB_TTL,
  603. DEFAULT_THEME_NAME,
  604. NSFW_POLICY_TYPES,
  605. STATIC_MAX_AGE,
  606. STATIC_PATHS,
  607. VIDEO_IMPORT_TIMEOUT,
  608. VIDEO_PLAYLIST_TYPES,
  609. MAX_LOGS_OUTPUT_CHARACTERS,
  610. ACTIVITY_PUB,
  611. ACTIVITY_PUB_ACTOR_TYPES,
  612. THUMBNAILS_SIZE,
  613. VIDEO_CATEGORIES,
  614. VIDEO_LANGUAGES,
  615. VIDEO_PRIVACIES,
  616. VIDEO_LICENCES,
  617. VIDEO_STATES,
  618. QUEUE_CONCURRENCY,
  619. VIDEO_RATE_TYPES,
  620. VIDEO_TRANSCODING_FPS,
  621. FFMPEG_NICE,
  622. VIDEO_ABUSE_STATES,
  623. LRU_CACHE,
  624. JOB_REQUEST_TIMEOUT,
  625. USER_PASSWORD_RESET_LIFETIME,
  626. MEMOIZE_TTL,
  627. USER_EMAIL_VERIFY_LIFETIME,
  628. OVERVIEWS,
  629. SCHEDULER_INTERVALS_MS,
  630. REPEAT_JOBS,
  631. STATIC_DOWNLOAD_PATHS,
  632. MIMETYPES,
  633. CRAWL_REQUEST_CONCURRENCY,
  634. DEFAULT_AUDIO_RESOLUTION,
  635. JOB_COMPLETED_LIFETIME,
  636. HTTP_SIGNATURE,
  637. VIDEO_IMPORT_STATES,
  638. VIDEO_VIEW_LIFETIME,
  639. CONTACT_FORM_LIFETIME,
  640. VIDEO_PLAYLIST_PRIVACIES,
  641. ASSETS_PATH,
  642. loadLanguages,
  643. buildLanguages
  644. }
  645. // ---------------------------------------------------------------------------
  646. function buildVideoMimetypeExt () {
  647. const data = {
  648. 'video/webm': '.webm',
  649. 'video/ogg': '.ogv',
  650. 'video/mp4': '.mp4'
  651. }
  652. if (CONFIG.TRANSCODING.ENABLED) {
  653. if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
  654. Object.assign(data, {
  655. 'video/quicktime': '.mov',
  656. 'video/x-msvideo': '.avi',
  657. 'video/x-flv': '.flv',
  658. 'video/x-matroska': '.mkv',
  659. 'application/octet-stream': '.mkv',
  660. 'video/avi': '.avi'
  661. })
  662. }
  663. if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
  664. Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
  665. }
  666. }
  667. return data
  668. }
  669. function updateWebserverUrls () {
  670. WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
  671. WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
  672. WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
  673. WEBSERVER.WS = CONFIG.WEBSERVER.WS
  674. WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
  675. WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
  676. }
  677. function updateWebserverConfig () {
  678. MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
  679. MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
  680. ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
  681. CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
  682. }
  683. function buildVideosExtname () {
  684. return Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
  685. }
  686. function loadLanguages () {
  687. Object.assign(VIDEO_LANGUAGES, buildLanguages())
  688. }
  689. function buildLanguages () {
  690. const iso639 = require('iso-639-3')
  691. const languages: { [ id: string ]: string } = {}
  692. const additionalLanguages = {
  693. 'sgn': true, // Sign languages (macro language)
  694. 'ase': true, // American sign language
  695. 'sdl': true, // Arabian sign language
  696. 'bfi': true, // British sign language
  697. 'bzs': true, // Brazilian sign language
  698. 'csl': true, // Chinese sign language
  699. 'cse': true, // Czech sign language
  700. 'dsl': true, // Danish sign language
  701. 'fsl': true, // French sign language
  702. 'gsg': true, // German sign language
  703. 'pks': true, // Pakistan sign language
  704. 'jsl': true, // Japanese sign language
  705. 'sfs': true, // South African sign language
  706. 'swl': true, // Swedish sign language
  707. 'rsl': true, // Russian sign language: true
  708. 'epo': true, // Esperanto
  709. 'tlh': true, // Klingon
  710. 'jbo': true, // Lojban
  711. 'avk': true // Kotava
  712. }
  713. // Only add ISO639-1 languages and some sign languages (ISO639-3)
  714. iso639
  715. .filter(l => {
  716. return (l.iso6391 !== null && l.type === 'living') ||
  717. additionalLanguages[ l.iso6393 ] === true
  718. })
  719. .forEach(l => languages[ l.iso6391 || l.iso6393 ] = l.name)
  720. // Override Occitan label
  721. languages[ 'oc' ] = 'Occitan'
  722. languages[ 'el' ] = 'Greek'
  723. return languages
  724. }