1 import * as config from 'config'
2 import { join } from 'path'
3 import { JobCategory, JobState, VideoRateType } 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, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
10 // ---------------------------------------------------------------------------
12 const LAST_MIGRATION_VERSION = 175
14 // ---------------------------------------------------------------------------
17 const API_VERSION = 'v1'
19 // Number of results by default for the pagination
20 const PAGINATION_COUNT_DEFAULT = 15
22 // Sortable columns per schema
23 const SORTABLE_COLUMNS = {
24 USERS: [ 'id', 'username', 'createdAt' ],
25 ACCOUNTS: [ 'createdAt' ],
26 JOBS: [ 'id', 'createdAt' ],
27 VIDEO_ABUSES: [ 'id', 'createdAt' ],
28 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
29 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
30 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
31 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
32 FOLLOWERS: [ 'createdAt' ],
33 FOLLOWING: [ 'createdAt' ]
36 const OAUTH_LIFETIME = {
37 ACCESS_TOKEN: 3600 * 4, // 4 hours
38 REFRESH_TOKEN: 1209600 // 2 weeks
41 // ---------------------------------------------------------------------------
43 // Number of points we add/remove after a successful/bad request
44 const ACTOR_FOLLOW_SCORE = {
51 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
56 const REMOTE_SCHEME = {
61 const JOB_STATES: { [ id: string ]: JobState } = {
63 PROCESSING: 'processing',
67 const JOB_CATEGORIES: { [ id: string ]: JobCategory } = {
68 TRANSCODING: 'transcoding',
69 ACTIVITYPUB_HTTP: 'activitypub-http'
71 // How many maximum jobs we fetch from the database per cycle
72 const JOBS_FETCH_LIMIT_PER_CYCLE = {
77 let JOBS_FETCHING_INTERVAL = 60000
80 let SCHEDULER_INTERVAL = 60000 * 60
82 // ---------------------------------------------------------------------------
86 PORT: config.get<number>('listen.port')
89 DBNAME: 'peertube' + config.get<string>('database.suffix'),
90 HOSTNAME: config.get<string>('database.hostname'),
91 PORT: config.get<number>('database.port'),
92 USERNAME: config.get<string>('database.username'),
93 PASSWORD: config.get<string>('database.password')
96 AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
97 LOG_DIR: buildPath(config.get<string>('storage.logs')),
98 VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
99 THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
100 PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
101 TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
102 CACHE_DIR: buildPath(config.get<string>('storage.cache'))
105 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
106 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
107 HOSTNAME: config.get<string>('webserver.hostname'),
108 PORT: config.get<number>('webserver.port'),
113 EMAIL: config.get<string>('admin.email')
116 ENABLED: config.get<boolean>('signup.enabled'),
117 LIMIT: config.get<number>('signup.limit')
120 VIDEO_QUOTA: config.get<number>('user.video_quota')
123 ENABLED: config.get<boolean>('transcoding.enabled'),
124 THREADS: config.get<number>('transcoding.threads'),
126 '240' : config.get<boolean>('transcoding.resolutions.240p'),
127 '360': config.get<boolean>('transcoding.resolutions.360p'),
128 '480': config.get<boolean>('transcoding.resolutions.480p'),
129 '720': config.get<boolean>('transcoding.resolutions.720p'),
130 '1080': config.get<boolean>('transcoding.resolutions.1080p')
135 SIZE: config.get<number>('cache.previews.size')
140 // ---------------------------------------------------------------------------
142 const CONSTRAINTS_FIELDS = {
144 USERNAME: { min: 3, max: 20 }, // Length
145 PASSWORD: { min: 6, max: 255 }, // Length
146 VIDEO_QUOTA: { min: -1 }
149 REASON: { min: 2, max: 300 } // Length
152 NAME: { min: 3, max: 120 }, // Length
153 DESCRIPTION: { min: 3, max: 250 }, // Length
154 URL: { min: 3, max: 2000 } // Length
157 NAME: { min: 3, max: 120 }, // Length
158 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
159 DESCRIPTION: { min: 3, max: 3000 }, // Length
160 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
161 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
162 DURATION: { min: 1 }, // Number
163 TAGS: { min: 0, max: 5 }, // Number of total tags
164 TAG: { min: 2, max: 30 }, // Length
165 THUMBNAIL: { min: 2, max: 30 },
166 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
169 DISLIKES: { min: 0 },
170 FILE_SIZE: { min: 10 },
171 URL: { min: 3, max: 2000 } // Length
174 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
175 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
176 URL: { min: 3, max: 2000 }, // Length
178 EXTNAME: [ '.png', '.jpeg', '.jpg' ],
180 max: 2 * 1024 * 1024 // 2MB
188 TEXT: { min: 2, max: 3000 }, // Length
189 URL: { min: 3, max: 2000 } // Length
193 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
198 const VIDEO_CATEGORIES = {
213 15: 'Science & Technology',
219 // See https://creativecommons.org/licenses/?lang=en
220 const VIDEO_LICENCES = {
222 2: 'Attribution - Share Alike',
223 3: 'Attribution - No Derivatives',
224 4: 'Attribution - Non Commercial',
225 5: 'Attribution - Non Commercial - Share Alike',
226 6: 'Attribution - Non Commercial - No Derivatives',
227 7: 'Public Domain Dedication'
230 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
231 const VIDEO_LANGUAGES = {
248 const VIDEO_PRIVACIES = {
249 [VideoPrivacy.PUBLIC]: 'Public',
250 [VideoPrivacy.UNLISTED]: 'Unlisted',
251 [VideoPrivacy.PRIVATE]: 'Private'
254 const VIDEO_MIMETYPE_EXT = {
255 'video/webm': '.webm',
260 const AVATAR_MIMETYPE_EXT = {
266 // ---------------------------------------------------------------------------
268 const SERVER_ACTOR_NAME = 'peertube'
270 const ACTIVITY_PUB = {
271 POTENTIAL_ACCEPT_HEADERS: [
272 'application/activity+json',
273 'application/ld+json',
274 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
276 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
277 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
278 COLLECTION_ITEMS_PER_PAGE: 10,
279 FETCH_PAGE_LIMIT: 100,
282 VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT
283 TORRENT: [ 'application/x-bittorrent' ],
284 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
286 MAX_RECURSION_COMMENTS: 100,
287 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
290 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
293 APPLICATION: 'Application'
296 // ---------------------------------------------------------------------------
298 const PRIVATE_RSA_KEY_SIZE = 2048
300 // Password encryption
301 const BCRYPT_SALT_SIZE = 10
303 // ---------------------------------------------------------------------------
305 // Express static paths (router)
306 const STATIC_PATHS = {
307 PREVIEWS: '/static/previews/',
308 THUMBNAILS: '/static/thumbnails/',
309 TORRENTS: '/static/torrents/',
310 WEBSEED: '/static/webseed/',
311 AVATARS: '/static/avatars/'
315 let STATIC_MAX_AGE = '30d'
317 // Videos thumbnail size
318 const THUMBNAILS_SIZE = {
322 const PREVIEWS_SIZE = {
326 const AVATARS_SIZE = {
336 // Sub folders of cache directory
339 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
343 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
345 // ---------------------------------------------------------------------------
347 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
349 // ---------------------------------------------------------------------------
351 // Special constants for a test instance
352 if (isTestInstance() === true) {
353 ACTOR_FOLLOW_SCORE.BASE = 20
354 JOBS_FETCHING_INTERVAL = 1000
355 REMOTE_SCHEME.HTTP = 'http'
356 REMOTE_SCHEME.WS = 'ws'
358 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
359 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
360 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
361 SCHEDULER_INTERVAL = 10000
364 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
365 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
367 // ---------------------------------------------------------------------------
379 JOBS_FETCH_LIMIT_PER_CYCLE,
380 JOBS_FETCHING_INTERVAL,
382 LAST_MIGRATION_VERSION,
384 OPENGRAPH_AND_OEMBED_COMMENT,
385 PAGINATION_COUNT_DEFAULT,
391 PRIVATE_RSA_KEY_SIZE,
396 ACTIVITY_PUB_ACTOR_TYPES,