X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Finitializers%2Fconstants.ts;h=481b21bbb2e3ffaa1b0c8697671b018fa7808ba3;hb=b32b78271856ee12fdce5fadc7ed0fe81ecaeff5;hp=50a939083c7db721ddad6ee2032b849fed4f0cb6;hpb=93e1258c7cbc0d1235ca6d2a1f7c1875985328b8;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/initializers/constants.ts b/server/initializers/constants.ts index 50a939083..481b21bbb 100644 --- a/server/initializers/constants.ts +++ b/server/initializers/constants.ts @@ -1,21 +1,18 @@ -import * as config from 'config' -import { join } from 'path' - +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 { root, isTestInstance } from '../helpers/core-utils' +import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils' -import { - UserRole, - VideoRateType, - RequestEndpoint, - RequestVideoEventType, - RequestVideoQaduType, - JobState -} from '../../shared/models' +// Use a variable to reload the configuration if we need +let config: IConfig = require('config') // --------------------------------------------------------------------------- -const LAST_MIGRATION_VERSION = 65 +const LAST_MIGRATION_VERSION = 195 // --------------------------------------------------------------------------- @@ -25,16 +22,18 @@ const API_VERSION = 'v1' // Number of results by default for the pagination const PAGINATION_COUNT_DEFAULT = 15 -// Sortable columns per schema -const SEARCHABLE_COLUMNS = { - VIDEOS: [ 'name', 'magnetUri', 'host', 'author', 'tags' ] -} - // Sortable columns per schema const SORTABLE_COLUMNS = { USERS: [ 'id', 'username', 'createdAt' ], + ACCOUNTS: [ 'createdAt' ], + JOBS: [ 'createdAt' ], VIDEO_ABUSES: [ 'id', 'createdAt' ], - VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ] + 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' ] } const OAUTH_LIFETIME = { @@ -44,7 +43,48 @@ const OAUTH_LIFETIME = { // --------------------------------------------------------------------------- +// Number of points we add/remove after a successful/bad request +const ACTOR_FOLLOW_SCORE = { + PENALTY: -10, + BONUS: 10, + BASE: 1000, + MAX: 10000 +} + +const FOLLOW_STATES: { [ id: string ]: FollowState } = { + PENDING: 'pending', + ACCEPTED: 'accepted' +} + +const REMOTE_SCHEME = { + HTTP: 'https', + WS: 'wss' +} + +const JOB_ATTEMPTS: { [ id in JobType ]: number } = { + 'activitypub-http-broadcast': 5, + 'activitypub-http-unicast': 5, + 'activitypub-http-fetcher': 5, + 'video-file': 1, + 'email': 5 +} +const JOB_CONCURRENCY: { [ id in JobType ]: number } = { + 'activitypub-http-broadcast': 1, + 'activitypub-http-unicast': 5, + 'activitypub-http-fetcher': 1, + 'video-file': 1, + 'email': 5 +} +// 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') }, @@ -55,14 +95,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: { - CERT_DIR: join(root(), config.get('storage.certs')), - 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', @@ -72,56 +127,119 @@ const CONFIG = { URL: '', HOST: '' }, + 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: { + 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: { + 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') }, + CUSTOMIZATIONS: { + get JAVASCRIPT () { return config.get('instance.customizations.javascript') }, + get CSS () { return config.get('instance.customizations.css') } } } } -CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT -CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT // --------------------------------------------------------------------------- const CONSTRAINTS_FIELDS = { USERS: { USERNAME: { min: 3, max: 20 }, // Length - PASSWORD: { min: 6, max: 255 } // Length + PASSWORD: { min: 6, max: 255 }, // Length + DESCRIPTION: { min: 3, max: 250 }, // Length + VIDEO_QUOTA: { min: -1 } }, VIDEO_ABUSES: { REASON: { min: 2, max: 300 } // Length }, - VIDEOS: { - NAME: { min: 3, max: 50 }, // Length + 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: 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, infohash is 20 bytes length but we represent it in hexa so 20 * 2 - DURATION: { min: 1, max: 7200 }, // Number - TAGS: { min: 0, max: 3 }, // Number of total tags - TAG: { min: 2, max: 10 }, // Length + 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 + TAGS: { min: 0, max: 5 }, // Number of total tags + TAG: { min: 2, max: 30 }, // Length THUMBNAIL: { min: 2, max: 30 }, THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes VIEWS: { min: 0 }, LIKES: { min: 0 }, DISLIKES: { min: 0 }, - FILE_SIZE: { min: 10, max: 1024 * 1024 * 1024 * 3 /* 3Go */ } + FILE_SIZE: { min: 10 }, + URL: { min: 3, max: 2000 } // Length + }, + ACTORS: { + PUBLIC_KEY: { min: 10, max: 5000 }, // Length + PRIVATE_KEY: { min: 10, max: 5000 }, // 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 } } +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' @@ -139,7 +257,7 @@ const VIDEO_CATEGORIES = { 9: 'Comedy', 10: 'Entertainment', 11: 'News', - 12: 'Howto', + 12: 'How To', 13: 'Education', 14: 'Activism', 15: 'Science & Technology', @@ -174,109 +292,65 @@ const VIDEO_LANGUAGES = { 11: 'German', 12: 'Korean', 13: 'French', - 14: 'Italien' + 14: 'Italian' } -const VIDEO_FILE_RESOLUTIONS = { - 0: 'original', - 1: '360p', - 2: '480p', - 3: '720p', - 4: '1080p' +const VIDEO_PRIVACIES = { + [VideoPrivacy.PUBLIC]: 'Public', + [VideoPrivacy.UNLISTED]: 'Unlisted', + [VideoPrivacy.PRIVATE]: 'Private' } -// --------------------------------------------------------------------------- - -// Score a pod has when we create it as a friend -const FRIEND_SCORE = { - BASE: 100, - MAX: 1000 +const VIDEO_MIMETYPE_EXT = { + 'video/webm': '.webm', + 'video/ogg': '.ogv', + 'video/mp4': '.mp4' } -// --------------------------------------------------------------------------- - -// Number of points we add/remove from a friend after a successful/bad request -const PODS_SCORE = { - MALUS: -10, - BONUS: 10 +const IMAGE_MIMETYPE_EXT = { + 'image/png': '.png', + 'image/jpg': '.jpg', + 'image/jpeg': '.jpg' } -// Time to wait between requests to the friends (10 min) -let REQUESTS_INTERVAL = 600000 - -// Number of requests in parallel we can make -const REQUESTS_IN_PARALLEL = 10 - -// To how many pods we send requests -const REQUESTS_LIMIT_PODS = 10 -// How many requests we send to a pod per interval -const REQUESTS_LIMIT_PER_POD = 5 - -const REQUESTS_VIDEO_QADU_LIMIT_PODS = 10 -// The QADU requests are not big -const REQUESTS_VIDEO_QADU_LIMIT_PER_POD = 50 - -const REQUESTS_VIDEO_EVENT_LIMIT_PODS = 10 -// The EVENTS requests are not big -const REQUESTS_VIDEO_EVENT_LIMIT_PER_POD = 50 - -// Number of requests to retry for replay requests module -const RETRY_REQUESTS = 5 - -const REQUEST_ENDPOINTS: { [ id: string ]: RequestEndpoint } = { - VIDEOS: 'videos' -} - -const REQUEST_ENDPOINT_ACTIONS: { [ id: string ]: any } = {} -REQUEST_ENDPOINT_ACTIONS[REQUEST_ENDPOINTS.VIDEOS] = { - ADD: 'add', - UPDATE: 'update', - REMOVE: 'remove', - REPORT_ABUSE: 'report-abuse' -} - -const REQUEST_VIDEO_QADU_ENDPOINT = 'videos/qadu' -const REQUEST_VIDEO_EVENT_ENDPOINT = 'videos/events' - -const REQUEST_VIDEO_QADU_TYPES: { [ id: string ]: RequestVideoQaduType } = { - LIKES: 'likes', - DISLIKES: 'dislikes', - VIEWS: 'views' -} - -const REQUEST_VIDEO_EVENT_TYPES: { [ id: string ]: RequestVideoEventType } = { - LIKES: 'likes', - DISLIKES: 'dislikes', - VIEWS: 'views' -} +// --------------------------------------------------------------------------- -const REMOTE_SCHEME = { - HTTP: 'https', - WS: 'wss' +const SERVER_ACTOR_NAME = 'peertube' + +const ACTIVITY_PUB = { + POTENTIAL_ACCEPT_HEADERS: [ + 'application/activity+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, + URL_MIME_TYPES: { + 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 JOB_STATES: { [ id: string ]: JobState } = { - PENDING: 'pending', - PROCESSING: 'processing', - ERROR: 'error', - SUCCESS: 'success' +const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = { + GROUP: 'Group', + PERSON: 'Person', + APPLICATION: 'Application' } -// How many maximum jobs we fetch from the database per cycle -const JOBS_FETCH_LIMIT_PER_CYCLE = 10 -const JOBS_CONCURRENCY = 1 -// 1 minutes -let JOBS_FETCHING_INTERVAL = 60000 // --------------------------------------------------------------------------- -const PRIVATE_CERT_NAME = 'peertube.key.pem' -const PUBLIC_CERT_NAME = 'peertube.pub' -const SIGNATURE_ALGORITHM = 'RSA-SHA256' -const SIGNATURE_ENCODING = 'hex' +const PRIVATE_RSA_KEY_SIZE = 2048 // Password encryption const BCRYPT_SALT_SIZE = 10 +const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes + // --------------------------------------------------------------------------- // Express static paths (router) @@ -284,95 +358,148 @@ const STATIC_PATHS = { PREVIEWS: '/static/previews/', THUMBNAILS: '/static/thumbnails/', TORRENTS: '/static/torrents/', - WEBSEED: '/static/webseed/' + WEBSEED: '/static/webseed/', + AVATARS: '/static/avatars/' } // Cache control let STATIC_MAX_AGE = '30d' // Videos thumbnail size -const THUMBNAILS_SIZE = '200x110' -const PREVIEWS_SIZE = '640x480' +const THUMBNAILS_SIZE = { + width: 200, + height: 110 +} +const PREVIEWS_SIZE = { + width: 560, + height: 315 +} +const AVATARS_SIZE = { + width: 120, + height: 120 +} -// Subfolders of cache directory +const EMBED_SIZE = { + width: 560, + height: 315 +} + +// Sub folders of cache directory const CACHE = { DIRECTORIES: { PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews') } } -// --------------------------------------------------------------------------- - -const USER_ROLES: { [ id: string ]: UserRole } = { - ADMIN: 'admin', - USER: 'user' -} +const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS) // --------------------------------------------------------------------------- -const OPENGRAPH_COMMENT = '' +const OPENGRAPH_AND_OEMBED_COMMENT = '' // --------------------------------------------------------------------------- // Special constants for a test instance if (isTestInstance() === true) { - CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14 - FRIEND_SCORE.BASE = 20 - REQUESTS_INTERVAL = 10000 - JOBS_FETCHING_INTERVAL = 10000 + 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 } +updateWebserverConfig() + // --------------------------------------------------------------------------- export { API_VERSION, + AVATARS_SIZE, + ACCEPT_HEADERS, BCRYPT_SALT_SIZE, CACHE, CONFIG, CONSTRAINTS_FIELDS, - FRIEND_SCORE, - JOB_STATES, - JOBS_CONCURRENCY, - JOBS_FETCH_LIMIT_PER_CYCLE, - JOBS_FETCHING_INTERVAL, + EMBED_SIZE, + JOB_CONCURRENCY, + JOB_ATTEMPTS, LAST_MIGRATION_VERSION, OAUTH_LIFETIME, - OPENGRAPH_COMMENT, + OPENGRAPH_AND_OEMBED_COMMENT, PAGINATION_COUNT_DEFAULT, - PODS_SCORE, + ACTOR_FOLLOW_SCORE, PREVIEWS_SIZE, - PRIVATE_CERT_NAME, - PUBLIC_CERT_NAME, REMOTE_SCHEME, - REQUEST_ENDPOINT_ACTIONS, - REQUEST_ENDPOINTS, - REQUEST_VIDEO_EVENT_ENDPOINT, - REQUEST_VIDEO_EVENT_TYPES, - REQUEST_VIDEO_QADU_ENDPOINT, - REQUEST_VIDEO_QADU_TYPES, - REQUESTS_IN_PARALLEL, - REQUESTS_INTERVAL, - REQUESTS_LIMIT_PER_POD, - REQUESTS_LIMIT_PODS, - REQUESTS_VIDEO_EVENT_LIMIT_PER_POD, - REQUESTS_VIDEO_EVENT_LIMIT_PODS, - REQUESTS_VIDEO_QADU_LIMIT_PER_POD, - REQUESTS_VIDEO_QADU_LIMIT_PODS, - RETRY_REQUESTS, - SEARCHABLE_COLUMNS, - SIGNATURE_ALGORITHM, - SIGNATURE_ENCODING, + FOLLOW_STATES, + SERVER_ACTOR_NAME, + PRIVATE_RSA_KEY_SIZE, SORTABLE_COLUMNS, STATIC_MAX_AGE, STATIC_PATHS, + ACTIVITY_PUB, + ACTIVITY_PUB_ACTOR_TYPES, THUMBNAILS_SIZE, - USER_ROLES, VIDEO_CATEGORIES, - VIDEO_FILE_RESOLUTIONS, VIDEO_LANGUAGES, + VIDEO_PRIVACIES, VIDEO_LICENCES, - VIDEO_RATE_TYPES + VIDEO_RATE_TYPES, + VIDEO_MIMETYPE_EXT, + VIDEO_TRANSCODING_FPS, + USER_PASSWORD_RESET_LIFETIME, + IMAGE_MIMETYPE_EXT, + SCHEDULER_INTERVAL, + 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() }