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 { isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
10 // ---------------------------------------------------------------------------
12 const LAST_MIGRATION_VERSION = 140
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 JOBS: [ 'id', 'createdAt' ],
26 VIDEO_ABUSES: [ 'id', 'createdAt' ],
27 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
28 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
29 VIDEO_COMMENT_THREADS: [ 'createdAt' ],
30 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
31 FOLLOWERS: [ 'createdAt' ],
32 FOLLOWING: [ 'createdAt' ]
35 const OAUTH_LIFETIME = {
36 ACCESS_TOKEN: 3600 * 4, // 4 hours
37 REFRESH_TOKEN: 1209600 // 2 weeks
40 // ---------------------------------------------------------------------------
42 // Number of points we add/remove from a friend after a successful/bad request
43 const SERVERS_SCORE = {
50 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
55 const REMOTE_SCHEME = {
60 const JOB_STATES: { [ id: string ]: JobState } = {
62 PROCESSING: 'processing',
66 const JOB_CATEGORIES: { [ id: string ]: JobCategory } = {
67 TRANSCODING: 'transcoding',
68 ACTIVITYPUB_HTTP: 'activitypub-http'
70 // How many maximum jobs we fetch from the database per cycle
71 const JOBS_FETCH_LIMIT_PER_CYCLE = {
76 let JOBS_FETCHING_INTERVAL = 60000
78 // ---------------------------------------------------------------------------
82 PORT: config.get<number>('listen.port')
85 DBNAME: 'peertube' + config.get<string>('database.suffix'),
86 HOSTNAME: config.get<string>('database.hostname'),
87 PORT: config.get<number>('database.port'),
88 USERNAME: config.get<string>('database.username'),
89 PASSWORD: config.get<string>('database.password')
92 AVATARS_DIR: join(root(), config.get<string>('storage.avatars')),
93 LOG_DIR: join(root(), config.get<string>('storage.logs')),
94 VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
95 THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
96 PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
97 TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
98 CACHE_DIR: join(root(), config.get<string>('storage.cache'))
101 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
102 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
103 HOSTNAME: config.get<string>('webserver.hostname'),
104 PORT: config.get<number>('webserver.port'),
109 EMAIL: config.get<string>('admin.email')
112 ENABLED: config.get<boolean>('signup.enabled'),
113 LIMIT: config.get<number>('signup.limit')
116 VIDEO_QUOTA: config.get<number>('user.video_quota')
119 ENABLED: config.get<boolean>('transcoding.enabled'),
120 THREADS: config.get<number>('transcoding.threads'),
122 '240' : config.get<boolean>('transcoding.resolutions.240p'),
123 '360': config.get<boolean>('transcoding.resolutions.360p'),
124 '480': config.get<boolean>('transcoding.resolutions.480p'),
125 '720': config.get<boolean>('transcoding.resolutions.720p'),
126 '1080': config.get<boolean>('transcoding.resolutions.1080p')
131 SIZE: config.get<number>('cache.previews.size')
136 const AVATARS_DIR = {
137 ACCOUNT: join(CONFIG.STORAGE.AVATARS_DIR, 'account')
139 // ---------------------------------------------------------------------------
141 const CONSTRAINTS_FIELDS = {
143 USERNAME: { min: 3, max: 20 }, // Length
144 PASSWORD: { min: 6, max: 255 }, // Length
145 VIDEO_QUOTA: { min: -1 }
148 REASON: { min: 2, max: 300 } // Length
151 NAME: { min: 3, max: 120 }, // Length
152 DESCRIPTION: { min: 3, max: 250 }, // Length
153 URL: { min: 3, max: 2000 } // Length
156 NAME: { min: 3, max: 120 }, // Length
157 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
158 DESCRIPTION: { min: 3, max: 3000 }, // Length
159 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
160 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
161 DURATION: { min: 1 }, // Number
162 TAGS: { min: 0, max: 5 }, // Number of total tags
163 TAG: { min: 2, max: 30 }, // Length
164 THUMBNAIL: { min: 2, max: 30 },
165 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
168 DISLIKES: { min: 0 },
169 FILE_SIZE: { min: 10 },
170 URL: { min: 3, max: 2000 } // Length
173 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
174 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
175 URL: { min: 3, max: 2000 } // Length
181 TEXT: { min: 2, max: 3000 }, // Length
182 URL: { min: 3, max: 2000 } // Length
186 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
191 const VIDEO_CATEGORIES = {
206 15: 'Science & Technology',
212 // See https://creativecommons.org/licenses/?lang=en
213 const VIDEO_LICENCES = {
215 2: 'Attribution - Share Alike',
216 3: 'Attribution - No Derivatives',
217 4: 'Attribution - Non Commercial',
218 5: 'Attribution - Non Commercial - Share Alike',
219 6: 'Attribution - Non Commercial - No Derivatives',
220 7: 'Public Domain Dedication'
223 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
224 const VIDEO_LANGUAGES = {
241 const VIDEO_PRIVACIES = {
242 [VideoPrivacy.PUBLIC]: 'Public',
243 [VideoPrivacy.UNLISTED]: 'Unlisted',
244 [VideoPrivacy.PRIVATE]: 'Private'
247 const VIDEO_MIMETYPE_EXT = {
248 'video/webm': '.webm',
253 // ---------------------------------------------------------------------------
255 const SERVER_ACTOR_NAME = 'peertube'
257 const ACTIVITY_PUB = {
258 POTENTIAL_ACCEPT_HEADERS: [
259 'application/activity+json',
260 'application/ld+json'
262 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
263 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
264 COLLECTION_ITEMS_PER_PAGE: 10,
265 FETCH_PAGE_LIMIT: 100,
268 VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT
269 TORRENT: [ 'application/x-bittorrent' ],
270 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
274 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
277 APPLICATION: 'Application'
280 // ---------------------------------------------------------------------------
282 const PRIVATE_RSA_KEY_SIZE = 2048
284 // Password encryption
285 const BCRYPT_SALT_SIZE = 10
287 // ---------------------------------------------------------------------------
289 // Express static paths (router)
290 const STATIC_PATHS = {
291 PREVIEWS: '/static/previews/',
292 THUMBNAILS: '/static/thumbnails/',
293 TORRENTS: '/static/torrents/',
294 WEBSEED: '/static/webseed/'
298 let STATIC_MAX_AGE = '30d'
300 // Videos thumbnail size
301 const THUMBNAILS_SIZE = {
305 const PREVIEWS_SIZE = {
315 // Sub folders of cache directory
318 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
322 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
324 // ---------------------------------------------------------------------------
326 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
328 // ---------------------------------------------------------------------------
330 // Special constants for a test instance
331 if (isTestInstance() === true) {
332 SERVERS_SCORE.BASE = 20
333 JOBS_FETCHING_INTERVAL = 1000
334 REMOTE_SCHEME.HTTP = 'http'
335 REMOTE_SCHEME.WS = 'ws'
337 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
340 CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
341 CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
343 // ---------------------------------------------------------------------------
354 JOBS_FETCH_LIMIT_PER_CYCLE,
355 JOBS_FETCHING_INTERVAL,
357 LAST_MIGRATION_VERSION,
359 OPENGRAPH_AND_OEMBED_COMMENT,
360 PAGINATION_COUNT_DEFAULT,
367 PRIVATE_RSA_KEY_SIZE,
372 ACTIVITY_PUB_ACTOR_TYPES,