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