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