AuthenticatesUsers.php 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. <?php
  2. namespace Illuminate\Foundation\Auth;
  3. use Illuminate\Http\JsonResponse;
  4. use Illuminate\Http\Request;
  5. use Illuminate\Support\Facades\Auth;
  6. use Illuminate\Validation\ValidationException;
  7. trait AuthenticatesUsers
  8. {
  9. use RedirectsUsers, ThrottlesLogins;
  10. /**
  11. * Show the application's login form.
  12. *
  13. * @return \Illuminate\View\View
  14. */
  15. public function showLoginForm()
  16. {
  17. return view('auth.login');
  18. }
  19. /**
  20. * Handle a login request to the application.
  21. *
  22. * @param \Illuminate\Http\Request $request
  23. * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response|\Illuminate\Http\JsonResponse
  24. *
  25. * @throws \Illuminate\Validation\ValidationException
  26. */
  27. public function login(Request $request)
  28. {
  29. $this->validateLogin($request);
  30. // If the class is using the ThrottlesLogins trait, we can automatically throttle
  31. // the login attempts for this application. We'll key this by the username and
  32. // the IP address of the client making these requests into this application.
  33. if (method_exists($this, 'hasTooManyLoginAttempts') &&
  34. $this->hasTooManyLoginAttempts($request)) {
  35. $this->fireLockoutEvent($request);
  36. return $this->sendLockoutResponse($request);
  37. }
  38. if ($this->attemptLogin($request)) {
  39. if ($request->hasSession()) {
  40. $request->session()->put('auth.password_confirmed_at', time());
  41. }
  42. return $this->sendLoginResponse($request);
  43. }
  44. // If the login attempt was unsuccessful we will increment the number of attempts
  45. // to login and redirect the user back to the login form. Of course, when this
  46. // user surpasses their maximum number of attempts they will get locked out.
  47. $this->incrementLoginAttempts($request);
  48. return $this->sendFailedLoginResponse($request);
  49. }
  50. /**
  51. * Validate the user login request.
  52. *
  53. * @param \Illuminate\Http\Request $request
  54. * @return void
  55. *
  56. * @throws \Illuminate\Validation\ValidationException
  57. */
  58. protected function validateLogin(Request $request)
  59. {
  60. $request->validate([
  61. $this->username() => 'required|string',
  62. 'password' => 'required|string',
  63. ]);
  64. }
  65. /**
  66. * Attempt to log the user into the application.
  67. *
  68. * @param \Illuminate\Http\Request $request
  69. * @return bool
  70. */
  71. protected function attemptLogin(Request $request)
  72. {
  73. return $this->guard()->attempt(
  74. $this->credentials($request), $request->boolean('remember')
  75. );
  76. }
  77. /**
  78. * Get the needed authorization credentials from the request.
  79. *
  80. * @param \Illuminate\Http\Request $request
  81. * @return array
  82. */
  83. protected function credentials(Request $request)
  84. {
  85. return $request->only($this->username(), 'password');
  86. }
  87. /**
  88. * Send the response after the user was authenticated.
  89. *
  90. * @param \Illuminate\Http\Request $request
  91. * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\JsonResponse
  92. */
  93. protected function sendLoginResponse(Request $request)
  94. {
  95. $request->session()->regenerate();
  96. $this->clearLoginAttempts($request);
  97. if ($response = $this->authenticated($request, $this->guard()->user())) {
  98. return $response;
  99. }
  100. return $request->wantsJson()
  101. ? new JsonResponse([], 204)
  102. : redirect()->intended($this->redirectPath());
  103. }
  104. /**
  105. * The user has been authenticated.
  106. *
  107. * @param \Illuminate\Http\Request $request
  108. * @param mixed $user
  109. * @return mixed
  110. */
  111. protected function authenticated(Request $request, $user)
  112. {
  113. //
  114. }
  115. /**
  116. * Get the failed login response instance.
  117. *
  118. * @param \Illuminate\Http\Request $request
  119. * @return \Symfony\Component\HttpFoundation\Response
  120. *
  121. * @throws \Illuminate\Validation\ValidationException
  122. */
  123. protected function sendFailedLoginResponse(Request $request)
  124. {
  125. throw ValidationException::withMessages([
  126. $this->username() => [trans('auth.failed')],
  127. ]);
  128. }
  129. /**
  130. * Get the login username to be used by the controller.
  131. *
  132. * @return string
  133. */
  134. public function username()
  135. {
  136. return 'email';
  137. }
  138. /**
  139. * Log the user out of the application.
  140. *
  141. * @param \Illuminate\Http\Request $request
  142. * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\JsonResponse
  143. */
  144. public function logout(Request $request)
  145. {
  146. $this->guard()->logout();
  147. $request->session()->invalidate();
  148. $request->session()->regenerateToken();
  149. if ($response = $this->loggedOut($request)) {
  150. return $response;
  151. }
  152. return $request->wantsJson()
  153. ? new JsonResponse([], 204)
  154. : redirect('/');
  155. }
  156. /**
  157. * The user has logged out of the application.
  158. *
  159. * @param \Illuminate\Http\Request $request
  160. * @return mixed
  161. */
  162. protected function loggedOut(Request $request)
  163. {
  164. //
  165. }
  166. /**
  167. * Get the guard to be used during authentication.
  168. *
  169. * @return \Illuminate\Contracts\Auth\StatefulGuard
  170. */
  171. protected function guard()
  172. {
  173. return Auth::guard();
  174. }
  175. }