X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Finitializers%2Fconstants.ts;h=d1915586ae78537c044ca195c9b811dfbfd425b6;hb=0883b3245bf0deb9106c4041e9afbd3521b79280;hp=100a77622f5ce2f214da8703d2111a0f23eee84b;hpb=225a89c2afbbe53cf39ffa7ea0cd485095a1d5f5;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/initializers/constants.ts b/server/initializers/constants.ts index 100a77622..d1915586a 100644 --- a/server/initializers/constants.ts +++ b/server/initializers/constants.ts @@ -1,15 +1,19 @@ -import * as config from 'config' -import { join } from 'path' -import { JobCategory, JobState, VideoRateType } from '../../shared/models' +import { IConfig } from 'config' +import { dirname, join } from 'path' +import { JobType, VideoRateType } from '../../shared/models' import { ActivityPubActorType } from '../../shared/models/activitypub' import { FollowState } from '../../shared/models/actors' import { VideoPrivacy } from '../../shared/models/videos' // Do not use barrels, remain constants as independent as possible -import { isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils' +import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils' +import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type' + +// Use a variable to reload the configuration if we need +let config: IConfig = require('config') // --------------------------------------------------------------------------- -const LAST_MIGRATION_VERSION = 140 +const LAST_MIGRATION_VERSION = 205 // --------------------------------------------------------------------------- @@ -22,10 +26,12 @@ const PAGINATION_COUNT_DEFAULT = 15 // Sortable columns per schema const SORTABLE_COLUMNS = { USERS: [ 'id', 'username', 'createdAt' ], - JOBS: [ 'id', 'createdAt' ], + ACCOUNTS: [ 'createdAt' ], + JOBS: [ 'createdAt' ], VIDEO_ABUSES: [ 'id', 'createdAt' ], VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ], VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ], + VIDEO_COMMENT_THREADS: [ 'createdAt' ], BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ], FOLLOWERS: [ 'createdAt' ], FOLLOWING: [ 'createdAt' ] @@ -38,12 +44,12 @@ const OAUTH_LIFETIME = { // --------------------------------------------------------------------------- -// Number of points we add/remove from a friend after a successful/bad request -const SERVERS_SCORE = { +// Number of points we add/remove after a successful/bad request +const ACTOR_FOLLOW_SCORE = { PENALTY: -10, BONUS: 10, - BASE: 100, - MAX: 1000 + BASE: 1000, + MAX: 10000 } const FOLLOW_STATES: { [ id: string ]: FollowState } = { @@ -56,29 +62,36 @@ const REMOTE_SCHEME = { WS: 'wss' } -const JOB_STATES: { [ id: string ]: JobState } = { - PENDING: 'pending', - PROCESSING: 'processing', - ERROR: 'error', - SUCCESS: 'success' +const JOB_ATTEMPTS: { [ id in JobType ]: number } = { + 'activitypub-http-broadcast': 5, + 'activitypub-http-unicast': 5, + 'activitypub-http-fetcher': 5, + 'activitypub-follow': 5, + 'video-file': 1, + 'email': 5 } -const JOB_CATEGORIES: { [ id: string ]: JobCategory } = { - TRANSCODING: 'transcoding', - ACTIVITYPUB_HTTP: 'activitypub-http' +const JOB_CONCURRENCY: { [ id in JobType ]: number } = { + 'activitypub-http-broadcast': 1, + 'activitypub-http-unicast': 5, + 'activitypub-http-fetcher': 1, + 'activitypub-follow': 3, + 'video-file': 1, + 'email': 5 } -// How many maximum jobs we fetch from the database per cycle -const JOBS_FETCH_LIMIT_PER_CYCLE = { - transcoding: 10, - httpRequest: 20 -} -// 1 minutes -let JOBS_FETCHING_INTERVAL = 60000 +const BROADCAST_CONCURRENCY = 5 // How many requests in parallel we do in activitypub-http-broadcast job +// 2 days +const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 + +// 1 hour +let SCHEDULER_INTERVAL = 60000 * 60 // --------------------------------------------------------------------------- const CONFIG = { + CUSTOM_FILE: getLocalConfigFilePath(), LISTEN: { - PORT: config.get('listen.port') + PORT: config.get('listen.port'), + HOSTNAME: config.get('listen.hostname') }, DATABASE: { DBNAME: 'peertube' + config.get('database.suffix'), @@ -87,14 +100,29 @@ const CONFIG = { USERNAME: config.get('database.username'), PASSWORD: config.get('database.password') }, + REDIS: { + HOSTNAME: config.get('redis.hostname'), + PORT: config.get('redis.port'), + AUTH: config.get('redis.auth') + }, + SMTP: { + HOSTNAME: config.get('smtp.hostname'), + PORT: config.get('smtp.port'), + USERNAME: config.get('smtp.username'), + PASSWORD: config.get('smtp.password'), + TLS: config.get('smtp.tls'), + DISABLE_STARTTLS: config.get('smtp.disable_starttls'), + CA_FILE: config.get('smtp.ca_file'), + FROM_ADDRESS: config.get('smtp.from_address') + }, STORAGE: { - AVATARS_DIR: join(root(), config.get('storage.avatars')), - LOG_DIR: join(root(), config.get('storage.logs')), - VIDEOS_DIR: join(root(), config.get('storage.videos')), - THUMBNAILS_DIR: join(root(), config.get('storage.thumbnails')), - PREVIEWS_DIR: join(root(), config.get('storage.previews')), - TORRENTS_DIR: join(root(), config.get('storage.torrents')), - CACHE_DIR: join(root(), config.get('storage.cache')) + AVATARS_DIR: buildPath(config.get('storage.avatars')), + LOG_DIR: buildPath(config.get('storage.logs')), + VIDEOS_DIR: buildPath(config.get('storage.videos')), + THUMBNAILS_DIR: buildPath(config.get('storage.thumbnails')), + PREVIEWS_DIR: buildPath(config.get('storage.previews')), + TORRENTS_DIR: buildPath(config.get('storage.torrents')), + CACHE_DIR: buildPath(config.get('storage.cache')) }, WEBSERVER: { SCHEME: config.get('webserver.https') === true ? 'https' : 'http', @@ -104,43 +132,57 @@ const CONFIG = { URL: '', HOST: '' }, + TRUST_PROXY: config.get('trust_proxy'), + LOG: { + LEVEL: config.get('log.level') + }, ADMIN: { - EMAIL: config.get('admin.email') + get EMAIL () { return config.get('admin.email') } }, SIGNUP: { - ENABLED: config.get('signup.enabled'), - LIMIT: config.get('signup.limit') + get ENABLED () { return config.get('signup.enabled') }, + get LIMIT () { return config.get('signup.limit') } }, USER: { - VIDEO_QUOTA: config.get('user.video_quota') + get VIDEO_QUOTA () { return config.get('user.video_quota') } }, TRANSCODING: { - ENABLED: config.get('transcoding.enabled'), - THREADS: config.get('transcoding.threads'), + get ENABLED () { return config.get('transcoding.enabled') }, + get THREADS () { return config.get('transcoding.threads') }, RESOLUTIONS: { - '240' : config.get('transcoding.resolutions.240p'), - '360': config.get('transcoding.resolutions.360p'), - '480': config.get('transcoding.resolutions.480p'), - '720': config.get('transcoding.resolutions.720p'), - '1080': config.get('transcoding.resolutions.1080p') + get '240p' () { return config.get('transcoding.resolutions.240p') }, + get '360p' () { return config.get('transcoding.resolutions.360p') }, + get '480p' () { return config.get('transcoding.resolutions.480p') }, + get '720p' () { return config.get('transcoding.resolutions.720p') }, + get '1080p' () { return config.get('transcoding.resolutions.1080p') } } }, CACHE: { PREVIEWS: { - SIZE: config.get('cache.previews.size') + get SIZE () { return config.get('cache.previews.size') } + } + }, + INSTANCE: { + get NAME () { return config.get('instance.name') }, + get SHORT_DESCRIPTION () { return config.get('instance.short_description') }, + get DESCRIPTION () { return config.get('instance.description') }, + get TERMS () { return config.get('instance.terms') }, + get DEFAULT_CLIENT_ROUTE () { return config.get('instance.default_client_route') }, + get DEFAULT_NSFW_POLICY () { return config.get('instance.default_nsfw_policy') }, + CUSTOMIZATIONS: { + get JAVASCRIPT () { return config.get('instance.customizations.javascript') }, + get CSS () { return config.get('instance.customizations.css') } } } } -const AVATARS_DIR = { - ACCOUNT: join(CONFIG.STORAGE.AVATARS_DIR, 'account') -} // --------------------------------------------------------------------------- const CONSTRAINTS_FIELDS = { USERS: { USERNAME: { min: 3, max: 20 }, // Length PASSWORD: { min: 6, max: 255 }, // Length + DESCRIPTION: { min: 3, max: 250 }, // Length VIDEO_QUOTA: { min: -1 } }, VIDEO_ABUSES: { @@ -149,12 +191,20 @@ const CONSTRAINTS_FIELDS = { VIDEO_CHANNELS: { NAME: { min: 3, max: 120 }, // Length DESCRIPTION: { min: 3, max: 250 }, // Length + SUPPORT: { min: 3, max: 300 }, // Length URL: { min: 3, max: 2000 } // Length }, VIDEOS: { NAME: { min: 3, max: 120 }, // Length TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length - DESCRIPTION: { min: 3, max: 3000 }, // Length + DESCRIPTION: { min: 3, max: 10000 }, // Length + SUPPORT: { min: 3, max: 300 }, // Length + IMAGE: { + EXTNAME: [ '.jpg', '.jpeg' ], + FILE_SIZE: { + max: 2 * 1024 * 1024 // 2MB + } + }, EXTNAME: [ '.mp4', '.ogv', '.webm' ], INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2 DURATION: { min: 1 }, // Number @@ -168,16 +218,42 @@ const CONSTRAINTS_FIELDS = { FILE_SIZE: { min: 10 }, URL: { min: 3, max: 2000 } // Length }, - ACTOR: { + ACTORS: { PUBLIC_KEY: { min: 10, max: 5000 }, // Length PRIVATE_KEY: { min: 10, max: 5000 }, // Length - URL: { min: 3, max: 2000 } // Length + URL: { min: 3, max: 2000 }, // Length + AVATAR: { + EXTNAME: [ '.png', '.jpeg', '.jpg' ], + FILE_SIZE: { + max: 2 * 1024 * 1024 // 2MB + } + } }, VIDEO_EVENTS: { COUNT: { min: 0 } + }, + VIDEO_COMMENTS: { + TEXT: { min: 1, max: 3000 }, // Length + URL: { min: 3, max: 2000 } // Length + }, + VIDEO_SHARE: { + URL: { min: 3, max: 2000 } // Length } } +const RATES_LIMIT = { + LOGIN: { + WINDOW_MS: 5 * 60 * 1000, // 5 minutes + MAX: 15 // 15 attempts + } +} + +let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour +const VIDEO_TRANSCODING_FPS = { + MIN: 10, + MAX: 30 +} + const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = { LIKE: 'like', DISLIKE: 'dislike' @@ -230,7 +306,22 @@ const VIDEO_LANGUAGES = { 11: 'German', 12: 'Korean', 13: 'French', - 14: 'Italian' + 14: 'Italian', + 1000: 'Sign Language', + 1001: 'American Sign Language', + 1002: 'Arab Sign Language', + 1003: 'British Sign Language', + 1004: 'Brazilian Sign Language', + 1005: 'Chinese Sign Language', + 1006: 'Czech Sign Language', + 1007: 'Danish Sign Language', + 1008: 'French Sign Language', + 1009: 'German Sign Language', + 1010: 'Indo-Pakistani Sign Language', + 1011: 'Japanese Sign Language', + 1012: 'South African Sign Language', + 1013: 'Swedish Sign Language', + 1014: 'Russian Sign Language' } const VIDEO_PRIVACIES = { @@ -245,6 +336,12 @@ const VIDEO_MIMETYPE_EXT = { 'video/mp4': '.mp4' } +const IMAGE_MIMETYPE_EXT = { + 'image/png': '.png', + 'image/jpg': '.jpg', + 'image/jpeg': '.jpg' +} + // --------------------------------------------------------------------------- const SERVER_ACTOR_NAME = 'peertube' @@ -252,18 +349,20 @@ const SERVER_ACTOR_NAME = 'peertube' const ACTIVITY_PUB = { POTENTIAL_ACCEPT_HEADERS: [ 'application/activity+json', - 'application/ld+json' + 'application/ld+json', + 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"' ], ACCEPT_HEADER: 'application/activity+json, application/ld+json', PUBLIC: 'https://www.w3.org/ns/activitystreams#Public', COLLECTION_ITEMS_PER_PAGE: 10, FETCH_PAGE_LIMIT: 100, - MAX_HTTP_ATTEMPT: 5, URL_MIME_TYPES: { - VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT + VIDEO: Object.keys(VIDEO_MIMETYPE_EXT), TORRENT: [ 'application/x-bittorrent' ], MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ] - } + }, + MAX_RECURSION_COMMENTS: 100, + ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day } const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = { @@ -279,6 +378,14 @@ const PRIVATE_RSA_KEY_SIZE = 2048 // Password encryption const BCRYPT_SALT_SIZE = 10 +const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes + +const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = { + DO_NOT_LIST: 'do_not_list', + BLUR: 'blur', + DISPLAY: 'display' +} + // --------------------------------------------------------------------------- // Express static paths (router) @@ -286,7 +393,8 @@ const STATIC_PATHS = { PREVIEWS: '/static/previews/', THUMBNAILS: '/static/thumbnails/', TORRENTS: '/static/torrents/', - WEBSEED: '/static/webseed/' + WEBSEED: '/static/webseed/', + AVATARS: '/static/avatars/' } // Cache control @@ -301,6 +409,10 @@ const PREVIEWS_SIZE = { width: 560, height: 315 } +const AVATARS_SIZE = { + width: 120, + height: 120 +} const EMBED_SIZE = { width: 560, @@ -322,45 +434,55 @@ const OPENGRAPH_AND_OEMBED_COMMENT = '' // --------------------------------------------------------------------------- +const FEEDS = { + COUNT: 20, + CACHE_LIFETIME: 1000 * 60 * 15 // 15 minutes +} + +// --------------------------------------------------------------------------- + // Special constants for a test instance if (isTestInstance() === true) { - SERVERS_SCORE.BASE = 20 - JOBS_FETCHING_INTERVAL = 1000 + ACTOR_FOLLOW_SCORE.BASE = 20 REMOTE_SCHEME.HTTP = 'http' REMOTE_SCHEME.WS = 'ws' STATIC_MAX_AGE = '0' ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2 + ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds + CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB + SCHEDULER_INTERVAL = 10000 + VIDEO_VIEW_LIFETIME = 1000 // 1 second } -CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT) -CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP) +updateWebserverConfig() // --------------------------------------------------------------------------- export { API_VERSION, + AVATARS_SIZE, ACCEPT_HEADERS, BCRYPT_SALT_SIZE, CACHE, CONFIG, CONSTRAINTS_FIELDS, EMBED_SIZE, - JOB_STATES, - JOBS_FETCH_LIMIT_PER_CYCLE, - JOBS_FETCHING_INTERVAL, - JOB_CATEGORIES, + JOB_CONCURRENCY, + JOB_ATTEMPTS, LAST_MIGRATION_VERSION, OAUTH_LIFETIME, OPENGRAPH_AND_OEMBED_COMMENT, + BROADCAST_CONCURRENCY, PAGINATION_COUNT_DEFAULT, - SERVERS_SCORE, + ACTOR_FOLLOW_SCORE, PREVIEWS_SIZE, REMOTE_SCHEME, FOLLOW_STATES, - AVATARS_DIR, SERVER_ACTOR_NAME, PRIVATE_RSA_KEY_SIZE, SORTABLE_COLUMNS, + FEEDS, + NSFW_POLICY_TYPES, STATIC_MAX_AGE, STATIC_PATHS, ACTIVITY_PUB, @@ -371,5 +493,59 @@ export { VIDEO_PRIVACIES, VIDEO_LICENCES, VIDEO_RATE_TYPES, - VIDEO_MIMETYPE_EXT + VIDEO_MIMETYPE_EXT, + VIDEO_TRANSCODING_FPS, + USER_PASSWORD_RESET_LIFETIME, + IMAGE_MIMETYPE_EXT, + SCHEDULER_INTERVAL, + RATES_LIMIT, + JOB_COMPLETED_LIFETIME, + VIDEO_VIEW_LIFETIME +} + +// --------------------------------------------------------------------------- + +function getLocalConfigFilePath () { + const configSources = config.util.getConfigSources() + if (configSources.length === 0) throw new Error('Invalid config source.') + + let filename = 'local' + if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}` + if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}` + + return join(dirname(configSources[ 0 ].name), filename + '.json') +} + +function updateWebserverConfig () { + CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT) + CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP) +} + +export function reloadConfig () { + + function directory () { + if (process.env.NODE_CONFIG_DIR) { + return process.env.NODE_CONFIG_DIR + } + + return join(root(), 'config') + } + + function purge () { + for (const fileName in require.cache) { + if (-1 === fileName.indexOf(directory())) { + continue + } + + delete require.cache[fileName] + } + + delete require.cache[require.resolve('config')] + } + + purge() + + config = require('config') + + updateWebserverConfig() }