3 namespace BookStack\Auth\Access;
5 use BookStack\Actions\ActivityType;
6 use BookStack\Auth\SocialAccount;
7 use BookStack\Auth\User;
8 use BookStack\Auth\UserRepo;
9 use BookStack\Exceptions\UserRegistrationException;
10 use BookStack\Facades\Activity;
11 use BookStack\Facades\Theme;
12 use BookStack\Theming\ThemeEvents;
14 use Illuminate\Support\Str;
16 class RegistrationService
19 protected $emailConfirmationService;
22 * RegistrationService constructor.
24 public function __construct(UserRepo $userRepo, EmailConfirmationService $emailConfirmationService)
26 $this->userRepo = $userRepo;
27 $this->emailConfirmationService = $emailConfirmationService;
31 * Check whether or not registrations are allowed in the app settings.
33 * @throws UserRegistrationException
35 public function ensureRegistrationAllowed()
37 if (!$this->registrationAllowed()) {
38 throw new UserRegistrationException(trans('auth.registrations_disabled'), '/login');
43 * Check if standard BookStack User registrations are currently allowed.
44 * Does not prevent external-auth based registration.
46 protected function registrationAllowed(): bool
48 $authMethod = config('auth.method');
49 $authMethodsWithRegistration = ['standard'];
51 return in_array($authMethod, $authMethodsWithRegistration) && setting('registration-enabled');
55 * Attempt to find a user in the system otherwise register them as a new
56 * user. For use with external auth systems since password is auto-generated.
57 * @throws UserRegistrationException
59 public function findOrRegister(string $name, string $email, string $externalId): User
62 ->where('external_auth_id', '=', $externalId)
69 'password' => Str::random(32),
70 'external_auth_id' => $externalId,
73 $user = $this->registerUser($userData, null, false);
80 * The registrations flow for all users.
82 * @throws UserRegistrationException
84 public function registerUser(array $userData, ?SocialAccount $socialAccount = null, bool $emailConfirmed = false): User
86 $userEmail = $userData['email'];
89 $this->ensureEmailDomainAllowed($userEmail);
91 // Ensure user does not already exist
92 $alreadyUser = !is_null($this->userRepo->getByEmail($userEmail));
94 throw new UserRegistrationException(trans('errors.error_user_exists_different_creds', ['email' => $userEmail]), '/login');
98 $newUser = $this->userRepo->registerNew($userData, $emailConfirmed);
100 // Assign social account if given
101 if ($socialAccount) {
102 $newUser->socialAccounts()->save($socialAccount);
105 Activity::add(ActivityType::AUTH_REGISTER, $socialAccount ?? $newUser);
106 Theme::dispatch(ThemeEvents::AUTH_REGISTER, $socialAccount ? $socialAccount->driver : auth()->getDefaultDriver(), $newUser);
108 // Start email confirmation flow if required
109 if ($this->emailConfirmationService->confirmationRequired() && !$emailConfirmed) {
113 $this->emailConfirmationService->sendConfirmation($newUser);
114 session()->flash('sent-email-confirmation', true);
115 } catch (Exception $e) {
116 $message = trans('auth.email_confirm_send_error');
118 throw new UserRegistrationException($message, '/register/confirm');
126 * Ensure that the given email meets any active email domain registration restrictions.
127 * Throws if restrictions are active and the email does not match an allowed domain.
129 * @throws UserRegistrationException
131 protected function ensureEmailDomainAllowed(string $userEmail): void
133 $registrationRestrict = setting('registration-restrict');
135 if (!$registrationRestrict) {
139 $restrictedEmailDomains = explode(',', str_replace(' ', '', $registrationRestrict));
140 $userEmailDomain = $domain = mb_substr(mb_strrchr($userEmail, '@'), 1);
141 if (!in_array($userEmailDomain, $restrictedEmailDomains)) {
142 $redirect = $this->registrationAllowed() ? '/register' : '/login';
144 throw new UserRegistrationException(trans('auth.registration_email_domain_invalid'), $redirect);