PeerTube/server/initializers/constants.ts

462 lines
12 KiB
TypeScript
Raw Normal View History

import { IConfig } from 'config'
import { dirname, join } from 'path'
import { JobType, VideoRateType } from '../../shared/models'
2017-12-14 17:38:41 +01:00
import { ActivityPubActorType } from '../../shared/models/activitypub'
import { FollowState } from '../../shared/models/actors'
2017-12-12 17:53:50 +01:00
import { VideoPrivacy } from '../../shared/models/videos'
2017-05-22 20:58:25 +02:00
// Do not use barrels, remain constants as independent as possible
import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
// Use a variable to reload the configuration if we need
let config: IConfig = require('config')
2017-06-16 10:36:18 +02:00
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
2018-01-29 11:58:07 +01:00
const LAST_MIGRATION_VERSION = 190
2017-02-18 11:56:28 +01:00
// ---------------------------------------------------------------------------
2016-10-02 11:14:08 +02:00
// API version
2016-03-16 22:29:27 +01:00
const API_VERSION = 'v1'
2016-10-02 11:14:08 +02:00
// Number of results by default for the pagination
const PAGINATION_COUNT_DEFAULT = 15
// Sortable columns per schema
const SORTABLE_COLUMNS = {
2017-02-26 19:26:57 +01:00
USERS: [ 'id', 'username', 'createdAt' ],
2018-01-03 16:38:50 +01:00
ACCOUNTS: [ 'createdAt' ],
JOBS: [ 'createdAt' ],
2017-02-26 19:26:57 +01:00
VIDEO_ABUSES: [ 'id', 'createdAt' ],
2017-10-24 19:41:09 +02:00
VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
Handle blacklist (#84) * Client: Add list blacklist feature * Server: Add list blacklist feature * Client: Add videoId column * Server: Add some video infos in the REST api * Client: Add video information in the blacklist list * Fix sortable columns :) * Client: Add removeFromBlacklist feature * Server: Add removeFromBlacklist feature * Move to TypeScript * Move to TypeScript and Promises * Server: Fix blacklist list sort * Server: Fetch videos informations * Use common shared interface for client and server * Add check-params remove blacklisted video tests * Add check-params list blacklisted videos tests * Add list blacklist tests * Add remove from blacklist tests * Add video blacklist management tests * Fix rebase onto develop issues * Server: Add sort on blacklist id column * Server: Add blacklists library * Add blacklist id sort test * Add check-params tests for blacklist list pagination, count and sort * Fix coding style * Increase Remote API tests timeout * Increase Request scheduler API tests timeout * Fix typo * Increase video transcoding API tests timeout * Move tests to Typescript * Use lodash orderBy method * Fix typos * Client: Remove optional tests in blacklist model attributes * Move blacklist routes from 'blacklists' to 'blacklist' * CLient: Remove blacklist-list.component.scss * Rename 'blacklists' files to 'blacklist' * Use only BlacklistedVideo interface * Server: Use getFormattedObjects method in listBlacklist method * Client: Use new coding style * Server: Use new sort validator methods * Server: Use new checkParams methods * Client: Fix sortable columns
2017-09-22 09:13:43 +02:00
VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
2017-12-22 10:50:07 +01:00
VIDEO_COMMENT_THREADS: [ 'createdAt' ],
2017-11-13 17:39:41 +01:00
BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
FOLLOWERS: [ 'createdAt' ],
FOLLOWING: [ 'createdAt' ]
2016-10-02 11:14:08 +02:00
}
2016-07-20 16:23:58 +02:00
const OAUTH_LIFETIME = {
ACCESS_TOKEN: 3600 * 4, // 4 hours
REFRESH_TOKEN: 1209600 // 2 weeks
}
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
2016-08-25 17:57:37 +02:00
// 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
}
const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
'activitypub-http-broadcast': 1,
'activitypub-http-unicast': 5,
'activitypub-http-fetcher': 1,
'video-file': 1
}
// 2 days
const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2
// 1 hour
let SCHEDULER_INTERVAL = 60000 * 60
// ---------------------------------------------------------------------------
2016-08-19 21:34:51 +02:00
const CONFIG = {
CUSTOM_FILE: getLocalConfigFilePath(),
LISTEN: {
2017-05-15 22:22:03 +02:00
PORT: config.get<number>('listen.port')
},
2016-08-19 21:34:51 +02:00
DATABASE: {
2017-05-15 22:22:03 +02:00
DBNAME: 'peertube' + config.get<string>('database.suffix'),
HOSTNAME: config.get<string>('database.hostname'),
PORT: config.get<number>('database.port'),
USERNAME: config.get<string>('database.username'),
PASSWORD: config.get<string>('database.password')
2016-08-19 21:34:51 +02:00
},
REDIS: {
HOSTNAME: config.get<string>('redis.hostname'),
PORT: config.get<string>('redis.port'),
AUTH: config.get<string>('redis.auth')
},
2016-08-19 21:34:51 +02:00
STORAGE: {
2018-01-16 08:46:44 +01:00
AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
LOG_DIR: buildPath(config.get<string>('storage.logs')),
VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
CACHE_DIR: buildPath(config.get<string>('storage.cache'))
2016-08-19 21:34:51 +02:00
},
WEBSERVER: {
2017-05-15 22:22:03 +02:00
SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
HOSTNAME: config.get<string>('webserver.hostname'),
PORT: config.get<number>('webserver.port'),
URL: '',
HOST: ''
2017-02-16 19:19:56 +01:00
},
2018-01-19 13:58:13 +01:00
LOG: {
LEVEL: config.get<string>('log.level')
},
2017-02-16 19:19:56 +01:00
ADMIN: {
get EMAIL () { return config.get<string>('admin.email') }
2017-03-10 11:32:39 +01:00
},
SIGNUP: {
get ENABLED () { return config.get<boolean>('signup.enabled') },
get LIMIT () { return config.get<number>('signup.limit') }
2017-09-04 20:07:54 +02:00
},
USER: {
get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
},
TRANSCODING: {
get ENABLED () { return config.get<boolean>('transcoding.enabled') },
get THREADS () { return config.get<number>('transcoding.threads') },
RESOLUTIONS: {
get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
}
2017-07-12 11:56:02 +02:00
},
CACHE: {
PREVIEWS: {
get SIZE () { return config.get<number>('cache.previews.size') }
2017-07-12 11:56:02 +02:00
}
2016-08-19 21:34:51 +02:00
}
}
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
2016-07-31 20:58:43 +02:00
const CONSTRAINTS_FIELDS = {
USERS: {
USERNAME: { min: 3, max: 20 }, // Length
2017-09-04 20:07:54 +02:00
PASSWORD: { min: 6, max: 255 }, // Length
VIDEO_QUOTA: { min: -1 }
2016-07-31 20:58:43 +02:00
},
2017-01-04 20:59:23 +01:00
VIDEO_ABUSES: {
REASON: { min: 2, max: 300 } // Length
},
2017-10-24 19:41:09 +02:00
VIDEO_CHANNELS: {
NAME: { min: 3, max: 120 }, // Length
2017-11-14 10:57:56 +01:00
DESCRIPTION: { min: 3, max: 250 }, // Length
URL: { min: 3, max: 2000 } // Length
2017-10-24 19:41:09 +02:00
},
2016-07-31 20:58:43 +02:00
VIDEOS: {
NAME: { min: 3, max: 120 }, // Length
2017-10-30 10:16:27 +01:00
TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
DESCRIPTION: { min: 3, max: 3000 }, // Length
2016-12-11 21:50:51 +01:00
EXTNAME: [ '.mp4', '.ogv', '.webm' ],
2017-09-04 21:21:47 +02:00
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
2016-07-31 20:58:43 +02:00
THUMBNAIL: { min: 2, max: 30 },
2017-02-26 18:57:33 +01:00
THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
VIEWS: { min: 0 },
LIKES: { min: 0 },
DISLIKES: { min: 0 },
FILE_SIZE: { min: 10 },
2017-11-14 10:57:56 +01:00
URL: { min: 3, max: 2000 } // Length
},
2018-01-03 11:10:40 +01:00
ACTORS: {
2017-11-14 10:57:56 +01:00
PUBLIC_KEY: { min: 10, max: 5000 }, // Length
PRIVATE_KEY: { min: 10, max: 5000 }, // Length
2017-12-29 19:10:13 +01:00
URL: { min: 3, max: 2000 }, // Length
AVATAR: {
2018-01-03 11:10:40 +01:00
EXTNAME: [ '.png', '.jpeg', '.jpg' ],
FILE_SIZE: {
max: 2 * 1024 * 1024 // 2MB
}
2017-12-29 19:10:13 +01:00
}
2017-02-26 18:57:33 +01:00
},
VIDEO_EVENTS: {
COUNT: { min: 0 }
},
2017-12-22 10:50:07 +01:00
VIDEO_COMMENTS: {
TEXT: { min: 2, max: 3000 }, // Length
URL: { min: 3, max: 2000 } // Length
},
VIDEO_SHARE: {
URL: { min: 3, max: 2000 } // Length
2016-07-31 20:58:43 +02:00
}
}
2017-06-16 10:36:18 +02:00
const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
2017-03-08 21:35:43 +01:00
LIKE: 'like',
DISLIKE: 'dislike'
}
2017-03-22 21:15:55 +01:00
const VIDEO_CATEGORIES = {
1: 'Music',
2: 'Films',
3: 'Vehicles',
4: 'Art',
5: 'Sports',
6: 'Travels',
7: 'Gaming',
8: 'People',
9: 'Comedy',
10: 'Entertainment',
11: 'News',
12: 'How To',
2017-03-22 21:15:55 +01:00
13: 'Education',
14: 'Activism',
15: 'Science & Technology',
16: 'Animals',
17: 'Kids',
18: 'Food'
}
2017-03-27 20:53:11 +02:00
// See https://creativecommons.org/licenses/?lang=en
const VIDEO_LICENCES = {
1: 'Attribution',
2: 'Attribution - Share Alike',
3: 'Attribution - No Derivatives',
4: 'Attribution - Non Commercial',
5: 'Attribution - Non Commercial - Share Alike',
6: 'Attribution - Non Commercial - No Derivatives',
7: 'Public Domain Dedication'
}
2017-04-07 12:13:37 +02:00
// See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
const VIDEO_LANGUAGES = {
1: 'English',
2: 'Spanish',
3: 'Mandarin',
4: 'Hindi',
5: 'Arabic',
6: 'Portuguese',
7: 'Bengali',
8: 'Russian',
9: 'Japanese',
10: 'Punjabi',
11: 'German',
12: 'Korean',
13: 'French',
14: 'Italian'
2017-04-07 12:13:37 +02:00
}
2017-10-31 11:52:52 +01:00
const VIDEO_PRIVACIES = {
[VideoPrivacy.PUBLIC]: 'Public',
[VideoPrivacy.UNLISTED]: 'Unlisted',
[VideoPrivacy.PRIVATE]: 'Private'
}
2017-11-10 14:34:45 +01:00
const VIDEO_MIMETYPE_EXT = {
'video/webm': '.webm',
'video/ogg': '.ogv',
'video/mp4': '.mp4'
2017-11-10 14:34:45 +01:00
}
2017-12-29 19:10:13 +01:00
const AVATAR_MIMETYPE_EXT = {
'image/png': '.png',
'image/jpg': '.jpg',
'image/jpeg': '.jpg'
}
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
2017-12-14 17:38:41 +01:00
const SERVER_ACTOR_NAME = 'peertube'
2017-11-14 17:31:26 +01:00
2017-11-09 17:51:58 +01:00
const ACTIVITY_PUB = {
2017-11-30 13:15:25 +01:00
POTENTIAL_ACCEPT_HEADERS: [
'application/activity+json',
2018-01-11 19:17:43 +01:00
'application/ld+json',
'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
],
2017-11-30 13:15:25 +01:00
ACCEPT_HEADER: 'application/activity+json, application/ld+json',
2017-11-17 15:20:42 +01:00
PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
2017-11-10 14:34:45 +01:00
COLLECTION_ITEMS_PER_PAGE: 10,
2017-11-22 10:29:55 +01:00
FETCH_PAGE_LIMIT: 100,
2017-11-16 15:22:39 +01:00
URL_MIME_TYPES: {
VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
2017-11-16 15:22:39 +01:00
TORRENT: [ 'application/x-bittorrent' ],
MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
2018-01-04 14:04:02 +01:00
},
2018-01-10 17:18:12 +01:00
MAX_RECURSION_COMMENTS: 100,
2018-01-11 11:40:18 +01:00
ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
2017-11-09 17:51:58 +01:00
}
2017-12-14 17:38:41 +01:00
const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
GROUP: 'Group',
PERSON: 'Person',
APPLICATION: 'Application'
}
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
2017-11-09 17:51:58 +01:00
const PRIVATE_RSA_KEY_SIZE = 2048
2016-10-02 11:14:08 +02:00
// Password encryption
const BCRYPT_SALT_SIZE = 10
2016-05-17 21:03:00 +02:00
// ---------------------------------------------------------------------------
// Express static paths (router)
const STATIC_PATHS = {
2016-11-11 15:20:03 +01:00
PREVIEWS: '/static/previews/',
THUMBNAILS: '/static/thumbnails/',
TORRENTS: '/static/torrents/',
2017-12-29 19:10:13 +01:00
WEBSEED: '/static/webseed/',
AVATARS: '/static/avatars/'
}
// Cache control
let STATIC_MAX_AGE = '30d'
// Videos thumbnail size
2017-10-16 10:05:49 +02:00
const THUMBNAILS_SIZE = {
width: 200,
height: 110
}
const PREVIEWS_SIZE = {
width: 560,
height: 315
}
2018-01-03 11:36:03 +01:00
const AVATARS_SIZE = {
width: 120,
height: 120
}
const EMBED_SIZE = {
width: 560,
height: 315
2017-10-16 10:05:49 +02:00
}
2017-09-04 21:45:05 +02:00
// Sub folders of cache directory
2017-07-12 11:56:02 +02:00
const CACHE = {
DIRECTORIES: {
PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
}
}
2017-12-19 10:34:56 +01:00
const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
2017-11-30 13:37:11 +01:00
// ---------------------------------------------------------------------------
2017-10-16 10:05:49 +02:00
const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
2017-07-07 16:57:28 +02:00
// ---------------------------------------------------------------------------
// Special constants for a test instance
if (isTestInstance() === true) {
ACTOR_FOLLOW_SCORE.BASE = 20
2016-11-11 15:20:03 +01:00
REMOTE_SCHEME.HTTP = 'http'
REMOTE_SCHEME.WS = 'ws'
2017-05-15 22:22:03 +02:00
STATIC_MAX_AGE = '0'
ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
2018-01-11 11:40:18 +01:00
ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
2018-01-03 11:10:40 +01:00
CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
SCHEDULER_INTERVAL = 10000
}
updateWebserverConfig()
// ---------------------------------------------------------------------------
2017-05-15 22:22:03 +02:00
export {
2016-10-02 11:14:08 +02:00
API_VERSION,
2018-01-03 11:36:03 +01:00
AVATARS_SIZE,
2017-11-30 13:37:11 +01:00
ACCEPT_HEADERS,
2016-10-02 11:14:08 +02:00
BCRYPT_SALT_SIZE,
2017-07-12 11:56:02 +02:00
CACHE,
2016-10-02 11:14:08 +02:00
CONFIG,
CONSTRAINTS_FIELDS,
EMBED_SIZE,
JOB_CONCURRENCY,
JOB_ATTEMPTS,
2016-12-25 09:44:57 +01:00
LAST_MIGRATION_VERSION,
2016-10-02 11:14:08 +02:00
OAUTH_LIFETIME,
2017-10-16 10:05:49 +02:00
OPENGRAPH_AND_OEMBED_COMMENT,
2016-10-02 11:14:08 +02:00
PAGINATION_COUNT_DEFAULT,
ACTOR_FOLLOW_SCORE,
2016-11-11 15:20:03 +01:00
PREVIEWS_SIZE,
REMOTE_SCHEME,
2017-11-13 17:39:41 +01:00
FOLLOW_STATES,
2017-12-14 17:38:41 +01:00
SERVER_ACTOR_NAME,
2017-11-09 17:51:58 +01:00
PRIVATE_RSA_KEY_SIZE,
2016-10-02 11:14:08 +02:00
SORTABLE_COLUMNS,
STATIC_MAX_AGE,
STATIC_PATHS,
2017-11-09 17:51:58 +01:00
ACTIVITY_PUB,
2017-12-14 17:38:41 +01:00
ACTIVITY_PUB_ACTOR_TYPES,
2016-10-02 11:14:08 +02:00
THUMBNAILS_SIZE,
2017-03-22 21:15:55 +01:00
VIDEO_CATEGORIES,
2017-04-07 12:13:37 +02:00
VIDEO_LANGUAGES,
2017-10-31 11:52:52 +01:00
VIDEO_PRIVACIES,
2017-03-27 20:53:11 +02:00
VIDEO_LICENCES,
2017-11-10 14:34:45 +01:00
VIDEO_RATE_TYPES,
2017-12-29 19:10:13 +01:00
VIDEO_MIMETYPE_EXT,
AVATAR_MIMETYPE_EXT,
SCHEDULER_INTERVAL,
JOB_COMPLETED_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()
}