Implement user API (create, update, remove, list)
[oweals/peertube.git] / server / initializers / constants.js
1 'use strict'
2
3 // API version of our pod
4 const API_VERSION = 'v1'
5
6 const CONSTRAINTS_FIELDS = {
7   USERS: {
8     USERNAME: { min: 3, max: 20 }, // Length
9     PASSWORD: { min: 6, max: 255 } // Length
10   },
11   VIDEOS: {
12     NAME: { min: 3, max: 50 }, // Length
13     DESCRIPTION: { min: 3, max: 250 }, // Length
14     MAGNET_URI: { min: 10 }, // Length
15     DURATION: { min: 1, max: 7200 }, // Number
16     TAGS: { min: 1, max: 3 }, // Number of total tags
17     TAG: { min: 2, max: 10 }, // Length
18     THUMBNAIL: { min: 2, max: 30 },
19     THUMBNAIL64: { min: 0, max: 20000 } // Bytes
20   }
21 }
22
23 // Score a pod has when we create it as a friend
24 const FRIEND_SCORE = {
25   BASE: 100,
26   MAX: 1000
27 }
28
29 // Time to wait between requests to the friends (10 min)
30 let INTERVAL = 600000
31
32 const OAUTH_LIFETIME = {
33   ACCESS_TOKEN: 3600 * 4, // 4 hours
34   REFRESH_TOKEN: 1209600 // 2 weeks
35 }
36
37 // Number of results by default for the pagination
38 const PAGINATION_COUNT_DEFAULT = 15
39
40 // Number of points we add/remove from a friend after a successful/bad request
41 const PODS_SCORE = {
42   MALUS: -10,
43   BONUS: 10
44 }
45
46 // Number of requests in parallel we can make
47 const REQUESTS_IN_PARALLEL = 10
48
49 // How many requests we put in request (request scheduler)
50 const REQUESTS_LIMIT = 10
51
52 // Number of requests to retry for replay requests module
53 const RETRY_REQUESTS = 5
54
55 // Sortable columns per schema
56 const SEARCHABLE_COLUMNS = {
57   VIDEOS: [ 'name', 'magnetUri', 'podUrl', 'author', 'tags' ]
58 }
59
60 // Seeds in parallel we send to electron when "seed all"
61 // Once a video is in seeding state we seed another video etc
62 const SEEDS_IN_PARALLEL = 3
63
64 // Sortable columns per schema
65 const SORTABLE_COLUMNS = {
66   VIDEOS: [ 'name', '-name', 'duration', '-duration', 'createdDate', '-createdDate' ]
67 }
68
69 // Videos thumbnail size
70 const THUMBNAILS_SIZE = '200x110'
71
72 // Path for access to thumbnails with express router
73 const THUMBNAILS_STATIC_PATH = '/static/thumbnails'
74
75 const USER_ROLES = {
76   ADMIN: 'admin',
77   USER: 'user'
78 }
79
80 // Special constants for a test instance
81 if (isTestInstance() === true) {
82   FRIEND_SCORE.BASE = 20
83   INTERVAL = 10000
84   CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
85 }
86
87 // ---------------------------------------------------------------------------
88
89 module.exports = {
90   API_VERSION: API_VERSION,
91   CONSTRAINTS_FIELDS: CONSTRAINTS_FIELDS,
92   FRIEND_SCORE: FRIEND_SCORE,
93   INTERVAL: INTERVAL,
94   OAUTH_LIFETIME: OAUTH_LIFETIME,
95   PAGINATION_COUNT_DEFAULT: PAGINATION_COUNT_DEFAULT,
96   PODS_SCORE: PODS_SCORE,
97   REQUESTS_IN_PARALLEL: REQUESTS_IN_PARALLEL,
98   REQUESTS_LIMIT: REQUESTS_LIMIT,
99   RETRY_REQUESTS: RETRY_REQUESTS,
100   SEARCHABLE_COLUMNS: SEARCHABLE_COLUMNS,
101   SEEDS_IN_PARALLEL: SEEDS_IN_PARALLEL,
102   SORTABLE_COLUMNS: SORTABLE_COLUMNS,
103   THUMBNAILS_SIZE: THUMBNAILS_SIZE,
104   THUMBNAILS_STATIC_PATH: THUMBNAILS_STATIC_PATH,
105   USER_ROLES: USER_ROLES
106 }
107
108 // ---------------------------------------------------------------------------
109
110 function isTestInstance () {
111   return (process.env.NODE_ENV === 'test')
112 }