mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 01:36:00 -04:00
3991fbe726
- Added tests to cover
118 lines
3.8 KiB
PHP
118 lines
3.8 KiB
PHP
<?php namespace BookStack\Auth\Access;
|
|
|
|
use BookStack\Auth\SocialAccount;
|
|
use BookStack\Auth\User;
|
|
use BookStack\Auth\UserRepo;
|
|
use BookStack\Exceptions\UserRegistrationException;
|
|
use Exception;
|
|
|
|
class RegistrationService
|
|
{
|
|
|
|
protected $userRepo;
|
|
protected $emailConfirmationService;
|
|
|
|
/**
|
|
* RegistrationService constructor.
|
|
*/
|
|
public function __construct(UserRepo $userRepo, EmailConfirmationService $emailConfirmationService)
|
|
{
|
|
$this->userRepo = $userRepo;
|
|
$this->emailConfirmationService = $emailConfirmationService;
|
|
}
|
|
|
|
/**
|
|
* Check whether or not registrations are allowed in the app settings.
|
|
* @throws UserRegistrationException
|
|
*/
|
|
public function ensureRegistrationAllowed()
|
|
{
|
|
if (!$this->registrationAllowed()) {
|
|
throw new UserRegistrationException(trans('auth.registrations_disabled'), '/login');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if standard BookStack User registrations are currently allowed.
|
|
* Does not prevent external-auth based registration.
|
|
*/
|
|
protected function registrationAllowed(): bool
|
|
{
|
|
$authMethod = config('auth.method');
|
|
$authMethodsWithRegistration = ['standard'];
|
|
return in_array($authMethod, $authMethodsWithRegistration) && setting('registration-enabled');
|
|
}
|
|
|
|
/**
|
|
* The registrations flow for all users.
|
|
* @throws UserRegistrationException
|
|
*/
|
|
public function registerUser(array $userData, ?SocialAccount $socialAccount = null, bool $emailConfirmed = false): User
|
|
{
|
|
$userEmail = $userData['email'];
|
|
|
|
// Email restriction
|
|
$this->ensureEmailDomainAllowed($userEmail);
|
|
|
|
// Ensure user does not already exist
|
|
$alreadyUser = !is_null($this->userRepo->getByEmail($userEmail));
|
|
if ($alreadyUser) {
|
|
throw new UserRegistrationException(trans('errors.error_user_exists_different_creds', ['email' => $userEmail]));
|
|
}
|
|
|
|
// Create the user
|
|
$newUser = $this->userRepo->registerNew($userData, $emailConfirmed);
|
|
|
|
// Assign social account if given
|
|
if ($socialAccount) {
|
|
$newUser->socialAccounts()->save($socialAccount);
|
|
}
|
|
|
|
// Start email confirmation flow if required
|
|
if ($this->emailConfirmationService->confirmationRequired() && !$emailConfirmed) {
|
|
$newUser->save();
|
|
$message = '';
|
|
|
|
try {
|
|
$this->emailConfirmationService->sendConfirmation($newUser);
|
|
} catch (Exception $e) {
|
|
$message = trans('auth.email_confirm_send_error');
|
|
}
|
|
|
|
throw new UserRegistrationException($message, '/register/confirm');
|
|
}
|
|
|
|
return $newUser;
|
|
}
|
|
|
|
/**
|
|
* Ensure that the given email meets any active email domain registration restrictions.
|
|
* Throws if restrictions are active and the email does not match an allowed domain.
|
|
* @throws UserRegistrationException
|
|
*/
|
|
protected function ensureEmailDomainAllowed(string $userEmail): void
|
|
{
|
|
$registrationRestrict = setting('registration-restrict');
|
|
|
|
if (!$registrationRestrict) {
|
|
return;
|
|
}
|
|
|
|
$restrictedEmailDomains = explode(',', str_replace(' ', '', $registrationRestrict));
|
|
$userEmailDomain = $domain = mb_substr(mb_strrchr($userEmail, "@"), 1);
|
|
if (!in_array($userEmailDomain, $restrictedEmailDomains)) {
|
|
$redirect = $this->registrationAllowed() ? '/register' : '/login';
|
|
throw new UserRegistrationException(trans('auth.registration_email_domain_invalid'), $redirect);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Alias to the UserRepo method of the same name.
|
|
* Attaches the default system role, if configured, to the given user.
|
|
*/
|
|
public function attachDefaultRole(User $user): void
|
|
{
|
|
$this->userRepo->attachDefaultRole($user);
|
|
}
|
|
|
|
} |