Skip to content

Commit ba0f261

Browse files
Brutus5000bukajsytlos
Brutus5000
authored and
bukajsytlos
committed
Refactor clan creation to be done via Elide POST call
+ other cleanups
1 parent 4680345 commit ba0f261

11 files changed

Lines changed: 304 additions & 191 deletions

File tree

‎src/main/java/com/faforever/api/clan/ClanService.java‎

Lines changed: 53 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,43 +10,75 @@
1010
import com.faforever.api.error.ApiException;
1111
import com.faforever.api.error.Error;
1212
import com.faforever.api.error.ErrorCode;
13-
import com.faforever.api.error.ProgrammingError;
14-
import com.faforever.api.player.PlayerRepository;
1513
import com.faforever.api.player.PlayerService;
1614
import com.faforever.api.security.JwtService;
1715
import com.fasterxml.jackson.databind.ObjectMapper;
1816
import lombok.RequiredArgsConstructor;
1917
import lombok.SneakyThrows;
20-
import org.springframework.security.core.Authentication;
2118
import org.springframework.security.jwt.Jwt;
2219
import org.springframework.stereotype.Service;
20+
import org.springframework.transaction.annotation.Transactional;
21+
import org.springframework.util.Assert;
2322

2423
import java.time.Instant;
2524
import java.time.temporal.ChronoUnit;
2625
import java.util.Set;
26+
import java.util.List;
2727

