mirrors
/
freecol
mirror of https://github.com/FreeCol/freecol.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add UUID to high score file, IR#226, GHPR#72.

This commit is contained in:
Mike Pope 2021-04-11 13:17:55 +09:30
parent f2927a344d
commit 17403824f7
3 changed files with 121 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/net/sf/freecol/common/model/Game.java
View File

@ -735,7 +735,7 @@ public class Game extends FreeColGameObject {
* @return The game {@code UUID}.
*/
public UUID getUUID () {
return this.uuid;
return this.uuid;
}
/**

92
src/net/sf/freecol/common/model/HighScore.java
View File

@ -32,6 +32,7 @@ import java.util.Date;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.UUID;
import javax.xml.stream.XMLStreamException;
@ -53,6 +54,9 @@ public class HighScore extends FreeColObject {
public static final String TAG = "highScore";
/** Trivial UUID to used when it is not present in the high score file. */
private static final UUID nullUUID = new UUID(0L, 0L);
/** A comparator by ascending AI object value. */
public static final Comparator<? super HighScore> descendingScoreComparator
= Comparator.comparingInt(HighScore::getScore).reversed();
@ -114,6 +118,9 @@ public class HighScore extends FreeColObject {
/** The nation type that retired. */
private String nationTypeId;
/** The game UUID. */
private UUID gameUUID;
/** The high score. */
private int score;
@ -150,12 +157,15 @@ public class HighScore extends FreeColObject {
/**
* Create a new high score record.
*
* Public for the test suite.
*
* @param player The {@code Player} the score is for.
*/
private HighScore(Player player) {
public HighScore(Player player) {
Game game = player.getGame();
this.date = new Date();
this.retirementTurn = game.getTurn().getNumber();
this.gameUUID = game.getUUID();
this.score = player.getScore();
this.level = find(ScoreLevel.values(),
sl -> sl.getMinimumScore() <= this.score,
@ -190,7 +200,7 @@ public class HighScore extends FreeColObject {
* @return The independence turn.
*/
public final int getIndependenceTurn() {
return independenceTurn;
return this.independenceTurn;
}
/**
@ -199,7 +209,7 @@ public class HighScore extends FreeColObject {
* @return The retirement turn.
*/
public final int getRetirementTurn() {
return retirementTurn;
return this.retirementTurn;
}
/**
@ -208,7 +218,7 @@ public class HighScore extends FreeColObject {
* @return The player name.
*/
public final String getPlayerName() {
return playerName;
return this.playerName;
}
/**
@ -217,7 +227,7 @@ public class HighScore extends FreeColObject {
* @return The nation identifier.
*/
public final String getNationId() {
return nationId;
return this.nationId;
}
/**
@ -229,13 +239,22 @@ public class HighScore extends FreeColObject {
return nationTypeId;
}
/**
* Get the game UUID.
*
* @return The UUID for the game with this score.
*/
public final UUID getGameUUID() {
return this.gameUUID;
}
/**
* Get the final score.
*
* @return The score.
*/
public final int getScore() {
return score;
return this.score;
}
/**
@ -244,7 +263,7 @@ public class HighScore extends FreeColObject {
* @return The score level.
*/
public final ScoreLevel getLevel() {
return level;
return this.level;
}
/**
@ -262,7 +281,7 @@ public class HighScore extends FreeColObject {
* @return The independent nation name.
*/
public final String getNationName() {
return nationName;
return this.nationName;
}
/**
@ -271,7 +290,7 @@ public class HighScore extends FreeColObject {
* @return The new land name.
*/
public final String getNewLandName() {
return newLandName;
return this.newLandName;
}
/**
@ -280,7 +299,7 @@ public class HighScore extends FreeColObject {
* @return The game difficulty key.
*/
public final String getDifficulty() {
return difficulty;
return this.difficulty;
}
/**
@ -289,7 +308,7 @@ public class HighScore extends FreeColObject {
* @return The number of units.
*/
public final int getUnitCount() {
return nUnits;
return this.nUnits;
}
/**
@ -298,7 +317,7 @@ public class HighScore extends FreeColObject {
* @return The number of colonies.
*/
public final int getColonyCount() {
return nColonies;
return this.nColonies;
}
/**
@ -308,7 +327,7 @@ public class HighScore extends FreeColObject {
*/
public final Date getDate() {
// findbugs says not to expose this.date directly
return new Date(date.getTime());
return new Date(this.date.getTime());
}
/**
@ -319,7 +338,7 @@ public class HighScore extends FreeColObject {
public final String getDateString() {
DateFormat format = DateFormat
.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.SHORT);
return format.format(date);
return format.format(this.date);
}
@ -344,14 +363,27 @@ public class HighScore extends FreeColObject {
/**
* Can a given score be added to a high score list.
*
* @param score The score to check.
* @param highScore The {@code HighScore} to check.
* @param scores A list of {@code HighScore} to check against.
* @return True if the given score can be added to the list.
* @return The index of a score to replace, or negative if no replacement.
*/
public static boolean checkHighScore(int score, List<HighScore> scores) {
return /*!FreeColDebugger.isInDebugMode() && */score >= 0
&& (scores.size() < NUMBER_OF_HIGH_SCORES
|| score > scores.get(scores.size()-1).getScore());
public static int checkHighScore(HighScore highScore,
List<HighScore> scores) {
final int nScores = scores.size();
final int score = highScore.getScore();
final UUID uuid = highScore.getGameUUID();
if (uuid.compareTo(nullUUID) != 0) {
// UUID is valid, check for duplicate games
for (int i = nScores-1; i >= 0; i--) {
HighScore hs = scores.get(i);
if (uuid.compareTo(hs.getGameUUID()) == 0
&& score > hs.getScore()) return i; // Replace score i
}
}
return (score >= 0
&& (nScores < NUMBER_OF_HIGH_SCORES
|| score > scores.get(nScores-1).getScore())) ? nScores-1
: -1;
}
/**
@ -363,9 +395,14 @@ public class HighScore extends FreeColObject {
*/
public static boolean newHighScore(Player player) {
List<HighScore> scores = loadHighScores();
if (!checkHighScore(player.getScore(), scores)) return false;
HighScore hs = new HighScore(player);
scores.add(hs);
int idx = checkHighScore(hs, scores);
if (idx < 0) return false;
if (idx < scores.size()) {
scores.set(idx, hs);
} else {
scores.add(hs);
}
tidyScores(scores);
return saveHighScores(scores);
}
@ -459,6 +496,7 @@ public class HighScore extends FreeColObject {
this.playerName = o.getPlayerName();
this.nationId = o.getNationId();
this.nationTypeId = o.getNationTypeId();
this.gameUUID = o.getGameUUID();
this.score = o.getScore();
this.level = o.getLevel();
this.nationName = o.getNationName();
@ -480,6 +518,7 @@ public class HighScore extends FreeColObject {
private static final String COLONIES_TAG = "colonies";
private static final String DATE_TAG = "date";
private static final String DIFFICULTY_TAG = "difficulty";
private static final String GAMEUUID_TAG = "gameUUID";
private static final String INDEPENDENCE_TURN_TAG = "independenceTurn";
private static final String LEVEL_TAG = "level";
private static final String NATION_ID_TAG = "nationId";
@ -512,6 +551,8 @@ public class HighScore extends FreeColObject {
xw.writeAttribute(NATION_TYPE_ID_TAG, nationTypeId);
xw.writeAttribute(GAMEUUID_TAG, gameUUID);
xw.writeAttribute(SCORE_TAG, score);
xw.writeAttribute(LEVEL_TAG, level.toString());
@ -570,6 +611,13 @@ public class HighScore extends FreeColObject {
nationTypeId = xr.getAttribute(NATION_TYPE_ID_TAG, (String)null);
String str = xr.getAttribute(GAMEUUID_TAG, (String)null);
try {
gameUUID = UUID.fromString(str);
} catch (Exception e) {
gameUUID = nullUUID;
}
score = xr.getAttribute(SCORE_TAG, 0);
level = xr.getAttribute(LEVEL_TAG, ScoreLevel.class,

50
test/src/net/sf/freecol/common/model/HighScoreTest.java Normal file
View File

@ -0,0 +1,50 @@
/**
* Copyright (C) 2002-2021 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.common.model;
import java.util.ArrayList;
import java.util.List;
import net.sf.freecol.common.model.HighScore;
import net.sf.freecol.common.model.Nation;
import net.sf.freecol.server.model.ServerPlayer;
import net.sf.freecol.util.test.FreeColTestCase;
public class HighScoreTest extends FreeColTestCase {
public void testAddHighScore() {
Game game = getStandardGame();
assertNotNull(game.getUUID());
Nation dutchNation = spec().getNation("model.nation.dutch");
ServerPlayer player = new ServerPlayer(game, false, dutchNation);
HighScore hs = new HighScore(player);
List<HighScore> scores = new ArrayList<>();
assertEquals(0, HighScore.checkHighScore(hs, scores));
scores.add(hs);
assertEquals(-1, HighScore.checkHighScore(hs, scores));
player.setScore(player.getScore() + 1);
hs = new HighScore(player);
assertEquals(0, HighScore.checkHighScore(hs, scores));
}
}