<%# Copyright 2013-2019 the original author or authors from the JHipster project. This file is part of the JHipster project, see https://www.jhipster.tech/ for more information. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -%> package <%=packageName%>.web.rest; <%_ if (authenticationType === 'oauth2') { _%> import <%=packageName%>.service.UserService; import <%=packageName%>.service.dto.<%= asDto('User') %>; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import javax.servlet.http.HttpServletRequest; import java.security.Principal; /** * REST controller for managing the current user's account. */ @RestController @RequestMapping("/api") public class AccountResource { private static class AccountResourceException extends RuntimeException { private AccountResourceException(String message) { super(message); } } private final Logger log = LoggerFactory.getLogger(AccountResource.class); private final UserService userService; public AccountResource(UserService userService) { this.userService = userService; } /** * {@code GET /authenticate} : check if the user is authenticated, and return its login. * * @param request the HTTP request. * @return the login if the user is authenticated. */ @GetMapping("/authenticate") public String isAuthenticated(HttpServletRequest request) { log.debug("REST request to check if the current user is authenticated"); return request.getRemoteUser(); } /** * {@code GET /account} : get the current user. * * @param principal the current user; resolves to {@code null} if not authenticated. * @return the current user. * @throws AccountResourceException {@code 500 (Internal Server Error)} if the user couldn't be returned. */ @GetMapping("/account") @SuppressWarnings("unchecked") public <%= asDto('User') %> getAccount(Principal principal) { if (principal instanceof OAuth2AuthenticationToken) { return userService.getUserFromAuthentication((OAuth2AuthenticationToken) principal); } else { throw new AccountResourceException("User could not be found"); } } } <%_ } else if (skipUserManagement) { // not oauth, skipUserManagement _%> import <%=packageName%>.security.SecurityUtils; import com.fasterxml.jackson.annotation.JsonCreator; import org.springframework.security.core.GrantedAuthority; import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import java.util.Set; import java.util.stream.Collectors; @RestController @RequestMapping("/api") public class AccountResource { private static class AccountResourceException extends RuntimeException { } /** * {@code GET /account} : get the current user. * * @return the current user. * @throws AccountResourceException {@code 500 (Internal Server Error)} if the user couldn't be returned. */ @GetMapping("/account") public UserVM getAccount() { String login = SecurityUtils.getCurrentUserLogin() .orElseThrow(AccountResourceException::new); Set authorities = SecurityContextHolder.getContext().getAuthentication().getAuthorities().stream() .map(GrantedAuthority::getAuthority) .collect(Collectors.toSet()); return new UserVM(login, authorities); } private static class UserVM { private String login; private Set authorities; @JsonCreator UserVM(String login, Set authorities) { this.login = login; this.authorities = authorities; } public boolean isActivated() { return true; } public Set getAuthorities() { return authorities; } public String getLogin() { return login; } } } <%_ } else { // not oauth, not skipUserManagement _%> <%_ if (authenticationType === 'session' && !reactive) { _%> import <%=packageName%>.domain.PersistentToken; import <%=packageName%>.repository.PersistentTokenRepository; <%_ } _%> <%_ if (!reactive) { _%> import <%=packageName%>.domain.<%= asEntity('User') %>; <%_ } _%> import <%=packageName%>.repository<% if (reactive) { %>.reactive<% } %>.UserRepository; import <%=packageName%>.security.SecurityUtils; import <%=packageName%>.service.MailService; import <%=packageName%>.service.UserService; import <%=packageName%>.service.dto.PasswordChangeDTO; import <%=packageName%>.service.dto.<%= asDto('User') %>; import <%=packageName%>.web.rest.errors.*; import <%=packageName%>.web.rest.vm.KeyAndPasswordVM; import <%=packageName%>.web.rest.vm.ManagedUserVM; import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.http.HttpStatus; import org.springframework.web.bind.annotation.*; <%_ if (reactive) { _%> import org.springframework.web.server.ServerWebExchange; import reactor.core.publisher.Mono; <%_ } _%> <%_ if (!reactive) { _%> import javax.servlet.http.HttpServletRequest; <%_ } _%> import javax.validation.Valid; <%_ if (authenticationType === 'session' && !reactive) { _%> import java.io.UnsupportedEncodingException; import java.net.URLDecoder; <%_ } _%> <%_ if (reactive) { _%> import java.security.Principal; <%_ } _%> <%_ if (!reactive) { _%> import java.util.*; <%_ } _%> /** * REST controller for managing the current user's account. */ @RestController @RequestMapping("/api") public class AccountResource { private static class AccountResourceException extends RuntimeException { private AccountResourceException(String message) { super(message); } } private final Logger log = LoggerFactory.getLogger(AccountResource.class); private final UserRepository userRepository; private final UserService userService; private final MailService mailService; <%_ if (authenticationType === 'session' && !reactive) { _%> private final PersistentTokenRepository persistentTokenRepository; <%_ } _%> public AccountResource(UserRepository userRepository, UserService userService, MailService mailService<% if (authenticationType === 'session' && !reactive) { %>, PersistentTokenRepository persistentTokenRepository<% } %>) { this.userRepository = userRepository; this.userService = userService; this.mailService = mailService; <%_ if (authenticationType === 'session' && !reactive) { _%> this.persistentTokenRepository = persistentTokenRepository; <%_ } _%> } /** * {@code POST /register} : register the user. * * @param managedUserVM the managed user View Model. * @throws InvalidPasswordException {@code 400 (Bad Request)} if the password is incorrect. * @throws EmailAlreadyUsedException {@code 400 (Bad Request)} if the email is already used. * @throws LoginAlreadyUsedException {@code 400 (Bad Request)} if the login is already used. */ @PostMapping("/register") @ResponseStatus(HttpStatus.CREATED) public <% if (reactive) { %>Mono<% } else { %>void<% } %> registerAccount(@Valid @RequestBody ManagedUserVM managedUserVM) { if (!checkPasswordLength(managedUserVM.getPassword())) { throw new InvalidPasswordException(); } <%_ if (!reactive) { _%> <%= asEntity('User') %> user = userService.registerUser(managedUserVM, managedUserVM.getPassword()); mailService.sendActivationEmail(user); <%_ } else { _%> return userService.registerUser(managedUserVM, managedUserVM.getPassword()) .doOnSuccess(mailService::sendActivationEmail) .then(); <%_ } _%> } /** * {@code GET /activate} : activate the registered user. * * @param key the activation key. * @throws RuntimeException {@code 500 (Internal Server Error)} if the user couldn't be activated. */ @GetMapping("/activate") public <% if (reactive) { %>Mono<% } else { %>void<% } %> activateAccount(@RequestParam(value = "key") String key) { <%_ if (!reactive) { _%> Optional<<%= asEntity('User') %>> user = userService.activateRegistration(key); if (!user.isPresent()) { throw new AccountResourceException("No user was found for this activation key"); } <%_ } else { _%> return userService.activateRegistration(key) .switchIfEmpty(Mono.error(new AccountResourceException("No user was found for this activation key"))) .then(); <%_ } _%> } /** * {@code GET /authenticate} : check if the user is authenticated, and return its login. * * @param request the HTTP request. * @return the login if the user is authenticated. */ @GetMapping("/authenticate") <%_ if (!reactive) { _%> public String isAuthenticated(HttpServletRequest request) { log.debug("REST request to check if the current user is authenticated"); return request.getRemoteUser(); <%_ } else { _%> public Mono isAuthenticated(ServerWebExchange request) { log.debug("REST request to check if the current user is authenticated"); return request.getPrincipal().map(Principal::getName); <%_ } _%> } /** * {@code GET /account} : get the current user. * * @return the current user. * @throws RuntimeException {@code 500 (Internal Server Error)} if the user couldn't be returned. */ @GetMapping("/account") public <% if (reactive) { %>Mono<<%= asDto('User') %>><% } else { %><%= asDto('User') %><% } %> getAccount() { return userService.getUserWithAuthorities() .map(<%= asDto('User') %>::new) <%_ if (!reactive) { _%> .orElseThrow(() -> new AccountResourceException("User could not be found")); <%_ } else { _%> .switchIfEmpty(Mono.error(new AccountResourceException("User could not be found"))); <%_ } _%> } /** * {@code POST /account} : update the current user information. * * @param userDTO the current user information. * @throws EmailAlreadyUsedException {@code 400 (Bad Request)} if the email is already used. * @throws RuntimeException {@code 500 (Internal Server Error)} if the user login wasn't found. */ @PostMapping("/account") <%_ if (!reactive) { _%> public void saveAccount(@Valid @RequestBody <%= asDto('User') %> userDTO) { String userLogin = SecurityUtils.getCurrentUserLogin().orElseThrow(() -> new AccountResourceException("Current user login not found")); Optional<<%= asEntity('User') %>> existingUser = userRepository.findOneByEmailIgnoreCase(userDTO.getEmail()); if (existingUser.isPresent() && (!existingUser.get().getLogin().equalsIgnoreCase(userLogin))) { throw new EmailAlreadyUsedException(); } Optional<<%= asEntity('User') %>> user = userRepository.findOneByLogin(userLogin); if (!user.isPresent()) { throw new AccountResourceException("User could not be found"); } userService.updateUser(userDTO.getFirstName(), userDTO.getLastName(), userDTO.getEmail(), userDTO.getLangKey()<% if (['sql', 'mongodb', 'couchbase'].includes(databaseType)) { %>, userDTO.getImageUrl()<% } %>); <%_ } else { _%> public Mono saveAccount(@Valid @RequestBody <%= asDto('User') %> userDTO) { return SecurityUtils.getCurrentUserLogin() .switchIfEmpty(Mono.error(new AccountResourceException("Current user login not found"))) .flatMap(userLogin -> userRepository.findOneByEmailIgnoreCase(userDTO.getEmail()) .filter(existingUser -> !existingUser.getLogin().equalsIgnoreCase(userLogin)) .hasElement() .flatMap(emailExists -> { if (emailExists) { throw new EmailAlreadyUsedException(); } return userRepository.findOneByLogin(userLogin); })) .switchIfEmpty(Mono.error(new AccountResourceException("User could not be found"))) .flatMap(user -> userService.updateUser(userDTO.getFirstName(), userDTO.getLastName(), userDTO.getEmail(), userDTO.getLangKey()<% if (['sql', 'mongodb', 'couchbase'].includes(databaseType)) { %>, userDTO.getImageUrl()<% } %>)); <%_ } _%> } /** * {@code POST /account/change-password} : changes the current user's password. * * @param passwordChangeDto current and new password. * @throws InvalidPasswordException {@code 400 (Bad Request)} if the new password is incorrect. */ @PostMapping(path = "/account/change-password") public <% if (reactive) { %>Mono<% } else { %>void<% } %> changePassword(@RequestBody PasswordChangeDTO passwordChangeDto) { if (!checkPasswordLength(passwordChangeDto.getNewPassword())) { throw new InvalidPasswordException(); } <% if (reactive) { %>return <% } %>userService.changePassword(passwordChangeDto.getCurrentPassword(), passwordChangeDto.getNewPassword()); }<% if (authenticationType === 'session' && !reactive) { %> /** * {@code GET /account/sessions} : get the current open sessions. * * @return the current open sessions. * @throws RuntimeException {@code 500 (Internal Server Error)} if the current open sessions couldn't be retrieved. */ @GetMapping("/account/sessions") public List getCurrentSessions() { return persistentTokenRepository.findByUser( userRepository.findOneByLogin(SecurityUtils.getCurrentUserLogin() .orElseThrow(() -> new AccountResourceException("Current user login not found"))) .orElseThrow(() -> new AccountResourceException("User could not be found")) ); } /** * {@code DELETE /account/sessions?series={series}} : invalidate an existing session. * * - You can only delete your own sessions, not any other user's session * - If you delete one of your existing sessions, and that you are currently logged in on that session, you will * still be able to use that session, until you quit your browser: it does not work in real time (there is * no API for that), it only removes the "remember me" cookie * - This is also true if you invalidate your current session: you will still be able to use it until you close * your browser or that the session times out. But automatic login (the "remember me" cookie) will not work * anymore. * There is an API to invalidate the current session, but there is no API to check which session uses which * cookie. * * @param series the series of an existing session. * @throws UnsupportedEncodingException if the series couldn't be URL decoded. */ @DeleteMapping("/account/sessions/{series}") public void invalidateSession(@PathVariable String series) throws UnsupportedEncodingException { String decodedSeries = URLDecoder.decode(series, "UTF-8"); SecurityUtils.getCurrentUserLogin() .flatMap(userRepository::findOneByLogin) .ifPresent(u -> persistentTokenRepository.findByUser(u).stream() .filter(persistentToken -> StringUtils.equals(persistentToken.getSeries(), decodedSeries))<% if (databaseType === 'sql' || databaseType === 'mongodb') { %> .findAny().ifPresent(t -> persistentTokenRepository.deleteById(decodedSeries)));<% } else if (databaseType === 'couchbase'){ %> .findAny().ifPresent(t -> persistentTokenRepository.deleteBySeries(decodedSeries)));<% } else { %> .findAny().ifPresent(persistentTokenRepository::delete) );<% } %> }<% } %> /** * {@code POST /account/reset-password/init} : Send an email to reset the password of the user. * * @param mail the mail of the user. * @throws EmailNotFoundException {@code 400 (Bad Request)} if the email address is not registered. */ @PostMapping(path = "/account/reset-password/init") <%_ if (!reactive) { _%> public void requestPasswordReset(@RequestBody String mail) { mailService.sendPasswordResetMail( userService.requestPasswordReset(mail) .orElseThrow(EmailNotFoundException::new) ); <%_ } else { _%> public Mono requestPasswordReset(@RequestBody String mail) { return userService.requestPasswordReset(mail) .switchIfEmpty(Mono.error(new EmailNotFoundException())) .doOnSuccess(mailService::sendPasswordResetMail) .then(); <%_ } _%> } /** * {@code POST /account/reset-password/finish} : Finish to reset the password of the user. * * @param keyAndPassword the generated key and the new password. * @throws InvalidPasswordException {@code 400 (Bad Request)} if the password is incorrect. * @throws RuntimeException {@code 500 (Internal Server Error)} if the password could not be reset. */ @PostMapping(path = "/account/reset-password/finish") public <% if (reactive) { %>Mono<% } else { %>void<% } %> finishPasswordReset(@RequestBody KeyAndPasswordVM keyAndPassword) { if (!checkPasswordLength(keyAndPassword.getNewPassword())) { throw new InvalidPasswordException(); } <%_ if (!reactive) { _%> Optional<<%= asEntity('User') %>> user = userService.completePasswordReset(keyAndPassword.getNewPassword(), keyAndPassword.getKey()); if (!user.isPresent()) { throw new AccountResourceException("No user was found for this reset key"); } <%_ } else { _%> return userService.completePasswordReset(keyAndPassword.getNewPassword(), keyAndPassword.getKey()) .switchIfEmpty(Mono.error(new AccountResourceException("No user was found for this reset key"))) .then(); <%_ } _%> } private static boolean checkPasswordLength(String password) { return !StringUtils.isEmpty(password) && password.length() >= ManagedUserVM.PASSWORD_MIN_LENGTH && password.length() <= ManagedUserVM.PASSWORD_MAX_LENGTH; } } <%_ } _%>