PeerTube/server/initializers/constants.ts

408 lines
11 KiB
TypeScript
Raw Normal View History

2017-06-05 21:53:49 +02:00
import * as config from 'config'
2017-05-15 22:22:03 +02:00
import { join } from 'path'
2016-08-19 21:34:51 +02:00
2017-05-22 20:58:25 +02:00
// Do not use barrels, remain constants as independent as possible
2017-06-11 15:19:43 +02:00
import { root, isTestInstance } from '../helpers/core-utils'
2017-05-22 20:58:25 +02:00
2017-06-16 10:36:18 +02:00
import {
VideoRateType,
RequestEndpoint,
RequestVideoEventType,
RequestVideoQaduType,
2017-10-24 19:41:09 +02:00
RemoteVideoRequestType,
2017-10-03 16:04:14 +02:00
JobState
2017-06-16 10:36:18 +02:00
} from '../../shared/models'
2017-10-31 11:52:52 +01:00
import { VideoPrivacy } from '../../shared/models/videos/video-privacy.enum'
2017-06-16 10:36:18 +02:00
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
2017-10-31 11:52:52 +01:00
const LAST_MIGRATION_VERSION = 95
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 SEARCHABLE_COLUMNS = {
2016-12-11 21:50:51 +01:00
VIDEOS: [ 'name', 'magnetUri', 'host', 'author', 'tags' ]
}
2016-10-02 11:14:08 +02:00
// Sortable columns per schema
const SORTABLE_COLUMNS = {
PODS: [ 'id', 'host', 'score', 'createdAt' ],
2017-02-26 19:26:57 +01:00
USERS: [ 'id', 'username', 'createdAt' ],
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' ],
BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', '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
2016-08-19 21:34:51 +02:00
const CONFIG = {
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
},
STORAGE: {
2017-05-22 20:58:25 +02:00
CERT_DIR: join(root(), config.get<string>('storage.certs')),
LOG_DIR: join(root(), config.get<string>('storage.logs')),
VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
2017-07-12 11:56:02 +02:00
TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
CACHE_DIR: join(root(), 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
},
ADMIN: {
2017-05-15 22:22:03 +02:00
EMAIL: config.get<string>('admin.email')
2017-03-10 11:32:39 +01:00
},
SIGNUP: {
ENABLED: config.get<boolean>('signup.enabled'),
2017-09-04 21:45:05 +02:00
LIMIT: config.get<number>('signup.limit')
2017-09-04 20:07:54 +02:00
},
USER: {
VIDEO_QUOTA: config.get<number>('user.video_quota')
},
TRANSCODING: {
2017-05-15 22:22:03 +02:00
ENABLED: config.get<boolean>('transcoding.enabled'),
THREADS: config.get<number>('transcoding.threads'),
RESOLUTIONS: {
'240' : config.get<boolean>('transcoding.resolutions.240p'),
'360': config.get<boolean>('transcoding.resolutions.360p'),
'480': config.get<boolean>('transcoding.resolutions.480p'),
'720': config.get<boolean>('transcoding.resolutions.720p'),
'1080': config.get<boolean>('transcoding.resolutions.1080p')
}
2017-07-12 11:56:02 +02:00
},
CACHE: {
PREVIEWS: {
SIZE: config.get<number>('cache.previews.size')
}
2016-08-19 21:34:51 +02:00
}
}
CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
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-10-24 19:41:09 +02:00
DESCRIPTION: { min: 3, max: 250 } // Length
},
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
2016-07-31 20:58:43 +02:00
DURATION: { min: 1, max: 7200 }, // 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, max: 1024 * 1024 * 1024 * 3 /* 3Go */ }
2017-02-26 18:57:33 +01:00
},
VIDEO_EVENTS: {
COUNT: { min: 0 }
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'
}
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
// Score a pod has when we create it as a friend
const FRIEND_SCORE = {
BASE: 100,
MAX: 1000
}
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
// Number of points we add/remove from a friend after a successful/bad request
2016-03-16 22:29:27 +01:00
const PODS_SCORE = {
PENALTY: -10,
BONUS: 10
}
2016-10-02 11:14:08 +02:00
// 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
2017-01-10 22:24:42 +01:00
// 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
2017-02-26 18:57:33 +01:00
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
2017-06-16 10:36:18 +02:00
const REQUEST_ENDPOINTS: { [ id: string ]: RequestEndpoint } = {
2017-03-04 09:48:35 +01:00
VIDEOS: 'videos'
2016-11-01 18:47:57 +01:00
}
2017-03-04 09:48:35 +01:00
2017-10-24 19:41:09 +02:00
const REQUEST_ENDPOINT_ACTIONS: {
[ id: string ]: {
[ id: string ]: RemoteVideoRequestType
}
} = {}
REQUEST_ENDPOINT_ACTIONS[REQUEST_ENDPOINTS.VIDEOS] = {
2017-10-24 19:41:09 +02:00
ADD_VIDEO: 'add-video',
UPDATE_VIDEO: 'update-video',
REMOVE_VIDEO: 'remove-video',
ADD_CHANNEL: 'add-channel',
UPDATE_CHANNEL: 'update-channel',
REMOVE_CHANNEL: 'remove-channel',
ADD_AUTHOR: 'add-author',
REMOVE_AUTHOR: 'remove-author',
REPORT_ABUSE: 'report-abuse'
}
2016-11-01 18:47:57 +01:00
2017-03-04 09:48:35 +01:00
const REQUEST_VIDEO_QADU_ENDPOINT = 'videos/qadu'
const REQUEST_VIDEO_EVENT_ENDPOINT = 'videos/events'
2017-06-16 10:36:18 +02:00
const REQUEST_VIDEO_QADU_TYPES: { [ id: string ]: RequestVideoQaduType } = {
LIKES: 'likes',
DISLIKES: 'dislikes',
VIEWS: 'views'
}
2017-06-16 10:36:18 +02:00
const REQUEST_VIDEO_EVENT_TYPES: { [ id: string ]: RequestVideoEventType } = {
2017-02-26 18:57:33 +01:00
LIKES: 'likes',
DISLIKES: 'dislikes',
VIEWS: 'views'
}
2016-11-11 15:20:03 +01:00
const REMOTE_SCHEME = {
HTTP: 'https',
WS: 'wss'
2016-11-11 15:20:03 +01:00
}
2017-06-16 10:36:18 +02:00
const JOB_STATES: { [ id: string ]: JobState } = {
PENDING: 'pending',
PROCESSING: 'processing',
ERROR: 'error',
SUCCESS: 'success'
}
// How many maximum jobs we fetch from the database per cycle
const JOBS_FETCH_LIMIT_PER_CYCLE = 10
// 1 minutes
let JOBS_FETCHING_INTERVAL = 60000
// ---------------------------------------------------------------------------
2017-01-17 21:42:47 +01:00
const PRIVATE_CERT_NAME = 'peertube.key.pem'
const PUBLIC_CERT_NAME = 'peertube.pub'
const SIGNATURE_ALGORITHM = 'RSA-SHA256'
const SIGNATURE_ENCODING = 'hex'
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/',
WEBSEED: '/static/webseed/'
}
// 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
}
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-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) {
2016-10-02 11:14:08 +02:00
CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
FRIEND_SCORE.BASE = 20
2016-09-19 21:33:46 +02:00
REQUESTS_INTERVAL = 10000
JOBS_FETCHING_INTERVAL = 10000
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'
}
// ---------------------------------------------------------------------------
2017-05-15 22:22:03 +02:00
export {
2016-10-02 11:14:08 +02:00
API_VERSION,
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,
2016-10-02 11:14:08 +02:00
FRIEND_SCORE,
JOB_STATES,
JOBS_FETCH_LIMIT_PER_CYCLE,
2017-07-07 16:57:28 +02:00
JOBS_FETCHING_INTERVAL,
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,
PODS_SCORE,
2016-11-11 15:20:03 +01:00
PREVIEWS_SIZE,
2017-01-17 21:42:47 +01:00
PRIVATE_CERT_NAME,
PUBLIC_CERT_NAME,
2016-11-11 15:20:03 +01:00
REMOTE_SCHEME,
REQUEST_ENDPOINT_ACTIONS,
2017-01-17 21:42:47 +01:00
REQUEST_ENDPOINTS,
2017-03-04 09:48:35 +01:00
REQUEST_VIDEO_EVENT_ENDPOINT,
2017-02-26 18:57:33 +01:00
REQUEST_VIDEO_EVENT_TYPES,
2017-03-04 09:48:35 +01:00
REQUEST_VIDEO_QADU_ENDPOINT,
REQUEST_VIDEO_QADU_TYPES,
2016-10-02 11:14:08 +02:00
REQUESTS_IN_PARALLEL,
REQUESTS_INTERVAL,
2017-01-10 22:24:42 +01:00
REQUESTS_LIMIT_PER_POD,
2017-01-17 21:42:47 +01:00
REQUESTS_LIMIT_PODS,
2017-02-26 18:57:33 +01:00
REQUESTS_VIDEO_EVENT_LIMIT_PER_POD,
REQUESTS_VIDEO_EVENT_LIMIT_PODS,
2017-03-04 09:48:35 +01:00
REQUESTS_VIDEO_QADU_LIMIT_PER_POD,
REQUESTS_VIDEO_QADU_LIMIT_PODS,
2016-10-02 11:14:08 +02:00
RETRY_REQUESTS,
SEARCHABLE_COLUMNS,
SIGNATURE_ALGORITHM,
SIGNATURE_ENCODING,
2016-10-02 11:14:08 +02:00
SORTABLE_COLUMNS,
STATIC_MAX_AGE,
STATIC_PATHS,
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-03-08 21:35:43 +01:00
VIDEO_RATE_TYPES
}