2828
@Service
2929
@RequiredArgsConstructor
3030
public class ClanService {
3131

3232
private final ClanRepository clanRepository;
33-
private final PlayerRepository playerRepository;
3433
private final FafApiProperties fafApiProperties;
3534
private final JwtService jwtService;
3635
private final ObjectMapper objectMapper;
3736
private final PlayerService playerService;
3837
private final ClanMembershipRepository clanMembershipRepository;
3938

39+
@Transactional
40+
public void preCreate(Clan clan) {
41+
Assert.isNull(clan.getId(), "Clan payload with id can not be used for creation.");
42+
43+
Player player = playerService.getCurrentPlayer();
44+
45+
if (player.getClanMembership() != null) {
46+
throw ApiException.of(ErrorCode.CLAN_CREATE_FOUNDER_IS_IN_A_CLAN);
47+
}
48+
49+
if (!player.equals(clan.getFounder())) {
50+
throw ApiException.of(ErrorCode.CLAN_INVALID_FOUNDER);
51+
}
52+
53+
clanRepository.findOneByName(clan.getName()).ifPresent(c -> {
54+
throw ApiException.of(ErrorCode.CLAN_NAME_EXISTS, clan.getName());
55+
});
56+
57+
clanRepository.findOneByTag(clan.getTag()).ifPresent(c -> {
58+
throw ApiException.of(ErrorCode.CLAN_TAG_EXISTS, clan.getTag());
59+
});
60+
61+
clan.setLeader(player);
62+
clan.setMemberships(List.of(new ClanMembership()
63+
.setClan(clan)
64+
.setPlayer(player)));
65+
}
66+
4067
@SneakyThrows
41-
Clan create(String name, String tag, String description, Player creator) {
68+
@Transactional
69+
@Deprecated
70+
// use preCreate instead
71+
Clan create(String name, String tag, String description) {
72+
Player creator = playerService.getCurrentPlayer();
73+
4274
if (creator.getClanMembership() != null) {
43-
throw new ApiException(new Error(ErrorCode.CLAN_CREATE_FOUNDER_IS_IN_A_CLAN));
75+
throw ApiException.of(ErrorCode.CLAN_CREATE_FOUNDER_IS_IN_A_CLAN);
4476
}
4577
if (clanRepository.findOneByName(name).isPresent()) {
46-
throw new ApiException(new Error(ErrorCode.CLAN_NAME_EXISTS, name));
78+
throw ApiException.of(ErrorCode.CLAN_NAME_EXISTS, name);
4779
}
4880
if (clanRepository.findOneByTag(tag).isPresent()) {
49-
throw new ApiException(new Error(ErrorCode.CLAN_TAG_EXISTS, tag));
81+
throw ApiException.of(ErrorCode.CLAN_TAG_EXISTS, tag);
5082
}
5183

5284
Clan clan = new Clan();
@@ -70,16 +102,18 @@ Clan create(String name, String tag, String description, Player creator) {
70102
}
71103

72104
@SneakyThrows
73-
String generatePlayerInvitationToken(Player requester, int newMemberId, int clanId) {
105+
@Transactional
106+
String generatePlayerInvitationToken(int newMemberId, int clanId) {
107+
Player requester = playerService.getCurrentPlayer();
108+
74109
Clan clan = clanRepository.findById(clanId)
75110
.orElseThrow(() -> new ApiException(new Error(ErrorCode.CLAN_NOT_EXISTS, clanId)));
76111

77112
if (requester.getId() != clan.getLeader().getId()) {
78-
throw new ApiException(new Error(ErrorCode.CLAN_NOT_LEADER, clanId));
113+
throw ApiException.of(ErrorCode.CLAN_NOT_LEADER, clanId);
79114
}
80115

81-
Player newMember = playerRepository.findById(newMemberId)
82-
.orElseThrow(() -> new ApiException(new Error(ErrorCode.CLAN_GENERATE_LINK_PLAYER_NOT_FOUND, newMemberId)));
116+
Player newMember = playerService.getById(newMemberId);
83117

84118
long expire = Instant.now()
85119
.plus(fafApiProperties.getClan().getInviteLinkExpireDurationMinutes(), ChronoUnit.MINUTES)
@@ -92,28 +126,27 @@ String generatePlayerInvitationToken(Player requester, int newMemberId, int clan
92126
}
93127

94128
@SneakyThrows
95-
void acceptPlayerInvitationToken(String stringToken, Authentication authentication) {
129+
@Transactional
130+
void acceptPlayerInvitationToken(String stringToken) {
96131
Jwt token = jwtService.decodeAndVerify(stringToken);
97132
InvitationResult invitation = objectMapper.readValue(token.getClaims(), InvitationResult.class);
98133

99134
if (invitation.isExpired()) {
100-
throw new ApiException(new Error(ErrorCode.CLAN_ACCEPT_TOKEN_EXPIRE));
135+
throw ApiException.of(ErrorCode.CLAN_ACCEPT_TOKEN_EXPIRE);
101136
}
102137

103138
final Integer clanId = invitation.getClan().getId();
104-
Player player = playerService.getPlayer(authentication);
139+
Player player = playerService.getCurrentPlayer();
105140
Clan clan = clanRepository.findById(clanId)
106141
.orElseThrow(() -> new ApiException(new Error(ErrorCode.CLAN_NOT_EXISTS, clanId)));
107142

108-
Player newMember = playerRepository.findById(invitation.getNewMember().getId())
109-
.orElseThrow(() -> new ProgrammingError("ClanMember does not exist: " + invitation.getNewMember().getId()));
110-
143+
Player newMember = playerService.getById(invitation.getNewMember().getId());
111144

112145
if (player.getId() != newMember.getId()) {
113-
throw new ApiException(new Error(ErrorCode.CLAN_ACCEPT_WRONG_PLAYER));
146+
throw ApiException.of(ErrorCode.CLAN_ACCEPT_WRONG_PLAYER);
114147
}
115148
if (newMember.getClan() != null) {
116-
throw new ApiException(new Error(ErrorCode.CLAN_ACCEPT_PLAYER_IN_A_CLAN));
149+
throw ApiException.of(ErrorCode.CLAN_ACCEPT_PLAYER_IN_A_CLAN);
117150
}
118151

119152
ClanMembership membership = new ClanMembership();

‎src/main/java/com/faforever/api/clan/ClansController.java‎

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,12 @@
1111
import io.swagger.annotations.ApiResponses;
1212
import lombok.RequiredArgsConstructor;
1313
import org.springframework.security.access.prepost.PreAuthorize;
14-
import org.springframework.security.core.Authentication;
15-
import org.springframework.transaction.annotation.Transactional;
1614
import org.springframework.web.bind.annotation.GetMapping;
1715
import org.springframework.web.bind.annotation.PostMapping;
1816
import org.springframework.web.bind.annotation.RequestMapping;
1917
import org.springframework.web.bind.annotation.RequestParam;
2018
import org.springframework.web.bind.annotation.RestController;
2119

22-
import java.io.IOException;
2320
import java.io.Serializable;
2421
import java.util.Map;
2522

@@ -40,8 +37,9 @@ public class ClansController {
4037
@ApiResponse(code = 200, message = "Success with JSON { player: {id: ?, login: ?}, clan: { id: ?, name: ?, tag: ?}}"),
4138
@ApiResponse(code = 400, message = "Bad Request")})
4239
@GetMapping(path = "/me", produces = APPLICATION_JSON_VALUE)
43-
public MeResult me(Authentication authentication) {
44-
Player player = playerService.getPlayer(authentication);
40+
@Deprecated // use regular /me route instead
41+
public MeResult me() {
42+
Player player = playerService.getCurrentPlayer();
4543

4644
Clan clan = player.getClan();
4745
ClanResult clanResult = null;
@@ -59,13 +57,11 @@ public MeResult me(Authentication authentication) {
5957
@ApiResponse(code = 400, message = "Bad Request")})
6058
@PostMapping(path = "/create", produces = APPLICATION_JSON_VALUE)
6159
@PreAuthorize("hasRole('ROLE_USER')")
62-
@Transactional
60+
@Deprecated // use POST /data/clans instead (with a founder in relationships)
6361
public Map<String, Serializable> createClan(@RequestParam(value = "name") String name,
6462
@RequestParam(value = "tag") String tag,
65-
@RequestParam(value = "description", required = false) String description,
66-
Authentication authentication) throws IOException {
67-
Player player = playerService.getPlayer(authentication);
68-
Clan clan = clanService.create(name, tag, description, player);
63+
@RequestParam(value = "description", required = false) String description) {
64+
Clan clan = clanService.create(name, tag, description);
6965
return Map.of("id", clan.getId(), "type", "clan");
7066
}
7167

@@ -76,19 +72,14 @@ public Map<String, Serializable> createClan(@RequestParam(value = "name") String
7672
@GetMapping(path = "/generateInvitationLink", produces = APPLICATION_JSON_VALUE)
7773
public Map<String, Serializable> generateInvitationLink(
7874
@RequestParam(value = "clanId") int clanId,
79-
@RequestParam(value = "playerId") int newMemberId,
80-
Authentication authentication) throws IOException {
81-
Player player = playerService.getPlayer(authentication);
82-
String jwtToken = clanService.generatePlayerInvitationToken(player, newMemberId, clanId);
75+
@RequestParam(value = "playerId") int newMemberId) {
76+
String jwtToken = clanService.generatePlayerInvitationToken(newMemberId, clanId);
8377
return Map.of("jwtToken", jwtToken);
8478
}
8579

86-
@ApiOperation("Check invitation link and add Member to Clan")
80+
@ApiOperation("Check invitation link and add member to Clan")
8781
@PostMapping(path = "/joinClan", produces = APPLICATION_JSON_VALUE)
88-
@Transactional
89-
public void joinClan(
90-
@RequestParam(value = "token") String stringToken,
91-
Authentication authentication) throws IOException {
92-
clanService.acceptPlayerInvitationToken(stringToken, authentication);
82+
public void joinClan(@RequestParam(value = "token") String stringToken) {
83+
clanService.acceptPlayerInvitationToken(stringToken);
9384
}
9485
}

‎src/main/java/com/faforever/api/data/domain/Clan.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ public class Clan extends AbstractEntity implements OwnableEntity {
4848
private String description;
4949
private String tagColor;
5050
private String websiteUrl;
51+
private Boolean requiresInvitation = Boolean.TRUE;
5152
private Set<ClanMembership> memberships;
52-
private Boolean requiresInvitation;
5353

5454
@Column(name = "name")
5555
@NotNull

‎src/main/java/com/faforever/api/data/listeners/ClanEnricherListener.java‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
package com.faforever.api.data.listeners;
22

3+
import com.faforever.api.clan.ClanService;
34
import com.faforever.api.config.FafApiProperties;
45
import com.faforever.api.data.domain.Clan;
56
import org.springframework.stereotype.Component;
67

78
import javax.inject.Inject;
89
import javax.persistence.PostLoad;
10+
import javax.persistence.PrePersist;
911

1012
@Component
1113
public class ClanEnricherListener {
1214

1315
private static FafApiProperties fafApiProperties;
16+
private static ClanService clanService;
1417

1518
@Inject
16-
public void init(FafApiProperties fafApiProperties) {
19+
public void init(FafApiProperties fafApiProperties, ClanService clanService) {
1720
ClanEnricherListener.fafApiProperties = fafApiProperties;
21+
ClanEnricherListener.clanService = clanService;
22+
}
23+
24+
@PrePersist
25+
public void prePersist(Clan clan) {
26+
if (clan.getId() == null) {
27+
clanService.preCreate(clan);
28+
}
1829
}
1930

2031
@PostLoad

‎src/main/java/com/faforever/api/error/ErrorCode.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public enum ErrorCode {
6161
CLAN_ACCEPT_PLAYER_IN_A_CLAN(152, "Player is in a clan", "You are already in a clan"),
6262
CLAN_NOT_LEADER(153, "You Permission", "You are not the leader of the clan"),
6363
CLAN_NOT_EXISTS(154, "Cannot find Clan", "Clan with id {0, number} is not available"),
64-
CLAN_GENERATE_LINK_PLAYER_NOT_FOUND(155, "Player not found", "Cannot find player with id {0, number} who should be invited to the clan"),
64+
PLAYER_NOT_FOUND(155, "Player not found", "Cannot find player with id {0, number}."),
6565
CLAN_NAME_EXISTS(156, "Clan Name already in use", "The clan name ''{0}'' is already in use. Please choose a different clan name."),
6666
CLAN_TAG_EXISTS(157, "Clan Tag already in use", "The clan tag ''{0}'' is already in use. Please choose a different clan tag."),
6767
VALIDATION_FAILED(158, "Validation failed", "{0}"),
@@ -100,6 +100,7 @@ public enum ErrorCode {
100100
NO_RUSH_RADIUS_MISSING(190, "No rush radius missing", "The scenario file must specify a no rush radius"),
101101
INVALID_FEATURED_MOD(191, "Invalid featured mod name", "The featured mod name ''{0}'' is not allowed in this context."),
102102
API_KEY_INVALID(192, "Api key is invalid", "The api key is invalid."),
103+
CLAN_INVALID_FOUNDER(193, "Invalid clan founder", "If you create a clan you must be the founder of it."),
103104
UNKNOWN_STEAM_ID(193, "Unable to resolve steam id", "The Steam ID ''{0}'' does not match any account.");
104105

105106

‎src/main/java/com/faforever/api/map/MapsController.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
import io.swagger.annotations.ApiResponses;
1515
import lombok.AllArgsConstructor;
1616
import lombok.extern.slf4j.Slf4j;
17-
import org.springframework.security.core.Authentication;
1817
import org.springframework.web.bind.annotation.RequestMapping;
1918
import org.springframework.web.bind.annotation.RequestMethod;
2019
import org.springframework.web.bind.annotation.RequestParam;
@@ -77,8 +76,7 @@ public void validateScenarioLua(@RequestParam(name = "scenarioLua") String scena
7776
@ApiResponse(code = 500, message = "Failure")})
7877
@RequestMapping(path = "/upload", method = RequestMethod.POST, produces = APPLICATION_JSON_UTF8_VALUE)
7978
public void uploadMap(@RequestParam("file") MultipartFile file,
80-
@RequestParam("metadata") String jsonString,
81-
Authentication authentication) throws IOException {
79+
@RequestParam("metadata") String jsonString) throws IOException {
8280
if (file == null) {
8381
throw new ApiException(new Error(ErrorCode.UPLOAD_FILE_MISSING));
8482
}
@@ -97,7 +95,7 @@ public void uploadMap(@RequestParam("file") MultipartFile file,
9795
throw new ApiException(new Error(ErrorCode.INVALID_METADATA, e.getMessage()));
9896
}
9997

100-
Player player = playerService.getPlayer(authentication);
98+
Player player = playerService.getCurrentPlayer();
10199
mapService.uploadMap(file.getInputStream(), file.getOriginalFilename(), player, ranked);
102100
}
103101
}

‎src/main/java/com/faforever/api/mod/ModsController.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
import com.faforever.api.player.PlayerService;
88
import com.google.common.io.Files;
99
import io.swagger.annotations.ApiOperation;
10-
import org.springframework.security.core.Authentication;
1110
import org.springframework.web.bind.annotation.RequestMapping;
1211
import org.springframework.web.bind.annotation.RequestMethod;
1312
import org.springframework.web.bind.annotation.RequestParam;
@@ -35,7 +34,7 @@ public ModsController(PlayerService playerService, ModService modService, FafApi
3534

3635
@ApiOperation("Upload a mod")
3736
@RequestMapping(path = "/upload", method = RequestMethod.POST, produces = APPLICATION_JSON_UTF8_VALUE)
38-
public void uploadMod(@RequestParam("file") MultipartFile file, Authentication authentication) throws IOException {
37+
public void uploadMod(@RequestParam("file") MultipartFile file) throws IOException {
3938
if (file == null) {
4039
throw new ApiException(new Error(ErrorCode.UPLOAD_FILE_MISSING));
4140
}
@@ -48,6 +47,6 @@ public void uploadMod(@RequestParam("file") MultipartFile file, Authentication a
4847
Path tempFile = java.nio.file.Files.createTempFile("mod", ".tmp");
4948
file.transferTo(tempFile.getFileName().toFile());
5049

51-
modService.processUploadedMod(tempFile, playerService.getPlayer(authentication));
50+
modService.processUploadedMod(tempFile, playerService.getCurrentPlayer());
5251
}
5352
}

‎src/main/java/com/faforever/api/player/PlayerService.java‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,34 @@
22

33
import com.faforever.api.data.domain.Player;
44
import com.faforever.api.error.ApiException;
5-
import com.faforever.api.error.Error;
65
import com.faforever.api.error.ErrorCode;
76
import com.faforever.api.security.FafUserDetails;
87
import lombok.RequiredArgsConstructor;
98
import org.springframework.security.core.Authentication;
9+
import org.springframework.security.core.context.SecurityContextHolder;
1010
import org.springframework.stereotype.Service;
1111

12-
import static com.faforever.api.error.ErrorCode.TOKEN_INVALID;
1312

1413
@Service
1514
@RequiredArgsConstructor
1615
public class PlayerService {
1716

1817
private final PlayerRepository playerRepository;
1918

20-
public Player getPlayer(Authentication authentication) {
19+
public Player getCurrentPlayer() {
20+
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
21+
2122
if (authentication != null
2223
&& authentication.getPrincipal() != null
2324
&& authentication.getPrincipal() instanceof FafUserDetails) {
2425
return playerRepository.findById(((FafUserDetails) authentication.getPrincipal()).getId())
25-
.orElseThrow(() -> new ApiException(new Error(TOKEN_INVALID)));
26+
.orElseThrow(() -> ApiException.of(ErrorCode.TOKEN_INVALID));
2627
}
27-
throw new ApiException(new Error(TOKEN_INVALID));
28+
throw ApiException.of(ErrorCode.TOKEN_INVALID);
2829
}
2930

3031
public Player getById(Integer playerId) {
3132
return playerRepository.findById(playerId)
32-
.orElseThrow(() -> new ApiException(new Error(ErrorCode.ENTITY_NOT_FOUND, playerId)));
33+
.orElseThrow(() -> ApiException.of(ErrorCode.PLAYER_NOT_FOUND, playerId));
3334
}
3435
}

‎src/main/java/com/faforever/api/voting/VotingController.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
import io.swagger.annotations.ApiOperation;
1010
import lombok.RequiredArgsConstructor;
1111
import org.springframework.security.access.prepost.PreAuthorize;
12-
import org.springframework.security.core.Authentication;
1312
import org.springframework.web.bind.annotation.RequestBody;
1413
import org.springframework.web.bind.annotation.RequestMapping;
1514
import org.springframework.web.bind.annotation.RequestMethod;
@@ -31,14 +30,14 @@ public class VotingController {
3130
@ApiOperation(value = "Post a vote")
3231
@PreAuthorize("#oauth2.hasScope('" + OAuthScope._VOTE + "')")
3332
@RequestMapping(path = "/vote", method = RequestMethod.POST, produces = JsonApiMediaType.JSON_API_MEDIA_TYPE)
34-
public void postVote(@RequestBody Vote vote, Authentication authentication) {
35-
votingService.saveVote(vote, playerService.getPlayer(authentication));
33+
public void postVote(@RequestBody Vote vote) {
34+
votingService.saveVote(vote, playerService.getCurrentPlayer());
3635
}
3736

3837
@ApiOperation(value = "See if user can vote on a subject")
3938
@RequestMapping(path = "/votingSubjectsAbleToVote", method = RequestMethod.GET, produces = JsonApiMediaType.JSON_API_MEDIA_TYPE)
40-
public void votingSubjectsAbleTo(HttpServletResponse response, Authentication authentication, HttpServletRequest request) throws IOException {
41-
List<VotingSubject> votingSubjects = votingService.votingSubjectsAbleToVote(playerService.getPlayer(authentication));
39+
public void votingSubjectsAbleTo(HttpServletResponse response, HttpServletRequest request) throws IOException {
40+
List<VotingSubject> votingSubjects = votingService.votingSubjectsAbleToVote(playerService.getCurrentPlayer());
4241
redirectToFilteredVotingSubjects(response, votingSubjects, request);
4342
}
4443

0 commit comments

Comments
 (0)