Change User Validation rules

krombox

Good day.

Have some troubles with registering users via API. I am using https://github.com/wuethrich44/flarum-ext-sso
to be able login users from WP site on Flarum. The problem is my WP users have nickname like user.name or my.custom_name where "." is used. As i see in Flarum\Core\Validator\UserValidator getRules method username expected to be "regex:/^{[a-z0-9_-]+$/i".} This cause validation issue - 'The username may only contain letters, numbers, and dashes. Is there a way to change this regexp rule or some workaround?

clarkwinkelmann

The validator is resolved via the IOC here https://github.com/flarum/core/blob/7837fff10762f25886cfa83a8b1bb9c0626f84c5/src/Core/Command/RegisterUserHandler.php#L72

So I guess you should be able to extend the UserValidator, change the rule and inject your new one via the IOC when the old one is required.

Were you thinking about making an extension for that ?

alex-arabadjiev

Hi everyone, I am new to Flarum and am working on integrating the forum with an existing Laravel project. For this, I am using the API to register my users to the forum. So far this works well but the user validation rules in Flarum are too strict for most of my users' names and I would like to change the regex rule.

clarkwinkelmann I didn't quite understand whether it's necessary to write a new extension just to change the validation rules. Is there a simpler way of doing this?

Any advice would be appreciated!

eslizn

my solved

/**
 * @param Dispatcher $events
 */
public function subscribe(Dispatcher $events)
{
	$events->listen(ConfigureValidator::class, [$this, 'changeUserValidate']);
}

/**
 * @param ConfigureValidator $events
 */
public function changeUserValidate(ConfigureValidator $events)
{
	$rules = $events->validator->getRules();
	if (isset($rules['username'])) {
		foreach ($rules['username'] as $k => $v) {
			if (strpos($v, 'regex:') === 0) {
				$rules['username'][$k] = '<your rule>';
			}
		}
	}
	$events->validator->setRules($rules);
}

luceos

alex-arabadjiev you can use a local extender, these can be added to the extend.php in the root of the flarum installation.

alex-arabadjiev

luceos Thank you for your quick response!

I tried listening to the ConfigureValidator event as per eslizn's response but it seems that event has been removed in the newer versions. I found a similar suggestion under https://discuss.flarum.org/d/7456-user-validation which also uses the same (presumably deprecated) event.

I'm not very familiar with using local extenders. Do you mean creating a set up similar to the one you documented under https://discuss.flarum.org/d/21954-local-extender-to-disable-sending-mail or is there a way to extend the Flarum\Core\Validator\UserValidator class entirely within the extend.php?

clarkwinkelmann

alex-arabadjiev the event in the latest version is called Validating https://github.com/flarum/core/blob/d492579638fb52dafbfe65f1f36a95eb6047f7f3/src/Foundation/Event/Validating.php

Local extenders are just a way to use extension features without creating a full extension.

Here's one way to do it:

Note: it would be easier to replace the whole $rules['username'] entry with new values, unfortunately there's a unique: check in there we can't replicate because $event->type->user is protected https://github.com/flarum/core/blob/d492579638fb52dafbfe65f1f36a95eb6047f7f3/src/User/UserValidator.php#L42 So I'm using array_map to replace only the values I want instead.

extend.php:

<?php

use Flarum\Extend;
use Flarum\Foundation\Event\Validating;
use Flarum\User\UserValidator;
use Illuminate\Contracts\Events\Dispatcher;
use Illuminate\Support\Str;

return [
  // Register extenders here
  new Extend\Compat(function(Dispatcher $events) {
    $events->listen(Validating::class, function(Validating $event) {
      if ($event->type instanceof UserValidator) {
        $rules = $event->validator->getRules();
        
        $rules['username'] = array_map(function(string $rule) {
          if (Str::startsWith($rule, 'regex:')) {
            return 'regex:/^[.a-z0-9_-]+$/i';
          }
          
          if (Str::startsWith($rule, 'min:')) {
            return 'min:10';
          }
          
          return $rule;
        }, $rules['username']);

        $event->validator->setRules($rules);
      }
    });
  }),
];

alex-arabadjiev

clarkwinkelmann That works perfectly! Thank you so much for your help!

I saw the Extend\Compat class while searching through the extenders but I didn't know how to use it. It seems that was exactly what I needed.

clarkwinkelmann

EDIT: see a Flarum 1.1 compatible version in https://discuss.flarum.org/d/29506-custom-user-validation-rules-examples

It has come to my attention that my script above has an issue.

When validating only some of the user properties, the validator will be loaded only with the rules to validate. So for example when you edit the user groups or email via the user edit modal, the UserValidator will be used but will not contain a username rule.

This would be the correct code to account for that:

<?php

use Flarum\Extend;
use Flarum\Foundation\Event\Validating;
use Flarum\User\UserValidator;
use Illuminate\Contracts\Events\Dispatcher;
use Illuminate\Support\Str;

return [
  // Register extenders here
  new Extend\Compat(function(Dispatcher $events) {
    $events->listen(Validating::class, function(Validating $event) {
      if ($event->type instanceof UserValidator) {
        $rules = $event->validator->getRules();

        if (!array_key_exists('username', $rules)) {
          return;
        }

        $rules['username'] = array_map(function(string $rule) {
          if (Str::startsWith($rule, 'regex:')) {
            return 'regex:/^[.a-z0-9_-]+$/i';
          }
          
          if (Str::startsWith($rule, 'min:')) {
            return 'min:10';
          }
          
          return $rule;
        }, $rules['username']);

        $event->validator->setRules($rules);
      }
    });
  }),
];

LucasPereira

clarkwinkelmann how could i create a new rule, containing regex in email verification?