Skip to content

ActivityPub-federated video streaming platform using P2P directly in your web browser

add filter:api.user.signup.requires-approval.result (#7446)

kontrollanten5a9c09be7ffd
diff --git a/client/src/app/+signup/+register/register.component.ts b/client/src/app/+signup/+register/register.component.ts
index eb5b82dc64..cb496ecc0e 100644
--- a/client/src/app/+signup/+register/register.component.ts
+++ b/client/src/app/+signup/+register/register.component.ts
@@ -6,7 +6,14 @@ import { AuthService, ServerService } from '@app/core'
import { HooksService } from '@app/core/plugins/hooks.service'
import { InstanceAboutAccordionComponent } from '@app/shared/shared-instance/instance-about-accordion.component'
import { AlertComponent } from '@app/shared/shared-main/common/alert.component'
-import { PeerTubeProblemDocument, ServerConfig, ServerStats, UserRegister } from '@peertube/peertube-models'
+import {
+ UserRegistrationState,
+ PeerTubeProblemDocument,
+ ServerConfig,
+ ServerStats,
+ UserRegister,
+ UserRegistration
+} from '@peertube/peertube-models'
import { LoaderComponent } from '../../shared/shared-main/common/loader.component'
import { SignupLabelComponent } from '../../shared/shared-main/users/signup-label.component'
import { SignupStepTitleComponent } from '../shared/signup-step-title.component'
@@ -81,13 +88,18 @@ export class RegisterComponent implements OnInit {
serverStats: ServerStats
private serverConfig: ServerConfig
+ private _requiresApproval: boolean
get requiresEmailVerification () {
return this.serverConfig.signup.requiresEmailVerification
}
get requiresApproval () {
- return this.serverConfig.signup.requiresApproval
+ return this._requiresApproval ?? this.serverConfig.signup.requiresApproval
+ }
+
+ set requiresApproval (value: boolean) {
+ this._requiresApproval = value
}
get minimumAge () {
@@ -194,10 +206,15 @@ export class RegisterComponent implements OnInit {
const obs = this.requiresApproval
? this.signupService.requestSignup(body)
- : this.signupService.directSignup(body)
+ : this.signupService.signup(body)
obs.subscribe({
- next: () => {
+ next: (registration) => {
+ if ('state' in registration) {
+ const { state } = registration as UserRegistration
+ this.requiresApproval = state.id === UserRegistrationState.PENDING
+ }
+
if (this.requiresEmailVerification || this.requiresApproval) {
this.signupSuccess = true
return
diff --git a/client/src/app/+signup/shared/signup.service.ts b/client/src/app/+signup/shared/signup.service.ts
index fab5037769..e4724db653 100644
--- a/client/src/app/+signup/shared/signup.service.ts
+++ b/client/src/app/+signup/shared/signup.service.ts
@@ -2,7 +2,7 @@ import { catchError, tap } from 'rxjs/operators'
import { HttpClient } from '@angular/common/http'
import { Injectable, inject } from '@angular/core'
import { RestExtractor, UserService } from '@app/core'
-import { UserRegister, UserRegistrationRequest } from '@peertube/peertube-models'
+import { UserRegister, UserRegistrationRequest, UserRegistration as UserRegistrationServerModel } from '@peertube/peertube-models'
@Injectable()
export class SignupService {
@@ -10,17 +10,17 @@ export class SignupService {
private restExtractor = inject(RestExtractor)
private userService = inject(UserService)
- directSignup (userCreate: UserRegister) {
- return this.authHttp.post(UserService.BASE_USERS_URL + 'register', userCreate)
- .pipe(
- tap(() => this.userService.setSignupInThisSession(true)),
- catchError(err => this.restExtractor.handleError(err))
- )
+ signup (userCreate: UserRegister) {
+ return this.authHttp.post<UserRegistrationServerModel>(UserService.BASE_USERS_URL + 'register', userCreate)
+ .pipe(
+ tap(() => this.userService.setSignupInThisSession(true)),
+ catchError(err => this.restExtractor.handleError(err))
+ )
}
requestSignup (userCreate: UserRegistrationRequest) {
return this.authHttp.post(UserService.BASE_USERS_URL + 'registrations/request', userCreate)
- .pipe(catchError(err => this.restExtractor.handleError(err)))
+ .pipe(catchError(err => this.restExtractor.handleError(err)))
}
// ---------------------------------------------------------------------------
diff --git a/packages/models/src/plugins/server/server-hook.model.ts b/packages/models/src/plugins/server/server-hook.model.ts
index dd667e04b8..7139a01e67 100644
--- a/packages/models/src/plugins/server/server-hook.model.ts
+++ b/packages/models/src/plugins/server/server-hook.model.ts
@@ -100,6 +100,9 @@ export const serverFilterHookObject = {
// Filter result used to check if a user can register on the instance
'filter:api.user.signup.allowed.result': true,
+ // Filter result used to check if signup requires approval on the instance
+ 'filter:api.user.signup.requires-approval.result': true,
+
// Filter result used to check if a user can send a registration request on the instance
// PeerTube >= 5.1
'filter:api.user.request-signup.allowed.result': true,
diff --git a/packages/server-commands/src/users/registrations-command.ts b/packages/server-commands/src/users/registrations-command.ts
index 9516ccb708..89628c88cf 100644
--- a/packages/server-commands/src/users/registrations-command.ts
+++ b/packages/server-commands/src/users/registrations-command.ts
@@ -20,13 +20,13 @@ export class RegistrationsCommand extends AbstractCommand {
path,
fields: {
- ...pick(options, [ 'username', 'displayName', 'channel' ]),
+ ...pick(options, [ 'username', 'displayName', 'channel', 'registrationReason' ]),
password,
email
},
implicitToken: false,
- defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
+ defaultExpectedStatus: HttpStatusCode.OK_200
})
}
@@ -36,7 +36,7 @@ export class RegistrationsCommand extends AbstractCommand {
const { password = 'password', email = options.username + '@example.com' } = options
const path = '/api/v1/users/registrations/request'
- return unwrapBody<UserRegistration>(this.postBodyRequest({
+ return unwrapBody<{ state: { id: UserRegistrationStateType, label: string } }>(this.postBodyRequest({
...options,
path,
diff --git a/packages/tests/fixtures/peertube-plugin-test/main.js b/packages/tests/fixtures/peertube-plugin-test/main.js
index e9dddb86f2..c373ccef7a 100644
--- a/packages/tests/fixtures/peertube-plugin-test/main.js
+++ b/packages/tests/fixtures/peertube-plugin-test/main.js
@@ -331,6 +331,16 @@ async function register ({ registerHook, registerSetting, settingsManager, stora
}
})
+ registerHook({
+ target: 'filter:api.user.signup.requires-approval.result',
+ handler: ({ requiresApproval, registrationReason }, { body, headers }) => {
+ return {
+ requiresApproval: body.username === 'waiting_john',
+ registrationReason: 'Marked as spam'
+ }
+ }
+ })
+
{
registerHook({
target: 'filter:api.user.signup.allowed.result',
diff --git a/packages/tests/src/api/check-params/registrations.ts b/packages/tests/src/api/check-params/registrations.ts
index cf704a3061..d480f2c5e3 100644
--- a/packages/tests/src/api/check-params/registrations.ts
+++ b/packages/tests/src/api/check-params/registrations.ts
@@ -196,10 +196,10 @@ describe('Test registrations API validators', function () {
const { total } = await server.users.list()
await server.config.enableSignup(false, total + 1)
- await server.registrations.register({ username: 'user43', expectedStatus: HttpStatusCode.NO_CONTENT_204 })
+ await server.registrations.register({ username: 'user43', expectedStatus: HttpStatusCode.OK_200 })
await server.config.enableSignup(true, total + 2)
- await server.registrations.requestRegistration({
+ await server.registrations.register({
username: 'user44',
registrationReason: 'reason',
expectedStatus: HttpStatusCode.OK_200
@@ -219,14 +219,14 @@ describe('Test registrations API validators', function () {
channel: { name: 'super_user_direct_1_channel', displayName: 'super user direct 1 channel' }
}
- await makePostBodyRequest({ url: server.url, path: registrationPath, fields, expectedStatus: HttpStatusCode.NO_CONTENT_204 })
+ await makePostBodyRequest({ url: server.url, path: registrationPath, fields, expectedStatus: HttpStatusCode.OK_200 })
})
it('Should fail if the instance requires approval', async function () {
this.timeout(60000)
await server.config.enableSignup(true)
- await server.registrations.register({ username: 'user42', expectedStatus: HttpStatusCode.FORBIDDEN_403 })
+ await server.registrations.register({ username: 'user42', expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
})
})
@@ -319,8 +319,18 @@ describe('Test registrations API validators', function () {
this.timeout(60000)
await server.config.enableSignup(true)
- ;({ id: id1 } = await server.registrations.requestRegistration({ username: 'request_2', registrationReason: 'toto' }))
- ;({ id: id2 } = await server.registrations.requestRegistration({ username: 'request_3', registrationReason: 'toto' }))
+ await server.registrations.requestRegistration({ username: 'request_2', registrationReason: 'toto' })
+
+ {
+ const registrations = await server.registrations.list()
+ id1 = registrations.data[0].id
+ }
+
+ {
+ await server.registrations.requestRegistration({ username: 'request_3', registrationReason: 'toto' })
+ const registrations = await server.registrations.list()
+ id2 = registrations.data[0].id
+ }
})
it('Should fail to accept/reject registration without token', async function () {
@@ -380,9 +390,24 @@ describe('Test registrations API validators', function () {
let id3: number
before(async function () {
- ;({ id: id1 } = await server.registrations.requestRegistration({ username: 'request_4', registrationReason: 'toto' }))
- ;({ id: id2 } = await server.registrations.requestRegistration({ username: 'request_5', registrationReason: 'toto' }))
- ;({ id: id3 } = await server.registrations.requestRegistration({ username: 'request_6', registrationReason: 'toto' }))
+
+ {
+ await server.registrations.requestRegistration({ username: 'request_4', registrationReason: 'toto' })
+ const registrations = await server.registrations.list()
+ id1 = registrations.data[0].id
+ }
+
+ {
+ await server.registrations.requestRegistration({ username: 'request_5', registrationReason: 'toto' })
+ const registrations = await server.registrations.list()
+ id2 = registrations.data[0].id
+ }
+
+ {
+ await server.registrations.requestRegistration({ username: 'request_6', registrationReason: 'toto' })
+ const registrations = await server.registrations.list()
+ id3 = registrations.data[0].id
+ }
await server.registrations.accept({ id: id2, moderationResponse: 'tt' })
await server.registrations.reject({ id: id3, moderationResponse: 'tt' })
diff --git a/packages/tests/src/api/server/email.ts b/packages/tests/src/api/server/email.ts
index 55d384c0f0..e54d0b842b 100644
--- a/packages/tests/src/api/server/email.ts
+++ b/packages/tests/src/api/server/email.ts
@@ -337,12 +337,13 @@ describe('Test emails', function () {
let registrationIdEmail: number
before(async function () {
- const { id } = await server.registrations.requestRegistration({
+ await server.registrations.requestRegistration({
username: 'request_1',
registrationReason: 'tt'
})
- registrationId = id
+ const registrations = await server.registrations.list()
+ registrationId = registrations.data[0].id
})
it('Should ask to send the verification email', async function () {
diff --git a/packages/tests/src/api/server/reverse-proxy.ts b/packages/tests/src/api/server/reverse-proxy.ts
index 7e334cc3e5..7607cf72ac 100644
--- a/packages/tests/src/api/server/reverse-proxy.ts
+++ b/packages/tests/src/api/server/reverse-proxy.ts
@@ -124,7 +124,7 @@ describe('Test application behind a reverse proxy', function () {
await server.registrations.register({ username: 'test' + i, expectedStatus: HttpStatusCode.CONFLICT_409 })
}
- await server.registrations.register({ username: 'test43', expectedStatus: HttpStatusCode.NO_CONTENT_204 })
+ await server.registrations.register({ username: 'test43', expectedStatus: HttpStatusCode.OK_200 })
})
diff --git a/packages/tests/src/api/server/stats.ts b/packages/tests/src/api/server/stats.ts
index df65990e77..2c0f28ae2d 100644
--- a/packages/tests/src/api/server/stats.ts
+++ b/packages/tests/src/api/server/stats.ts
@@ -316,9 +316,12 @@ describe('Test stats (excluding redundancy)', function () {
it('Should create registration requests, accept one and have correct stats', async function () {
beforeTimestamp = new Date().getTime()
- const { id: id1 } = await servers[0].registrations.requestRegistration({ username: 'user2', registrationReason: 'reason 1' });
- ({ id: id2 } = await servers[0].registrations.requestRegistration({ username: 'user3', registrationReason: 'reason 2' }))
- await servers[0].registrations.requestRegistration({ username: 'user4', registrationReason: 'reason 3' })
+ await servers[0].registrations.register({ username: 'user2', registrationReason: 'reason 1' })
+ await servers[0].registrations.register({ username: 'user3', registrationReason: 'reason 2' })
+ const registrations = await servers[0].registrations.list()
+ const id1 = registrations.data[1].id
+ id2 = registrations.data[0].id
+ await servers[0].registrations.register({ username: 'user4', registrationReason: 'reason 3' })
await wait(1500)
diff --git a/packages/tests/src/api/users/registrations.ts b/packages/tests/src/api/users/registrations.ts
index 6455eef6f3..ac77019d81 100644
--- a/packages/tests/src/api/users/registrations.ts
+++ b/packages/tests/src/api/users/registrations.ts
@@ -83,6 +83,103 @@ describe('Test registrations', function () {
})
})
+ describe('Eventual registration requests', function () {
+ let id1: number
+ let id2: number
+
+ before(async function () {
+ this.timeout(60000)
+
+ await server.config.enableSignup(true)
+ })
+
+ it('Should request a registration without a channel', async function () {
+ await server.registrations.register({
+ username: 'request_user2',
+ displayName: 'my super request_user 2',
+ email: '[email protected]',
+ password: 'request_user2password',
+ registrationReason: 'registration reason 2'
+ })
+
+ const registrations = await server.registrations.list()
+ id1 = registrations.data[0].id
+ })
+
+ it('Should request a registration with a channel', async function () {
+ await server.registrations.register({
+ username: 'request_user3',
+ displayName: 'my super request_user 3',
+ channel: {
+ displayName: 'my request_user 3 channel',
+ name: 'super_request_user3_channel'
+ },
+ email: '[email protected]',
+ password: 'request_user3password',
+ registrationReason: 'registration reason 3'
+ })
+
+ const registrations = await server.registrations.list()
+ id2 = registrations.data[0].id
+ })
+
+ it('Should list these registration requests', async function () {
+ const { total, data } = await server.registrations.list({ sort: '-createdAt' })
+ expect(total).to.equal(2)
+ expect(data).to.have.lengthOf(2)
+
+ {
+ expect(data[1].id).to.equal(id1)
+ expect(data[1].username).to.equal('request_user2')
+ expect(data[1].accountDisplayName).to.equal('my super request_user 2')
+
+ expect(data[1].channelDisplayName).to.be.null
+ expect(data[1].channelHandle).to.be.null
+
+ expect(data[1].createdAt).to.exist
+ expect(data[1].updatedAt).to.exist
+
+ expect(data[1].email).to.equal('[email protected]')
+ expect(data[1].emailVerified).to.be.null
+
+ expect(data[1].moderationResponse).to.be.null
+ expect(data[1].registrationReason).to.equal('registration reason 2')
+ expect(data[1].state.id).to.equal(UserRegistrationState.PENDING)
+ expect(data[1].state.label).to.equal('Pending')
+ expect(data[1].user).to.be.null
+ }
+
+ {
+ expect(data[0].id).to.equal(id2)
+ expect(data[0].username).to.equal('request_user3')
+ expect(data[0].accountDisplayName).to.equal('my super request_user 3')
+
+ expect(data[0].channelDisplayName).to.equal('my request_user 3 channel')
+ expect(data[0].channelHandle).to.equal('super_request_user3_channel')
+
+ expect(data[0].createdAt).to.exist
+ expect(data[0].updatedAt).to.exist
+
+ expect(data[0].email).to.equal('[email protected]')
+ expect(data[0].emailVerified).to.be.null
+
+ expect(data[0].moderationResponse).to.be.null
+ expect(data[0].registrationReason).to.equal('registration reason 3')
+ expect(data[0].state.id).to.equal(UserRegistrationState.PENDING)
+ expect(data[0].state.label).to.equal('Pending')
+ expect(data[0].user).to.be.null
+ }
+ })
+
+ after(async function () {
+ const registrations = await server.registrations.list()
+
+ for (const reg of registrations.data) {
+ await server.registrations.delete({ id: reg.id })
+ }
+ })
+ })
+
describe('Registration requests', function () {
let id2: number
let id3: number
@@ -97,18 +194,19 @@ describe('Test registrations', function () {
await server.config.enableSignup(true)
{
- const { id } = await server.registrations.requestRegistration({
+ await server.registrations.requestRegistration({
username: 'user4',
registrationReason: 'registration reason 4'
})
- id4 = id
+ const registrations = await server.registrations.list()
+ id4 = registrations.data[0].id
}
})
it('Should request a registration without a channel', async function () {
{
- const { id } = await server.registrations.requestRegistration({
+ await server.registrations.requestRegistration({
username: 'user2',
displayName: 'my super user 2',
@@ -116,12 +214,13 @@ describe('Test registrations', function () {
registrationReason: 'registration reason 2'
})
- id2 = id
+ const registrations = await server.registrations.list()
+ id2 = registrations.data[0].id
}
})
it('Should request a registration with a channel', async function () {
- const { id } = await server.registrations.requestRegistration({
+ await server.registrations.requestRegistration({
username: 'user3',
displayName: 'my super user 3',
channel: {
@@ -133,7 +232,8 @@ describe('Test registrations', function () {
registrationReason: 'registration reason 3'
})
- id3 = id
+ const registrations = await server.registrations.list()
+ id3 = registrations.data[0].id
})
it('Should list these registration requests', async function () {
@@ -355,20 +455,24 @@ describe('Test registrations', function () {
let id2: number
{
- const { id } = await server.registrations.requestRegistration({
+ await server.registrations.requestRegistration({
username: 'user7',
registrationReason: 'tt'
})
- id1 = id
+
+ const registrations = await server.registrations.list()
+ id1 = registrations.data[0].id
}
{
- const { id } = await server.registrations.requestRegistration({
+ await server.registrations.requestRegistration({
username: 'user8',
registrationReason: 'tt'
})
- id2 = id
+
+ const registrations = await server.registrations.list()
+ id2 = registrations.data[0].id
}
await server.registrations.accept({ id: id1, moderationResponse: 'tt', preventEmailDelivery: true })
@@ -389,7 +493,7 @@ describe('Test registrations', function () {
let id2: number
{
- const { id } = await server.registrations.requestRegistration({
+ await server.registrations.requestRegistration({
registrationReason: 'tt',
username: 'user5',
password: 'user5password',
@@ -399,17 +503,20 @@ describe('Test registrations', function () {
}
})
- id1 = id
+ const registrations = await server.registrations.list()
+ id1 = registrations.data[0].id
}
{
- const { id } = await server.registrations.requestRegistration({
+ await server.registrations.requestRegistration({
registrationReason: 'tt',
username: 'user6',
password: 'user6password'
})
- id2 = id
+
+ const registrations = await server.registrations.list()
+ id2 = registrations.data[0].id
}
await server.registrations.accept({ id: id1, moderationResponse: 'tt' })
diff --git a/packages/tests/src/plugins/filter-hooks.ts b/packages/tests/src/plugins/filter-hooks.ts
index c5f15a42a9..9e4819580b 100644
--- a/packages/tests/src/plugins/filter-hooks.ts
+++ b/packages/tests/src/plugins/filter-hooks.ts
@@ -4,6 +4,7 @@ import {
HttpStatusCode,
MyUser,
PeerTubeProblemDocument,
+ UserRegistrationState,
VideoDetails,
VideoImportState,
VideoPlaylist,
@@ -70,7 +71,7 @@ describe('Test plugin filter hooks', function () {
await servers[0].config.updateExistingConfig({
newConfig: {
live: { enabled: true },
- signup: { enabled: true },
+ signup: { enabled: true, limit: -1 },
videoFile: {
update: {
enabled: true
@@ -488,6 +489,28 @@ describe('Test plugin filter hooks', function () {
})
})
+ describe('Should run filter:api.user.signup.requires-approval.result', function () {
+
+ before(async function () {
+ await servers[0].config.updateExistingConfig({ newConfig: { signup: { requiresApproval: false } } })
+ })
+
+ it('Should require approval', async function () {
+ await servers[0].registrations.register({ username: 'waiting_john' })
+ const registrations = await servers[0].registrations.list()
+
+ expect(registrations.data[0].username).to.equal('waiting_john')
+ expect(registrations.data[0].state.id).to.equal(UserRegistrationState.PENDING)
+ })
+
+ it('Should not require approval', async function () {
+ await servers[0].registrations.register({ username: 'anybody' })
+ const users = await servers[0].users.list()
+
+ expect(users.data.map((reg) => reg.username)).to.contain('anybody')
+ })
+ })
+
describe('Should run filter:api.user.signup.allowed.result', function () {
before(async function () {
await servers[0].config.updateExistingConfig({ newConfig: { signup: { requiresApproval: false } } })
@@ -906,7 +929,7 @@ describe('Test plugin filter hooks', function () {
const { total } = await servers[0].channels.list({ start: 0, count: 1 })
// plugin do +1 to the total parameter
- expect(total).to.equal(6)
+ expect(total).to.equal(7)
})
it('Should run filter:api.video-channel.get.result', async function () {
diff --git a/server/core/controllers/api/users/registrations.ts b/server/core/controllers/api/users/registrations.ts
index 8ddcdc825a..184b6dcbc7 100644
--- a/server/core/controllers/api/users/registrations.ts
+++ b/server/core/controllers/api/users/registrations.ts
@@ -1,4 +1,5 @@
import { pick } from '@peertube/peertube-core-utils'
+import { USER_REGISTRATION_STATES } from '@server/initializers/constants.js'
import {
HttpStatusCode,
UserRegister,
@@ -27,6 +28,7 @@ import {
asyncRetryTransactionMiddleware,
authenticate,
buildRateLimiter,
+ determineSignupMode,
ensureUserHasRight,
ensureUserRegistrationAllowedFactory,
ensureUserRegistrationAllowedForIP,
@@ -36,7 +38,7 @@ import {
setDefaultPagination,
setDefaultSort,
userRegistrationsSortValidator,
- usersDirectRegistrationValidator,
+ usersRegistrationValidator,
usersRequestRegistrationValidator
} from '../../../middlewares/index.js'
@@ -97,9 +99,10 @@ registrationsRouter.get(
registrationsRouter.post(
'/register',
registrationRateLimiter,
- asyncMiddleware(ensureUserRegistrationAllowedFactory('direct-registration')),
+ asyncMiddleware(determineSignupMode),
+ asyncMiddleware(ensureUserRegistrationAllowedFactory()),
ensureUserRegistrationAllowedForIP,
- asyncMiddleware(usersDirectRegistrationValidator),
+ usersRegistrationValidator,
asyncRetryTransactionMiddleware(registerUser)
)
@@ -136,7 +139,12 @@ async function requestRegistration (req: express.Request, res: express.Response)
Hooks.runAction('action:api.user.requested-registration', { body, registration, req, res })
- return res.json(registration.toFormattedJSON())
+ return res.json({
+ state: {
+ id: UserRegistrationState.PENDING,
+ label: USER_REGISTRATION_STATES[UserRegistrationState.PENDING]
+ }
+ })
}
// ---------------------------------------------------------------------------
@@ -236,6 +244,10 @@ async function listRegistrations (req: express.Request, res: express.Response) {
// ---------------------------------------------------------------------------
async function registerUser (req: express.Request, res: express.Response) {
+ if (res.locals.signupMode === 'request-registration') {
+ return requestRegistration(req, res)
+ }
+
const body: UserRegister = req.body
const userToCreate = buildUser({
@@ -261,5 +273,10 @@ async function registerUser (req: express.Request, res: express.Response) {
Hooks.runAction('action:api.user.registered', { body, user, account, videoChannel, req, res })
- return res.sendStatus(HttpStatusCode.NO_CONTENT_204)
+ return res.json({
+ state: {
+ id: UserRegistrationState.ACCEPTED,
+ label: USER_REGISTRATION_STATES[UserRegistrationState.ACCEPTED]
+ }
+ })
}
diff --git a/server/core/middlewares/validators/users/user-registrations.ts b/server/core/middlewares/validators/users/user-registrations.ts
index 7096c6bd77..b6b54dc187 100644
--- a/server/core/middlewares/validators/users/user-registrations.ts
+++ b/server/core/middlewares/validators/users/user-registrations.ts
@@ -16,8 +16,16 @@ import { isVideoChannelDisplayNameValid, isVideoChannelUsernameValid } from '../
import { isSignupAllowed, isSignupAllowedForCurrentIP, SignupMode } from '../../../lib/signup.js'
import { areValidationErrors, checkUsernameOrEmailDoNotAlreadyExist } from '../shared/index.js'
import { checkRegistrationHandlesDoNotAlreadyExist, checkRegistrationIdExist } from './shared/user-registrations.js'
+import { pick } from '@peertube/peertube-core-utils'
+import { asyncMiddleware } from '@server/middlewares/async.js'
-const usersDirectRegistrationValidator = usersCommonRegistrationValidatorFactory()
+const usersRegistrationValidator = (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ if (res.locals.signupMode === 'direct-registration') {
+ return asyncMiddleware(usersCommonRegistrationValidatorFactory())(req, res, next)
+ }
+
+ return asyncMiddleware(usersRequestRegistrationValidator)(req, res, next)
+}
const usersRequestRegistrationValidator = [
...usersCommonRegistrationValidatorFactory([
@@ -27,8 +35,10 @@ const usersRequestRegistrationValidator = [
async (req: express.Request, res: express.Response, next: express.NextFunction) => {
const body: UserRegistrationRequest = req.body
+ // CONFIG.SIGNUP.REQUIRES_APPROVAL is only used for /registrations/request endpoint
+ const requiresApproval = (res.locals.signupMode === 'request-registration') || CONFIG.SIGNUP.REQUIRES_APPROVAL
- if (CONFIG.SIGNUP.REQUIRES_APPROVAL !== true) {
+ if (requiresApproval !== true) {
return res.fail({
status: HttpStatusCode.BAD_REQUEST_400,
message: req.t('Signup approval is not enabled on this instance')
@@ -44,8 +54,30 @@ const usersRequestRegistrationValidator = [
// ---------------------------------------------------------------------------
-function ensureUserRegistrationAllowedFactory (signupMode: SignupMode) {
+const determineSignupMode = [
+ async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ const { registrationReason, requiresApproval } = await Hooks.wrapObject(
+ {
+ requiresApproval: CONFIG.SIGNUP.REQUIRES_APPROVAL,
+ registrationReason: req.body.registrationReason
+ },
+ 'filter:api.user.signup.requires-approval.result',
+ {
+ body: pick(req.body, [ 'username', 'email', 'registrationReason' ]),
+ headers: req.headers
+ }
+ )
+
+ req.body.registrationReason = registrationReason
+ res.locals.signupMode = requiresApproval ? 'request-registration' : 'direct-registration'
+
+ return next()
+ }
+]
+
+function ensureUserRegistrationAllowedFactory (sm?: SignupMode) {
return async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ const signupMode = sm || res.locals.signupMode // sm is provided by /registrations/request endpoint
const allowedParams = {
body: req.body,
ip: req.ip,
@@ -151,12 +183,13 @@ const listRegistrationsValidator = [
// ---------------------------------------------------------------------------
export {
+ determineSignupMode,
+ usersRegistrationValidator,
acceptOrRejectRegistrationValidator,
ensureUserRegistrationAllowedFactory,
ensureUserRegistrationAllowedForIP,
getRegistrationValidator,
listRegistrationsValidator,
- usersDirectRegistrationValidator,
usersRequestRegistrationValidator
}
diff --git a/server/core/types/express.d.ts b/server/core/types/express.d.ts
index 0e285e137a..4b340c431b 100644
--- a/server/core/types/express.d.ts
+++ b/server/core/types/express.d.ts
@@ -63,6 +63,7 @@ import {
} from './models/index.js'
import { MRunner, MRunnerJobRunner, MRunnerRegistrationToken } from './models/runners/index.js'
import { MVideoSource } from './models/video/video-source.js'
+import { SignupMode } from '@server/lib/signup.ts'
declare module 'express' {
export interface Request {
@@ -131,6 +132,8 @@ declare module 'express' {
}) => void
locals: {
+ signupMode?: SignupMode
+
requestStart: number
apicacheGroups: string[]
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index ac1d2af572..9c98ac78d7 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -2790,8 +2790,20 @@ paths:
tags:
- Register
responses:
- '204':
+ '200':
description: successful operation
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ state:
+ type: object
+ properties:
+ id:
+ $ref: '#/components/schemas/UserRegistrationState'
+ label:
+ type: string
'400':
description: request error
'403':
@@ -2818,7 +2830,15 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/UserRegistration'
+ type: object
+ properties:
+ state:
+ type: object
+ properties:
+ id:
+ $ref: '#/components/schemas/UserRegistrationState'
+ label:
+ type: string
'400':
description: request error or signup approval is not enabled on the instance
'403':