Skip to content

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

Add quick filter for registration requests

Chocobozzz4ce5b37c14bb
diff --git a/client/src/app/+admin/moderation/registration-list/admin-registration.service.ts b/client/src/app/+admin/moderation/registration-list/admin-registration.service.ts
index b43bd53836..d32f97c3ba 100644
--- a/client/src/app/+admin/moderation/registration-list/admin-registration.service.ts
+++ b/client/src/app/+admin/moderation/registration-list/admin-registration.service.ts
@@ -1,11 +1,11 @@
-import { SortMeta } from 'primeng/api'
-import { from } from 'rxjs'
-import { catchError, concatMap, toArray } from 'rxjs/operators'
import { HttpClient, HttpParams } from '@angular/common/http'
import { Injectable, inject } from '@angular/core'
import { RestExtractor, RestPagination, RestService } from '@app/core'
import { arrayify } from '@peertube/peertube-core-utils'
-import { ResultList, UserRegistration, UserRegistrationUpdateState } from '@peertube/peertube-models'
+import { ResultList, UserRegistration, UserRegistrationStateType, UserRegistrationUpdateState } from '@peertube/peertube-models'
+import { SortMeta } from 'primeng/api'
+import { from } from 'rxjs'
+import { catchError, concatMap, toArray } from 'rxjs/operators'
import { environment } from '../../../../environments/environment'
@Injectable()
@@ -20,17 +20,18 @@ export class AdminRegistrationService {
pagination: RestPagination
sort: SortMeta
search?: string
+ stateOneOf?: UserRegistrationStateType[]
}) {
- const { pagination, sort, search } = options
+ const { pagination, sort, search, stateOneOf } = options
const url = AdminRegistrationService.BASE_REGISTRATION_URL
let params = new HttpParams()
params = this.restService.addRestGetParams(params, pagination, sort)
- if (search) {
- params = params.append('search', search)
- }
+ if (search) params = params.append('search', search)
+
+ params = this.restService.addObjectParams(params, { stateOneOf })
return this.authHttp.get<ResultList<UserRegistration>>(url, { params })
.pipe(
diff --git a/client/src/app/+admin/moderation/registration-list/registration-list.component.html b/client/src/app/+admin/moderation/registration-list/registration-list.component.html
index 4c55040419..cdd70702d7 100644
--- a/client/src/app/+admin/moderation/registration-list/registration-list.component.html
+++ b/client/src/app/+admin/moderation/registration-list/registration-list.component.html
@@ -8,6 +8,7 @@
columnConfig="true"
[bulkActions]="bulkActions"
searchInput="true"
+ [inputFilters]="inputFilters"
>
<ng-template #totalTitle let-totalRecords>
<ng-container i18n>{ totalRecords, plural, =0 {No registration} =1 {1 registration} other {{{ totalRecords | myNumberFormatter }} registrations}}</ng-container>
@@ -51,13 +52,13 @@
@if (table.isColumnDisplayed('state')) {
<td class="abuse-states">
@if (isRegistrationAccepted(registration)) {
- <div [title]="registration.state.label" class="pt-badge badge-success">
+ <a routerLink="." [queryParams]="{ state: registration.state.id }" [title]="getStateFilterTitle(registration.state.label)" class="pt-badge badge-success">
<my-global-icon iconName="tick"></my-global-icon>
- </div>
+ </a>
} @else if (isRegistrationRejected(registration)) {
- <div [title]="registration.state.label" class="pt-badge badge-danger">
+ <a routerLink="." [queryParams]="{ state: registration.state.id }" [title]="getStateFilterTitle(registration.state.label)" class="pt-badge badge-danger">
<my-global-icon iconName="cross"></my-global-icon>
- </div>
+ </a>
}
</td>
}
diff --git a/client/src/app/+admin/moderation/registration-list/registration-list.component.ts b/client/src/app/+admin/moderation/registration-list/registration-list.component.ts
index f5a0accc5d..9f08504e8b 100644
--- a/client/src/app/+admin/moderation/registration-list/registration-list.component.ts
+++ b/client/src/app/+admin/moderation/registration-list/registration-list.component.ts
@@ -1,10 +1,17 @@
import { Component, OnInit, inject, viewChild } from '@angular/core'
+import { RouterLink } from '@angular/router'
import { ConfirmService, MarkdownService, Notifier, ServerService } from '@app/core'
import { formatICU } from '@app/helpers'
+import { AdvancedFilterDef } from '@app/shared/shared-forms/advanced-input-filter.component'
import { buildDropdownSimpleAndBulkActions } from '@app/shared/shared-main/buttons/action-dropdown-helpers'
import { PTDatePipe } from '@app/shared/shared-main/common/date.pipe'
import { NgbTooltip } from '@ng-bootstrap/ng-bootstrap'
-import { ResultList, UserRegistration as UserRegistrationServer, UserRegistrationState } from '@peertube/peertube-models'
+import {
+ ResultList,
+ UserRegistration as UserRegistrationServer,
+ UserRegistrationState,
+ UserRegistrationStateType
+} from '@peertube/peertube-models'
import { switchMap } from 'rxjs'
import { GlobalIconComponent } from '../../../shared/shared-icons/global-icon.component'
import { ActionDropdownComponent, DropdownAction } from '../../../shared/shared-main/buttons/action-dropdown.component'
@@ -16,12 +23,14 @@ import { ProcessRegistrationModalComponent } from './process-registration-modal.
type UserRegistration = UserRegistrationServer & { registrationReasonHTML?: string, moderationResponseHTML?: string }
type ColumnName = 'account' | 'email' | 'channel' | 'registrationReason' | 'state' | 'moderationResponse' | 'createdAt'
+type DataLoaderParameter = Parameters<RegistrationListComponent['_dataLoader']>[0]
@Component({
selector: 'my-registration-list',
templateUrl: './registration-list.component.html',
styleUrls: [ '../../../shared/shared-moderation/moderation.scss', './registration-list.component.scss' ],
imports: [
+ RouterLink,
GlobalIconComponent,
ActionDropdownComponent,
NgbTooltip,
@@ -59,6 +68,20 @@ export class RegistrationListComponent implements OnInit {
dataLoader: typeof this._dataLoader
+ inputFilters: AdvancedFilterDef<DataLoaderParameter>[] = [
+ {
+ type: 'options',
+ key: 'state',
+ title: $localize`Registration state`,
+ options: [
+ { value: 'all', label: $localize`All registrations` },
+ { value: UserRegistrationState.ACCEPTED, label: $localize`Accepted registrations` },
+ { value: UserRegistrationState.REJECTED, label: $localize`Rejected registrations` },
+ { value: UserRegistrationState.PENDING, label: $localize`Pending registrations` }
+ ]
+ }
+ ]
+
constructor () {
this.dataLoader = this._dataLoader.bind(this)
@@ -110,8 +133,18 @@ export class RegistrationListComponent implements OnInit {
this.table().reloadData({ field: 'createdAt', order: -1 })
}
- private _dataLoader (options: DataLoaderOptionsBase) {
- return this.adminRegistrationService.listRegistrations(options)
+ getStateFilterTitle (stateLabel: string) {
+ return $localize`Filter by state: ${stateLabel}`
+ }
+
+ private _dataLoader (options: DataLoaderOptionsBase & { state?: UserRegistrationStateType }) {
+ const { state, ...restOptions } = options
+
+ let stateOneOf: UserRegistrationStateType[]
+
+ if (state) stateOneOf = [ state ]
+
+ return this.adminRegistrationService.listRegistrations({ ...restOptions, stateOneOf })
.pipe(
switchMap(async (resultList: ResultList<UserRegistration>) => {
for (const registration of resultList.data) {
diff --git a/packages/server-commands/src/users/registrations-command.ts b/packages/server-commands/src/users/registrations-command.ts
index 2111fbd39b..9516ccb708 100644
--- a/packages/server-commands/src/users/registrations-command.ts
+++ b/packages/server-commands/src/users/registrations-command.ts
@@ -4,13 +4,13 @@ import {
ResultList,
UserRegistration,
UserRegistrationRequest,
+ UserRegistrationStateType,
UserRegistrationUpdateState
} from '@peertube/peertube-models'
import { unwrapBody } from '../requests/index.js'
import { AbstractCommand, OverrideCommandOptions } from '../shared/index.js'
export class RegistrationsCommand extends AbstractCommand {
-
register (options: OverrideCommandOptions & Partial<UserRegistrationRequest> & Pick<UserRegistrationRequest, 'username'>) {
const { password = 'password', email = options.username + '@example.com' } = options
const path = '/api/v1/users/register'
@@ -83,9 +83,11 @@ export class RegistrationsCommand extends AbstractCommand {
// ---------------------------------------------------------------------------
- delete (options: OverrideCommandOptions & {
- id: number
- }) {
+ delete (
+ options: OverrideCommandOptions & {
+ id: number
+ }
+ ) {
const { id } = options
const path = '/api/v1/users/registrations/' + id
@@ -105,6 +107,7 @@ export class RegistrationsCommand extends AbstractCommand {
count?: number
sort?: string
search?: string
+ stateOneOf?: UserRegistrationStateType[]
} = {}) {
const path = '/api/v1/users/registrations'
@@ -112,7 +115,7 @@ export class RegistrationsCommand extends AbstractCommand {
...options,
path,
- query: pick(options, [ 'start', 'count', 'sort', 'search' ]),
+ query: pick(options, [ 'start', 'count', 'sort', 'search', 'stateOneOf' ]),
implicitToken: true,
defaultExpectedStatus: HttpStatusCode.OK_200
})
@@ -120,9 +123,11 @@ export class RegistrationsCommand extends AbstractCommand {
// ---------------------------------------------------------------------------
- askSendVerifyEmail (options: OverrideCommandOptions & {
- email: string
- }) {
+ askSendVerifyEmail (
+ options: OverrideCommandOptions & {
+ email: string
+ }
+ ) {
const { email } = options
const path = '/api/v1/users/registrations/ask-send-verify-email'
@@ -136,10 +141,12 @@ export class RegistrationsCommand extends AbstractCommand {
})
}
- verifyEmail (options: OverrideCommandOptions & {
- registrationId: number
- verificationString: string
- }) {
+ verifyEmail (
+ options: OverrideCommandOptions & {
+ registrationId: number
+ verificationString: string
+ }
+ ) {
const { registrationId, verificationString } = options
const path = '/api/v1/users/registrations/' + registrationId + '/verify-email'
diff --git a/packages/tests/src/api/check-params/registrations.ts b/packages/tests/src/api/check-params/registrations.ts
index a142ab8d68..cf704a3061 100644
--- a/packages/tests/src/api/check-params/registrations.ts
+++ b/packages/tests/src/api/check-params/registrations.ts
@@ -1,9 +1,10 @@
import { omit } from '@peertube/peertube-core-utils'
-import { HttpStatusCode, HttpStatusCodeType, UserRole } from '@peertube/peertube-models'
+import { HttpStatusCode, HttpStatusCodeType, UserRegistrationState, UserRole } from '@peertube/peertube-models'
import { checkBadCountPagination, checkBadSort, checkBadStartPagination } from '@tests/shared/checks.js'
import {
cleanupTests,
createSingleServer,
+ makeGetRequest,
makePostBodyRequest,
PeerTubeServer,
setAccessTokensToServers,
@@ -436,12 +437,29 @@ describe('Test registrations API validators', function () {
})
})
+ it('Should fail with an invalid stateOneOf', async function () {
+ await makeGetRequest({
+ url: server.url,
+ path,
+ token: moderatorToken,
+ query: { stateOneOf: 'invalid' },
+ expectedStatus: HttpStatusCode.BAD_REQUEST_400
+ })
+ })
+
it('Should succeed with the correct params', async function () {
await server.registrations.list({
token: moderatorToken,
search: 'toto'
})
})
+
+ it('Should succeed with stateOneOf filter', async function () {
+ await server.registrations.list({
+ token: moderatorToken,
+ stateOneOf: [ UserRegistrationState.ACCEPTED, UserRegistrationState.REJECTED ]
+ })
+ })
})
after(async function () {
diff --git a/packages/tests/src/api/users/registrations.ts b/packages/tests/src/api/users/registrations.ts
index 25f9ff78d2..6455eef6f3 100644
--- a/packages/tests/src/api/users/registrations.ts
+++ b/packages/tests/src/api/users/registrations.ts
@@ -322,6 +322,16 @@ describe('Test registrations', function () {
}
})
+ it('Should filter these registration requests', async function () {
+ const { total, data } = await server.registrations.list({ sort: 'createdAt', stateOneOf: [ UserRegistrationState.ACCEPTED ] })
+ expect(total).to.equal(2)
+ expect(data).to.have.lengthOf(2)
+
+ for (const d of data) {
+ expect(d.state.id).to.equal(UserRegistrationState.ACCEPTED)
+ }
+ })
+
it('Should delete a registration', async function () {
await server.registrations.delete({ id: id2 })
await server.registrations.delete({ id: id3 })
diff --git a/server/core/controllers/api/users/registrations.ts b/server/core/controllers/api/users/registrations.ts
index a3ef130abf..8ddcdc825a 100644
--- a/server/core/controllers/api/users/registrations.ts
+++ b/server/core/controllers/api/users/registrations.ts
@@ -223,7 +223,8 @@ async function listRegistrations (req: express.Request, res: express.Response) {
start: req.query.start,
count: req.query.count,
sort: req.query.sort,
- search: req.query.search
+ search: req.query.search,
+ stateOneOf: req.query.stateOneOf
})
return res.json({
diff --git a/server/core/helpers/custom-validators/user-registration.ts b/server/core/helpers/custom-validators/user-registration.ts
index 7d8c8e5927..447e4fcfdb 100644
--- a/server/core/helpers/custom-validators/user-registration.ts
+++ b/server/core/helpers/custom-validators/user-registration.ts
@@ -1,25 +1,21 @@
import validator from 'validator'
import { CONSTRAINTS_FIELDS, USER_REGISTRATION_STATES } from '../../initializers/constants.js'
-import { exists } from './misc.js'
+import { exists, isArray } from './misc.js'
const USER_REGISTRATIONS_CONSTRAINTS_FIELDS = CONSTRAINTS_FIELDS.USER_REGISTRATIONS
-function isRegistrationStateValid (value: string) {
+export function isRegistrationStateValid (value: string) {
return exists(value) && USER_REGISTRATION_STATES[value] !== undefined
}
-function isRegistrationModerationResponseValid (value: string) {
- return exists(value) && validator.default.isLength(value, USER_REGISTRATIONS_CONSTRAINTS_FIELDS.MODERATOR_MESSAGE)
+export function isRegistrationStateArrayValid (value: any) {
+ return isArray(value) && value.every(v => isRegistrationStateValid(v))
}
-function isRegistrationReasonValid (value: string) {
- return exists(value) && validator.default.isLength(value, USER_REGISTRATIONS_CONSTRAINTS_FIELDS.REASON_MESSAGE)
+export function isRegistrationModerationResponseValid (value: string) {
+ return exists(value) && validator.default.isLength(value, USER_REGISTRATIONS_CONSTRAINTS_FIELDS.MODERATOR_MESSAGE)
}
-// ---------------------------------------------------------------------------
-
-export {
- isRegistrationStateValid,
- isRegistrationModerationResponseValid,
- isRegistrationReasonValid
+export function isRegistrationReasonValid (value: string) {
+ return exists(value) && validator.default.isLength(value, USER_REGISTRATIONS_CONSTRAINTS_FIELDS.REASON_MESSAGE)
}
diff --git a/server/core/middlewares/validators/users/user-registrations.ts b/server/core/middlewares/validators/users/user-registrations.ts
index 61d1c12662..7096c6bd77 100644
--- a/server/core/middlewares/validators/users/user-registrations.ts
+++ b/server/core/middlewares/validators/users/user-registrations.ts
@@ -1,6 +1,11 @@
+import { arrayify } from '@peertube/peertube-core-utils'
import { HttpStatusCode, UserRegister, UserRegistrationRequest, UserRegistrationState } from '@peertube/peertube-models'
import { exists, isBooleanValid, isIdValid, toBooleanOrNull } from '@server/helpers/custom-validators/misc.js'
-import { isRegistrationModerationResponseValid, isRegistrationReasonValid } from '@server/helpers/custom-validators/user-registration.js'
+import {
+ isRegistrationModerationResponseValid,
+ isRegistrationReasonValid,
+ isRegistrationStateArrayValid
+} from '@server/helpers/custom-validators/user-registration.js'
import { CONFIG } from '@server/initializers/config.js'
import { loadReservedActorName } from '@server/lib/local-actor.js'
import { Hooks } from '@server/lib/plugins/hooks.js'
@@ -131,6 +136,11 @@ const listRegistrationsValidator = [
.optional()
.custom(exists),
+ query('stateOneOf')
+ .optional()
+ .customSanitizer(arrayify)
+ .custom(isRegistrationStateArrayValid),
+
(req: express.Request, res: express.Response, next: express.NextFunction) => {
if (areValidationErrors(req, res)) return
diff --git a/server/core/models/user/user-registration.ts b/server/core/models/user/user-registration.ts
index 7647a7a7ae..7e15c7616f 100644
--- a/server/core/models/user/user-registration.ts
+++ b/server/core/models/user/user-registration.ts
@@ -198,8 +198,9 @@ export class UserRegistrationModel extends SequelizeModel<UserRegistrationModel>
count: number
sort: string
search?: string
+ stateOneOf?: UserRegistrationStateType[]
}) {
- const { start, count, sort, search } = options
+ const { start, count, sort, search, stateOneOf } = options
const where: WhereOptions = {}
@@ -220,6 +221,14 @@ export class UserRegistrationModel extends SequelizeModel<UserRegistrationModel>
})
}
+ if (Array.isArray(stateOneOf) && stateOneOf.length !== 0) {
+ Object.assign(where, {
+ state: {
+ [Op.in]: stateOneOf
+ }
+ })
+ }
+
const query: FindOptions = {
offset: start,
limit: count,
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 0553d89d2f..ac1d2af572 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -2918,6 +2918,13 @@ paths:
- createdAt
- state
- -state
+ - name: stateOneOf
+ in: query
+ required: false
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserRegistrationState'
responses:
'200':
description: successful operation
@@ -11853,6 +11860,14 @@ components:
required:
- moderationResponse
+ UserRegistrationState:
+ type: integer
+ enum:
+ - 1
+ - 2
+ - 3
+ description: 'The registration state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
+
UserRegistration:
properties:
id:
@@ -11861,12 +11876,7 @@ components:
type: object
properties:
id:
- type: integer
- enum:
- - 1
- - 2
- - 3
- description: 'The registration state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
+ $ref: '#/components/schemas/UserRegistrationState'
label:
type: string
registrationReason: