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