Replace OfflinePlayer#getLastPlayed

Currently OfflinePlayer#getLastPlayed could more accurately be described
as "OfflinePlayer#getLastTimeTheirDataWasSaved".

The API doc says it should return the last time the server "witnessed"
the player, whilst also saying it should return the last time they
logged in. The current implementation does neither.

Given this interesting contradiction in the API documentation and the
current defacto implementation, I've elected to deprecate (with no
intent to remove) and replace it with two new methods, clearly named and
documented as to their purpose.
This commit is contained in:
Zach Brown
2019-01-02 00:35:43 -06:00
parent f5226d3739
commit f1f016dd5e
4 changed files with 181 additions and 98 deletions

View File

@@ -262,6 +262,61 @@ public class CraftOfflinePlayer implements OfflinePlayer, ConfigurationSerializa
return this.getData() != null;
}
// Paper start
@Override
public long getLastLogin() {
Player player = getPlayer();
if (player != null) return player.getLastLogin();
CompoundTag data = getPaperData();
if (data != null) {
if (data.contains("LastLogin")) {
return data.getLong("LastLogin");
} else {
// if the player file cannot provide accurate data, this is probably the closest we can approximate
File file = getDataFile();
return file.lastModified();
}
} else {
return 0;
}
}
@Override
public long getLastSeen() {
Player player = getPlayer();
if (player != null) return player.getLastSeen();
CompoundTag data = getPaperData();
if (data != null) {
if (data.contains("LastSeen")) {
return data.getLong("LastSeen");
} else {
// if the player file cannot provide accurate data, this is probably the closest we can approximate
File file = getDataFile();
return file.lastModified();
}
} else {
return 0;
}
}
private CompoundTag getPaperData() {
CompoundTag result = getData();
if (result != null) {
if (!result.contains("Paper")) {
result.put("Paper", new CompoundTag());
}
result = result.getCompound("Paper");
}
return result;
}
// Paper end
@Override
public Location getLastDeathLocation() {
if (this.getData().contains("LastDeathLocation", 10)) {

View File

@@ -215,6 +215,7 @@ public class CraftPlayer extends CraftHumanEntity implements Player {
private BorderChangeListener clientWorldBorderListener = this.createWorldBorderListener();
public org.bukkit.event.player.PlayerResourcePackStatusEvent.Status resourcePackStatus; // Paper - more resource pack API
private static final boolean DISABLE_CHANNEL_LIMIT = System.getProperty("paper.disableChannelLimit") != null; // Paper - add a flag to disable the channel limit
private long lastSaveTime; // Paper - getLastPlayed replacement API
public CraftPlayer(CraftServer server, ServerPlayer entity) {
super(server, entity);
@@ -2064,6 +2065,18 @@ public class CraftPlayer extends CraftHumanEntity implements Player {
this.firstPlayed = firstPlayed;
}
// Paper start - getLastPlayed replacement API
@Override
public long getLastLogin() {
return this.getHandle().loginTime;
}
@Override
public long getLastSeen() {
return this.isOnline() ? System.currentTimeMillis() : this.lastSaveTime;
}
// Paper end - getLastPlayed replacement API
public void readExtraData(CompoundTag nbttagcompound) {
this.hasPlayedBefore = true;
if (nbttagcompound.contains("bukkit")) {
@@ -2086,6 +2099,8 @@ public class CraftPlayer extends CraftHumanEntity implements Player {
}
public void setExtraData(CompoundTag nbttagcompound) {
this.lastSaveTime = System.currentTimeMillis(); // Paper
if (!nbttagcompound.contains("bukkit")) {
nbttagcompound.put("bukkit", new CompoundTag());
}
@@ -2100,6 +2115,16 @@ public class CraftPlayer extends CraftHumanEntity implements Player {
data.putLong("firstPlayed", this.getFirstPlayed());
data.putLong("lastPlayed", System.currentTimeMillis());
data.putString("lastKnownName", handle.getScoreboardName());
// Paper start - persist for use in offline save data
if (!nbttagcompound.contains("Paper")) {
nbttagcompound.put("Paper", new CompoundTag());
}
CompoundTag paper = nbttagcompound.getCompound("Paper");
paper.putLong("LastLogin", handle.loginTime);
paper.putLong("LastSeen", System.currentTimeMillis());
// Paper end
}
@Override