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