3 namespace BookStack\Http\Controllers\Auth;
6 use BookStack\Auth\Access\LoginService;
7 use BookStack\Auth\Access\SocialAuthService;
8 use BookStack\Exceptions\LoginAttemptEmailNeededException;
9 use BookStack\Exceptions\LoginAttemptException;
10 use BookStack\Http\Controllers\Controller;
11 use Illuminate\Foundation\Auth\AuthenticatesUsers;
12 use Illuminate\Http\Request;
13 use Illuminate\Validation\ValidationException;
15 class LoginController extends Controller
18 |--------------------------------------------------------------------------
20 |--------------------------------------------------------------------------
22 | This controller handles authenticating users for the application and
23 | redirecting them to your home screen. The controller uses a trait
24 | to conveniently provide its functionality to your applications.
28 use AuthenticatesUsers;
33 protected $redirectTo = '/';
34 protected $redirectPath = '/';
35 protected $redirectAfterLogout = '/login';
37 protected $socialAuthService;
38 protected $loginService;
41 * Create a new controller instance.
43 public function __construct(SocialAuthService $socialAuthService, LoginService $loginService)
45 $this->middleware('guest', ['only' => ['getLogin', 'login']]);
46 $this->middleware('guard:standard,ldap', ['only' => ['login', 'logout']]);
48 $this->socialAuthService = $socialAuthService;
49 $this->loginService = $loginService;
51 $this->redirectPath = url('/');
52 $this->redirectAfterLogout = url('/login');
55 public function username()
57 return config('auth.method') === 'standard' ? 'email' : 'username';
61 * Get the needed authorization credentials from the request.
63 protected function credentials(Request $request)
65 return $request->only('username', 'email', 'password');
69 * Show the application login form.
71 public function getLogin(Request $request)
73 $socialDrivers = $this->socialAuthService->getActiveDrivers();
74 $authMethod = config('auth.method');
76 if ($request->has('email')) {
77 session()->flashInput([
78 'email' => $request->get('email'),
79 'password' => (config('app.env') === 'demo') ? $request->get('password', '') : '',
83 // Store the previous location for redirect after login
84 $previous = url()->previous('');
85 if ($previous && $previous !== url('/login') && setting('app-public')) {
86 $isPreviousFromInstance = (strpos($previous, url('/')) === 0);
87 if ($isPreviousFromInstance) {
88 redirect()->setIntendedUrl($previous);
92 return view('auth.login', [
93 'socialDrivers' => $socialDrivers,
94 'authMethod' => $authMethod,
99 * Handle a login request to the application.
101 * @param \Illuminate\Http\Request $request
103 * @throws \Illuminate\Validation\ValidationException
105 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response|\Illuminate\Http\JsonResponse
107 public function login(Request $request)
109 $this->validateLogin($request);
110 $username = $request->get($this->username());
112 // If the class is using the ThrottlesLogins trait, we can automatically throttle
113 // the login attempts for this application. We'll key this by the username and
114 // the IP address of the client making these requests into this application.
115 if (method_exists($this, 'hasTooManyLoginAttempts') &&
116 $this->hasTooManyLoginAttempts($request)) {
117 $this->fireLockoutEvent($request);
119 Activity::logFailedLogin($username);
121 return $this->sendLockoutResponse($request);
125 if ($this->attemptLogin($request)) {
126 return $this->sendLoginResponse($request);
128 } catch (LoginAttemptException $exception) {
129 Activity::logFailedLogin($username);
131 return $this->sendLoginAttemptExceptionResponse($exception, $request);
134 // If the login attempt was unsuccessful we will increment the number of attempts
135 // to login and redirect the user back to the login form. Of course, when this
136 // user surpasses their maximum number of attempts they will get locked out.
137 $this->incrementLoginAttempts($request);
139 Activity::logFailedLogin($username);
141 return $this->sendFailedLoginResponse($request);
145 * Attempt to log the user into the application.
147 * @param \Illuminate\Http\Request $request
150 protected function attemptLogin(Request $request)
152 return $this->loginService->attempt(
153 $this->credentials($request), auth()->getDefaultDriver(), $request->filled('remember')
158 * The user has been authenticated.
160 * @param \Illuminate\Http\Request $request
165 protected function authenticated(Request $request, $user)
167 return redirect()->intended($this->redirectPath());
171 * Validate the user login request.
173 * @param \Illuminate\Http\Request $request
175 * @throws \Illuminate\Validation\ValidationException
179 protected function validateLogin(Request $request)
181 $rules = ['password' => 'required|string'];
182 $authMethod = config('auth.method');
184 if ($authMethod === 'standard') {
185 $rules['email'] = 'required|email';
188 if ($authMethod === 'ldap') {
189 $rules['username'] = 'required|string';
190 $rules['email'] = 'email';
193 $request->validate($rules);
197 * Send a response when a login attempt exception occurs.
199 protected function sendLoginAttemptExceptionResponse(LoginAttemptException $exception, Request $request)
201 if ($exception instanceof LoginAttemptEmailNeededException) {
203 session()->flash('request-email', true);
206 if ($message = $exception->getMessage()) {
207 $this->showWarningNotification($message);
210 return redirect('/login');
214 * Get the failed login response instance.
216 * @param \Illuminate\Http\Request $request
218 * @throws \Illuminate\Validation\ValidationException
220 * @return \Symfony\Component\HttpFoundation\Response
222 protected function sendFailedLoginResponse(Request $request)
224 throw ValidationException::withMessages([
225 $this->username() => [trans('auth.failed')],
226 ])->redirectTo('/login');