]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - server/initializers/constants.ts
Videos overview page: first version
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
CommitLineData
fd206f0b
C
1import { IConfig } from 'config'
2import { dirname, join } from 'path'
2186386c 3import { JobType, VideoRateType, VideoState } from '../../shared/models'
50d6de9c 4import { ActivityPubActorType } from '../../shared/models/activitypub'
225a89c2 5import { FollowState } from '../../shared/models/actors'
6b616860 6import { VideoAbuseState, VideoImportState, VideoPrivacy } from '../../shared/models/videos'
e02643f3 7// Do not use barrels, remain constants as independent as possible
fd206f0b 8import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
0883b324 9import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
28be8916 10import { invert } from 'lodash'
6b616860 11import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
fd206f0b
C
12
13// Use a variable to reload the configuration if we need
14let config: IConfig = require('config')
ee9e7b61 15
9f6bae3a
C
16// ---------------------------------------------------------------------------
17
d9eaee39 18const LAST_MIGRATION_VERSION = 265
5804c0db
C
19
20// ---------------------------------------------------------------------------
21
9f6bae3a 22// API version
f0f5567b 23const API_VERSION = 'v1'
9f10b292 24
1194e8b4
C
25const PAGINATION = {
26 COUNT: {
27 DEFAULT: 15,
28 MAX: 100
29 }
30}
9f6bae3a 31
9f6bae3a
C
32// Sortable columns per schema
33const SORTABLE_COLUMNS = {
9c2c18f3 34 USERS: [ 'id', 'username', 'createdAt' ],
06a05d5f 35 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
265ba139 36 ACCOUNTS: [ 'createdAt' ],
94a5ff8a 37 JOBS: [ 'createdAt' ],
26b7305a 38 VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
72c7248b 39 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
136cce4d 40 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
ed31c059 41 VIDEO_IMPORTS: [ 'createdAt' ],
bf1f6508 42 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
7a7724e6
C
43 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
44 FOLLOWERS: [ 'createdAt' ],
57c36b27
C
45 FOLLOWING: [ 'createdAt' ],
46
f37dc0dd 47 VIDEOS_SEARCH: [ 'match', 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
f5b0af50 48 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ]
9f6bae3a 49}
9f10b292 50
2f372a86 51const OAUTH_LIFETIME = {
ff193d5e 52 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
2f372a86
C
53 REFRESH_TOKEN: 1209600 // 2 weeks
54}
55
fd4484f1 56const ROUTE_CACHE_LIFETIME = {
3f6d68d9
RK
57 FEEDS: '15 minutes',
58 ROBOTS: '2 hours',
59 NODEINFO: '10 minutes',
aad0ec24 60 DNT_POLICY: '1 week',
2d3741d6
C
61 OVERVIEWS: {
62 VIDEOS: '1 hour'
63 },
fd4484f1 64 ACTIVITY_PUB: {
3f6d68d9 65 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
fd4484f1
C
66 }
67}
68
9f6bae3a 69// ---------------------------------------------------------------------------
26d7d31b 70
60650c77
C
71// Number of points we add/remove after a successful/bad request
72const ACTOR_FOLLOW_SCORE = {
225a89c2
C
73 PENALTY: -10,
74 BONUS: 10,
60650c77
C
75 BASE: 1000,
76 MAX: 10000
225a89c2
C
77}
78
79const FOLLOW_STATES: { [ id: string ]: FollowState } = {
80 PENDING: 'pending',
81 ACCEPTED: 'accepted'
82}
83
84const REMOTE_SCHEME = {
85 HTTP: 'https',
86 WS: 'wss'
87}
88
94a5ff8a
C
89const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
90 'activitypub-http-broadcast': 5,
91 'activitypub-http-unicast': 5,
92 'activitypub-http-fetcher': 5,
5350fd8e 93 'activitypub-follow': 5,
0138af92 94 'video-file-import': 1,
ecb4e35f 95 'video-file': 1,
fbad87b0 96 'video-import': 1,
6b616860
C
97 'email': 5,
98 'videos-views': 1
225a89c2 99}
94a5ff8a
C
100const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
101 'activitypub-http-broadcast': 1,
102 'activitypub-http-unicast': 5,
103 'activitypub-http-fetcher': 1,
5350fd8e 104 'activitypub-follow': 3,
0138af92 105 'video-file-import': 1,
ecb4e35f 106 'video-file': 1,
fbad87b0 107 'video-import': 1,
6b616860
C
108 'email': 5,
109 'videos-views': 1
225a89c2 110}
2b86fe72
C
111const JOB_TTL: { [ id in JobType ]: number } = {
112 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
113 'activitypub-http-unicast': 60000 * 10, // 10 minutes
114 'activitypub-http-fetcher': 60000 * 10, // 10 minutes
115 'activitypub-follow': 60000 * 10, // 10 minutes
116 'video-file-import': 1000 * 3600, // 1 hour
117 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
118 'video-import': 1000 * 3600 * 5, // 5 hours
6b616860
C
119 'email': 60000 * 10, // 10 minutes
120 'videos-views': undefined // Unlimited
2b86fe72 121}
6b616860
C
122const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
123 'videos-views': {
124 cron: '1 * * * *' // At 1 minutes past the hour
125 }
126}
127
71e3dfda 128const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
240085d0 129const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
71e3dfda 130const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
71e3dfda 131const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
225a89c2 132
60650c77 133// 1 hour
2baea0c7
C
134let SCHEDULER_INTERVALS_MS = {
135 badActorFollow: 60000 * 60, // 1 hour
bbe0f064 136 removeOldJobs: 60000 * 60, // 1 hour
ce32426b
C
137 updateVideos: 60000, // 1 minute
138 youtubeDLUpdate: 60000 * 60 * 24 // 1 day
2baea0c7 139}
60650c77 140
225a89c2
C
141// ---------------------------------------------------------------------------
142
e861452f 143const CONFIG = {
fd206f0b 144 CUSTOM_FILE: getLocalConfigFilePath(),
d16b5172 145 LISTEN: {
cff8b272
PAT
146 PORT: config.get<number>('listen.port'),
147 HOSTNAME: config.get<string>('listen.hostname')
d16b5172 148 },
e861452f 149 DATABASE: {
65fcc311
C
150 DBNAME: 'peertube' + config.get<string>('database.suffix'),
151 HOSTNAME: config.get<string>('database.hostname'),
152 PORT: config.get<number>('database.port'),
153 USERNAME: config.get<string>('database.username'),
1c3386e8
RK
154 PASSWORD: config.get<string>('database.password'),
155 POOL: {
156 MAX: config.get<number>('database.pool.max')
157 }
e861452f 158 },
94a5ff8a 159 REDIS: {
19f7b248
RK
160 HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null,
161 PORT: config.has('redis.port') ? config.get<number>('redis.port') : null,
162 SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null,
163 AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null,
164 DB: config.has('redis.db') ? config.get<number>('redis.db') : null
94a5ff8a 165 },
ecb4e35f
C
166 SMTP: {
167 HOSTNAME: config.get<string>('smtp.hostname'),
168 PORT: config.get<number>('smtp.port'),
169 USERNAME: config.get<string>('smtp.username'),
170 PASSWORD: config.get<string>('smtp.password'),
171 TLS: config.get<boolean>('smtp.tls'),
bebf2d89 172 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
ecb4e35f
C
173 CA_FILE: config.get<string>('smtp.ca_file'),
174 FROM_ADDRESS: config.get<string>('smtp.from_address')
175 },
e861452f 176 STORAGE: {
0b4204f9
C
177 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
178 LOG_DIR: buildPath(config.get<string>('storage.logs')),
179 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
180 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
181 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
40e87e9e 182 CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')),
0b4204f9
C
183 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
184 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
e861452f
C
185 },
186 WEBSERVER: {
65fcc311
C
187 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
188 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
189 HOSTNAME: config.get<string>('webserver.hostname'),
190 PORT: config.get<number>('webserver.port'),
191 URL: '',
192 HOST: ''
4793c343 193 },
490b595a 194 TRUST_PROXY: config.get<string[]>('trust_proxy'),
23e27dd5
C
195 LOG: {
196 LEVEL: config.get<string>('log.level')
197 },
1297eb5d
C
198 SEARCH: {
199 REMOTE_URI: {
200 USERS: config.get<boolean>('search.remote_uri.users'),
201 ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous')
202 }
203 },
4793c343 204 ADMIN: {
fd206f0b 205 get EMAIL () { return config.get<string>('admin.email') }
e22528ac
C
206 },
207 SIGNUP: {
fd206f0b 208 get ENABLED () { return config.get<boolean>('signup.enabled') },
ff2c1fe8 209 get LIMIT () { return config.get<number>('signup.limit') },
d9eaee39 210 get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') },
ff2c1fe8
RK
211 FILTERS: {
212 CIDR: {
213 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
214 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
215 }
216 }
b0f9f39e
C
217 },
218 USER: {
bee0abff
FA
219 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') },
220 get VIDEO_QUOTA_DAILY () { return config.get<number>('user.video_quota_daily') }
227d02fe
C
221 },
222 TRANSCODING: {
fd206f0b
C
223 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
224 get THREADS () { return config.get<number>('transcoding.threads') },
40298b02 225 RESOLUTIONS: {
fd206f0b
C
226 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
227 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
228 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
229 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
230 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
40298b02 231 }
f981dae8 232 },
5d08a6a7
C
233 IMPORT: {
234 VIDEOS: {
235 HTTP: {
236 get ENABLED () { return config.get<boolean>('import.videos.http.enabled') }
a84b8fa5
C
237 },
238 TORRENT: {
239 get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') }
5d08a6a7
C
240 }
241 }
242 },
f981dae8
C
243 CACHE: {
244 PREVIEWS: {
fd206f0b 245 get SIZE () { return config.get<number>('cache.previews.size') }
40e87e9e
C
246 },
247 VIDEO_CAPTIONS: {
248 get SIZE () { return config.get<number>('cache.captions.size') }
f981dae8 249 }
66b16caf
C
250 },
251 INSTANCE: {
252 get NAME () { return config.get<string>('instance.name') },
2e3a0215 253 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
66b16caf 254 get DESCRIPTION () { return config.get<string>('instance.description') },
00b5556c 255 get TERMS () { return config.get<string>('instance.terms') },
901637bb 256 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
81e504b3 257 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
00b5556c
C
258 CUSTOMIZATIONS: {
259 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
260 get CSS () { return config.get<string>('instance.customizations.css') }
ac235c37
RK
261 },
262 get ROBOTS () { return config.get<string>('instance.robots') }
8be1afa1
C
263 },
264 SERVICES: {
265 TWITTER: {
266 get USERNAME () { return config.get<string>('services.twitter.username') },
267 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
268 }
e861452f
C
269 }
270}
e861452f 271
9f6bae3a
C
272// ---------------------------------------------------------------------------
273
e4c55619
C
274const CONSTRAINTS_FIELDS = {
275 USERS: {
ed56ad11
C
276 NAME: { min: 3, max: 120 }, // Length
277 DESCRIPTION: { min: 3, max: 250 }, // Length
e4c55619 278 USERNAME: { min: 3, max: 20 }, // Length
b0f9f39e 279 PASSWORD: { min: 6, max: 255 }, // Length
eacb25c4 280 VIDEO_QUOTA: { min: -1 },
bee0abff 281 VIDEO_QUOTA_DAILY: { min: -1 },
eacb25c4 282 BLOCKED_REASON: { min: 3, max: 250 } // Length
e4c55619 283 },
55fa55a9 284 VIDEO_ABUSES: {
268eebed
C
285 REASON: { min: 2, max: 300 }, // Length
286 MODERATION_COMMENT: { min: 2, max: 300 } // Length
55fa55a9 287 },
26b7305a
C
288 VIDEO_BLACKLIST: {
289 REASON: { min: 2, max: 300 } // Length
290 },
72c7248b 291 VIDEO_CHANNELS: {
a265f7f3 292 NAME: { min: 3, max: 120 }, // Length
a10fc78b
C
293 DESCRIPTION: { min: 3, max: 500 }, // Length
294 SUPPORT: { min: 3, max: 500 }, // Length
e34c85e5 295 URL: { min: 3, max: 2000 } // Length
72c7248b 296 },
40e87e9e
C
297 VIDEO_CAPTIONS: {
298 CAPTION_FILE: {
f4001cf4 299 EXTNAME: [ '.vtt', '.srt' ],
40e87e9e
C
300 FILE_SIZE: {
301 max: 2 * 1024 * 1024 // 2MB
302 }
303 }
304 },
fbad87b0 305 VIDEO_IMPORTS: {
ce33919c
C
306 URL: { min: 3, max: 2000 }, // Length
307 TORRENT_NAME: { min: 3, max: 255 }, // Length
990b6a0b
C
308 TORRENT_FILE: {
309 EXTNAME: [ '.torrent' ],
310 FILE_SIZE: {
311 max: 1024 * 200 // 200 KB
312 }
313 }
fbad87b0 314 },
e4c55619 315 VIDEOS: {
a265f7f3 316 NAME: { min: 3, max: 120 }, // Length
9d3ef9fe 317 LANGUAGE: { min: 1, max: 10 }, // Length
9567011b 318 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
2422c46b 319 DESCRIPTION: { min: 3, max: 10000 }, // Length
a10fc78b 320 SUPPORT: { min: 3, max: 500 }, // Length
ac81d1a0
C
321 IMAGE: {
322 EXTNAME: [ '.jpg', '.jpeg' ],
323 FILE_SIZE: {
324 max: 2 * 1024 * 1024 // 2MB
325 }
326 },
feb4bdfd 327 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
0e1dc3e7 328 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
fbad87b0 329 DURATION: { min: 0 }, // Number
a265f7f3
C
330 TAGS: { min: 0, max: 5 }, // Number of total tags
331 TAG: { min: 2, max: 30 }, // Length
e4c55619 332 THUMBNAIL: { min: 2, max: 30 },
e4c87ec2
C
333 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
334 VIEWS: { min: 0 },
335 LIKES: { min: 0 },
93e1258c 336 DISLIKES: { min: 0 },
c60774b0 337 FILE_SIZE: { min: 10 },
e34c85e5
C
338 URL: { min: 3, max: 2000 } // Length
339 },
01de67b9 340 ACTORS: {
e34c85e5
C
341 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
342 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
c5911fd3
C
343 URL: { min: 3, max: 2000 }, // Length
344 AVATAR: {
01de67b9
C
345 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
346 FILE_SIZE: {
347 max: 2 * 1024 * 1024 // 2MB
348 }
c5911fd3 349 }
e4c87ec2
C
350 },
351 VIDEO_EVENTS: {
352 COUNT: { min: 0 }
6d852470 353 },
bf1f6508 354 VIDEO_COMMENTS: {
b32b7827 355 TEXT: { min: 1, max: 3000 }, // Length
6d852470 356 URL: { min: 3, max: 2000 } // Length
4ba3b8ea
C
357 },
358 VIDEO_SHARE: {
359 URL: { min: 3, max: 2000 } // Length
e4c55619
C
360 }
361}
362
490b595a
C
363const RATES_LIMIT = {
364 LOGIN: {
365 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
09becad8 366 MAX: 15 // 15 attempts
490b595a
C
367 }
368}
369
b5c0e955 370let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
a7977280
C
371const VIDEO_TRANSCODING_FPS = {
372 MIN: 10,
3a6f351b
C
373 AVERAGE: 30,
374 MAX: 60,
375 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
a7977280 376}
b5c0e955 377
ee9e7b61 378const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
d38b8281
C
379 LIKE: 'like',
380 DISLIKE: 'dislike'
381}
382
80bc88c1
J
383const FFMPEG_NICE: { [ id: string ]: number } = {
384 THUMBNAIL: 2, // 2 just for don't blocking servers
385 TRANSCODING: 15
386}
387
6e07c3de
C
388const VIDEO_CATEGORIES = {
389 1: 'Music',
390 2: 'Films',
391 3: 'Vehicles',
392 4: 'Art',
393 5: 'Sports',
394 6: 'Travels',
395 7: 'Gaming',
396 8: 'People',
397 9: 'Comedy',
398 10: 'Entertainment',
399 11: 'News',
40298b02 400 12: 'How To',
6e07c3de
C
401 13: 'Education',
402 14: 'Activism',
403 15: 'Science & Technology',
404 16: 'Animals',
405 17: 'Kids',
406 18: 'Food'
407}
408
6f0c39e2
C
409// See https://creativecommons.org/licenses/?lang=en
410const VIDEO_LICENCES = {
411 1: 'Attribution',
412 2: 'Attribution - Share Alike',
413 3: 'Attribution - No Derivatives',
414 4: 'Attribution - Non Commercial',
415 5: 'Attribution - Non Commercial - Share Alike',
416 6: 'Attribution - Non Commercial - No Derivatives',
417 7: 'Public Domain Dedication'
418}
419
9d3ef9fe 420const VIDEO_LANGUAGES = buildLanguages()
3092476e 421
fd45e8f4
C
422const VIDEO_PRIVACIES = {
423 [VideoPrivacy.PUBLIC]: 'Public',
424 [VideoPrivacy.UNLISTED]: 'Unlisted',
425 [VideoPrivacy.PRIVATE]: 'Private'
426}
427
2186386c
C
428const VIDEO_STATES = {
429 [VideoState.PUBLISHED]: 'Published',
fbad87b0
C
430 [VideoState.TO_TRANSCODE]: 'To transcode',
431 [VideoState.TO_IMPORT]: 'To import'
432}
433
434const VIDEO_IMPORT_STATES = {
435 [VideoImportState.FAILED]: 'Failed',
436 [VideoImportState.PENDING]: 'Pending',
437 [VideoImportState.SUCCESS]: 'Success'
2186386c
C
438}
439
268eebed
C
440const VIDEO_ABUSE_STATES = {
441 [VideoAbuseState.PENDING]: 'Pending',
442 [VideoAbuseState.REJECTED]: 'Rejected',
443 [VideoAbuseState.ACCEPTED]: 'Accepted'
444}
445
0d0e8dd0 446const VIDEO_MIMETYPE_EXT = {
efc32059
C
447 'video/webm': '.webm',
448 'video/ogg': '.ogv',
449 'video/mp4': '.mp4'
0d0e8dd0 450}
28be8916 451const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
0d0e8dd0 452
ac81d1a0 453const IMAGE_MIMETYPE_EXT = {
c5911fd3
C
454 'image/png': '.png',
455 'image/jpg': '.jpg',
456 'image/jpeg': '.jpg'
457}
458
40e87e9e 459const VIDEO_CAPTIONS_MIMETYPE_EXT = {
f4001cf4
C
460 'text/vtt': '.vtt',
461 'application/x-subrip': '.srt'
40e87e9e
C
462}
463
990b6a0b
C
464const TORRENT_MIMETYPE_EXT = {
465 'application/x-bittorrent': '.torrent'
466}
467
9f6bae3a
C
468// ---------------------------------------------------------------------------
469
2d3741d6
C
470const OVERVIEWS = {
471 VIDEOS: {
472 SAMPLE_THRESHOLD: 4,
473 SAMPLES_COUNT: 2
474 }
475}
476
477// ---------------------------------------------------------------------------
478
50d6de9c 479const SERVER_ACTOR_NAME = 'peertube'
350e31d6 480
e4f97bab 481const ACTIVITY_PUB = {
1b5b10d1
C
482 POTENTIAL_ACCEPT_HEADERS: [
483 'application/activity+json',
9a8cbd82
C
484 'application/ld+json',
485 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
165cdc75 486 ],
1b5b10d1 487 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
9a27cdc2 488 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
0d0e8dd0 489 COLLECTION_ITEMS_PER_PAGE: 10,
c986175d 490 FETCH_PAGE_LIMIT: 100,
20494f12 491 URL_MIME_TYPES: {
f05a1c30 492 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
20494f12
C
493 TORRENT: [ 'application/x-bittorrent' ],
494 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
a5625b41 495 },
2ccaeeb3 496 MAX_RECURSION_COMMENTS: 100,
1297eb5d
C
497 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day
498 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
e4f97bab
C
499}
500
50d6de9c
C
501const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
502 GROUP: 'Group',
503 PERSON: 'Person',
504 APPLICATION: 'Application'
505}
506
9f6bae3a
C
507// ---------------------------------------------------------------------------
508
e4f97bab 509const PRIVATE_RSA_KEY_SIZE = 2048
bdfbd4f1 510
9f6bae3a
C
511// Password encryption
512const BCRYPT_SALT_SIZE = 10
a877d5ac 513
ecb4e35f
C
514const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
515
d9eaee39
JM
516const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
517
0883b324
C
518const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
519 DO_NOT_LIST: 'do_not_list',
520 BLUR: 'blur',
521 DISPLAY: 'display'
522}
523
bdfbd4f1
C
524// ---------------------------------------------------------------------------
525
052937db
C
526// Express static paths (router)
527const STATIC_PATHS = {
f285faa0
C
528 PREVIEWS: '/static/previews/',
529 THUMBNAILS: '/static/thumbnails/',
052937db 530 TORRENTS: '/static/torrents/',
c5911fd3 531 WEBSEED: '/static/webseed/',
40e87e9e
C
532 AVATARS: '/static/avatars/',
533 VIDEO_CAPTIONS: '/static/video-captions/'
052937db 534}
02756fbd
C
535const STATIC_DOWNLOAD_PATHS = {
536 TORRENTS: '/download/torrents/',
537 VIDEOS: '/download/videos/'
538}
052937db 539
dc009132 540// Cache control
57a81ff6 541let STATIC_MAX_AGE = '2h'
dc009132 542
cbe2f7c3 543// Videos thumbnail size
d8755eed
C
544const THUMBNAILS_SIZE = {
545 width: 200,
546 height: 110
547}
548const PREVIEWS_SIZE = {
164174a6
C
549 width: 560,
550 height: 315
551}
e8e12200
C
552const AVATARS_SIZE = {
553 width: 120,
554 height: 120
555}
164174a6
C
556
557const EMBED_SIZE = {
558 width: 560,
559 height: 315
d8755eed 560}
cbe2f7c3 561
980246ea 562// Sub folders of cache directory
f981dae8 563const CACHE = {
f4001cf4
C
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
f981dae8
C
571 }
572}
573
e12a0092 574const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
4f491371 575
bdfbd4f1
C
576// ---------------------------------------------------------------------------
577
e032aec9
C
578const CUSTOM_HTML_TAG_COMMENTS = {
579 TITLE: '<!-- title tag -->',
580 DESCRIPTION: '<!-- description tag -->',
581 CUSTOM_CSS: '<!-- custom css tag -->',
582 OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
583}
709756b8
C
584
585// ---------------------------------------------------------------------------
586
4195cd2b 587const FEEDS = {
fd4484f1 588 COUNT: 20
4195cd2b
C
589}
590
591// ---------------------------------------------------------------------------
592
9b67da3d
C
593const TRACKER_RATE_LIMITS = {
594 INTERVAL: 60000 * 5, // 5 minutes
8244c85a 595 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
9b67da3d
C
596 ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
597}
598
599// ---------------------------------------------------------------------------
600
9f10b292
C
601// Special constants for a test instance
602if (isTestInstance() === true) {
60650c77 603 ACTOR_FOLLOW_SCORE.BASE = 20
3cd0734f 604
f285faa0
C
605 REMOTE_SCHEME.HTTP = 'http'
606 REMOTE_SCHEME.WS = 'ws'
3cd0734f 607
65fcc311 608 STATIC_MAX_AGE = '0'
3cd0734f 609
c46edbc2 610 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
7bc29171 611 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
1297eb5d 612 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
3cd0734f 613
01de67b9 614 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
3cd0734f 615
2baea0c7
C
616 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
617 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
618 SCHEDULER_INTERVALS_MS.updateVideos = 5000
6b616860 619 REPEAT_JOBS['videos-views'] = { every: 5000 }
2baea0c7 620
b5c0e955 621 VIDEO_VIEW_LIFETIME = 1000 // 1 second
3cd0734f
C
622
623 JOB_ATTEMPTS['email'] = 1
f4001cf4
C
624
625 CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
9f10b292
C
626}
627
fd206f0b 628updateWebserverConfig()
225a89c2 629
9f10b292
C
630// ---------------------------------------------------------------------------
631
65fcc311 632export {
9f6bae3a 633 API_VERSION,
40e87e9e 634 VIDEO_CAPTIONS_MIMETYPE_EXT,
e8e12200 635 AVATARS_SIZE,
4f491371 636 ACCEPT_HEADERS,
9f6bae3a 637 BCRYPT_SALT_SIZE,
9b67da3d 638 TRACKER_RATE_LIMITS,
f981dae8 639 CACHE,
9f6bae3a
C
640 CONFIG,
641 CONSTRAINTS_FIELDS,
164174a6 642 EMBED_SIZE,
94a5ff8a
C
643 JOB_CONCURRENCY,
644 JOB_ATTEMPTS,
b769007f 645 LAST_MIGRATION_VERSION,
9f6bae3a 646 OAUTH_LIFETIME,
e032aec9 647 CUSTOM_HTML_TAG_COMMENTS,
f55e5a7b 648 BROADCAST_CONCURRENCY,
1194e8b4 649 PAGINATION,
60650c77 650 ACTOR_FOLLOW_SCORE,
f285faa0
C
651 PREVIEWS_SIZE,
652 REMOTE_SCHEME,
7a7724e6 653 FOLLOW_STATES,
50d6de9c 654 SERVER_ACTOR_NAME,
e4f97bab 655 PRIVATE_RSA_KEY_SIZE,
fd4484f1 656 ROUTE_CACHE_LIFETIME,
9f6bae3a 657 SORTABLE_COLUMNS,
4195cd2b 658 FEEDS,
2b86fe72 659 JOB_TTL,
0883b324 660 NSFW_POLICY_TYPES,
990b6a0b 661 TORRENT_MIMETYPE_EXT,
dc009132 662 STATIC_MAX_AGE,
a6375e69 663 STATIC_PATHS,
e4f97bab 664 ACTIVITY_PUB,
50d6de9c 665 ACTIVITY_PUB_ACTOR_TYPES,
9f6bae3a 666 THUMBNAILS_SIZE,
6e07c3de 667 VIDEO_CATEGORIES,
3092476e 668 VIDEO_LANGUAGES,
fd45e8f4 669 VIDEO_PRIVACIES,
6f0c39e2 670 VIDEO_LICENCES,
2186386c 671 VIDEO_STATES,
0d0e8dd0 672 VIDEO_RATE_TYPES,
c5911fd3 673 VIDEO_MIMETYPE_EXT,
a7977280 674 VIDEO_TRANSCODING_FPS,
80bc88c1 675 FFMPEG_NICE,
268eebed 676 VIDEO_ABUSE_STATES,
71e3dfda 677 JOB_REQUEST_TIMEOUT,
ecb4e35f 678 USER_PASSWORD_RESET_LIFETIME,
d9eaee39 679 USER_EMAIL_VERIFY_LIFETIME,
ac81d1a0 680 IMAGE_MIMETYPE_EXT,
2d3741d6 681 OVERVIEWS,
2baea0c7 682 SCHEDULER_INTERVALS_MS,
6b616860 683 REPEAT_JOBS,
02756fbd 684 STATIC_DOWNLOAD_PATHS,
490b595a 685 RATES_LIMIT,
28be8916 686 VIDEO_EXT_MIMETYPE,
f6eebcb3 687 CRAWL_REQUEST_CONCURRENCY,
b5c0e955 688 JOB_COMPLETED_LIFETIME,
fbad87b0 689 VIDEO_IMPORT_STATES,
7ce44a74
C
690 VIDEO_VIEW_LIFETIME,
691 buildLanguages
9f10b292 692}
fd206f0b
C
693
694// ---------------------------------------------------------------------------
695
696function getLocalConfigFilePath () {
697 const configSources = config.util.getConfigSources()
698 if (configSources.length === 0) throw new Error('Invalid config source.')
699
700 let filename = 'local'
701 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
702 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
703
704 return join(dirname(configSources[ 0 ].name), filename + '.json')
705}
706
707function updateWebserverConfig () {
708 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
709 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
710}
711
9d3ef9fe
C
712function buildLanguages () {
713 const iso639 = require('iso-639-3')
714
715 const languages: { [ id: string ]: string } = {}
716
1d94c154
C
717 const additionalLanguages = {
718 'sgn': true, // Sign languages (macro language)
719 'ase': true, // American sign language
720 'sdl': true, // Arabian sign language
721 'bfi': true, // British sign language
722 'bzs': true, // Brazilian sign language
723 'csl': true, // Chinese sign language
724 'cse': true, // Czech sign language
725 'dsl': true, // Danish sign language
726 'fsl': true, // French sign language
727 'gsg': true, // German sign language
728 'pks': true, // Pakistan sign language
729 'jsl': true, // Japanese sign language
730 'sfs': true, // South African sign language
731 'swl': true, // Swedish sign language
732 'rsl': true, // Russian sign language: true
733
734 'epo': true, // Esperanto
735 'tlh': true, // Klingon
736 'jbo': true, // Lojban
737 'avk': true // Kotava
738 }
9d3ef9fe
C
739
740 // Only add ISO639-1 languages and some sign languages (ISO639-3)
741 iso639
742 .filter(l => {
743 return (l.iso6391 !== null && l.type === 'living') ||
1d94c154 744 additionalLanguages[l.iso6393] === true
9d3ef9fe
C
745 })
746 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
747
748 return languages
749}
750
fd206f0b
C
751export function reloadConfig () {
752
753 function directory () {
754 if (process.env.NODE_CONFIG_DIR) {
755 return process.env.NODE_CONFIG_DIR
756 }
757
758 return join(root(), 'config')
759 }
760
761 function purge () {
762 for (const fileName in require.cache) {
763 if (-1 === fileName.indexOf(directory())) {
764 continue
765 }
766
767 delete require.cache[fileName]
768 }
769
770 delete require.cache[require.resolve('config')]
771 }
772
773 purge()
774
775 config = require('config')
776
777 updateWebserverConfig()
778}