mirror of
https://github.com/mcMMO-Dev/mcMMO.git
synced 2024-10-17 17:43:39 +02:00
95f15e68fe
- Scoreboards now AUTO-UPDATE - Scoreboards now COME IN COLOR - If you want, they can come in EVERY COLOR (Config setting) - Scoreboards can be displayed alongside chat output! - Prevention of denial of service to SQL via spamming /mctop using a cooldown - Added /mccooldown command to show cooldowns for all available skills
105 lines
3.3 KiB
Java
105 lines
3.3 KiB
Java
package com.gmail.nossr50.database;
|
|
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
import com.gmail.nossr50.config.Config;
|
|
import com.gmail.nossr50.datatypes.database.DatabaseType;
|
|
import com.gmail.nossr50.datatypes.database.PlayerStat;
|
|
import com.gmail.nossr50.datatypes.player.PlayerProfile;
|
|
import com.gmail.nossr50.datatypes.skills.SkillType;
|
|
|
|
public interface DatabaseManager {
|
|
// One month in milliseconds
|
|
public final long PURGE_TIME = 2630000000L * Config.getInstance().getOldUsersCutoff();
|
|
// During convertUsers, how often to output a status
|
|
public final int progressInterval = 200;
|
|
|
|
/**
|
|
* Purge users with 0 power level from the database.
|
|
*/
|
|
public void purgePowerlessUsers();
|
|
|
|
/**
|
|
* Purge users who haven't logged on in over a certain time frame from the database.
|
|
*/
|
|
public void purgeOldUsers();
|
|
|
|
/**
|
|
* Remove a user from the database.
|
|
*
|
|
* @param playerName The name of the user to remove
|
|
* @return true if the user was successfully removed, false otherwise
|
|
*/
|
|
public boolean removeUser(String playerName);
|
|
|
|
/**
|
|
* Save a user to the database.
|
|
*
|
|
* @param profile The profile of the player to save
|
|
* @return true if successful, false on failure
|
|
*/
|
|
public boolean saveUser(PlayerProfile profile);
|
|
|
|
/**
|
|
* Retrieve leaderboard info.
|
|
*
|
|
* @param skillName The skill to retrieve info on
|
|
* @param pageNumber Which page in the leaderboards to retrieve
|
|
* @param statsPerPage The number of stats per page
|
|
* @return the requested leaderboard information
|
|
*/
|
|
public List<PlayerStat> readLeaderboard(SkillType skill, int pageNumber, int statsPerPage);
|
|
|
|
/**
|
|
* Retrieve rank info into a HashMap from SkillType to the rank.
|
|
* <p>
|
|
* The special value <code>null</code> is used to represent the Power
|
|
* Level rank (the combination of all skill levels).
|
|
*
|
|
* @param playerName The name of the user to retrieve the rankings for
|
|
* @return the requested rank information
|
|
*/
|
|
public Map<SkillType, Integer> readRank(String playerName);
|
|
|
|
/**
|
|
* Add a new user to the database.
|
|
*
|
|
* @param playerName The name of the player to be added to the database
|
|
*/
|
|
public void newUser(String playerName);
|
|
|
|
/**
|
|
* Load a player from the database.
|
|
*
|
|
* @param playerName The name of the player to load from the database
|
|
* @param createNew Whether to create a new record if the player is not
|
|
* found
|
|
* @return The player's data, or an unloaded PlayerProfile if not found
|
|
* and createNew is false
|
|
*/
|
|
public PlayerProfile loadPlayerProfile(String playerName, boolean createNew);
|
|
|
|
/**
|
|
* Get all users currently stored in the database.
|
|
*
|
|
* @return list of playernames
|
|
*/
|
|
public List<String> getStoredUsers();
|
|
|
|
/**
|
|
* Convert all users from this database to the provided database using
|
|
* {@link #saveUser(PlayerProfile)}.
|
|
*
|
|
* @param destination The DatabaseManager to save to
|
|
*/
|
|
public void convertUsers(DatabaseManager destination);
|
|
|
|
/**
|
|
* Retrieve the type of database in use. Custom databases should return CUSTOM.
|
|
*
|
|
* @return The type of database
|
|
*/
|
|
public DatabaseType getDatabaseType();
|
|
}
|