PeerTube/server/initializers/constants.ts

835 lines
22 KiB
TypeScript
Raw Normal View History

2019-04-11 11:33:44 +02:00
import { join } from 'path'
2019-05-16 16:55:34 +02:00
import { JobType, VideoRateType, VideoResolution, VideoState } from '../../shared/models'
2017-12-14 17:38:41 +01:00
import { ActivityPubActorType } from '../../shared/models/activitypub'
import { FollowState } from '../../shared/models/actors'
import { VideoAbuseState, VideoImportState, VideoPrivacy, VideoTranscodingFPS } from '../../shared/models/videos'
2017-05-22 20:58:25 +02:00
// Do not use barrels, remain constants as independent as possible
import { isTestInstance, sanitizeHost, sanitizeUrl, root, parseDurationToMs } from '../helpers/core-utils'
import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
import { invert } from 'lodash'
2018-08-29 16:26:25 +02:00
import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
2019-02-26 10:55:40 +01:00
import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
2019-03-05 10:58:44 +01:00
import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
2019-04-11 11:33:44 +02:00
import { CONFIG, registerConfigChangedHandler } from './config'
2017-06-16 10:36:18 +02:00
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
2019-08-09 11:32:40 +02:00
const LAST_MIGRATION_VERSION = 420
2017-02-18 11:56:28 +01:00
// ---------------------------------------------------------------------------
2016-03-16 22:29:27 +01:00
const API_VERSION = 'v1'
const PEERTUBE_VERSION = require(join(root(), 'package.json')).version
2018-07-24 16:27:45 +02:00
const PAGINATION = {
COUNT: {
DEFAULT: 15,
MAX: 100
}
}
2016-10-02 11:14:08 +02:00
2019-04-11 11:33:44 +02:00
const WEBSERVER = {
URL: '',
HOST: '',
SCHEME: '',
WS: '',
HOSTNAME: '',
PORT: 0
}
2016-10-02 11:14:08 +02:00
// Sortable columns per schema
const SORTABLE_COLUMNS = {
2019-07-25 11:15:03 +02:00
USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt' ],
USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
2018-01-03 16:38:50 +01:00
ACCOUNTS: [ 'createdAt' ],
JOBS: [ 'createdAt' ],
2018-08-13 16:57:13 +02:00
VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ],
2017-10-24 19:41:09 +02:00
VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
2018-08-02 17:48:50 +02:00
VIDEO_IMPORTS: [ 'createdAt' ],
2017-12-22 10:50:07 +01:00
VIDEO_COMMENT_THREADS: [ 'createdAt' ],
VIDEO_RATES: [ 'createdAt' ],
2017-11-13 17:39:41 +01:00
BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
FOLLOWERS: [ 'createdAt' ],
2018-07-19 16:17:54 +02:00
FOLLOWING: [ 'createdAt' ],
2018-08-31 17:18:13 +02:00
VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ],
VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ],
VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
2018-12-26 10:36:24 +01:00
SERVERS_BLOCKLIST: [ 'createdAt' ],
2019-02-26 10:55:40 +01:00
USER_NOTIFICATIONS: [ 'createdAt' ],
VIDEO_PLAYLISTS: [ 'displayName', 'createdAt', 'updatedAt' ],
PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ]
2016-10-02 11:14:08 +02:00
}
2016-07-20 16:23:58 +02:00
const OAUTH_LIFETIME = {
2018-06-08 08:17:41 +02:00
ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
2016-07-20 16:23:58 +02:00
REFRESH_TOKEN: 1209600 // 2 weeks
}
2018-05-11 09:44:04 +02:00
const ROUTE_CACHE_LIFETIME = {
2018-07-21 23:00:25 +02:00
FEEDS: '15 minutes',
ROBOTS: '2 hours',
2018-12-05 17:27:24 +01:00
SITEMAP: '1 day',
SECURITYTXT: '2 hours',
2018-07-21 23:00:25 +02:00
NODEINFO: '10 minutes',
DNT_POLICY: '1 week',
2018-08-30 14:58:00 +02:00
OVERVIEWS: {
VIDEOS: '1 hour'
},
2018-05-11 09:44:04 +02:00
ACTIVITY_PUB: {
2018-07-21 23:00:25 +02:00
VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
2018-09-14 14:57:59 +02:00
},
STATS: '4 hours'
2018-05-11 09:44:04 +02:00
}
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'
}
// TODO: remove 'video-file'
2019-04-11 11:33:44 +02:00
const JOB_ATTEMPTS: { [id in (JobType | 'video-file')]: number } = {
'activitypub-http-broadcast': 5,
'activitypub-http-unicast': 5,
'activitypub-http-fetcher': 5,
'activitypub-follow': 5,
'video-file-import': 1,
'video-transcoding': 1,
2018-01-30 13:27:07 +01:00
'video-file': 1,
'video-import': 1,
2018-08-29 16:26:25 +02:00
'email': 5,
'videos-views': 1,
'activitypub-refresher': 1
}
2019-04-11 11:33:44 +02:00
const JOB_CONCURRENCY: { [id in (JobType | 'video-file')]: number } = {
'activitypub-http-broadcast': 1,
'activitypub-http-unicast': 5,
'activitypub-http-fetcher': 1,
'activitypub-follow': 3,
'video-file-import': 1,
'video-transcoding': 1,
2018-01-30 13:27:07 +01:00
'video-file': 1,
'video-import': 1,
2018-08-29 16:26:25 +02:00
'email': 5,
'videos-views': 1,
'activitypub-refresher': 1
}
2019-04-11 11:33:44 +02:00
const JOB_TTL: { [id in (JobType | 'video-file')]: number } = {
2018-08-03 10:19:51 +02:00
'activitypub-http-broadcast': 60000 * 10, // 10 minutes
'activitypub-http-unicast': 60000 * 10, // 10 minutes
'activitypub-http-fetcher': 60000 * 10, // 10 minutes
'activitypub-follow': 60000 * 10, // 10 minutes
'video-file-import': 1000 * 3600, // 1 hour
'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
2018-08-03 10:19:51 +02:00
'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long
'video-import': 1000 * 3600 * 2, // hours
2018-08-29 16:26:25 +02:00
'email': 60000 * 10, // 10 minutes
'videos-views': undefined, // Unlimited
'activitypub-refresher': 60000 * 10 // 10 minutes
2018-08-03 10:19:51 +02:00
}
2018-08-29 16:26:25 +02:00
const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
'videos-views': {
cron: '1 * * * *' // At 1 minute past the hour
2018-08-29 16:26:25 +02:00
}
}
2018-05-09 09:08:22 +02:00
const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
2018-08-23 10:30:53 +02:00
const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
2018-05-09 09:08:22 +02:00
const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
const SCHEDULER_INTERVALS_MS = {
actorFollowScores: 60000 * 60, // 1 hour
removeOldJobs: 60000 * 60, // 1 hour
2018-08-02 16:02:51 +02:00
updateVideos: 60000, // 1 minute
youtubeDLUpdate: 60000 * 60 * 24, // 1 day
checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
2019-04-11 17:33:36 +02:00
removeOldViews: 60000 * 60 * 24, // 1 day
removeOldHistory: 60000 * 60 * 24 // 1 day
}
// ---------------------------------------------------------------------------
const CONSTRAINTS_FIELDS = {
2016-07-31 20:58:43 +02:00
USERS: {
NAME: { min: 1, max: 120 }, // Length
DESCRIPTION: { min: 3, max: 1000 }, // Length
USERNAME: { min: 1, max: 50 }, // Length
2017-09-04 20:07:54 +02:00
PASSWORD: { min: 6, max: 255 }, // Length
2018-08-08 17:36:10 +02:00
VIDEO_QUOTA: { min: -1 },
VIDEO_QUOTA_DAILY: { min: -1 },
VIDEO_LANGUAGES: { max: 500 }, // Array length
2018-08-08 17:36:10 +02:00
BLOCKED_REASON: { min: 3, max: 250 } // Length
2016-07-31 20:58:43 +02:00
},
2017-01-04 20:59:23 +01:00
VIDEO_ABUSES: {
REASON: { min: 2, max: 3000 }, // Length
MODERATION_COMMENT: { min: 2, max: 3000 } // Length
2017-01-04 20:59:23 +01:00
},
2018-08-13 16:57:13 +02:00
VIDEO_BLACKLIST: {
REASON: { min: 2, max: 300 } // Length
},
2017-10-24 19:41:09 +02:00
VIDEO_CHANNELS: {
NAME: { min: 1, max: 120 }, // Length
DESCRIPTION: { min: 3, max: 1000 }, // Length
SUPPORT: { min: 3, max: 1000 }, // Length
2017-11-14 10:57:56 +01:00
URL: { min: 3, max: 2000 } // Length
2017-10-24 19:41:09 +02:00
},
2018-07-12 19:02:00 +02:00
VIDEO_CAPTIONS: {
CAPTION_FILE: {
2018-07-16 14:22:16 +02:00
EXTNAME: [ '.vtt', '.srt' ],
2018-07-12 19:02:00 +02:00
FILE_SIZE: {
max: 2 * 1024 * 1024 // 2MB
}
}
},
VIDEO_IMPORTS: {
2018-08-06 17:13:39 +02:00
URL: { min: 3, max: 2000 }, // Length
TORRENT_NAME: { min: 3, max: 255 }, // Length
2018-08-07 09:54:36 +02:00
TORRENT_FILE: {
EXTNAME: [ '.torrent' ],
FILE_SIZE: {
max: 1024 * 200 // 200 KB
}
}
},
2018-09-11 16:27:07 +02:00
VIDEOS_REDUNDANCY: {
URL: { min: 3, max: 2000 } // Length
},
2018-11-14 15:01:28 +01:00
VIDEO_RATES: {
URL: { min: 3, max: 2000 } // Length
},
2016-07-31 20:58:43 +02:00
VIDEOS: {
NAME: { min: 3, max: 120 }, // Length
2018-04-23 14:39:52 +02:00
LANGUAGE: { min: 1, max: 10 }, // Length
2017-10-30 10:16:27 +01:00
TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
DESCRIPTION: { min: 3, max: 10000 }, // Length
SUPPORT: { min: 3, max: 1000 }, // Length
IMAGE: {
EXTNAME: [ '.jpg', '.jpeg' ],
FILE_SIZE: {
max: 2 * 1024 * 1024 // 2MB
}
},
2019-05-16 16:55:34 +02:00
EXTNAME: [] as string[],
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: 0 }, // 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
},
2019-02-26 10:55:40 +01:00
VIDEO_PLAYLISTS: {
NAME: { min: 1, max: 120 }, // Length
DESCRIPTION: { min: 3, max: 1000 }, // Length
URL: { min: 3, max: 2000 }, // Length
IMAGE: {
EXTNAME: [ '.jpg', '.jpeg' ],
FILE_SIZE: {
max: 2 * 1024 * 1024 // 2MB
}
}
},
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: 1, max: 3000 }, // Length
URL: { min: 3, max: 2000 } // Length
},
VIDEO_SHARE: {
URL: { min: 3, max: 2000 } // Length
2019-01-09 15:14:29 +01:00
},
CONTACT_FORM: {
FROM_NAME: { min: 1, max: 120 }, // Length
BODY: { min: 3, max: 5000 } // Length
},
PLUGINS: {
NAME: { min: 1, max: 214 }, // Length
DESCRIPTION: { min: 1, max: 20000 } // Length
2016-07-31 20:58:43 +02:00
}
}
2018-02-23 16:39:51 +01:00
let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
2019-01-09 15:14:29 +01:00
let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
MIN: 10,
AVERAGE: 30,
MAX: 60,
KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
}
2018-02-23 16:39:51 +01:00
2019-05-16 16:55:34 +02:00
const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
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'
}
const FFMPEG_NICE: { [ id: string ]: number } = {
THUMBNAIL: 2, // 2 just for don't blocking servers
TRANSCODING: 15
}
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 & Politics',
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'
}
let VIDEO_LANGUAGES: { [id: string]: string } = {}
2017-04-07 12:13:37 +02:00
2017-10-31 11:52:52 +01:00
const VIDEO_PRIVACIES = {
2019-04-11 11:33:44 +02:00
[ VideoPrivacy.PUBLIC ]: 'Public',
[ VideoPrivacy.UNLISTED ]: 'Unlisted',
[ VideoPrivacy.PRIVATE ]: 'Private'
2017-10-31 11:52:52 +01:00
}
const VIDEO_STATES = {
2019-04-11 11:33:44 +02:00
[ VideoState.PUBLISHED ]: 'Published',
[ VideoState.TO_TRANSCODE ]: 'To transcode',
[ VideoState.TO_IMPORT ]: 'To import'
}
const VIDEO_IMPORT_STATES = {
2019-04-11 11:33:44 +02:00
[ VideoImportState.FAILED ]: 'Failed',
[ VideoImportState.PENDING ]: 'Pending',
[ VideoImportState.SUCCESS ]: 'Success'
}
const VIDEO_ABUSE_STATES = {
2019-04-11 11:33:44 +02:00
[ VideoAbuseState.PENDING ]: 'Pending',
[ VideoAbuseState.REJECTED ]: 'Rejected',
[ VideoAbuseState.ACCEPTED ]: 'Accepted'
}
2019-02-26 10:55:40 +01:00
const VIDEO_PLAYLIST_PRIVACIES = {
2019-04-11 11:33:44 +02:00
[ VideoPlaylistPrivacy.PUBLIC ]: 'Public',
[ VideoPlaylistPrivacy.UNLISTED ]: 'Unlisted',
[ VideoPlaylistPrivacy.PRIVATE ]: 'Private'
2019-02-26 10:55:40 +01:00
}
2019-03-05 10:58:44 +01:00
const VIDEO_PLAYLIST_TYPES = {
2019-04-11 11:33:44 +02:00
[ VideoPlaylistType.REGULAR ]: 'Regular',
[ VideoPlaylistType.WATCH_LATER ]: 'Watch later'
2019-03-05 10:58:44 +01:00
}
2018-12-11 14:52:50 +01:00
const MIMETYPES = {
2019-05-16 16:55:34 +02:00
AUDIO: {
MIMETYPE_EXT: {
'audio/mpeg': '.mp3',
'audio/mp3': '.mp3',
'application/ogg': '.ogg',
'audio/ogg': '.ogg',
'audio/flac': '.flac'
},
EXT_MIMETYPE: null as { [ id: string ]: string }
},
2018-12-11 14:52:50 +01:00
VIDEO: {
2019-05-16 16:55:34 +02:00
MIMETYPE_EXT: null as { [ id: string ]: string },
2018-12-11 14:52:50 +01:00
EXT_MIMETYPE: null as { [ id: string ]: string }
},
IMAGE: {
MIMETYPE_EXT: {
'image/png': '.png',
'image/jpg': '.jpg',
'image/jpeg': '.jpg'
}
},
VIDEO_CAPTIONS: {
MIMETYPE_EXT: {
'text/vtt': '.vtt',
'application/x-subrip': '.srt'
}
},
TORRENT: {
MIMETYPE_EXT: {
'application/x-bittorrent': '.torrent'
}
}
2018-08-07 09:54:36 +02:00
}
2019-05-16 16:55:34 +02:00
MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
2018-08-07 09:54:36 +02:00
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
2018-08-30 14:58:00 +02:00
const OVERVIEWS = {
VIDEOS: {
2018-08-31 14:26:51 +02:00
SAMPLE_THRESHOLD: 6,
2018-08-30 14:58:00 +02:00
SAMPLES_COUNT: 2
}
}
// ---------------------------------------------------------------------------
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: {
2019-05-16 16:55:34 +02:00
VIDEO: [] as string[],
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,
2019-03-19 11:15:42 +01:00
ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
2019-03-19 14:13:53 +01:00
VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
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'
}
const HTTP_SIGNATURE = {
HEADER_NAME: 'signature',
ALGORITHM: 'rsa-sha256',
HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ]
}
2016-10-02 11:14:08 +02:00
// ---------------------------------------------------------------------------
let 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
2018-01-30 13:27:07 +01:00
const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
2019-04-11 11:33:44 +02:00
const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
DO_NOT_LIST: 'do_not_list',
BLUR: 'blur',
DISPLAY: 'display'
}
// ---------------------------------------------------------------------------
// 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/',
2018-12-04 17:08:55 +01:00
REDUNDANCY: '/static/redundancy/',
STREAMING_PLAYLISTS: {
HLS: '/static/streaming-playlists/hls'
2019-01-29 08:37:25 +01:00
},
2018-07-12 19:02:00 +02:00
AVATARS: '/static/avatars/',
VIDEO_CAPTIONS: '/static/video-captions/'
}
2018-05-29 18:30:11 +02:00
const STATIC_DOWNLOAD_PATHS = {
TORRENTS: '/download/torrents/',
VIDEOS: '/download/videos/'
}
2019-08-09 11:32:40 +02:00
const LAZY_STATIC_PATHS = {
AVATARS: '/lazy-static/avatars/',
PREVIEWS: '/static/previews/',
VIDEO_CAPTIONS: '/static/video-captions/'
}
// Cache control
2019-07-29 15:20:36 +02:00
let STATIC_MAX_AGE = {
SERVER: '2h',
CLIENT: '30d'
}
// Videos thumbnail size
2017-10-16 10:05:49 +02:00
const THUMBNAILS_SIZE = {
2019-02-20 13:59:31 +01:00
width: 223,
2019-03-06 15:36:44 +01:00
height: 122
2017-10-16 10:05:49 +02:00
}
const PREVIEWS_SIZE = {
2019-05-17 11:56:12 +02:00
width: 850,
height: 480
}
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
2019-03-19 14:23:17 +01:00
const FILES_CACHE = {
2018-07-16 14:22:16 +02:00
PREVIEWS: {
DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
MAX_AGE: 1000 * 3600 * 3 // 3 hours
},
VIDEO_CAPTIONS: {
DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
MAX_AGE: 1000 * 3600 * 3 // 3 hours
2017-07-12 11:56:02 +02:00
}
}
2019-08-09 11:32:40 +02:00
const LRU_CACHE = {
2019-03-19 14:23:17 +01:00
USER_TOKENS: {
2019-08-09 11:32:40 +02:00
MAX_SIZE: 1000
},
AVATAR_STATIC: {
MAX_SIZE: 500
2019-03-19 14:23:17 +01:00
}
}
const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
2019-01-29 08:37:25 +01:00
const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
2018-09-14 11:52:23 +02:00
const MEMOIZE_TTL = {
OVERVIEWS_SAMPLE: 1000 * 3600 * 4 // 4 hours
}
2019-08-09 11:32:40 +02:00
const QUEUE_CONCURRENCY = {
AVATAR_PROCESS_IMAGE: 3
}
2018-09-11 16:27:07 +02:00
const REDUNDANCY = {
VIDEOS: {
RANDOMIZED_FACTOR: 5
}
}
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
2019-05-16 16:55:34 +02:00
const ASSETS_PATH = {
DEFAULT_AUDIO_BACKGROUND: join(root(), 'server', 'assets', 'default-audio-background.jpg')
}
// ---------------------------------------------------------------------------
const CUSTOM_HTML_TAG_COMMENTS = {
TITLE: '<!-- title tag -->',
DESCRIPTION: '<!-- description tag -->',
CUSTOM_CSS: '<!-- custom css tag -->',
2019-02-21 14:06:10 +01:00
META_TAGS: '<!-- meta tags -->'
}
2017-07-07 16:57:28 +02:00
// ---------------------------------------------------------------------------
2018-04-17 14:01:06 +02:00
const FEEDS = {
2018-05-11 09:44:04 +02:00
COUNT: 20
2018-04-17 14:01:06 +02:00
}
2019-04-10 15:26:33 +02:00
const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
2018-04-17 14:01:06 +02:00
// ---------------------------------------------------------------------------
2018-06-26 16:53:24 +02:00
const TRACKER_RATE_LIMITS = {
INTERVAL: 60000 * 5, // 5 minutes
2018-06-29 09:33:36 +02:00
ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
2018-06-26 16:53:24 +02:00
ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval
}
2019-04-08 11:13:49 +02:00
const P2P_MEDIA_LOADER_PEER_VERSION = 2
2018-06-26 16:53:24 +02:00
// ---------------------------------------------------------------------------
const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
2019-07-10 14:06:19 +02:00
const DEFAULT_THEME_NAME = 'default'
const DEFAULT_USER_THEME_NAME = 'instance-default'
2019-07-09 11:45:19 +02:00
// ---------------------------------------------------------------------------
// Special constants for a test instance
if (isTestInstance() === true) {
PRIVATE_RSA_KEY_SIZE = 1024
ACTOR_FOLLOW_SCORE.BASE = 20
2016-11-11 15:20:03 +01:00
REMOTE_SCHEME.HTTP = 'http'
REMOTE_SCHEME.WS = 'ws'
2019-07-29 15:20:36 +02:00
STATIC_MAX_AGE.SERVER = '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-08-22 16:15:35 +02:00
ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
2019-03-19 14:13:53 +01:00
ACTIVITY_PUB.VIDEO_PLAYLIST_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_INTERVALS_MS.actorFollowScores = 1000
SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
2019-04-11 17:33:36 +02:00
SCHEDULER_INTERVALS_MS.removeOldViews = 5000
SCHEDULER_INTERVALS_MS.updateVideos = 5000
2019-04-11 11:33:44 +02:00
REPEAT_JOBS[ 'videos-views' ] = { every: 5000 }
2018-09-11 16:27:07 +02:00
REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
2018-02-23 16:39:51 +01:00
VIDEO_VIEW_LIFETIME = 1000 // 1 second
2019-01-09 15:14:29 +01:00
CONTACT_FORM_LIFETIME = 1000 // 1 second
2019-04-11 11:33:44 +02:00
JOB_ATTEMPTS[ 'email' ] = 1
2018-07-16 14:22:16 +02:00
2019-03-19 14:23:17 +01:00
FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
2018-09-17 09:39:08 +02:00
MEMOIZE_TTL.OVERVIEWS_SAMPLE = 1
ROUTE_CACHE_LIFETIME.OVERVIEWS.VIDEOS = '0ms'
}
2018-12-11 14:52:50 +01:00
updateWebserverUrls()
2019-05-16 16:55:34 +02:00
updateWebserverConfig()
2019-04-11 11:33:44 +02:00
registerConfigChangedHandler(() => {
updateWebserverUrls()
updateWebserverConfig()
})
// ---------------------------------------------------------------------------
2017-05-15 22:22:03 +02:00
export {
2019-04-11 11:33:44 +02:00
WEBSERVER,
2016-10-02 11:14:08 +02:00
API_VERSION,
2019-07-17 10:03:55 +02:00
PEERTUBE_VERSION,
2019-08-09 11:32:40 +02:00
LAZY_STATIC_PATHS,
2019-01-29 08:37:25 +01:00
HLS_REDUNDANCY_DIRECTORY,
2019-04-08 11:13:49 +02:00
P2P_MEDIA_LOADER_PEER_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,
2018-06-26 16:53:24 +02:00
TRACKER_RATE_LIMITS,
2019-03-19 14:23:17 +01:00
FILES_CACHE,
2016-10-02 11:14:08 +02:00
CONSTRAINTS_FIELDS,
EMBED_SIZE,
2018-09-11 16:27:07 +02:00
REDUNDANCY,
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,
CUSTOM_HTML_TAG_COMMENTS,
2018-04-18 16:04:49 +02:00
BROADCAST_CONCURRENCY,
2018-07-24 16:27:45 +02:00
PAGINATION,
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,
2019-07-10 14:06:19 +02:00
DEFAULT_USER_THEME_NAME,
2017-12-14 17:38:41 +01:00
SERVER_ACTOR_NAME,
PLUGIN_GLOBAL_CSS_FILE_NAME,
PLUGIN_GLOBAL_CSS_PATH,
2017-11-09 17:51:58 +01:00
PRIVATE_RSA_KEY_SIZE,
2018-05-11 09:44:04 +02:00
ROUTE_CACHE_LIFETIME,
2016-10-02 11:14:08 +02:00
SORTABLE_COLUMNS,
HLS_STREAMING_PLAYLIST_DIRECTORY,
2018-04-17 14:01:06 +02:00
FEEDS,
2018-08-03 10:19:51 +02:00
JOB_TTL,
2019-07-10 14:06:19 +02:00
DEFAULT_THEME_NAME,
NSFW_POLICY_TYPES,
STATIC_MAX_AGE,
STATIC_PATHS,
VIDEO_IMPORT_TIMEOUT,
2019-03-05 10:58:44 +01:00
VIDEO_PLAYLIST_TYPES,
2019-04-10 15:26:33 +02:00
MAX_LOGS_OUTPUT_CHARACTERS,
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,
VIDEO_STATES,
2019-08-09 11:32:40 +02:00
QUEUE_CONCURRENCY,
2017-11-10 14:34:45 +01:00
VIDEO_RATE_TYPES,
VIDEO_TRANSCODING_FPS,
FFMPEG_NICE,
VIDEO_ABUSE_STATES,
2019-08-09 11:32:40 +02:00
LRU_CACHE,
2018-05-09 09:08:22 +02:00
JOB_REQUEST_TIMEOUT,
2018-01-30 13:27:07 +01:00
USER_PASSWORD_RESET_LIFETIME,
2018-09-14 11:52:23 +02:00
MEMOIZE_TTL,
USER_EMAIL_VERIFY_LIFETIME,
2018-08-30 14:58:00 +02:00
OVERVIEWS,
SCHEDULER_INTERVALS_MS,
2018-08-29 16:26:25 +02:00
REPEAT_JOBS,
2018-05-29 18:30:11 +02:00
STATIC_DOWNLOAD_PATHS,
2018-12-11 14:52:50 +01:00
MIMETYPES,
CRAWL_REQUEST_CONCURRENCY,
2019-05-16 16:55:34 +02:00
DEFAULT_AUDIO_RESOLUTION,
2018-02-23 16:39:51 +01:00
JOB_COMPLETED_LIFETIME,
HTTP_SIGNATURE,
VIDEO_IMPORT_STATES,
2018-06-06 16:46:42 +02:00
VIDEO_VIEW_LIFETIME,
2019-01-09 15:14:29 +01:00
CONTACT_FORM_LIFETIME,
2019-02-26 10:55:40 +01:00
VIDEO_PLAYLIST_PRIVACIES,
2019-05-16 16:55:34 +02:00
ASSETS_PATH,
loadLanguages,
2018-06-06 16:46:42 +02:00
buildLanguages
}
// ---------------------------------------------------------------------------
2018-12-11 14:52:50 +01:00
function buildVideoMimetypeExt () {
const data = {
'video/webm': '.webm',
'video/ogg': '.ogv',
'video/mp4': '.mp4'
}
2019-05-16 16:55:34 +02:00
if (CONFIG.TRANSCODING.ENABLED) {
if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
Object.assign(data, {
'video/quicktime': '.mov',
'video/x-msvideo': '.avi',
'video/x-flv': '.flv',
'video/x-matroska': '.mkv',
'application/octet-stream': '.mkv',
'video/avi': '.avi'
})
}
if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
}
2018-12-11 14:52:50 +01:00
}
return data
}
function updateWebserverUrls () {
2019-04-11 11:33:44 +02:00
WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
WEBSERVER.WS = CONFIG.WEBSERVER.WS
WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
}
2018-12-11 14:52:50 +01:00
function updateWebserverConfig () {
MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
MIMETYPES.VIDEO.EXT_MIMETYPE = invert(MIMETYPES.VIDEO.MIMETYPE_EXT)
2019-05-16 16:55:34 +02:00
ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = buildVideosExtname()
2018-12-11 14:52:50 +01:00
}
function buildVideosExtname () {
2019-05-16 16:55:34 +02:00
return Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
2018-12-11 14:52:50 +01:00
}
function loadLanguages () {
Object.assign(VIDEO_LANGUAGES, buildLanguages())
}
2018-04-23 14:39:52 +02:00
function buildLanguages () {
const iso639 = require('iso-639-3')
const languages: { [ id: string ]: string } = {}
const additionalLanguages = {
'sgn': true, // Sign languages (macro language)
'ase': true, // American sign language
'sdl': true, // Arabian sign language
'bfi': true, // British sign language
'bzs': true, // Brazilian sign language
'csl': true, // Chinese sign language
'cse': true, // Czech sign language
'dsl': true, // Danish sign language
'fsl': true, // French sign language
'gsg': true, // German sign language
'pks': true, // Pakistan sign language
'jsl': true, // Japanese sign language
'sfs': true, // South African sign language
'swl': true, // Swedish sign language
'rsl': true, // Russian sign language: true
'epo': true, // Esperanto
'tlh': true, // Klingon
'jbo': true, // Lojban
'avk': true // Kotava
}
2018-04-23 14:39:52 +02:00
// Only add ISO639-1 languages and some sign languages (ISO639-3)
iso639
.filter(l => {
return (l.iso6391 !== null && l.type === 'living') ||
2019-04-11 11:33:44 +02:00
additionalLanguages[ l.iso6393 ] === true
2018-04-23 14:39:52 +02:00
})
2019-04-11 11:33:44 +02:00
.forEach(l => languages[ l.iso6391 || l.iso6393 ] = l.name)
2018-04-23 14:39:52 +02:00
2018-09-05 15:59:43 +02:00
// Override Occitan label
2019-04-11 11:33:44 +02:00
languages[ 'oc' ] = 'Occitan'
2019-05-13 09:45:02 +02:00
languages[ 'el' ] = 'Greek'
2018-09-05 15:59:43 +02:00
2018-04-23 14:39:52 +02:00
return languages
}