]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/initializers/constants.ts
Limit comment length to 1 character, fixes #394 (#399)
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
index f209bef90bd2b3144d1c0a16c756a712913124bd..481b21bbb2e3ffaa1b0c8697671b018fa7808ba3 100644 (file)
@@ -1,14 +1,18 @@
-import * as config from 'config'
-import { join } from 'path'
-import { JobCategory, JobState, VideoRateType } from '../../shared/models'
-import { FollowState } from '../../shared/models/accounts'
+import { IConfig } from 'config'
+import { dirname, join } from 'path'
+import { JobType, VideoRateType } from '../../shared/models'
+import { ActivityPubActorType } from '../../shared/models/activitypub'
+import { FollowState } from '../../shared/models/actors'
 import { VideoPrivacy } from '../../shared/models/videos'
 // Do not use barrels, remain constants as independent as possible
-import { isTestInstance, root } from '../helpers/core-utils'
+import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
+
+// Use a variable to reload the configuration if we need
+let config: IConfig = require('config')
 
 // ---------------------------------------------------------------------------
 
-const LAST_MIGRATION_VERSION = 130
+const LAST_MIGRATION_VERSION = 195
 
 // ---------------------------------------------------------------------------
 
@@ -21,10 +25,12 @@ const PAGINATION_COUNT_DEFAULT = 15
 // Sortable columns per schema
 const SORTABLE_COLUMNS = {
   USERS: [ 'id', 'username', 'createdAt' ],
-  JOBS: [ 'id', 'createdAt' ],
+  ACCOUNTS: [ 'createdAt' ],
+  JOBS: [ 'createdAt' ],
   VIDEO_ABUSES: [ 'id', 'createdAt' ],
   VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
   VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
+  VIDEO_COMMENT_THREADS: [ 'createdAt' ],
   BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
   FOLLOWERS: [ 'createdAt' ],
   FOLLOWING: [ 'createdAt' ]
@@ -37,7 +43,48 @@ const OAUTH_LIFETIME = {
 
 // ---------------------------------------------------------------------------
 
+// 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'
+}
+
+const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
+  'activitypub-http-broadcast': 5,
+  'activitypub-http-unicast': 5,
+  'activitypub-http-fetcher': 5,
+  'video-file': 1,
+  'email': 5
+}
+const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
+  'activitypub-http-broadcast': 1,
+  'activitypub-http-unicast': 5,
+  'activitypub-http-fetcher': 1,
+  'video-file': 1,
+  'email': 5
+}
+// 2 days
+const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2
+
+// 1 hour
+let SCHEDULER_INTERVAL = 60000 * 60
+
+// ---------------------------------------------------------------------------
+
 const CONFIG = {
+  CUSTOM_FILE: getLocalConfigFilePath(),
   LISTEN: {
     PORT: config.get<number>('listen.port')
   },
@@ -48,14 +95,29 @@ const CONFIG = {
     USERNAME: config.get<string>('database.username'),
     PASSWORD: config.get<string>('database.password')
   },
+  REDIS: {
+    HOSTNAME: config.get<string>('redis.hostname'),
+    PORT: config.get<number>('redis.port'),
+    AUTH: config.get<string>('redis.auth')
+  },
+  SMTP: {
+    HOSTNAME: config.get<string>('smtp.hostname'),
+    PORT: config.get<number>('smtp.port'),
+    USERNAME: config.get<string>('smtp.username'),
+    PASSWORD: config.get<string>('smtp.password'),
+    TLS: config.get<boolean>('smtp.tls'),
+    DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'),
+    CA_FILE: config.get<string>('smtp.ca_file'),
+    FROM_ADDRESS: config.get<string>('smtp.from_address')
+  },
   STORAGE: {
-    AVATARS_DIR: join(root(), config.get<string>('storage.avatars')),
-    LOG_DIR: join(root(), config.get<string>('storage.logs')),
-    VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
-    THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
-    PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
-    TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
-    CACHE_DIR: join(root(), config.get<string>('storage.cache'))
+    AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
+    LOG_DIR: buildPath(config.get<string>('storage.logs')),
+    VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
+    THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
+    PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
+    TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
+    CACHE_DIR: buildPath(config.get<string>('storage.cache'))
   },
   WEBSERVER: {
     SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
@@ -65,45 +127,55 @@ const CONFIG = {
     URL: '',
     HOST: ''
   },
+  LOG: {
+    LEVEL: config.get<string>('log.level')
+  },
   ADMIN: {
-    EMAIL: config.get<string>('admin.email')
+    get EMAIL () { return config.get<string>('admin.email') }
   },
   SIGNUP: {
-    ENABLED: config.get<boolean>('signup.enabled'),
-    LIMIT: config.get<number>('signup.limit')
+    get ENABLED () { return config.get<boolean>('signup.enabled') },
+    get LIMIT () { return config.get<number>('signup.limit') }
   },
   USER: {
-    VIDEO_QUOTA: config.get<number>('user.video_quota')
+    get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
   },
   TRANSCODING: {
-    ENABLED: config.get<boolean>('transcoding.enabled'),
-    THREADS: config.get<number>('transcoding.threads'),
+    get ENABLED () { return config.get<boolean>('transcoding.enabled') },
+    get THREADS () { return config.get<number>('transcoding.threads') },
     RESOLUTIONS: {
-      '240' : config.get<boolean>('transcoding.resolutions.240p'),
-      '360': config.get<boolean>('transcoding.resolutions.360p'),
-      '480': config.get<boolean>('transcoding.resolutions.480p'),
-      '720': config.get<boolean>('transcoding.resolutions.720p'),
-      '1080': config.get<boolean>('transcoding.resolutions.1080p')
+      get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
+      get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
+      get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
+      get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
+      get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
     }
   },
   CACHE: {
     PREVIEWS: {
-      SIZE: config.get<number>('cache.previews.size')
+      get SIZE () { return config.get<number>('cache.previews.size') }
+    }
+  },
+  INSTANCE: {
+    get NAME () { return config.get<string>('instance.name') },
+    get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') },
+    get DESCRIPTION () { return config.get<string>('instance.description') },
+    get TERMS () { return config.get<string>('instance.terms') },
+    get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
+    CUSTOMIZATIONS: {
+      get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
+      get CSS () { return config.get<string>('instance.customizations.css') }
     }
   }
 }
-CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
-CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
 
-const AVATARS_DIR = {
-  ACCOUNT: join(CONFIG.STORAGE.AVATARS_DIR, 'account')
-}
 // ---------------------------------------------------------------------------
 
 const CONSTRAINTS_FIELDS = {
   USERS: {
     USERNAME: { min: 3, max: 20 }, // Length
     PASSWORD: { min: 6, max: 255 }, // Length
+    DESCRIPTION: { min: 3, max: 250 }, // Length
     VIDEO_QUOTA: { min: -1 }
   },
   VIDEO_ABUSES: {
@@ -112,12 +184,20 @@ const CONSTRAINTS_FIELDS = {
   VIDEO_CHANNELS: {
     NAME: { min: 3, max: 120 }, // Length
     DESCRIPTION: { min: 3, max: 250 }, // Length
+    SUPPORT: { min: 3, max: 300 }, // Length
     URL: { min: 3, max: 2000 } // Length
   },
   VIDEOS: {
     NAME: { min: 3, max: 120 }, // Length
     TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
-    DESCRIPTION: { min: 3, max: 3000 }, // Length
+    DESCRIPTION: { min: 3, max: 10000 }, // Length
+    SUPPORT: { min: 3, max: 300 }, // Length
+    IMAGE: {
+      EXTNAME: [ '.jpg', '.jpeg' ],
+      FILE_SIZE: {
+        max: 2 * 1024 * 1024 // 2MB
+      }
+    },
     EXTNAME: [ '.mp4', '.ogv', '.webm' ],
     INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
     DURATION: { min: 1 }, // Number
@@ -131,16 +211,35 @@ const CONSTRAINTS_FIELDS = {
     FILE_SIZE: { min: 10 },
     URL: { min: 3, max: 2000 } // Length
   },
-  ACTOR: {
+  ACTORS: {
     PUBLIC_KEY: { min: 10, max: 5000 }, // Length
     PRIVATE_KEY: { min: 10, max: 5000 }, // Length
-    URL: { min: 3, max: 2000 } // Length
+    URL: { min: 3, max: 2000 }, // Length
+    AVATAR: {
+      EXTNAME: [ '.png', '.jpeg', '.jpg' ],
+      FILE_SIZE: {
+        max: 2 * 1024 * 1024 // 2MB
+      }
+    }
   },
   VIDEO_EVENTS: {
     COUNT: { min: 0 }
+  },
+  VIDEO_COMMENTS: {
+    TEXT: { min: 1, max: 3000 }, // Length
+    URL: { min: 3, max: 2000 } // Length
+  },
+  VIDEO_SHARE: {
+    URL: { min: 3, max: 2000 } // Length
   }
 }
 
+let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
+const VIDEO_TRANSCODING_FPS = {
+  MIN: 10,
+  MAX: 30
+}
+
 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
   LIKE: 'like',
   DISLIKE: 'dislike'
@@ -208,64 +307,40 @@ const VIDEO_MIMETYPE_EXT = {
   'video/mp4': '.mp4'
 }
 
+const IMAGE_MIMETYPE_EXT = {
+  'image/png': '.png',
+  'image/jpg': '.jpg',
+  'image/jpeg': '.jpg'
+}
+
 // ---------------------------------------------------------------------------
 
-const SERVER_ACCOUNT_NAME = 'peertube'
+const SERVER_ACTOR_NAME = 'peertube'
 
 const ACTIVITY_PUB = {
   POTENTIAL_ACCEPT_HEADERS: [
     'application/activity+json',
-    'application/ld+json'
+    'application/ld+json',
+    'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
   ],
   ACCEPT_HEADER: 'application/activity+json, application/ld+json',
   PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
   COLLECTION_ITEMS_PER_PAGE: 10,
   FETCH_PAGE_LIMIT: 100,
-  MAX_HTTP_ATTEMPT: 5,
   URL_MIME_TYPES: {
-    VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT
+    VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
     TORRENT: [ 'application/x-bittorrent' ],
     MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
-  }
-}
-
-// ---------------------------------------------------------------------------
-
-// Number of points we add/remove from a friend after a successful/bad request
-const SERVERS_SCORE = {
-  PENALTY: -10,
-  BONUS: 10,
-  BASE: 100,
-  MAX: 1000
-}
-
-const FOLLOW_STATES: { [ id: string ]: FollowState } = {
-  PENDING: 'pending',
-  ACCEPTED: 'accepted'
-}
-
-const REMOTE_SCHEME = {
-  HTTP: 'https',
-  WS: 'wss'
+  },
+  MAX_RECURSION_COMMENTS: 100,
+  ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
 }
 
-const JOB_STATES: { [ id: string ]: JobState } = {
-  PENDING: 'pending',
-  PROCESSING: 'processing',
-  ERROR: 'error',
-  SUCCESS: 'success'
-}
-const JOB_CATEGORIES: { [ id: string ]: JobCategory } = {
-  TRANSCODING: 'transcoding',
-  ACTIVITYPUB_HTTP: 'activitypub-http'
+const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
+  GROUP: 'Group',
+  PERSON: 'Person',
+  APPLICATION: 'Application'
 }
-// How many maximum jobs we fetch from the database per cycle
-const JOBS_FETCH_LIMIT_PER_CYCLE = {
-  transcoding: 10,
-  httpRequest: 20
-}
-// 1 minutes
-let JOBS_FETCHING_INTERVAL = 60000
 
 // ---------------------------------------------------------------------------
 
@@ -274,6 +349,8 @@ const PRIVATE_RSA_KEY_SIZE = 2048
 // Password encryption
 const BCRYPT_SALT_SIZE = 10
 
+const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
+
 // ---------------------------------------------------------------------------
 
 // Express static paths (router)
@@ -281,7 +358,8 @@ const STATIC_PATHS = {
   PREVIEWS: '/static/previews/',
   THUMBNAILS: '/static/thumbnails/',
   TORRENTS: '/static/torrents/',
-  WEBSEED: '/static/webseed/'
+  WEBSEED: '/static/webseed/',
+  AVATARS: '/static/avatars/'
 }
 
 // Cache control
@@ -296,6 +374,10 @@ const PREVIEWS_SIZE = {
   width: 560,
   height: 315
 }
+const AVATARS_SIZE = {
+  width: 120,
+  height: 120
+}
 
 const EMBED_SIZE = {
   width: 560,
@@ -309,7 +391,7 @@ const CACHE = {
   }
 }
 
-const ACCEPT_HEADERS = ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS.concat('html', 'application/json')
+const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
 
 // ---------------------------------------------------------------------------
 
@@ -319,48 +401,105 @@ const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
 
 // Special constants for a test instance
 if (isTestInstance() === true) {
-  SERVERS_SCORE.BASE = 20
-  JOBS_FETCHING_INTERVAL = 1000
+  ACTOR_FOLLOW_SCORE.BASE = 20
   REMOTE_SCHEME.HTTP = 'http'
   REMOTE_SCHEME.WS = 'ws'
   STATIC_MAX_AGE = '0'
   ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
+  ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
+  CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
+  SCHEDULER_INTERVAL = 10000
+  VIDEO_VIEW_LIFETIME = 1000 // 1 second
 }
 
+updateWebserverConfig()
+
 // ---------------------------------------------------------------------------
 
 export {
   API_VERSION,
+  AVATARS_SIZE,
   ACCEPT_HEADERS,
   BCRYPT_SALT_SIZE,
   CACHE,
   CONFIG,
   CONSTRAINTS_FIELDS,
   EMBED_SIZE,
-  JOB_STATES,
-  JOBS_FETCH_LIMIT_PER_CYCLE,
-  JOBS_FETCHING_INTERVAL,
-  JOB_CATEGORIES,
+  JOB_CONCURRENCY,
+  JOB_ATTEMPTS,
   LAST_MIGRATION_VERSION,
   OAUTH_LIFETIME,
   OPENGRAPH_AND_OEMBED_COMMENT,
   PAGINATION_COUNT_DEFAULT,
-  SERVERS_SCORE,
+  ACTOR_FOLLOW_SCORE,
   PREVIEWS_SIZE,
   REMOTE_SCHEME,
   FOLLOW_STATES,
-  AVATARS_DIR,
-  SERVER_ACCOUNT_NAME,
+  SERVER_ACTOR_NAME,
   PRIVATE_RSA_KEY_SIZE,
   SORTABLE_COLUMNS,
   STATIC_MAX_AGE,
   STATIC_PATHS,
   ACTIVITY_PUB,
+  ACTIVITY_PUB_ACTOR_TYPES,
   THUMBNAILS_SIZE,
   VIDEO_CATEGORIES,
   VIDEO_LANGUAGES,
   VIDEO_PRIVACIES,
   VIDEO_LICENCES,
   VIDEO_RATE_TYPES,
-  VIDEO_MIMETYPE_EXT
+  VIDEO_MIMETYPE_EXT,
+  VIDEO_TRANSCODING_FPS,
+  USER_PASSWORD_RESET_LIFETIME,
+  IMAGE_MIMETYPE_EXT,
+  SCHEDULER_INTERVAL,
+  JOB_COMPLETED_LIFETIME,
+  VIDEO_VIEW_LIFETIME
+}
+
+// ---------------------------------------------------------------------------
+
+function getLocalConfigFilePath () {
+  const configSources = config.util.getConfigSources()
+  if (configSources.length === 0) throw new Error('Invalid config source.')
+
+  let filename = 'local'
+  if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
+  if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
+
+  return join(dirname(configSources[ 0 ].name), filename + '.json')
+}
+
+function updateWebserverConfig () {
+  CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
+  CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
+}
+
+export function reloadConfig () {
+
+  function directory () {
+    if (process.env.NODE_CONFIG_DIR) {
+      return process.env.NODE_CONFIG_DIR
+    }
+
+    return join(root(), 'config')
+  }
+
+  function purge () {
+    for (const fileName in require.cache) {
+      if (-1 === fileName.indexOf(directory())) {
+        continue
+      }
+
+      delete require.cache[fileName]
+    }
+
+    delete require.cache[require.resolve('config')]
+  }
+
+  purge()
+
+  config = require('config')
+
+  updateWebserverConfig()
 }