]>
Commit | Line | Data |
---|---|---|
0223291c | 1 | import { CronRepeatOptions, EveryRepeatOptions } from 'bull' |
adbf1ed8 | 2 | import { randomBytes } from 'crypto' |
0223291c | 3 | import { invert } from 'lodash' |
6dd9de95 | 4 | import { join } from 'path' |
c55e3d72 | 5 | import { randomInt, root } from '@shared/core-utils' |
d95d1559 C |
6 | import { |
7 | AbuseState, | |
0223291c | 8 | JobType, |
d95d1559 C |
9 | VideoImportState, |
10 | VideoPrivacy, | |
d95d1559 C |
11 | VideoRateType, |
12 | VideoResolution, | |
0223291c C |
13 | VideoState, |
14 | VideoTranscodingFPS | |
d95d1559 | 15 | } from '../../shared/models' |
0223291c | 16 | import { ActivityPubActorType } from '../../shared/models/activitypub' |
d0800f76 | 17 | import { ActorImageType, FollowState } from '../../shared/models/actors' |
0883b324 | 18 | import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type' |
418d092a | 19 | import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model' |
df0b219d | 20 | import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model' |
0223291c | 21 | // Do not use barrels, remain constants as independent as possible |
9452d4fd | 22 | import { isTestInstance, isTestOrDevInstance, parseDurationToMs, sanitizeHost, sanitizeUrl } from '../helpers/core-utils' |
6dd9de95 | 23 | import { CONFIG, registerConfigChangedHandler } from './config' |
ee9e7b61 | 24 | |
9f6bae3a C |
25 | // --------------------------------------------------------------------------- |
26 | ||
c795e196 | 27 | const LAST_MIGRATION_VERSION = 725 |
5804c0db C |
28 | |
29 | // --------------------------------------------------------------------------- | |
30 | ||
f0f5567b | 31 | const API_VERSION = 'v1' |
db4b15f2 | 32 | const PEERTUBE_VERSION: string = require(join(root(), 'package.json')).version |
9f10b292 | 33 | |
1194e8b4 | 34 | const PAGINATION = { |
e0b56b74 C |
35 | GLOBAL: { |
36 | COUNT: { | |
37 | DEFAULT: 15, | |
38 | MAX: 100 | |
39 | } | |
40 | }, | |
41 | OUTBOX: { | |
42 | COUNT: { | |
43 | MAX: 50 | |
44 | } | |
1194e8b4 C |
45 | } |
46 | } | |
9f6bae3a | 47 | |
6dd9de95 C |
48 | const WEBSERVER = { |
49 | URL: '', | |
50 | HOST: '', | |
51 | SCHEME: '', | |
52 | WS: '', | |
53 | HOSTNAME: '', | |
c6c0fa6c | 54 | PORT: 0, |
df1db951 C |
55 | RTMP_URL: '', |
56 | RTMPS_URL: '' | |
6dd9de95 C |
57 | } |
58 | ||
9f6bae3a C |
59 | // Sortable columns per schema |
60 | const SORTABLE_COLUMNS = { | |
87a0cac6 | 61 | ADMIN_USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ], |
06a05d5f | 62 | USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ], |
265ba139 | 63 | ACCOUNTS: [ 'createdAt' ], |
94a5ff8a | 64 | JOBS: [ 'createdAt' ], |
72c7248b | 65 | VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ], |
ed31c059 | 66 | VIDEO_IMPORTS: [ 'createdAt' ], |
0f8d00e3 | 67 | |
c1125bca | 68 | VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ], |
0f8d00e3 C |
69 | VIDEO_COMMENTS: [ 'createdAt' ], |
70 | ||
c100a614 | 71 | VIDEO_RATES: [ 'createdAt' ], |
7a7724e6 | 72 | BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ], |
4beda9e1 | 73 | |
9593a78a C |
74 | INSTANCE_FOLLOWERS: [ 'createdAt', 'state', 'score' ], |
75 | INSTANCE_FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ], | |
4beda9e1 C |
76 | ACCOUNT_FOLLOWERS: [ 'createdAt' ], |
77 | CHANNEL_FOLLOWERS: [ 'createdAt' ], | |
57c36b27 | 78 | |
3d4e112d | 79 | VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot', 'best' ], |
9a629c6e | 80 | |
5fb2e288 | 81 | // Don't forget to update peertube-search-index with the same values |
2fd59d7d | 82 | VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ], |
7ad9b984 | 83 | VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ], |
37a44fc9 | 84 | VIDEO_PLAYLISTS_SEARCH: [ 'match', 'displayName', 'createdAt' ], |
7ad9b984 | 85 | |
d95d1559 C |
86 | ABUSES: [ 'id', 'createdAt', 'state' ], |
87 | ||
7ad9b984 | 88 | ACCOUNTS_BLOCKLIST: [ 'createdAt' ], |
cef534ed C |
89 | SERVERS_BLOCKLIST: [ 'createdAt' ], |
90 | ||
654a188f | 91 | USER_NOTIFICATIONS: [ 'createdAt', 'read' ], |
418d092a | 92 | |
49cff3a4 | 93 | VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ], |
ad91e700 | 94 | |
6702a1b2 C |
95 | PLUGINS: [ 'name', 'createdAt', 'updatedAt' ], |
96 | ||
b764380a C |
97 | AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ], |
98 | ||
99 | VIDEO_REDUNDANCIES: [ 'name' ] | |
9f6bae3a | 100 | } |
9f10b292 | 101 | |
2f372a86 | 102 | const OAUTH_LIFETIME = { |
ff193d5e | 103 | ACCESS_TOKEN: 3600 * 24, // 1 day, for upload |
2f372a86 C |
104 | REFRESH_TOKEN: 1209600 // 2 weeks |
105 | } | |
106 | ||
fd4484f1 | 107 | const ROUTE_CACHE_LIFETIME = { |
3f6d68d9 RK |
108 | FEEDS: '15 minutes', |
109 | ROBOTS: '2 hours', | |
2feebf3e | 110 | SITEMAP: '1 day', |
5447516b | 111 | SECURITYTXT: '2 hours', |
3f6d68d9 | 112 | NODEINFO: '10 minutes', |
aad0ec24 | 113 | DNT_POLICY: '1 week', |
fd4484f1 | 114 | ACTIVITY_PUB: { |
3f6d68d9 | 115 | VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example |
4b5384f6 C |
116 | }, |
117 | STATS: '4 hours' | |
fd4484f1 C |
118 | } |
119 | ||
9f6bae3a | 120 | // --------------------------------------------------------------------------- |
26d7d31b | 121 | |
60650c77 C |
122 | // Number of points we add/remove after a successful/bad request |
123 | const ACTOR_FOLLOW_SCORE = { | |
225a89c2 C |
124 | PENALTY: -10, |
125 | BONUS: 10, | |
60650c77 C |
126 | BASE: 1000, |
127 | MAX: 10000 | |
225a89c2 C |
128 | } |
129 | ||
130 | const FOLLOW_STATES: { [ id: string ]: FollowState } = { | |
131 | PENDING: 'pending', | |
927fa4b1 C |
132 | ACCEPTED: 'accepted', |
133 | REJECTED: 'rejected' | |
225a89c2 C |
134 | } |
135 | ||
136 | const REMOTE_SCHEME = { | |
137 | HTTP: 'https', | |
138 | WS: 'wss' | |
139 | } | |
140 | ||
b764380a | 141 | const JOB_ATTEMPTS: { [id in JobType]: number } = { |
9db437c8 | 142 | 'activitypub-http-broadcast': 1, |
f27b7a75 | 143 | 'activitypub-http-broadcast-parallel': 1, |
9db437c8 C |
144 | 'activitypub-http-unicast': 1, |
145 | 'activitypub-http-fetcher': 2, | |
5350fd8e | 146 | 'activitypub-follow': 5, |
74d249bc | 147 | 'activitypub-cleaner': 1, |
0138af92 | 148 | 'video-file-import': 1, |
a0327eed | 149 | 'video-transcoding': 1, |
fbad87b0 | 150 | 'video-import': 1, |
6b616860 | 151 | 'email': 5, |
8795d6f2 | 152 | 'actor-keys': 3, |
51353d9a | 153 | 'videos-views-stats': 1, |
b764380a | 154 | 'activitypub-refresher': 1, |
a5cf76af | 155 | 'video-redundancy': 1, |
0305db28 | 156 | 'video-live-ending': 1, |
92e66e04 | 157 | 'video-studio-edition': 1, |
f012319a | 158 | 'manage-video-torrent': 1, |
0305db28 | 159 | 'move-to-object-storage': 3 |
225a89c2 | 160 | } |
74d249bc C |
161 | // Excluded keys are jobs that can be configured by admins |
162 | const JOB_CONCURRENCY: { [id in Exclude<JobType, 'video-transcoding' | 'video-import'>]: number } = { | |
94a5ff8a | 163 | 'activitypub-http-broadcast': 1, |
f27b7a75 | 164 | 'activitypub-http-broadcast-parallel': 30, |
9db437c8 | 165 | 'activitypub-http-unicast': 10, |
60520c7c | 166 | 'activitypub-http-fetcher': 3, |
74d249bc | 167 | 'activitypub-cleaner': 1, |
ab4d4db4 | 168 | 'activitypub-follow': 1, |
0138af92 | 169 | 'video-file-import': 1, |
6b616860 | 170 | 'email': 5, |
8795d6f2 | 171 | 'actor-keys': 1, |
51353d9a | 172 | 'videos-views-stats': 1, |
b764380a | 173 | 'activitypub-refresher': 1, |
a5cf76af | 174 | 'video-redundancy': 1, |
0305db28 | 175 | 'video-live-ending': 10, |
92e66e04 | 176 | 'video-studio-edition': 1, |
f012319a | 177 | 'manage-video-torrent': 1, |
0305db28 | 178 | 'move-to-object-storage': 1 |
225a89c2 | 179 | } |
b764380a | 180 | const JOB_TTL: { [id in JobType]: number } = { |
2b86fe72 | 181 | 'activitypub-http-broadcast': 60000 * 10, // 10 minutes |
f27b7a75 | 182 | 'activitypub-http-broadcast-parallel': 60000 * 10, // 10 minutes |
2b86fe72 | 183 | 'activitypub-http-unicast': 60000 * 10, // 10 minutes |
d694b193 | 184 | 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours |
2b86fe72 | 185 | 'activitypub-follow': 60000 * 10, // 10 minutes |
74d249bc | 186 | 'activitypub-cleaner': 1000 * 3600, // 1 hour |
2b86fe72 | 187 | 'video-file-import': 1000 * 3600, // 1 hour |
a0327eed | 188 | 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long |
92e66e04 | 189 | 'video-studio-edition': 1000 * 3600 * 10, // 10 hours |
3eba7ab8 | 190 | 'video-import': CONFIG.IMPORT.VIDEOS.TIMEOUT, |
6b616860 | 191 | 'email': 60000 * 10, // 10 minutes |
8795d6f2 | 192 | 'actor-keys': 60000 * 20, // 20 minutes |
51353d9a | 193 | 'videos-views-stats': undefined, // Unlimited |
b764380a | 194 | 'activitypub-refresher': 60000 * 10, // 10 minutes |
a5cf76af | 195 | 'video-redundancy': 1000 * 3600 * 3, // 3 hours |
0305db28 | 196 | 'video-live-ending': 1000 * 60 * 10, // 10 minutes |
f012319a | 197 | 'manage-video-torrent': 1000 * 3600 * 3, // 3 hours |
0305db28 | 198 | 'move-to-object-storage': 1000 * 60 * 60 * 3 // 3 hours |
2b86fe72 | 199 | } |
51353d9a C |
200 | const REPEAT_JOBS: { [ id in JobType ]?: EveryRepeatOptions | CronRepeatOptions } = { |
201 | 'videos-views-stats': { | |
0223291c | 202 | cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour |
74d249bc C |
203 | }, |
204 | 'activitypub-cleaner': { | |
205 | cron: '30 5 * * ' + randomInt(0, 7) // 1 time per week (random day) at 5:30 AM | |
6b616860 C |
206 | } |
207 | } | |
77d7e851 | 208 | const JOB_PRIORITY = { |
a6e37eeb | 209 | TRANSCODING: 100 |
77d7e851 | 210 | } |
6b616860 | 211 | |
67bd004d | 212 | const BROADCAST_CONCURRENCY = 30 // How many requests in parallel we do in activitypub-http-broadcast job |
240085d0 | 213 | const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...) |
f1569117 C |
214 | |
215 | const AP_CLEANER = { | |
216 | CONCURRENCY: 10, // How many requests in parallel we do in activitypub-cleaner job | |
7a4fd56c | 217 | UNAVAILABLE_TRESHOLD: 3, // How many attempts we do before removing an unavailable remote resource |
f1569117 C |
218 | PERIOD: parseDurationToMs('1 week') // /!\ Has to be sync with REPEAT_JOBS |
219 | } | |
220 | ||
4c99953a C |
221 | const REQUEST_TIMEOUTS = { |
222 | DEFAULT: 7000, // 7 seconds | |
223 | FILE: 30000, // 30 seconds | |
224 | REDUNDANCY: JOB_TTL['video-redundancy'] | |
225 | } | |
226 | ||
71e3dfda | 227 | const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days |
7630e1c8 | 228 | const VIDEO_IMPORT_TIMEOUT = Math.floor(JOB_TTL['video-import'] * 0.9) |
225a89c2 | 229 | |
8f0bc73d | 230 | const SCHEDULER_INTERVALS_MS = { |
61953742 C |
231 | ACTOR_FOLLOW_SCORES: 60000 * 60, // 1 hour |
232 | REMOVE_OLD_JOBS: 60000 * 60, // 1 hour | |
233 | UPDATE_VIDEOS: 60000, // 1 minute | |
234 | YOUTUBE_DL_UPDATE: 60000 * 60 * 24, // 1 day | |
b2111066 | 235 | GEO_IP_UPDATE: 60000 * 60 * 24, // 1 day |
51353d9a | 236 | VIDEO_VIEWS_BUFFER_UPDATE: CONFIG.VIEWS.VIDEOS.LOCAL_BUFFER_UPDATE_INTERVAL, |
61953742 C |
237 | CHECK_PLUGINS: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL, |
238 | CHECK_PEERTUBE_VERSION: 60000 * 60 * 24, // 1 day | |
239 | AUTO_FOLLOW_INDEX_INSTANCES: 60000 * 60 * 24, // 1 day | |
240 | REMOVE_OLD_VIEWS: 60000 * 60 * 24, // 1 day | |
241 | REMOVE_OLD_HISTORY: 60000 * 60 * 24, // 1 day | |
242 | UPDATE_INBOX_STATS: 1000 * 60, // 1 minute | |
6d472b40 | 243 | REMOVE_DANGLING_RESUMABLE_UPLOADS: 60000 * 60 // 1 hour |
2baea0c7 | 244 | } |
60650c77 | 245 | |
225a89c2 C |
246 | // --------------------------------------------------------------------------- |
247 | ||
503c6f44 | 248 | const CONSTRAINTS_FIELDS = { |
e4c55619 | 249 | USERS: { |
9f7a1953 | 250 | NAME: { min: 1, max: 120 }, // Length |
d23e6a1c | 251 | DESCRIPTION: { min: 3, max: 1000 }, // Length |
d0ce42c1 | 252 | USERNAME: { min: 1, max: 50 }, // Length |
b0f9f39e | 253 | PASSWORD: { min: 6, max: 255 }, // Length |
eacb25c4 | 254 | VIDEO_QUOTA: { min: -1 }, |
bee0abff | 255 | VIDEO_QUOTA_DAILY: { min: -1 }, |
3caf77d3 | 256 | VIDEO_LANGUAGES: { max: 500 }, // Array length |
eacb25c4 | 257 | BLOCKED_REASON: { min: 3, max: 250 } // Length |
e4c55619 | 258 | }, |
d95d1559 | 259 | ABUSES: { |
1506307f C |
260 | REASON: { min: 2, max: 3000 }, // Length |
261 | MODERATION_COMMENT: { min: 2, max: 3000 } // Length | |
55fa55a9 | 262 | }, |
edbc9325 C |
263 | ABUSE_MESSAGES: { |
264 | MESSAGE: { min: 2, max: 3000 } // Length | |
265 | }, | |
26b7305a C |
266 | VIDEO_BLACKLIST: { |
267 | REASON: { min: 2, max: 300 } // Length | |
268 | }, | |
72c7248b | 269 | VIDEO_CHANNELS: { |
9f7a1953 | 270 | NAME: { min: 1, max: 120 }, // Length |
d23e6a1c BY |
271 | DESCRIPTION: { min: 3, max: 1000 }, // Length |
272 | SUPPORT: { min: 3, max: 1000 }, // Length | |
e34c85e5 | 273 | URL: { min: 3, max: 2000 } // Length |
72c7248b | 274 | }, |
40e87e9e C |
275 | VIDEO_CAPTIONS: { |
276 | CAPTION_FILE: { | |
f4001cf4 | 277 | EXTNAME: [ '.vtt', '.srt' ], |
40e87e9e | 278 | FILE_SIZE: { |
ce7c099f | 279 | max: 20 * 1024 * 1024 // 20MB |
40e87e9e C |
280 | } |
281 | } | |
282 | }, | |
fbad87b0 | 283 | VIDEO_IMPORTS: { |
ce33919c C |
284 | URL: { min: 3, max: 2000 }, // Length |
285 | TORRENT_NAME: { min: 3, max: 255 }, // Length | |
990b6a0b C |
286 | TORRENT_FILE: { |
287 | EXTNAME: [ '.torrent' ], | |
288 | FILE_SIZE: { | |
289 | max: 1024 * 200 // 200 KB | |
290 | } | |
291 | } | |
fbad87b0 | 292 | }, |
c48e82b5 C |
293 | VIDEOS_REDUNDANCY: { |
294 | URL: { min: 3, max: 2000 } // Length | |
295 | }, | |
5c6d985f C |
296 | VIDEO_RATES: { |
297 | URL: { min: 3, max: 2000 } // Length | |
298 | }, | |
e4c55619 | 299 | VIDEOS: { |
a265f7f3 | 300 | NAME: { min: 3, max: 120 }, // Length |
9d3ef9fe | 301 | LANGUAGE: { min: 1, max: 10 }, // Length |
9567011b | 302 | TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length |
2422c46b | 303 | DESCRIPTION: { min: 3, max: 10000 }, // Length |
d23e6a1c | 304 | SUPPORT: { min: 3, max: 1000 }, // Length |
ac81d1a0 | 305 | IMAGE: { |
e08ff02a | 306 | EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ], |
ac81d1a0 | 307 | FILE_SIZE: { |
a13df19d | 308 | max: 4 * 1024 * 1024 // 4MB |
ac81d1a0 C |
309 | } |
310 | }, | |
536598cf | 311 | EXTNAME: [] as string[], |
0e1dc3e7 | 312 | INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2 |
fbad87b0 | 313 | DURATION: { min: 0 }, // Number |
a265f7f3 C |
314 | TAGS: { min: 0, max: 5 }, // Number of total tags |
315 | TAG: { min: 2, max: 30 }, // Length | |
e4c87ec2 C |
316 | VIEWS: { min: 0 }, |
317 | LIKES: { min: 0 }, | |
93e1258c | 318 | DISLIKES: { min: 0 }, |
c6c0fa6c | 319 | FILE_SIZE: { min: -1 }, |
f6d6e7f8 | 320 | PARTIAL_UPLOAD_SIZE: { max: 50 * 1024 * 1024 * 1024 }, // 50GB |
e34c85e5 C |
321 | URL: { min: 3, max: 2000 } // Length |
322 | }, | |
418d092a C |
323 | VIDEO_PLAYLISTS: { |
324 | NAME: { min: 1, max: 120 }, // Length | |
325 | DESCRIPTION: { min: 3, max: 1000 }, // Length | |
326 | URL: { min: 3, max: 2000 }, // Length | |
327 | IMAGE: { | |
328 | EXTNAME: [ '.jpg', '.jpeg' ], | |
329 | FILE_SIZE: { | |
a13df19d | 330 | max: 4 * 1024 * 1024 // 4MB |
418d092a C |
331 | } |
332 | } | |
333 | }, | |
01de67b9 | 334 | ACTORS: { |
e34c85e5 C |
335 | PUBLIC_KEY: { min: 10, max: 5000 }, // Length |
336 | PRIVATE_KEY: { min: 10, max: 5000 }, // Length | |
c5911fd3 | 337 | URL: { min: 3, max: 2000 }, // Length |
2cb03dc1 | 338 | IMAGE: { |
e08ff02a | 339 | EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ], |
01de67b9 | 340 | FILE_SIZE: { |
a13df19d | 341 | max: 4 * 1024 * 1024 // 4MB |
01de67b9 | 342 | } |
c5911fd3 | 343 | } |
e4c87ec2 C |
344 | }, |
345 | VIDEO_EVENTS: { | |
346 | COUNT: { min: 0 } | |
6d852470 | 347 | }, |
bf1f6508 | 348 | VIDEO_COMMENTS: { |
298b3fd3 | 349 | TEXT: { min: 1, max: 10000 }, // Length |
6d852470 | 350 | URL: { min: 3, max: 2000 } // Length |
4ba3b8ea C |
351 | }, |
352 | VIDEO_SHARE: { | |
353 | URL: { min: 3, max: 2000 } // Length | |
a4101923 C |
354 | }, |
355 | CONTACT_FORM: { | |
356 | FROM_NAME: { min: 1, max: 120 }, // Length | |
357 | BODY: { min: 3, max: 5000 } // Length | |
345da516 C |
358 | }, |
359 | PLUGINS: { | |
360 | NAME: { min: 1, max: 214 }, // Length | |
361 | DESCRIPTION: { min: 1, max: 20000 } // Length | |
2735a154 C |
362 | }, |
363 | COMMONS: { | |
364 | URL: { min: 5, max: 2000 } // Length | |
c729caf6 | 365 | }, |
92e66e04 | 366 | VIDEO_STUDIO: { |
c729caf6 C |
367 | TASKS: { min: 1, max: 10 }, // Number of tasks |
368 | CUT_TIME: { min: 0 } // Value | |
42b40636 C |
369 | }, |
370 | LOGS: { | |
371 | CLIENT_MESSAGE: { min: 1, max: 1000 }, // Length | |
372 | CLIENT_STACK_TRACE: { min: 1, max: 5000 }, // Length | |
373 | CLIENT_META: { min: 1, max: 5000 }, // Length | |
374 | CLIENT_USER_AGENT: { min: 1, max: 200 } // Length | |
e4c55619 C |
375 | } |
376 | } | |
377 | ||
c655c9ef | 378 | const VIEW_LIFETIME = { |
51353d9a | 379 | VIEW: CONFIG.VIEWS.VIDEOS.IP_VIEW_EXPIRATION, |
f53e1fcd | 380 | VIEWER_COUNTER: 60000 * 2, // 2 minutes |
b2111066 | 381 | VIEWER_STATS: 60000 * 60 // 1 hour |
e4bf7856 C |
382 | } |
383 | ||
42e6a7a7 | 384 | const MAX_LOCAL_VIEWER_WATCH_SECTIONS = 100 |
b2111066 | 385 | |
a4101923 C |
386 | let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour |
387 | ||
edb4ffc7 | 388 | const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = { |
f7bb2bb5 | 389 | MIN: 1, |
a1587156 C |
390 | STANDARD: [ 24, 25, 30 ], |
391 | HD_STANDARD: [ 50, 60 ], | |
c729caf6 | 392 | AUDIO_MERGE: 25, |
3a6f351b C |
393 | AVERAGE: 30, |
394 | MAX: 60, | |
395 | KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum) | |
a7977280 | 396 | } |
b5c0e955 | 397 | |
536598cf C |
398 | const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P |
399 | ||
ee9e7b61 | 400 | const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = { |
d38b8281 C |
401 | LIKE: 'like', |
402 | DISLIKE: 'dislike' | |
403 | } | |
404 | ||
80bc88c1 | 405 | const FFMPEG_NICE: { [ id: string ]: number } = { |
7abb6060 RK |
406 | // parent process defaults to niceness = 0 |
407 | // reminder: lower = higher priority, max value is 19, lowest is -20 | |
a4a8cd39 C |
408 | LIVE: 5, // prioritize over VOD and THUMBNAIL |
409 | THUMBNAIL: 10, | |
7abb6060 | 410 | VOD: 15 |
80bc88c1 J |
411 | } |
412 | ||
6e07c3de C |
413 | const VIDEO_CATEGORIES = { |
414 | 1: 'Music', | |
415 | 2: 'Films', | |
416 | 3: 'Vehicles', | |
417 | 4: 'Art', | |
418 | 5: 'Sports', | |
419 | 6: 'Travels', | |
420 | 7: 'Gaming', | |
421 | 8: 'People', | |
422 | 9: 'Comedy', | |
423 | 10: 'Entertainment', | |
6f2ae7a1 | 424 | 11: 'News & Politics', |
40298b02 | 425 | 12: 'How To', |
6e07c3de C |
426 | 13: 'Education', |
427 | 14: 'Activism', | |
428 | 15: 'Science & Technology', | |
429 | 16: 'Animals', | |
430 | 17: 'Kids', | |
431 | 18: 'Food' | |
432 | } | |
433 | ||
6f0c39e2 C |
434 | // See https://creativecommons.org/licenses/?lang=en |
435 | const VIDEO_LICENCES = { | |
436 | 1: 'Attribution', | |
437 | 2: 'Attribution - Share Alike', | |
438 | 3: 'Attribution - No Derivatives', | |
439 | 4: 'Attribution - Non Commercial', | |
440 | 5: 'Attribution - Non Commercial - Share Alike', | |
441 | 6: 'Attribution - Non Commercial - No Derivatives', | |
442 | 7: 'Public Domain Dedication' | |
443 | } | |
444 | ||
a1587156 | 445 | const VIDEO_LANGUAGES: { [id: string]: string } = {} |
3092476e | 446 | |
c6c0fa6c | 447 | const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = { |
a1587156 C |
448 | [VideoPrivacy.PUBLIC]: 'Public', |
449 | [VideoPrivacy.UNLISTED]: 'Unlisted', | |
450 | [VideoPrivacy.PRIVATE]: 'Private', | |
451 | [VideoPrivacy.INTERNAL]: 'Internal' | |
fd45e8f4 C |
452 | } |
453 | ||
c6c0fa6c | 454 | const VIDEO_STATES: { [ id in VideoState ]: string } = { |
a1587156 C |
455 | [VideoState.PUBLISHED]: 'Published', |
456 | [VideoState.TO_TRANSCODE]: 'To transcode', | |
c6c0fa6c C |
457 | [VideoState.TO_IMPORT]: 'To import', |
458 | [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream', | |
0305db28 | 459 | [VideoState.LIVE_ENDED]: 'Livestream ended', |
4e29f4fe | 460 | [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE]: 'To move to an external storage', |
dbd9fb44 | 461 | [VideoState.TRANSCODING_FAILED]: 'Transcoding failed', |
c729caf6 C |
462 | [VideoState.TO_MOVE_TO_EXTERNAL_STORAGE_FAILED]: 'External storage move failed', |
463 | [VideoState.TO_EDIT]: 'To edit*' | |
fbad87b0 C |
464 | } |
465 | ||
c6c0fa6c | 466 | const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = { |
a1587156 C |
467 | [VideoImportState.FAILED]: 'Failed', |
468 | [VideoImportState.PENDING]: 'Pending', | |
2158ac90 | 469 | [VideoImportState.SUCCESS]: 'Success', |
419b520c C |
470 | [VideoImportState.REJECTED]: 'Rejected', |
471 | [VideoImportState.CANCELLED]: 'Cancelled', | |
472 | [VideoImportState.PROCESSING]: 'Processing' | |
2186386c C |
473 | } |
474 | ||
c6c0fa6c | 475 | const ABUSE_STATES: { [ id in AbuseState ]: string } = { |
d95d1559 C |
476 | [AbuseState.PENDING]: 'Pending', |
477 | [AbuseState.REJECTED]: 'Rejected', | |
478 | [AbuseState.ACCEPTED]: 'Accepted' | |
268eebed C |
479 | } |
480 | ||
c6c0fa6c | 481 | const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = { |
a1587156 C |
482 | [VideoPlaylistPrivacy.PUBLIC]: 'Public', |
483 | [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted', | |
484 | [VideoPlaylistPrivacy.PRIVATE]: 'Private' | |
418d092a C |
485 | } |
486 | ||
c6c0fa6c | 487 | const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = { |
a1587156 C |
488 | [VideoPlaylistType.REGULAR]: 'Regular', |
489 | [VideoPlaylistType.WATCH_LATER]: 'Watch later' | |
df0b219d C |
490 | } |
491 | ||
14e2014a | 492 | const MIMETYPES = { |
536598cf C |
493 | AUDIO: { |
494 | MIMETYPE_EXT: { | |
495 | 'audio/mpeg': '.mp3', | |
496 | 'audio/mp3': '.mp3', | |
4b7a20d8 | 497 | |
536598cf C |
498 | 'application/ogg': '.ogg', |
499 | 'audio/ogg': '.ogg', | |
4b7a20d8 | 500 | |
99d362de C |
501 | 'audio/x-ms-wma': '.wma', |
502 | 'audio/wav': '.wav', | |
e622db05 | 503 | 'audio/x-wav': '.wav', |
4b7a20d8 | 504 | |
99d362de | 505 | 'audio/x-flac': '.flac', |
b056afe0 | 506 | 'audio/flac': '.flac', |
4b7a20d8 C |
507 | |
508 | 'audio/vnd.dlna.adts': '.aac', | |
e622db05 | 509 | 'audio/aac': '.aac', |
4b7a20d8 | 510 | |
9556ce48 | 511 | 'audio/m4a': '.m4a', |
e072fb1e | 512 | 'audio/mp4': '.m4a', |
9556ce48 | 513 | 'audio/x-m4a': '.m4a', |
4b7a20d8 C |
514 | |
515 | 'audio/vnd.dolby.dd-raw': '.ac3', | |
b056afe0 | 516 | 'audio/ac3': '.ac3' |
536598cf C |
517 | }, |
518 | EXT_MIMETYPE: null as { [ id: string ]: string } | |
519 | }, | |
14e2014a | 520 | VIDEO: { |
30bc55c8 C |
521 | MIMETYPE_EXT: null as { [ id: string ]: string | string[] }, |
522 | MIMETYPES_REGEX: null as string, | |
14e2014a C |
523 | EXT_MIMETYPE: null as { [ id: string ]: string } |
524 | }, | |
525 | IMAGE: { | |
526 | MIMETYPE_EXT: { | |
527 | 'image/png': '.png', | |
2cb03dc1 C |
528 | 'image/gif': '.gif', |
529 | 'image/webp': '.webp', | |
14e2014a C |
530 | 'image/jpg': '.jpg', |
531 | 'image/jpeg': '.jpg' | |
c6de3a85 C |
532 | }, |
533 | EXT_MIMETYPE: null as { [ id: string ]: string } | |
14e2014a C |
534 | }, |
535 | VIDEO_CAPTIONS: { | |
536 | MIMETYPE_EXT: { | |
537 | 'text/vtt': '.vtt', | |
2f26030d C |
538 | 'application/x-subrip': '.srt', |
539 | 'text/plain': '.srt' | |
14e2014a C |
540 | } |
541 | }, | |
542 | TORRENT: { | |
543 | MIMETYPE_EXT: { | |
544 | 'application/x-bittorrent': '.torrent' | |
545 | } | |
546 | } | |
990b6a0b | 547 | } |
536598cf | 548 | MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT) |
c6de3a85 | 549 | MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT) |
990b6a0b | 550 | |
62549e6c C |
551 | const BINARY_CONTENT_TYPES = new Set([ |
552 | 'binary/octet-stream', | |
553 | 'application/octet-stream', | |
554 | 'application/x-binary' | |
555 | ]) | |
556 | ||
9f6bae3a C |
557 | // --------------------------------------------------------------------------- |
558 | ||
2d3741d6 C |
559 | const OVERVIEWS = { |
560 | VIDEOS: { | |
1a471091 | 561 | SAMPLE_THRESHOLD: 6, |
764a9657 | 562 | SAMPLES_COUNT: 20 |
2d3741d6 C |
563 | } |
564 | } | |
565 | ||
566 | // --------------------------------------------------------------------------- | |
567 | ||
50d6de9c | 568 | const SERVER_ACTOR_NAME = 'peertube' |
350e31d6 | 569 | |
e4f97bab | 570 | const ACTIVITY_PUB = { |
1b5b10d1 C |
571 | POTENTIAL_ACCEPT_HEADERS: [ |
572 | 'application/activity+json', | |
9a8cbd82 C |
573 | 'application/ld+json', |
574 | 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"' | |
165cdc75 | 575 | ], |
1b5b10d1 | 576 | ACCEPT_HEADER: 'application/activity+json, application/ld+json', |
9a27cdc2 | 577 | PUBLIC: 'https://www.w3.org/ns/activitystreams#Public', |
0d0e8dd0 | 578 | COLLECTION_ITEMS_PER_PAGE: 10, |
4d9ae8f7 | 579 | FETCH_PAGE_LIMIT: 2000, |
20494f12 | 580 | URL_MIME_TYPES: { |
536598cf | 581 | VIDEO: [] as string[], |
20494f12 C |
582 | TORRENT: [ 'application/x-bittorrent' ], |
583 | MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ] | |
a5625b41 | 584 | }, |
2ccaeeb3 | 585 | MAX_RECURSION_COMMENTS: 100, |
0e0c745b | 586 | ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days |
9f79ade6 C |
587 | VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days |
588 | VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days | |
e4f97bab C |
589 | } |
590 | ||
50d6de9c C |
591 | const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = { |
592 | GROUP: 'Group', | |
593 | PERSON: 'Person', | |
47581df0 C |
594 | APPLICATION: 'Application', |
595 | ORGANIZATION: 'Organization', | |
596 | SERVICE: 'Service' | |
50d6de9c C |
597 | } |
598 | ||
41f2ebae C |
599 | const HTTP_SIGNATURE = { |
600 | HEADER_NAME: 'signature', | |
601 | ALGORITHM: 'rsa-sha256', | |
543affef | 602 | HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ], |
f67d7574 | 603 | CLOCK_SKEW_SECONDS: 1800 |
41f2ebae C |
604 | } |
605 | ||
9f6bae3a C |
606 | // --------------------------------------------------------------------------- |
607 | ||
04b8c3fb | 608 | let PRIVATE_RSA_KEY_SIZE = 2048 |
bdfbd4f1 | 609 | |
9f6bae3a C |
610 | // Password encryption |
611 | const BCRYPT_SALT_SIZE = 10 | |
a877d5ac | 612 | |
f88ee4a9 | 613 | const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes |
45f1bd72 | 614 | const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days |
ecb4e35f | 615 | |
d9eaee39 JM |
616 | const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes |
617 | ||
6dd9de95 | 618 | const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = { |
0883b324 C |
619 | DO_NOT_LIST: 'do_not_list', |
620 | BLUR: 'blur', | |
621 | DISPLAY: 'display' | |
622 | } | |
623 | ||
bdfbd4f1 C |
624 | // --------------------------------------------------------------------------- |
625 | ||
052937db C |
626 | // Express static paths (router) |
627 | const STATIC_PATHS = { | |
f285faa0 | 628 | THUMBNAILS: '/static/thumbnails/', |
c5911fd3 | 629 | WEBSEED: '/static/webseed/', |
b9fffa29 | 630 | REDUNDANCY: '/static/redundancy/', |
9c6ca37f C |
631 | STREAMING_PLAYLISTS: { |
632 | HLS: '/static/streaming-playlists/hls' | |
90a8bd30 | 633 | } |
052937db | 634 | } |
02756fbd C |
635 | const STATIC_DOWNLOAD_PATHS = { |
636 | TORRENTS: '/download/torrents/', | |
d7a25329 C |
637 | VIDEOS: '/download/videos/', |
638 | HLS_VIDEOS: '/download/streaming-playlists/hls/videos/' | |
02756fbd | 639 | } |
557b13ae | 640 | const LAZY_STATIC_PATHS = { |
f4796856 | 641 | BANNERS: '/lazy-static/banners/', |
557b13ae | 642 | AVATARS: '/lazy-static/avatars/', |
20dcfd74 | 643 | PREVIEWS: '/lazy-static/previews/', |
90a8bd30 C |
644 | VIDEO_CAPTIONS: '/lazy-static/video-captions/', |
645 | TORRENTS: '/lazy-static/torrents/' | |
557b13ae | 646 | } |
052937db | 647 | |
dc009132 | 648 | // Cache control |
a1587156 | 649 | const STATIC_MAX_AGE = { |
cd4cb177 | 650 | SERVER: '2h', |
90a8bd30 | 651 | LAZY_SERVER: '2d', |
cd4cb177 C |
652 | CLIENT: '30d' |
653 | } | |
dc009132 | 654 | |
cbe2f7c3 | 655 | // Videos thumbnail size |
d8755eed | 656 | const THUMBNAILS_SIZE = { |
4363ce0e C |
657 | width: 280, |
658 | height: 157, | |
ca6d3622 | 659 | minWidth: 150 |
d8755eed C |
660 | } |
661 | const PREVIEWS_SIZE = { | |
b345a804 | 662 | width: 850, |
ca6d3622 C |
663 | height: 480, |
664 | minWidth: 400 | |
164174a6 | 665 | } |
d0800f76 | 666 | const ACTOR_IMAGES_SIZE: { [key in ActorImageType]: { width: number, height: number }[]} = { |
667 | [ActorImageType.AVATAR]: [ | |
668 | { | |
669 | width: 120, | |
670 | height: 120 | |
671 | }, | |
672 | { | |
673 | width: 48, | |
674 | height: 48 | |
675 | } | |
676 | ], | |
677 | [ActorImageType.BANNER]: [ | |
678 | { | |
679 | width: 1920, | |
680 | height: 317 // 6/1 ratio | |
681 | } | |
682 | ] | |
e8e12200 | 683 | } |
164174a6 C |
684 | |
685 | const EMBED_SIZE = { | |
686 | width: 560, | |
687 | height: 315 | |
d8755eed | 688 | } |
cbe2f7c3 | 689 | |
980246ea | 690 | // Sub folders of cache directory |
d74d29ad | 691 | const FILES_CACHE = { |
f4001cf4 C |
692 | PREVIEWS: { |
693 | DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'), | |
694 | MAX_AGE: 1000 * 3600 * 3 // 3 hours | |
695 | }, | |
696 | VIDEO_CAPTIONS: { | |
697 | DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'), | |
698 | MAX_AGE: 1000 * 3600 * 3 // 3 hours | |
90a8bd30 C |
699 | }, |
700 | TORRENTS: { | |
701 | DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'torrents'), | |
702 | MAX_AGE: 1000 * 3600 * 3 // 3 hours | |
f981dae8 C |
703 | } |
704 | } | |
705 | ||
557b13ae | 706 | const LRU_CACHE = { |
d74d29ad | 707 | USER_TOKENS: { |
557b13ae C |
708 | MAX_SIZE: 1000 |
709 | }, | |
f4796856 | 710 | ACTOR_IMAGE_STATIC: { |
557b13ae | 711 | MAX_SIZE: 500 |
d74d29ad C |
712 | } |
713 | } | |
714 | ||
f6d6e7f8 | 715 | const RESUMABLE_UPLOAD_DIRECTORY = join(CONFIG.STORAGE.TMP_DIR, 'resumable-uploads') |
9c6ca37f | 716 | const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls') |
09209296 C |
717 | const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls') |
718 | ||
276250f0 RK |
719 | const RESUMABLE_UPLOAD_SESSION_LIFETIME = SCHEDULER_INTERVALS_MS.REMOVE_DANGLING_RESUMABLE_UPLOADS |
720 | ||
c6c0fa6c C |
721 | const VIDEO_LIVE = { |
722 | EXTENSION: '.ts', | |
fb719404 | 723 | CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes |
f443a746 C |
724 | SEGMENT_TIME_SECONDS: { |
725 | DEFAULT_LATENCY: 4, // 4 seconds | |
726 | SMALL_LATENCY: 2 // 2 seconds | |
727 | }, | |
fb719404 | 728 | SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist |
937581b8 | 729 | REPLAY_DIRECTORY: 'replay', |
e14de000 | 730 | EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4, |
00b87c57 | 731 | MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB |
c6c0fa6c C |
732 | RTMP: { |
733 | CHUNK_SIZE: 60000, | |
734 | GOP_CACHE: true, | |
735 | PING: 60, | |
736 | PING_TIMEOUT: 30, | |
737 | BASE_PATH: 'live' | |
738 | } | |
739 | } | |
740 | ||
7348b1fd | 741 | const MEMOIZE_TTL = { |
35f28e94 | 742 | OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours |
fb719404 | 743 | INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours |
aa2ce188 | 744 | VIDEO_DURATION: 1000 * 10, // 10 seconds |
00b87c57 | 745 | LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute |
630d0a1b C |
746 | LIVE_CHECK_SOCKET_HEALTH: 1000 * 60, // 1 minute |
747 | GET_STATS_FOR_OPEN_TELEMETRY_METRICS: 1000 * 60 // 1 minute | |
35f28e94 C |
748 | } |
749 | ||
750 | const MEMOIZE_LENGTH = { | |
aa2ce188 C |
751 | INFO_HASH_EXISTS: 200, |
752 | VIDEO_DURATION: 200 | |
7348b1fd C |
753 | } |
754 | ||
c53853ca C |
755 | const WORKER_THREADS = { |
756 | DOWNLOAD_IMAGE: { | |
757 | CONCURRENCY: 3, | |
758 | MAX_THREADS: 1 | |
3a54605d C |
759 | }, |
760 | PROCESS_IMAGE: { | |
761 | CONCURRENCY: 1, | |
762 | MAX_THREADS: 5 | |
c53853ca | 763 | } |
557b13ae C |
764 | } |
765 | ||
c48e82b5 C |
766 | const REDUNDANCY = { |
767 | VIDEOS: { | |
c48e82b5 C |
768 | RANDOMIZED_FACTOR: 5 |
769 | } | |
770 | } | |
771 | ||
e12a0092 | 772 | const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS) |
4f491371 | 773 | |
536598cf | 774 | const ASSETS_PATH = { |
c6c0fa6c C |
775 | DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'), |
776 | DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg') | |
536598cf C |
777 | } |
778 | ||
bdfbd4f1 C |
779 | // --------------------------------------------------------------------------- |
780 | ||
e032aec9 C |
781 | const CUSTOM_HTML_TAG_COMMENTS = { |
782 | TITLE: '<!-- title tag -->', | |
783 | DESCRIPTION: '<!-- description tag -->', | |
784 | CUSTOM_CSS: '<!-- custom css tag -->', | |
aea0b0e7 C |
785 | META_TAGS: '<!-- meta tags -->', |
786 | SERVER_CONFIG: '<!-- server config -->' | |
e032aec9 | 787 | } |
709756b8 | 788 | |
fd8710b8 | 789 | const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000 |
566c125d C |
790 | const LOG_FILENAME = 'peertube.log' |
791 | const AUDIT_LOG_FILENAME = 'peertube-audit.log' | |
fd8710b8 | 792 | |
4195cd2b C |
793 | // --------------------------------------------------------------------------- |
794 | ||
9b67da3d C |
795 | const TRACKER_RATE_LIMITS = { |
796 | INTERVAL: 60000 * 5, // 5 minutes | |
8244c85a | 797 | ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval |
db48de85 | 798 | ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval |
ba881f0e | 799 | BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes |
9b67da3d C |
800 | } |
801 | ||
ae9bbed4 C |
802 | const P2P_MEDIA_LOADER_PEER_VERSION = 2 |
803 | ||
9b67da3d C |
804 | // --------------------------------------------------------------------------- |
805 | ||
345da516 C |
806 | const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css' |
807 | const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME) | |
808 | ||
9107d791 C |
809 | let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes |
810 | ||
ffb321be C |
811 | const DEFAULT_THEME_NAME = 'default' |
812 | const DEFAULT_USER_THEME_NAME = 'instance-default' | |
7cd4d2ba | 813 | |
345da516 C |
814 | // --------------------------------------------------------------------------- |
815 | ||
5fb2e288 C |
816 | const SEARCH_INDEX = { |
817 | ROUTES: { | |
818 | VIDEOS: '/api/v1/search/videos', | |
819 | VIDEO_CHANNELS: '/api/v1/search/video-channels' | |
820 | } | |
821 | } | |
822 | ||
823 | // --------------------------------------------------------------------------- | |
824 | ||
b2111066 | 825 | const STATS_TIMESERIE = { |
f40712ab | 826 | MAX_DAYS: 365 * 10 // Around 10 years |
b2111066 C |
827 | } |
828 | ||
829 | // --------------------------------------------------------------------------- | |
830 | ||
9f10b292 | 831 | // Special constants for a test instance |
9452d4fd C |
832 | if (process.env.PRODUCTION_CONSTANTS !== 'true') { |
833 | if (isTestOrDevInstance()) { | |
834 | PRIVATE_RSA_KEY_SIZE = 1024 | |
04b8c3fb | 835 | |
9452d4fd | 836 | ACTOR_FOLLOW_SCORE.BASE = 20 |
3cd0734f | 837 | |
9452d4fd C |
838 | REMOTE_SCHEME.HTTP = 'http' |
839 | REMOTE_SCHEME.WS = 'ws' | |
3cd0734f | 840 | |
9452d4fd | 841 | STATIC_MAX_AGE.SERVER = '0' |
3cd0734f | 842 | |
9452d4fd C |
843 | SCHEDULER_INTERVALS_MS.ACTOR_FOLLOW_SCORES = 1000 |
844 | SCHEDULER_INTERVALS_MS.REMOVE_OLD_JOBS = 10000 | |
845 | SCHEDULER_INTERVALS_MS.REMOVE_OLD_HISTORY = 5000 | |
846 | SCHEDULER_INTERVALS_MS.REMOVE_OLD_VIEWS = 5000 | |
847 | SCHEDULER_INTERVALS_MS.UPDATE_VIDEOS = 5000 | |
848 | SCHEDULER_INTERVALS_MS.AUTO_FOLLOW_INDEX_INSTANCES = 5000 | |
849 | SCHEDULER_INTERVALS_MS.UPDATE_INBOX_STATS = 5000 | |
850 | SCHEDULER_INTERVALS_MS.CHECK_PEERTUBE_VERSION = 2000 | |
3cd0734f | 851 | |
9452d4fd | 852 | REPEAT_JOBS['videos-views-stats'] = { every: 5000 } |
3cd0734f | 853 | |
9452d4fd C |
854 | REPEAT_JOBS['activitypub-cleaner'] = { every: 5000 } |
855 | AP_CLEANER.PERIOD = 5000 | |
f1569117 | 856 | |
9452d4fd | 857 | REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1 |
f1569117 | 858 | |
9452d4fd | 859 | CONTACT_FORM_LIFETIME = 1000 // 1 second |
2baea0c7 | 860 | |
9452d4fd | 861 | JOB_ATTEMPTS['email'] = 1 |
c48e82b5 | 862 | |
9452d4fd C |
863 | FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000 |
864 | MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000 | |
865 | MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000 | |
866 | OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2 | |
3cd0734f | 867 | |
9452d4fd C |
868 | PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000 |
869 | } | |
870 | ||
871 | if (isTestInstance()) { | |
872 | ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2 | |
873 | ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds | |
874 | ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds | |
875 | ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds | |
f4001cf4 | 876 | |
9452d4fd C |
877 | CONSTRAINTS_FIELDS.ACTORS.IMAGE.FILE_SIZE.max = 100 * 1024 // 100KB |
878 | CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB | |
9107d791 | 879 | |
9452d4fd C |
880 | VIEW_LIFETIME.VIEWER_COUNTER = 1000 * 5 // 5 second |
881 | VIEW_LIFETIME.VIEWER_STATS = 1000 * 5 // 5 second | |
31c82cd9 | 882 | |
9452d4fd C |
883 | VIDEO_LIVE.CLEANUP_DELAY = getIntEnv('PEERTUBE_TEST_CONSTANTS_VIDEO_LIVE_CLEANUP_DELAY') ?? 5000 |
884 | VIDEO_LIVE.SEGMENT_TIME_SECONDS.DEFAULT_LATENCY = 2 | |
885 | VIDEO_LIVE.SEGMENT_TIME_SECONDS.SMALL_LATENCY = 1 | |
886 | VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1 | |
887 | } | |
9f10b292 C |
888 | } |
889 | ||
14e2014a | 890 | updateWebserverUrls() |
536598cf | 891 | updateWebserverConfig() |
225a89c2 | 892 | |
6dd9de95 C |
893 | registerConfigChangedHandler(() => { |
894 | updateWebserverUrls() | |
895 | updateWebserverConfig() | |
896 | }) | |
897 | ||
9f10b292 C |
898 | // --------------------------------------------------------------------------- |
899 | ||
caf2aaf4 K |
900 | const FILES_CONTENT_HASH = { |
901 | MANIFEST: generateContentHash(), | |
902 | FAVICON: generateContentHash(), | |
903 | LOGO: generateContentHash() | |
904 | } | |
905 | ||
906 | // --------------------------------------------------------------------------- | |
907 | ||
c729caf6 C |
908 | const VIDEO_FILTERS = { |
909 | WATERMARK: { | |
910 | SIZE_RATIO: 1 / 10, | |
911 | HORIZONTAL_MARGIN_RATIO: 1 / 20, | |
912 | VERTICAL_MARGIN_RATIO: 1 / 20 | |
913 | } | |
914 | } | |
915 | ||
916 | // --------------------------------------------------------------------------- | |
917 | ||
65fcc311 | 918 | export { |
6dd9de95 | 919 | WEBSERVER, |
9f6bae3a | 920 | API_VERSION, |
c6c0fa6c | 921 | VIDEO_LIVE, |
66170ca8 | 922 | PEERTUBE_VERSION, |
557b13ae | 923 | LAZY_STATIC_PATHS, |
5fb2e288 | 924 | SEARCH_INDEX, |
f6d6e7f8 | 925 | RESUMABLE_UPLOAD_DIRECTORY, |
276250f0 | 926 | RESUMABLE_UPLOAD_SESSION_LIFETIME, |
09209296 | 927 | HLS_REDUNDANCY_DIRECTORY, |
ae9bbed4 | 928 | P2P_MEDIA_LOADER_PEER_VERSION, |
2cb03dc1 | 929 | ACTOR_IMAGES_SIZE, |
4f491371 | 930 | ACCEPT_HEADERS, |
9f6bae3a | 931 | BCRYPT_SALT_SIZE, |
9b67da3d | 932 | TRACKER_RATE_LIMITS, |
d74d29ad | 933 | FILES_CACHE, |
566c125d | 934 | LOG_FILENAME, |
9f6bae3a | 935 | CONSTRAINTS_FIELDS, |
164174a6 | 936 | EMBED_SIZE, |
c48e82b5 | 937 | REDUNDANCY, |
94a5ff8a C |
938 | JOB_CONCURRENCY, |
939 | JOB_ATTEMPTS, | |
f1569117 | 940 | AP_CLEANER, |
b769007f | 941 | LAST_MIGRATION_VERSION, |
9f6bae3a | 942 | OAUTH_LIFETIME, |
e032aec9 | 943 | CUSTOM_HTML_TAG_COMMENTS, |
b2111066 | 944 | STATS_TIMESERIE, |
f55e5a7b | 945 | BROADCAST_CONCURRENCY, |
566c125d | 946 | AUDIT_LOG_FILENAME, |
1194e8b4 | 947 | PAGINATION, |
60650c77 | 948 | ACTOR_FOLLOW_SCORE, |
f285faa0 C |
949 | PREVIEWS_SIZE, |
950 | REMOTE_SCHEME, | |
7a7724e6 | 951 | FOLLOW_STATES, |
ffb321be | 952 | DEFAULT_USER_THEME_NAME, |
50d6de9c | 953 | SERVER_ACTOR_NAME, |
345da516 C |
954 | PLUGIN_GLOBAL_CSS_FILE_NAME, |
955 | PLUGIN_GLOBAL_CSS_PATH, | |
e4f97bab | 956 | PRIVATE_RSA_KEY_SIZE, |
c729caf6 | 957 | VIDEO_FILTERS, |
fd4484f1 | 958 | ROUTE_CACHE_LIFETIME, |
9f6bae3a | 959 | SORTABLE_COLUMNS, |
9c6ca37f | 960 | HLS_STREAMING_PLAYLIST_DIRECTORY, |
2b86fe72 | 961 | JOB_TTL, |
ffb321be | 962 | DEFAULT_THEME_NAME, |
0883b324 | 963 | NSFW_POLICY_TYPES, |
dc009132 | 964 | STATIC_MAX_AGE, |
a6375e69 | 965 | STATIC_PATHS, |
cf9166cf | 966 | VIDEO_IMPORT_TIMEOUT, |
df0b219d | 967 | VIDEO_PLAYLIST_TYPES, |
fd8710b8 | 968 | MAX_LOGS_OUTPUT_CHARACTERS, |
e4f97bab | 969 | ACTIVITY_PUB, |
50d6de9c | 970 | ACTIVITY_PUB_ACTOR_TYPES, |
9f6bae3a | 971 | THUMBNAILS_SIZE, |
6e07c3de | 972 | VIDEO_CATEGORIES, |
35f28e94 | 973 | MEMOIZE_LENGTH, |
3092476e | 974 | VIDEO_LANGUAGES, |
fd45e8f4 | 975 | VIDEO_PRIVACIES, |
6f0c39e2 | 976 | VIDEO_LICENCES, |
2186386c | 977 | VIDEO_STATES, |
c53853ca | 978 | WORKER_THREADS, |
0d0e8dd0 | 979 | VIDEO_RATE_TYPES, |
77d7e851 | 980 | JOB_PRIORITY, |
a7977280 | 981 | VIDEO_TRANSCODING_FPS, |
80bc88c1 | 982 | FFMPEG_NICE, |
d95d1559 | 983 | ABUSE_STATES, |
557b13ae | 984 | LRU_CACHE, |
4c99953a | 985 | REQUEST_TIMEOUTS, |
b2111066 | 986 | MAX_LOCAL_VIEWER_WATCH_SECTIONS, |
ecb4e35f | 987 | USER_PASSWORD_RESET_LIFETIME, |
45f1bd72 | 988 | USER_PASSWORD_CREATE_LIFETIME, |
7348b1fd | 989 | MEMOIZE_TTL, |
d9eaee39 | 990 | USER_EMAIL_VERIFY_LIFETIME, |
2d3741d6 | 991 | OVERVIEWS, |
2baea0c7 | 992 | SCHEDULER_INTERVALS_MS, |
6b616860 | 993 | REPEAT_JOBS, |
02756fbd | 994 | STATIC_DOWNLOAD_PATHS, |
14e2014a | 995 | MIMETYPES, |
f6eebcb3 | 996 | CRAWL_REQUEST_CONCURRENCY, |
536598cf | 997 | DEFAULT_AUDIO_RESOLUTION, |
62549e6c | 998 | BINARY_CONTENT_TYPES, |
b5c0e955 | 999 | JOB_COMPLETED_LIFETIME, |
41f2ebae | 1000 | HTTP_SIGNATURE, |
fbad87b0 | 1001 | VIDEO_IMPORT_STATES, |
e4bf7856 | 1002 | VIEW_LIFETIME, |
a4101923 | 1003 | CONTACT_FORM_LIFETIME, |
418d092a | 1004 | VIDEO_PLAYLIST_PRIVACIES, |
9107d791 | 1005 | PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME, |
536598cf | 1006 | ASSETS_PATH, |
caf2aaf4 | 1007 | FILES_CONTENT_HASH, |
74dc3bca | 1008 | loadLanguages, |
caf2aaf4 K |
1009 | buildLanguages, |
1010 | generateContentHash | |
9f10b292 | 1011 | } |
fd206f0b C |
1012 | |
1013 | // --------------------------------------------------------------------------- | |
1014 | ||
14e2014a C |
1015 | function buildVideoMimetypeExt () { |
1016 | const data = { | |
fccbbc1a | 1017 | // streamable formats that warrant cross-browser compatibility |
14e2014a | 1018 | 'video/webm': '.webm', |
30bc55c8 C |
1019 | // We'll add .ogg if additional extensions are enabled |
1020 | // We could add .ogg here but since it could be an audio file, | |
1021 | // it would be confusing for users because PeerTube will refuse their file (based on the mimetype) | |
1022 | 'video/ogg': [ '.ogv' ], | |
14e2014a C |
1023 | 'video/mp4': '.mp4' |
1024 | } | |
1025 | ||
536598cf C |
1026 | if (CONFIG.TRANSCODING.ENABLED) { |
1027 | if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) { | |
30bc55c8 C |
1028 | data['video/ogg'].push('.ogg') |
1029 | ||
536598cf | 1030 | Object.assign(data, { |
536598cf | 1031 | 'video/x-matroska': '.mkv', |
fccbbc1a RK |
1032 | |
1033 | // Developed by Apple | |
b056afe0 | 1034 | 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software |
c37a52b0 | 1035 | 'video/x-m4v': '.m4v', |
fccbbc1a RK |
1036 | 'video/m4v': '.m4v', |
1037 | ||
1038 | // Developed by the Adobe Flash Platform | |
1039 | 'video/x-flv': '.flv', | |
1040 | 'video/x-f4v': '.f4v', // replacement for flv | |
1041 | ||
1042 | // Developed by Microsoft | |
1043 | 'video/x-ms-wmv': '.wmv', | |
1044 | 'video/x-msvideo': '.avi', | |
1045 | 'video/avi': '.avi', | |
1046 | ||
1047 | // Developed by 3GPP | |
1048 | // common video formats for cell phones | |
b056afe0 RK |
1049 | 'video/3gpp': [ '.3gp', '.3gpp' ], |
1050 | 'video/3gpp2': [ '.3g2', '.3gpp2' ], | |
fccbbc1a RK |
1051 | |
1052 | // Developed by FFmpeg/Mplayer | |
1053 | 'application/x-nut': '.nut', | |
1054 | ||
1055 | // The standard video format used by many Sony and Panasonic HD camcorders. | |
1056 | // It is also used for storing high definition video on Blu-ray discs. | |
1057 | 'video/mp2t': '.mts', | |
4b7a20d8 C |
1058 | 'video/vnd.dlna.mpeg-tts': '.mts', |
1059 | ||
fccbbc1a RK |
1060 | 'video/m2ts': '.m2ts', |
1061 | ||
1062 | // Old formats reliant on MPEG-1/MPEG-2 | |
1063 | 'video/mpv': '.mpv', | |
1064 | 'video/mpeg2': '.m2v', | |
b056afe0 RK |
1065 | 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ], |
1066 | 'video/dvd': '.vob', | |
fccbbc1a | 1067 | |
26469f9e C |
1068 | // Could be anything |
1069 | 'application/octet-stream': null, | |
fccbbc1a | 1070 | 'application/mxf': '.mxf' // often used as exchange format by editing software |
536598cf C |
1071 | }) |
1072 | } | |
1073 | ||
1074 | if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) { | |
1075 | Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT) | |
1076 | } | |
14e2014a C |
1077 | } |
1078 | ||
1079 | return data | |
1080 | } | |
1081 | ||
1082 | function updateWebserverUrls () { | |
6dd9de95 C |
1083 | WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT) |
1084 | WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP) | |
6dd9de95 | 1085 | WEBSERVER.WS = CONFIG.WEBSERVER.WS |
c6c0fa6c C |
1086 | |
1087 | WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME | |
6dd9de95 C |
1088 | WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME |
1089 | WEBSERVER.PORT = CONFIG.WEBSERVER.PORT | |
c6c0fa6c | 1090 | |
cfbe6be5 C |
1091 | const rtmpHostname = CONFIG.LIVE.RTMP.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME |
1092 | const rtmpsHostname = CONFIG.LIVE.RTMPS.PUBLIC_HOSTNAME || CONFIG.WEBSERVER.HOSTNAME | |
1093 | ||
1094 | WEBSERVER.RTMP_URL = 'rtmp://' + rtmpHostname + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH | |
1095 | WEBSERVER.RTMPS_URL = 'rtmps://' + rtmpsHostname + ':' + CONFIG.LIVE.RTMPS.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH | |
fd206f0b C |
1096 | } |
1097 | ||
14e2014a | 1098 | function updateWebserverConfig () { |
14e2014a | 1099 | MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt() |
30bc55c8 C |
1100 | MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT) |
1101 | ||
536598cf C |
1102 | ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT) |
1103 | ||
30bc55c8 C |
1104 | MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT) |
1105 | ||
1106 | CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE) | |
1107 | } | |
1108 | ||
1109 | function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) { | |
1110 | const result: { [id: string]: string } = {} | |
1111 | ||
1112 | for (const mimetype of Object.keys(obj)) { | |
1113 | const value = obj[mimetype] | |
1114 | if (!value) continue | |
1115 | ||
1116 | const extensions = Array.isArray(value) ? value : [ value ] | |
1117 | ||
1118 | for (const extension of extensions) { | |
1119 | result[extension] = mimetype | |
1120 | } | |
1121 | } | |
1122 | ||
1123 | return result | |
14e2014a C |
1124 | } |
1125 | ||
30bc55c8 C |
1126 | function buildMimetypesRegex (obj: { [id: string]: string | string[] }) { |
1127 | return Object.keys(obj) | |
1128 | .map(m => `(${m})`) | |
1129 | .join('|') | |
14e2014a C |
1130 | } |
1131 | ||
74dc3bca | 1132 | function loadLanguages () { |
8f0bc73d | 1133 | Object.assign(VIDEO_LANGUAGES, buildLanguages()) |
74dc3bca C |
1134 | } |
1135 | ||
9d3ef9fe C |
1136 | function buildLanguages () { |
1137 | const iso639 = require('iso-639-3') | |
1138 | ||
a1587156 | 1139 | const languages: { [id: string]: string } = {} |
9d3ef9fe | 1140 | |
1d94c154 | 1141 | const additionalLanguages = { |
a1587156 C |
1142 | sgn: true, // Sign languages (macro language) |
1143 | ase: true, // American sign language | |
1144 | sdl: true, // Arabian sign language | |
1145 | bfi: true, // British sign language | |
1146 | bzs: true, // Brazilian sign language | |
1147 | csl: true, // Chinese sign language | |
1148 | cse: true, // Czech sign language | |
1149 | dsl: true, // Danish sign language | |
1150 | fsl: true, // French sign language | |
1151 | gsg: true, // German sign language | |
1152 | pks: true, // Pakistan sign language | |
1153 | jsl: true, // Japanese sign language | |
1154 | sfs: true, // South African sign language | |
1155 | swl: true, // Swedish sign language | |
07c01b31 C |
1156 | rsl: true, // Russian sign language |
1157 | ||
1158 | kab: true, // Kabyle | |
a1587156 | 1159 | |
23fdb0ff C |
1160 | lat: true, // Latin |
1161 | ||
a1587156 C |
1162 | epo: true, // Esperanto |
1163 | tlh: true, // Klingon | |
1164 | jbo: true, // Lojban | |
81547acb FC |
1165 | avk: true, // Kotava |
1166 | ||
1167 | zxx: true // No linguistic content (ISO-639-2) | |
1d94c154 | 1168 | } |
9d3ef9fe C |
1169 | |
1170 | // Only add ISO639-1 languages and some sign languages (ISO639-3) | |
1171 | iso639 | |
1172 | .filter(l => { | |
4fdeef81 | 1173 | return (l.iso6391 !== undefined && l.type === 'living') || |
a1587156 | 1174 | additionalLanguages[l.iso6393] === true |
9d3ef9fe | 1175 | }) |
a1587156 | 1176 | .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name }) |
9d3ef9fe | 1177 | |
db6d617d | 1178 | // Override Occitan label |
a1587156 C |
1179 | languages['oc'] = 'Occitan' |
1180 | languages['el'] = 'Greek' | |
978489b6 | 1181 | languages['tok'] = 'Toki Pona' |
db6d617d | 1182 | |
8f7d35fd C |
1183 | // Chinese languages |
1184 | languages['zh-Hans'] = 'Simplified Chinese' | |
1185 | languages['zh-Hant'] = 'Traditional Chinese' | |
1186 | ||
9d3ef9fe C |
1187 | return languages |
1188 | } | |
caf2aaf4 K |
1189 | |
1190 | function generateContentHash () { | |
1191 | return randomBytes(20).toString('hex') | |
1192 | } | |
53023be3 C |
1193 | |
1194 | function getIntEnv (path: string) { | |
1195 | if (process.env[path]) return parseInt(process.env[path]) | |
1196 | ||
1197 | return undefined | |
1198 | } |