]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - server/initializers/constants.ts
Add ability for uploaders to schedule video update
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
1 import { IConfig } from 'config'
2 import { dirname, join } from 'path'
3 import { JobType, VideoRateType, VideoState } from '../../shared/models'
4 import { ActivityPubActorType } from '../../shared/models/activitypub'
5 import { FollowState } from '../../shared/models/actors'
6 import { VideoPrivacy } from '../../shared/models/videos'
7 // Do not use barrels, remain constants as independent as possible
8 import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
9 import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
10 import { invert } from 'lodash'
11 import { RemoveOldJobsScheduler } from '../lib/schedulers/remove-old-jobs-scheduler'
12 import { UpdateVideosScheduler } from '../lib/schedulers/update-videos-scheduler'
13
14 // Use a variable to reload the configuration if we need
15 let config: IConfig = require('config')
16
17 // ---------------------------------------------------------------------------
18
19 const LAST_MIGRATION_VERSION = 220
20
21 // ---------------------------------------------------------------------------
22
23 // API version
24 const API_VERSION = 'v1'
25
26 // Number of results by default for the pagination
27 const PAGINATION_COUNT_DEFAULT = 15
28
29 // Sortable columns per schema
30 const SORTABLE_COLUMNS = {
31 USERS: [ 'id', 'username', 'createdAt' ],
32 ACCOUNTS: [ 'createdAt' ],
33 JOBS: [ 'createdAt' ],
34 VIDEO_ABUSES: [ 'id', 'createdAt' ],
35 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
36 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes' ],
37 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
38 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
39 FOLLOWERS: [ 'createdAt' ],
40 FOLLOWING: [ 'createdAt' ]
41 }
42
43 const OAUTH_LIFETIME = {
44 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
45 REFRESH_TOKEN: 1209600 // 2 weeks
46 }
47
48 const ROUTE_CACHE_LIFETIME = {
49 FEEDS: 1000 * 60 * 15, // 15 minutes
50 ACTIVITY_PUB: {
51 VIDEOS: 1000 // 1 second, cache concurrent requests after a broadcast for example
52 }
53 }
54
55 // ---------------------------------------------------------------------------
56
57 // Number of points we add/remove after a successful/bad request
58 const ACTOR_FOLLOW_SCORE = {
59 PENALTY: -10,
60 BONUS: 10,
61 BASE: 1000,
62 MAX: 10000
63 }
64
65 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
66 PENDING: 'pending',
67 ACCEPTED: 'accepted'
68 }
69
70 const REMOTE_SCHEME = {
71 HTTP: 'https',
72 WS: 'wss'
73 }
74
75 const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
76 'activitypub-http-broadcast': 5,
77 'activitypub-http-unicast': 5,
78 'activitypub-http-fetcher': 5,
79 'activitypub-follow': 5,
80 'video-file-import': 1,
81 'video-file': 1,
82 'email': 5
83 }
84 const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
85 'activitypub-http-broadcast': 1,
86 'activitypub-http-unicast': 5,
87 'activitypub-http-fetcher': 1,
88 'activitypub-follow': 3,
89 'video-file-import': 1,
90 'video-file': 1,
91 'email': 5
92 }
93 const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
94 const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
95 const JOB_REQUEST_TTL = 60000 * 10 // 10 minutes
96 const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
97
98 // 1 hour
99 let SCHEDULER_INTERVALS_MS = {
100 badActorFollow: 60000 * 60, // 1 hour
101 removeOldJobs: 60000 * 60, // 1 jour
102 updateVideos: 60000 * 1, // 1 minute
103 }
104
105 // ---------------------------------------------------------------------------
106
107 const CONFIG = {
108 CUSTOM_FILE: getLocalConfigFilePath(),
109 LISTEN: {
110 PORT: config.get<number>('listen.port'),
111 HOSTNAME: config.get<string>('listen.hostname')
112 },
113 DATABASE: {
114 DBNAME: 'peertube' + config.get<string>('database.suffix'),
115 HOSTNAME: config.get<string>('database.hostname'),
116 PORT: config.get<number>('database.port'),
117 USERNAME: config.get<string>('database.username'),
118 PASSWORD: config.get<string>('database.password')
119 },
120 REDIS: {
121 HOSTNAME: config.get<string>('redis.hostname'),
122 PORT: config.get<number>('redis.port'),
123 AUTH: config.get<string>('redis.auth'),
124 DB: config.get<number>('redis.db')
125 },
126 SMTP: {
127 HOSTNAME: config.get<string>('smtp.hostname'),
128 PORT: config.get<number>('smtp.port'),
129 USERNAME: config.get<string>('smtp.username'),
130 PASSWORD: config.get<string>('smtp.password'),
131 TLS: config.get<boolean>('smtp.tls'),
132 DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
133 CA_FILE: config.get<string>('smtp.ca_file'),
134 FROM_ADDRESS: config.get<string>('smtp.from_address')
135 },
136 STORAGE: {
137 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
138 LOG_DIR: buildPath(config.get<string>('storage.logs')),
139 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
140 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
141 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
142 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
143 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
144 },
145 WEBSERVER: {
146 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
147 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
148 HOSTNAME: config.get<string>('webserver.hostname'),
149 PORT: config.get<number>('webserver.port'),
150 URL: '',
151 HOST: ''
152 },
153 TRUST_PROXY: config.get<string[]>('trust_proxy'),
154 LOG: {
155 LEVEL: config.get<string>('log.level')
156 },
157 ADMIN: {
158 get EMAIL () { return config.get<string>('admin.email') }
159 },
160 SIGNUP: {
161 get ENABLED () { return config.get<boolean>('signup.enabled') },
162 get LIMIT () { return config.get<number>('signup.limit') },
163 FILTERS: {
164 CIDR: {
165 get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') },
166 get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') }
167 }
168 }
169 },
170 USER: {
171 get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
172 },
173 TRANSCODING: {
174 get ENABLED () { return config.get<boolean>('transcoding.enabled') },
175 get THREADS () { return config.get<number>('transcoding.threads') },
176 RESOLUTIONS: {
177 get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
178 get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
179 get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
180 get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
181 get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
182 }
183 },
184 CACHE: {
185 PREVIEWS: {
186 get SIZE () { return config.get<number>('cache.previews.size') }
187 }
188 },
189 INSTANCE: {
190 get NAME () { return config.get<string>('instance.name') },
191 get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
192 get DESCRIPTION () { return config.get<string>('instance.description') },
193 get TERMS () { return config.get<string>('instance.terms') },
194 get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
195 get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') },
196 CUSTOMIZATIONS: {
197 get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
198 get CSS () { return config.get<string>('instance.customizations.css') }
199 },
200 get ROBOTS () { return config.get<string>('instance.robots') }
201 },
202 SERVICES: {
203 TWITTER: {
204 get USERNAME () { return config.get<string>('services.twitter.username') },
205 get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') }
206 }
207 }
208 }
209
210 // ---------------------------------------------------------------------------
211
212 const CONSTRAINTS_FIELDS = {
213 USERS: {
214 NAME: { min: 3, max: 120 }, // Length
215 DESCRIPTION: { min: 3, max: 250 }, // Length
216 USERNAME: { min: 3, max: 20 }, // Length
217 PASSWORD: { min: 6, max: 255 }, // Length
218 VIDEO_QUOTA: { min: -1 }
219 },
220 VIDEO_ABUSES: {
221 REASON: { min: 2, max: 300 } // Length
222 },
223 VIDEO_CHANNELS: {
224 NAME: { min: 3, max: 120 }, // Length
225 DESCRIPTION: { min: 3, max: 500 }, // Length
226 SUPPORT: { min: 3, max: 500 }, // Length
227 URL: { min: 3, max: 2000 } // Length
228 },
229 VIDEOS: {
230 NAME: { min: 3, max: 120 }, // Length
231 LANGUAGE: { min: 1, max: 10 }, // Length
232 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
233 DESCRIPTION: { min: 3, max: 10000 }, // Length
234 SUPPORT: { min: 3, max: 500 }, // Length
235 IMAGE: {
236 EXTNAME: [ '.jpg', '.jpeg' ],
237 FILE_SIZE: {
238 max: 2 * 1024 * 1024 // 2MB
239 }
240 },
241 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
242 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
243 DURATION: { min: 1 }, // Number
244 TAGS: { min: 0, max: 5 }, // Number of total tags
245 TAG: { min: 2, max: 30 }, // Length
246 THUMBNAIL: { min: 2, max: 30 },
247 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
248 VIEWS: { min: 0 },
249 LIKES: { min: 0 },
250 DISLIKES: { min: 0 },
251 FILE_SIZE: { min: 10 },
252 URL: { min: 3, max: 2000 } // Length
253 },
254 ACTORS: {
255 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
256 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
257 URL: { min: 3, max: 2000 }, // Length
258 AVATAR: {
259 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
260 FILE_SIZE: {
261 max: 2 * 1024 * 1024 // 2MB
262 }
263 }
264 },
265 VIDEO_EVENTS: {
266 COUNT: { min: 0 }
267 },
268 VIDEO_COMMENTS: {
269 TEXT: { min: 1, max: 3000 }, // Length
270 URL: { min: 3, max: 2000 } // Length
271 },
272 VIDEO_SHARE: {
273 URL: { min: 3, max: 2000 } // Length
274 }
275 }
276
277 const RATES_LIMIT = {
278 LOGIN: {
279 WINDOW_MS: 5 * 60 * 1000, // 5 minutes
280 MAX: 15 // 15 attempts
281 }
282 }
283
284 let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
285 const VIDEO_TRANSCODING_FPS = {
286 MIN: 10,
287 MAX: 30
288 }
289
290 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
291 LIKE: 'like',
292 DISLIKE: 'dislike'
293 }
294
295 const VIDEO_CATEGORIES = {
296 1: 'Music',
297 2: 'Films',
298 3: 'Vehicles',
299 4: 'Art',
300 5: 'Sports',
301 6: 'Travels',
302 7: 'Gaming',
303 8: 'People',
304 9: 'Comedy',
305 10: 'Entertainment',
306 11: 'News',
307 12: 'How To',
308 13: 'Education',
309 14: 'Activism',
310 15: 'Science & Technology',
311 16: 'Animals',
312 17: 'Kids',
313 18: 'Food'
314 }
315
316 // See https://creativecommons.org/licenses/?lang=en
317 const VIDEO_LICENCES = {
318 1: 'Attribution',
319 2: 'Attribution - Share Alike',
320 3: 'Attribution - No Derivatives',
321 4: 'Attribution - Non Commercial',
322 5: 'Attribution - Non Commercial - Share Alike',
323 6: 'Attribution - Non Commercial - No Derivatives',
324 7: 'Public Domain Dedication'
325 }
326
327 const VIDEO_LANGUAGES = buildLanguages()
328
329 const VIDEO_PRIVACIES = {
330 [VideoPrivacy.PUBLIC]: 'Public',
331 [VideoPrivacy.UNLISTED]: 'Unlisted',
332 [VideoPrivacy.PRIVATE]: 'Private'
333 }
334
335 const VIDEO_STATES = {
336 [VideoState.PUBLISHED]: 'Published',
337 [VideoState.TO_TRANSCODE]: 'To transcode'
338 }
339
340 const VIDEO_MIMETYPE_EXT = {
341 'video/webm': '.webm',
342 'video/ogg': '.ogv',
343 'video/mp4': '.mp4'
344 }
345 const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT)
346
347 const IMAGE_MIMETYPE_EXT = {
348 'image/png': '.png',
349 'image/jpg': '.jpg',
350 'image/jpeg': '.jpg'
351 }
352
353 // ---------------------------------------------------------------------------
354
355 const SERVER_ACTOR_NAME = 'peertube'
356
357 const ACTIVITY_PUB = {
358 POTENTIAL_ACCEPT_HEADERS: [
359 'application/activity+json',
360 'application/ld+json',
361 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
362 ],
363 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
364 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
365 COLLECTION_ITEMS_PER_PAGE: 10,
366 FETCH_PAGE_LIMIT: 100,
367 URL_MIME_TYPES: {
368 VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
369 TORRENT: [ 'application/x-bittorrent' ],
370 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
371 },
372 MAX_RECURSION_COMMENTS: 100,
373 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
374 }
375
376 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
377 GROUP: 'Group',
378 PERSON: 'Person',
379 APPLICATION: 'Application'
380 }
381
382 // ---------------------------------------------------------------------------
383
384 const PRIVATE_RSA_KEY_SIZE = 2048
385
386 // Password encryption
387 const BCRYPT_SALT_SIZE = 10
388
389 const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
390
391 const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = {
392 DO_NOT_LIST: 'do_not_list',
393 BLUR: 'blur',
394 DISPLAY: 'display'
395 }
396
397 // ---------------------------------------------------------------------------
398
399 // Express static paths (router)
400 const STATIC_PATHS = {
401 PREVIEWS: '/static/previews/',
402 THUMBNAILS: '/static/thumbnails/',
403 TORRENTS: '/static/torrents/',
404 WEBSEED: '/static/webseed/',
405 AVATARS: '/static/avatars/'
406 }
407 const STATIC_DOWNLOAD_PATHS = {
408 TORRENTS: '/download/torrents/',
409 VIDEOS: '/download/videos/'
410 }
411
412 // Cache control
413 let STATIC_MAX_AGE = '30d'
414
415 // Videos thumbnail size
416 const THUMBNAILS_SIZE = {
417 width: 200,
418 height: 110
419 }
420 const PREVIEWS_SIZE = {
421 width: 560,
422 height: 315
423 }
424 const AVATARS_SIZE = {
425 width: 120,
426 height: 120
427 }
428
429 const EMBED_SIZE = {
430 width: 560,
431 height: 315
432 }
433
434 // Sub folders of cache directory
435 const CACHE = {
436 DIRECTORIES: {
437 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
438 }
439 }
440
441 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
442
443 // ---------------------------------------------------------------------------
444
445 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
446
447 // ---------------------------------------------------------------------------
448
449 const FEEDS = {
450 COUNT: 20
451 }
452
453 // ---------------------------------------------------------------------------
454
455 // Special constants for a test instance
456 if (isTestInstance() === true) {
457 ACTOR_FOLLOW_SCORE.BASE = 20
458
459 REMOTE_SCHEME.HTTP = 'http'
460 REMOTE_SCHEME.WS = 'ws'
461
462 STATIC_MAX_AGE = '0'
463
464 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
465 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
466
467 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
468
469 SCHEDULER_INTERVALS_MS.badActorFollow = 10000
470 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
471 SCHEDULER_INTERVALS_MS.updateVideos = 5000
472
473 VIDEO_VIEW_LIFETIME = 1000 // 1 second
474
475 JOB_ATTEMPTS['email'] = 1
476 }
477
478 updateWebserverConfig()
479
480 // ---------------------------------------------------------------------------
481
482 export {
483 API_VERSION,
484 AVATARS_SIZE,
485 ACCEPT_HEADERS,
486 BCRYPT_SALT_SIZE,
487 CACHE,
488 CONFIG,
489 CONSTRAINTS_FIELDS,
490 EMBED_SIZE,
491 JOB_CONCURRENCY,
492 JOB_ATTEMPTS,
493 LAST_MIGRATION_VERSION,
494 OAUTH_LIFETIME,
495 OPENGRAPH_AND_OEMBED_COMMENT,
496 BROADCAST_CONCURRENCY,
497 PAGINATION_COUNT_DEFAULT,
498 ACTOR_FOLLOW_SCORE,
499 PREVIEWS_SIZE,
500 REMOTE_SCHEME,
501 FOLLOW_STATES,
502 SERVER_ACTOR_NAME,
503 PRIVATE_RSA_KEY_SIZE,
504 ROUTE_CACHE_LIFETIME,
505 SORTABLE_COLUMNS,
506 FEEDS,
507 NSFW_POLICY_TYPES,
508 STATIC_MAX_AGE,
509 STATIC_PATHS,
510 ACTIVITY_PUB,
511 ACTIVITY_PUB_ACTOR_TYPES,
512 THUMBNAILS_SIZE,
513 VIDEO_CATEGORIES,
514 VIDEO_LANGUAGES,
515 VIDEO_PRIVACIES,
516 VIDEO_LICENCES,
517 VIDEO_STATES,
518 VIDEO_RATE_TYPES,
519 VIDEO_MIMETYPE_EXT,
520 VIDEO_TRANSCODING_FPS,
521 JOB_REQUEST_TIMEOUT,
522 JOB_REQUEST_TTL,
523 USER_PASSWORD_RESET_LIFETIME,
524 IMAGE_MIMETYPE_EXT,
525 SCHEDULER_INTERVALS_MS,
526 STATIC_DOWNLOAD_PATHS,
527 RATES_LIMIT,
528 VIDEO_EXT_MIMETYPE,
529 JOB_COMPLETED_LIFETIME,
530 VIDEO_VIEW_LIFETIME,
531 buildLanguages
532 }
533
534 // ---------------------------------------------------------------------------
535
536 function getLocalConfigFilePath () {
537 const configSources = config.util.getConfigSources()
538 if (configSources.length === 0) throw new Error('Invalid config source.')
539
540 let filename = 'local'
541 if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
542 if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
543
544 return join(dirname(configSources[ 0 ].name), filename + '.json')
545 }
546
547 function updateWebserverConfig () {
548 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
549 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
550 }
551
552 function buildLanguages () {
553 const iso639 = require('iso-639-3')
554
555 const languages: { [ id: string ]: string } = {}
556
557 const signLanguages = [
558 'sgn', // Sign languages (macro language)
559 'ase', // American
560 'sdl', // Arabian
561 'bfi', // British
562 'bzs', // Brazilian
563 'csl', // Chinese
564 'cse', // Czech
565 'dsl', // Danish
566 'fsl', // French
567 'gsg', // German
568 'pks', // Pakistan
569 'jsl', // Japanese
570 'sfs', // South African
571 'swl', // Swedish
572 'rsl' // Russian
573 ]
574
575 // Only add ISO639-1 languages and some sign languages (ISO639-3)
576 iso639
577 .filter(l => {
578 return (l.iso6391 !== null && l.type === 'living') ||
579 signLanguages.indexOf(l.iso6393) !== -1
580 })
581 .forEach(l => languages[l.iso6391 || l.iso6393] = l.name)
582
583 return languages
584 }
585
586 export function reloadConfig () {
587
588 function directory () {
589 if (process.env.NODE_CONFIG_DIR) {
590 return process.env.NODE_CONFIG_DIR
591 }
592
593 return join(root(), 'config')
594 }
595
596 function purge () {
597 for (const fileName in require.cache) {
598 if (-1 === fileName.indexOf(directory())) {
599 continue
600 }
601
602 delete require.cache[fileName]
603 }
604
605 delete require.cache[require.resolve('config')]
606 }
607
608 purge()
609
610 config = require('config')
611
612 updateWebserverConfig()
613 }