miteruzo
/
nizika_video
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
ニジカ投稿局 https://tv.nizika.tv
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
13 Commits
1 Branch
24 MiB
 
 
 
 
 
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
nizika_video/server/core/controllers/api/config.ts

498 lines
16 KiB
Raw Permalink Blame History 

  1. import { About, ActorImageType, ActorImageType_Type, CustomConfig, HttpStatusCode, UserRight } from '@peertube/peertube-models'

  2. import { createReqFiles } from '@server/helpers/express-utils.js'

  3. import { MIMETYPES } from '@server/initializers/constants.js'

  4. import { deleteLocalActorImageFile, updateLocalActorImageFiles } from '@server/lib/local-actor.js'

  5. import { ServerConfigManager } from '@server/lib/server-config-manager.js'

  6. import { ActorImageModel } from '@server/models/actor/actor-image.js'

  7. import { getServerActor } from '@server/models/application/application.js'

  8. import { ModelCache } from '@server/models/shared/model-cache.js'

  9. import express from 'express'

  10. import { remove, writeJSON } from 'fs-extra/esm'

  11. import snakeCase from 'lodash-es/snakeCase.js'

  12. import validator from 'validator'

  13. import { CustomConfigAuditView, auditLoggerFactory, getAuditIdFromRes } from '../../helpers/audit-logger.js'

  14. import { objectConverter } from '../../helpers/core-utils.js'

  15. import { CONFIG, reloadConfig } from '../../initializers/config.js'

  16. import { ClientHtml } from '../../lib/html/client-html.js'

  17. import {

  18.   apiRateLimiter,

  19.   asyncMiddleware,

  20.   authenticate,

  21.   ensureUserHasRight,

  22.   openapiOperationDoc,

  23.   updateAvatarValidator,

  24.   updateBannerValidator

  25. } from '../../middlewares/index.js'

  26. import { customConfigUpdateValidator, ensureConfigIsEditable } from '../../middlewares/validators/config.js'

  27. 

  28. const configRouter = express.Router()

  29. 

  30. configRouter.use(apiRateLimiter)

  31. 

  32. const auditLogger = auditLoggerFactory('config')

  33. 

  34. configRouter.get('/',

  35.   openapiOperationDoc({ operationId: 'getConfig' }),

  36.   asyncMiddleware(getConfig)

  37. )

  38. 

  39. configRouter.get('/about',

  40.   openapiOperationDoc({ operationId: 'getAbout' }),

  41.   asyncMiddleware(getAbout)

  42. )

  43. 

  44. configRouter.get('/custom',

  45.   openapiOperationDoc({ operationId: 'getCustomConfig' }),

  46.   authenticate,

  47.   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),

  48.   getCustomConfig

  49. )

  50. 

  51. configRouter.put('/custom',

  52.   openapiOperationDoc({ operationId: 'putCustomConfig' }),

  53.   authenticate,

  54.   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),

  55.   ensureConfigIsEditable,

  56.   customConfigUpdateValidator,

  57.   asyncMiddleware(updateCustomConfig)

  58. )

  59. 

  60. configRouter.delete('/custom',

  61.   openapiOperationDoc({ operationId: 'delCustomConfig' }),

  62.   authenticate,

  63.   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),

  64.   ensureConfigIsEditable,

  65.   asyncMiddleware(deleteCustomConfig)

  66. )

  67. 

  68. // ---------------------------------------------------------------------------

  69. 

  70. configRouter.post('/instance-banner/pick',

  71.   authenticate,

  72.   createReqFiles([ 'bannerfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT),

  73.   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),

  74.   updateBannerValidator,

  75.   asyncMiddleware(updateInstanceImageFactory(ActorImageType.BANNER))

  76. )

  77. 

  78. configRouter.delete('/instance-banner',

  79.   authenticate,

  80.   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),

  81.   asyncMiddleware(deleteInstanceImageFactory(ActorImageType.BANNER))

  82. )

  83. 

  84. // ---------------------------------------------------------------------------

  85. 

  86. configRouter.post('/instance-avatar/pick',

  87.   authenticate,

  88.   createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT),

  89.   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),

  90.   updateAvatarValidator,

  91.   asyncMiddleware(updateInstanceImageFactory(ActorImageType.AVATAR))

  92. )

  93. 

  94. configRouter.delete('/instance-avatar',

  95.   authenticate,

  96.   ensureUserHasRight(UserRight.MANAGE_CONFIGURATION),

  97.   asyncMiddleware(deleteInstanceImageFactory(ActorImageType.AVATAR))

  98. )

  99. 

  100. // ---------------------------------------------------------------------------

  101. 

  102. async function getConfig (req: express.Request, res: express.Response) {

  103.   const json = await ServerConfigManager.Instance.getServerConfig(req.ip)

  104. 

  105.   return res.json(json)

  106. }

  107. 

  108. async function getAbout (req: express.Request, res: express.Response) {

  109.   const serverActor = await getServerActor()

  110. 

  111.   const about: About = {

  112.     instance: {

  113.       name: CONFIG.INSTANCE.NAME,

  114.       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,

  115.       description: CONFIG.INSTANCE.DESCRIPTION,

  116.       terms: CONFIG.INSTANCE.TERMS,

  117.       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,

  118. 

  119.       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,

  120. 

  121.       creationReason: CONFIG.INSTANCE.CREATION_REASON,

  122.       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,

  123.       administrator: CONFIG.INSTANCE.ADMINISTRATOR,

  124.       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,

  125.       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,

  126. 

  127.       languages: CONFIG.INSTANCE.LANGUAGES,

  128.       categories: CONFIG.INSTANCE.CATEGORIES,

  129. 

  130.       banners: serverActor.Banners.map(b => b.toFormattedJSON()),

  131.       avatars: serverActor.Avatars.map(a => a.toFormattedJSON())

  132.     }

  133.   }

  134. 

  135.   return res.json(about)

  136. }

  137. 

  138. function getCustomConfig (req: express.Request, res: express.Response) {

  139.   const data = customConfig()

  140. 

  141.   return res.json(data)

  142. }

  143. 

  144. async function deleteCustomConfig (req: express.Request, res: express.Response) {

  145.   await remove(CONFIG.CUSTOM_FILE)

  146. 

  147.   auditLogger.delete(getAuditIdFromRes(res), new CustomConfigAuditView(customConfig()))

  148. 

  149.   await reloadConfig()

  150.   ClientHtml.invalidateCache()

  151. 

  152.   const data = customConfig()

  153. 

  154.   return res.json(data)

  155. }

  156. 

  157. async function updateCustomConfig (req: express.Request, res: express.Response) {

  158.   const oldCustomConfigAuditKeys = new CustomConfigAuditView(customConfig())

  159. 

  160.   // camelCase to snake_case key + Force number conversion

  161.   const toUpdateJSON = convertCustomConfigBody(req.body)

  162. 

  163.   await writeJSON(CONFIG.CUSTOM_FILE, toUpdateJSON, { spaces: 2 })

  164. 

  165.   await reloadConfig()

  166.   ClientHtml.invalidateCache()

  167. 

  168.   const data = customConfig()

  169. 

  170.   auditLogger.update(

  171.     getAuditIdFromRes(res),

  172.     new CustomConfigAuditView(data),

  173.     oldCustomConfigAuditKeys

  174.   )

  175. 

  176.   return res.json(data)

  177. }

  178. 

  179. // ---------------------------------------------------------------------------

  180. 

  181. function updateInstanceImageFactory (imageType: ActorImageType_Type) {

  182.   return async (req: express.Request, res: express.Response) => {

  183.     const field = imageType === ActorImageType.BANNER

  184.       ? 'bannerfile'

  185.       : 'avatarfile'

  186. 

  187.     const imagePhysicalFile = req.files[field][0]

  188. 

  189.     await updateLocalActorImageFiles({

  190.       accountOrChannel: (await getServerActorWithUpdatedImages(imageType)).Account,

  191.       imagePhysicalFile,

  192.       type: imageType,

  193.       sendActorUpdate: false

  194.     })

  195. 

  196.     ClientHtml.invalidateCache()

  197.     ModelCache.Instance.clearCache('server-account')

  198. 

  199.     return res.sendStatus(HttpStatusCode.NO_CONTENT_204)

  200.   }

  201. }

  202. 

  203. function deleteInstanceImageFactory (imageType: ActorImageType_Type) {

  204.   return async (req: express.Request, res: express.Response) => {

  205.     await deleteLocalActorImageFile((await getServerActorWithUpdatedImages(imageType)).Account, imageType)

  206. 

  207.     ClientHtml.invalidateCache()

  208.     ModelCache.Instance.clearCache('server-account')

  209. 

  210.     return res.sendStatus(HttpStatusCode.NO_CONTENT_204)

  211.   }

  212. }

  213. 

  214. async function getServerActorWithUpdatedImages (imageType: ActorImageType_Type) {

  215.   const serverActor = await getServerActor()

  216.   const updatedImages = await ActorImageModel.listByActor(serverActor, imageType) // Reload images from DB

  217. 

  218.   if (imageType === ActorImageType.BANNER) serverActor.Banners = updatedImages

  219.   else serverActor.Avatars = updatedImages

  220. 

  221.   return serverActor

  222. }

  223. 

  224. // ---------------------------------------------------------------------------

  225. 

  226. export {

  227.   configRouter

  228. }

  229. 

  230. // ---------------------------------------------------------------------------

  231. 

  232. function customConfig (): CustomConfig {

  233.   return {

  234.     instance: {

  235.       name: CONFIG.INSTANCE.NAME,

  236.       shortDescription: CONFIG.INSTANCE.SHORT_DESCRIPTION,

  237.       description: CONFIG.INSTANCE.DESCRIPTION,

  238.       terms: CONFIG.INSTANCE.TERMS,

  239.       codeOfConduct: CONFIG.INSTANCE.CODE_OF_CONDUCT,

  240. 

  241.       creationReason: CONFIG.INSTANCE.CREATION_REASON,

  242.       moderationInformation: CONFIG.INSTANCE.MODERATION_INFORMATION,

  243.       administrator: CONFIG.INSTANCE.ADMINISTRATOR,

  244.       maintenanceLifetime: CONFIG.INSTANCE.MAINTENANCE_LIFETIME,

  245.       businessModel: CONFIG.INSTANCE.BUSINESS_MODEL,

  246.       hardwareInformation: CONFIG.INSTANCE.HARDWARE_INFORMATION,

  247. 

  248.       languages: CONFIG.INSTANCE.LANGUAGES,

  249.       categories: CONFIG.INSTANCE.CATEGORIES,

  250. 

  251.       isNSFW: CONFIG.INSTANCE.IS_NSFW,

  252.       defaultNSFWPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,

  253. 

  254.       defaultClientRoute: CONFIG.INSTANCE.DEFAULT_CLIENT_ROUTE,

  255. 

  256.       customizations: {

  257.         css: CONFIG.INSTANCE.CUSTOMIZATIONS.CSS,

  258.         javascript: CONFIG.INSTANCE.CUSTOMIZATIONS.JAVASCRIPT

  259.       }

  260.     },

  261.     theme: {

  262.       default: CONFIG.THEME.DEFAULT

  263.     },

  264.     services: {

  265.       twitter: {

  266.         username: CONFIG.SERVICES.TWITTER.USERNAME

  267.       }

  268.     },

  269.     client: {

  270.       videos: {

  271.         miniature: {

  272.           preferAuthorDisplayName: CONFIG.CLIENT.VIDEOS.MINIATURE.PREFER_AUTHOR_DISPLAY_NAME

  273.         }

  274.       },

  275.       menu: {

  276.         login: {

  277.           redirectOnSingleExternalAuth: CONFIG.CLIENT.MENU.LOGIN.REDIRECT_ON_SINGLE_EXTERNAL_AUTH

  278.         }

  279.       }

  280.     },

  281.     cache: {

  282.       previews: {

  283.         size: CONFIG.CACHE.PREVIEWS.SIZE

  284.       },

  285.       captions: {

  286.         size: CONFIG.CACHE.VIDEO_CAPTIONS.SIZE

  287.       },

  288.       torrents: {

  289.         size: CONFIG.CACHE.TORRENTS.SIZE

  290.       },

  291.       storyboards: {

  292.         size: CONFIG.CACHE.STORYBOARDS.SIZE

  293.       }

  294.     },

  295.     signup: {

  296.       enabled: CONFIG.SIGNUP.ENABLED,

  297.       limit: CONFIG.SIGNUP.LIMIT,

  298.       requiresApproval: CONFIG.SIGNUP.REQUIRES_APPROVAL,

  299.       requiresEmailVerification: CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION,

  300.       minimumAge: CONFIG.SIGNUP.MINIMUM_AGE

  301.     },

  302.     admin: {

  303.       email: CONFIG.ADMIN.EMAIL

  304.     },

  305.     contactForm: {

  306.       enabled: CONFIG.CONTACT_FORM.ENABLED

  307.     },

  308.     user: {

  309.       history: {

  310.         videos: {

  311.           enabled: CONFIG.USER.HISTORY.VIDEOS.ENABLED

  312.         }

  313.       },

  314.       videoQuota: CONFIG.USER.VIDEO_QUOTA,

  315.       videoQuotaDaily: CONFIG.USER.VIDEO_QUOTA_DAILY,

  316.       defaultChannelName: CONFIG.USER.DEFAULT_CHANNEL_NAME

  317.     },

  318.     videoChannels: {

  319.       maxPerUser: CONFIG.VIDEO_CHANNELS.MAX_PER_USER

  320.     },

  321.     transcoding: {

  322.       enabled: CONFIG.TRANSCODING.ENABLED,

  323.       originalFile: {

  324.         keep: CONFIG.TRANSCODING.ORIGINAL_FILE.KEEP

  325.       },

  326.       remoteRunners: {

  327.         enabled: CONFIG.TRANSCODING.REMOTE_RUNNERS.ENABLED

  328.       },

  329.       allowAdditionalExtensions: CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS,

  330.       allowAudioFiles: CONFIG.TRANSCODING.ALLOW_AUDIO_FILES,

  331.       threads: CONFIG.TRANSCODING.THREADS,

  332.       concurrency: CONFIG.TRANSCODING.CONCURRENCY,

  333.       profile: CONFIG.TRANSCODING.PROFILE,

  334.       resolutions: {

  335.         '0p': CONFIG.TRANSCODING.RESOLUTIONS['0p'],

  336.         '144p': CONFIG.TRANSCODING.RESOLUTIONS['144p'],

  337.         '240p': CONFIG.TRANSCODING.RESOLUTIONS['240p'],

  338.         '360p': CONFIG.TRANSCODING.RESOLUTIONS['360p'],

  339.         '480p': CONFIG.TRANSCODING.RESOLUTIONS['480p'],

  340.         '720p': CONFIG.TRANSCODING.RESOLUTIONS['720p'],

  341.         '1080p': CONFIG.TRANSCODING.RESOLUTIONS['1080p'],

  342.         '1440p': CONFIG.TRANSCODING.RESOLUTIONS['1440p'],

  343.         '2160p': CONFIG.TRANSCODING.RESOLUTIONS['2160p']

  344.       },

  345.       alwaysTranscodeOriginalResolution: CONFIG.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION,

  346.       webVideos: {

  347.         enabled: CONFIG.TRANSCODING.WEB_VIDEOS.ENABLED

  348.       },

  349.       hls: {

  350.         enabled: CONFIG.TRANSCODING.HLS.ENABLED

  351.       }

  352.     },

  353.     live: {

  354.       enabled: CONFIG.LIVE.ENABLED,

  355.       allowReplay: CONFIG.LIVE.ALLOW_REPLAY,

  356.       latencySetting: {

  357.         enabled: CONFIG.LIVE.LATENCY_SETTING.ENABLED

  358.       },

  359.       maxDuration: CONFIG.LIVE.MAX_DURATION,

  360.       maxInstanceLives: CONFIG.LIVE.MAX_INSTANCE_LIVES,

  361.       maxUserLives: CONFIG.LIVE.MAX_USER_LIVES,

  362.       transcoding: {

  363.         enabled: CONFIG.LIVE.TRANSCODING.ENABLED,

  364.         remoteRunners: {

  365.           enabled: CONFIG.LIVE.TRANSCODING.REMOTE_RUNNERS.ENABLED

  366.         },

  367.         threads: CONFIG.LIVE.TRANSCODING.THREADS,

  368.         profile: CONFIG.LIVE.TRANSCODING.PROFILE,

  369.         resolutions: {

  370.           '144p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['144p'],

  371.           '240p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['240p'],

  372.           '360p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['360p'],

  373.           '480p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['480p'],

  374.           '720p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['720p'],

  375.           '1080p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1080p'],

  376.           '1440p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['1440p'],

  377.           '2160p': CONFIG.LIVE.TRANSCODING.RESOLUTIONS['2160p']

  378.         },

  379.         alwaysTranscodeOriginalResolution: CONFIG.LIVE.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION

  380.       }

  381.     },

  382.     videoStudio: {

  383.       enabled: CONFIG.VIDEO_STUDIO.ENABLED,

  384.       remoteRunners: {

  385.         enabled: CONFIG.VIDEO_STUDIO.REMOTE_RUNNERS.ENABLED

  386.       }

  387.     },

  388.     videoTranscription: {

  389.       enabled: CONFIG.VIDEO_TRANSCRIPTION.ENABLED,

  390.       remoteRunners: {

  391.         enabled: CONFIG.VIDEO_TRANSCRIPTION.REMOTE_RUNNERS.ENABLED

  392.       }

  393.     },

  394.     videoFile: {

  395.       update: {

  396.         enabled: CONFIG.VIDEO_FILE.UPDATE.ENABLED

  397.       }

  398.     },

  399.     import: {

  400.       videos: {

  401.         concurrency: CONFIG.IMPORT.VIDEOS.CONCURRENCY,

  402.         http: {

  403.           enabled: CONFIG.IMPORT.VIDEOS.HTTP.ENABLED

  404.         },

  405.         torrent: {

  406.           enabled: CONFIG.IMPORT.VIDEOS.TORRENT.ENABLED

  407.         }

  408.       },

  409.       videoChannelSynchronization: {

  410.         enabled: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.ENABLED,

  411.         maxPerUser: CONFIG.IMPORT.VIDEO_CHANNEL_SYNCHRONIZATION.MAX_PER_USER

  412.       },

  413.       users: {

  414.         enabled: CONFIG.IMPORT.USERS.ENABLED

  415.       }

  416.     },

  417.     export: {

  418.       users: {

  419.         enabled: CONFIG.EXPORT.USERS.ENABLED,

  420.         exportExpiration: CONFIG.EXPORT.USERS.EXPORT_EXPIRATION,

  421.         maxUserVideoQuota: CONFIG.EXPORT.USERS.MAX_USER_VIDEO_QUOTA

  422.       }

  423.     },

  424.     trending: {

  425.       videos: {

  426.         algorithms: {

  427.           enabled: CONFIG.TRENDING.VIDEOS.ALGORITHMS.ENABLED,

  428.           default: CONFIG.TRENDING.VIDEOS.ALGORITHMS.DEFAULT

  429.         }

  430.       }

  431.     },

  432.     autoBlacklist: {

  433.       videos: {

  434.         ofUsers: {

  435.           enabled: CONFIG.AUTO_BLACKLIST.VIDEOS.OF_USERS.ENABLED

  436.         }

  437.       }

  438.     },

  439.     followers: {

  440.       instance: {

  441.         enabled: CONFIG.FOLLOWERS.INSTANCE.ENABLED,

  442.         manualApproval: CONFIG.FOLLOWERS.INSTANCE.MANUAL_APPROVAL

  443.       }

  444.     },

  445.     followings: {

  446.       instance: {

  447.         autoFollowBack: {

  448.           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_BACK.ENABLED

  449.         },

  450. 

  451.         autoFollowIndex: {

  452.           enabled: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.ENABLED,

  453.           indexUrl: CONFIG.FOLLOWINGS.INSTANCE.AUTO_FOLLOW_INDEX.INDEX_URL

  454.         }

  455.       }

  456.     },

  457.     broadcastMessage: {

  458.       enabled: CONFIG.BROADCAST_MESSAGE.ENABLED,

  459.       message: CONFIG.BROADCAST_MESSAGE.MESSAGE,

  460.       level: CONFIG.BROADCAST_MESSAGE.LEVEL,

  461.       dismissable: CONFIG.BROADCAST_MESSAGE.DISMISSABLE

  462.     },

  463.     search: {

  464.       remoteUri: {

  465.         users: CONFIG.SEARCH.REMOTE_URI.USERS,

  466.         anonymous: CONFIG.SEARCH.REMOTE_URI.ANONYMOUS

  467.       },

  468.       searchIndex: {

  469.         enabled: CONFIG.SEARCH.SEARCH_INDEX.ENABLED,

  470.         url: CONFIG.SEARCH.SEARCH_INDEX.URL,

  471.         disableLocalSearch: CONFIG.SEARCH.SEARCH_INDEX.DISABLE_LOCAL_SEARCH,

  472.         isDefaultSearch: CONFIG.SEARCH.SEARCH_INDEX.IS_DEFAULT_SEARCH

  473.       }

  474.     },

  475.     storyboards: {

  476.       enabled: CONFIG.STORYBOARDS.ENABLED

  477.     }

  478.   }

  479. }

  480. 

  481. function convertCustomConfigBody (body: CustomConfig) {

  482.   function keyConverter (k: string) {

  483.     // Transcoding resolutions exception

  484.     if (/^\d{3,4}p$/.exec(k)) return k

  485.     if (k === '0p') return k

  486. 

  487.     return snakeCase(k)

  488.   }

  489. 

  490.   function valueConverter (v: any) {

  491.     if (validator.default.isNumeric(v + '')) return parseInt('' + v, 10)

  492. 

  493.     return v

  494.   }

  495. 

  496.   return objectConverter(body, keyConverter, valueConverter)

  497. }