+ + +# Backup Locations + +The backups are stored in the directory: + +`plugins/Prison/backups/` + +None of the backups are ever removed automatically. If they are to be removed, they must manually be removed. + +
+ + + +# The versions.log file + +All backups are logged in the file: +`plugins/Prison/backups/versions.log` + +Also all detections of version changes for Prison are logged in this file, which is how prison detects when a new version of prison is being used. + +It should be noted that only the last entry in the versions.log file is used to compare to the current version, and if the versions do not match, then it forces a version change backup. The important point here is that "any" change will be detected and trigger a backup, which will work if downgraded or if it skips many versions. + +
+ + + +# The "Backup Stats" Report + +Within each backup, there will be generated one Backup Stats report that will be placed at the root directory of the backup. It is a plain text file. + +This report contains detailed information on what temporary files were backed up and then deleted. + +The rest of this report is a dump of all of the `/prison suppor submit` documents, all combined together in to one document. + +
+ + + +# The Auto Backup on Version Change Detection + + +The problem with backing up the files within Prison upon startup, is that the Backup Stats file cannot be generated because all of the sub-systems that build that report, have not yet been loaded. But there is a risk that on a version update, the original configuration files may be automatically backed up. + +To deal with this issue of starting up and potential changes to the config files, prison, upon startup, will make a backup of all config files. That way, if any are updated upon startup, their prior state and format will have been preserved as a backup file. + +The list of configuration files that are copied as backup files: + + - config.yml + - autoFeaturesConfig.yml + - blockConvertersConfig.json + - modules.yml + - module_conf/mines/mineBombsConfig.json + - SellAllConfig.yml + - GuiConfig.yml + - backpacks/backpacksconfig.yml + +All of these files are copied with a new name that follows this format: +`
+ + + +# Temporary Files Will Be Purged after being Backed Up + + +Prison Backups will identify various temporary files. These files will be added to the current backup, and then they will be removed from the server's file system. + +This is a list of identifiers that are used to detect temporary files, where `*` is a wild-card character. + + - `*.bu` + - `*.temp` + - `*.del` + - `_archived_*` + - `*.json.ver_*.txt` + +**Warning:** When temporary files are backed up, they are removed from the server's file system. Therefore the **only** copy of those files are within that specific backup file. Therefore, it is very important that you do not delete these backup files without careful consideration. Deleting them will mean the permanent loss of those files. + + + + + +
+ diff --git a/docs/prison_docs_115_using_BlockEvents.md b/docs/prison_docs_115_using_BlockEvents.md index 0b239dc31..610bf9364 100644 --- a/docs/prison_docs_115_using_BlockEvents.md +++ b/docs/prison_docs_115_using_BlockEvents.md @@ -4,16 +4,16 @@ # BlockEvents -Prison's BlockEvents provides a way to fire commands when a block is broken by a player. Every BlockEvent must have a chance which can range from 0.0000 percent to 100.0 percent. Optionally, you can tie the block event to a permission, to an event type, and for Token Enchant explosions you can filter on the enchantment type that triggered that explosion. You can also filter on a Crazy Enchant blast too. Soon, BlockEvents will be able to filter on block types too. +Prison's BlockEvents provides a way to fire commands when a block is broken by a player. Every BlockEvent must have a chance which can range from 0.0000 percent to 100.0 percent. Optionally, you can tie the block event to a permission, to an event type, and for Token Enchant explosions you can filter on the enchantment type that triggered that explosion. You can also filter on a Crazy Enchant blast too. BlockEvents can even filter on block types so you can only trigger an even on a specific block type. -A single BlockEvent can also have more than one command that is ran together with each command separated by a semi-colon. ";" +A single BlockEvent can consist of more than one command that is ran together with each command separated by a semi-colon. ";" BlockEvents have a taskMode that defines how the specified commands are to be ran. -*Documented updated: 2021-12-03* +*Documented updated: 2022-08-06*
@@ -22,8 +22,9 @@ BlockEvents have a taskMode that defines how the specified commands are to be ra BlockEvents can be access through the command prefixes of: `/mines blockEvent` +`/mines blockEvent block` -There are 9 sub-commands, which includes add and list, which are probably the most important of the commands. +There are 10 sub-commands (two under blocks), which includes add and list, which are probably the most important of the commands.
@@ -38,14 +39,30 @@ The BlockEvent listings can also be included in the following command by includi
## Use of Row Numbers In The BlockEvent Commands:
- Due to the complexity of the blockEvent commands being deeply nested, and there could be so many of them, many of the blockEvent commands uses a **Row** identifier. This row identifier is based upon the order of the commands as listed under the `/mines blockEvent list` command.
+ Due to the complexity of the blockEvent commands being deeply nested, and there could be so many of them, many of the blockEvent commands uses a **Row** identifier to select the blockEvent of interest. This row identifier is based upon the order of the commands as listed under the `/mines blockEvent list` command.
+
+
+All of the blockEvent commands now supports displaying the current list of rows by completing the blockEvent command up to the required mine name. When pressing enter to submit the incomplete command, it will then show the list of rows.
+
A number of examples of a few different blockEvets is as follows. Emphasis is on the row numbers.
+
+# Starting with BlockEvents - Add a new BlockEvent
+
+It is strongly suggested that you first review the help on the following command:
+
+`/mines blockEvent add help`
+
+
+That will show the current information on blockEvents. It's also important to understand that the list of **placeholders** is also critical since it provides a great deal of power and flexibility in what commands can be crafted. See the next section on **BlockEvents Placeholders**.
+
+
+The first step of creating blockEvents, is to add them. There are a lot of options that can be used for customizing them and they can become rather complicated, so the add function only requires a percentage value since all other options are optional, and some may not be used.
# BlockEvents Placeholders
@@ -55,12 +72,33 @@ Within the BlockEvents commands you can use placeholders and Prison will substit
For a current list of all blockEvent commands use **placeholders** keyword with the **add** command:
+`/mines blockEvent add help`
+
`/mines blockEvent add placeholders`
`{player} {player_uid} {msg} {broadcast} {title} {actionBar} {inline} {inlinePlayer} {sync} {syncPlayer} {blockName} {mineName} {locationWorld} {locationX} {locationY} {locationZ} {coordinates} {worldCoordinates} {blockCoordinates} {blockChance} {blockIsAir} {blocksPlaced} {blockRemaining} {blocksMinedTotal} {mineBlocksRemaining} {mineBlocksRemainingPercent} {mineBlocksTotalMined} {mineBlocksSize} {blockMinedName} {blockMinedNameFormal} {blockMinedBlockType} {eventType} {eventTriggered} {utilsDecay}`
+
+Some examples showing how to use placeholders in the blockEvents.
+
+
+```
+/mines blockEvent add a 100 {utilsDecay} rainbow {blockCoordinates} AIR 40 {mineName}
+
+/mines blockevent add A 0.075 prison utils repairAll {player};{actionBar}Your items have been repaired!
+
+/mines blockevent add A 1 prison utils smelt {player}
+
+/mines blockEvent add A 5.0 prison utils potionEffect speed 90 2;prison utils potionEffect night_vision 300 1
+
+```
+
+
+Placeholders Explained
+ + - **{player}** Provides the player's name. @@ -98,27 +136,11 @@ There are four **taskModes** on how BlockEvent commands run. The taskModes can b - **{syncPlayer}** This placeholder is similar to the **{sync}** placeholder, with the exception the commands are ran as the player, so the player must have access to those commands. -NOTE: It is impossible to run a command asynchronously, since the execution of a command must always be in a synchronous thread. Hence you can submit an async task, but then when you run the command, it does so in a sync thread. +NOTE: It is impossible to run a command asynchronously, since the execution of a command must always be in a synchronous thread. Hence you can submit an async task, but then when you run the command, it does so in a sync thread. This explanation may not make a lot of sense, but it creates an additional task, but fails to run in asynchronous mode since it's impossible so it's not even worth using it. -`/mines blockEvent add help` -`/mines blockEvent add placeholders` - - -Some examples showing how to use placeholders in the blockEvents. -``` - -/mines blockEvent add a 100 {utilsDecay} rainbow {blockCoordinates} AIR 40 {mineName} - -/mines blockevent add A 0.075 prison utils repairAll {player};{actionBar}Your items have been repaired! - -/mines blockevent add A 1 prison utils smelt {player} - -/mines blockEvent add A 5.0 prison utils potionEffect speed 90 2;prison utils potionEffect night_vision 300 1 - -``` - **{blockName}** The name of the block that was placed in the mine during the last mine reset. The same name as used and provided within the command `/mines block search`. @@ -206,7 +228,7 @@ The BlockEvent command that is used must be be runnable from the console. It is The structure of the command should be the same as within the console. Do not include a a leading /. Do not quote the command. Use the placeholders mentioned above for referring to the players. -Move than one command can be chained together by using a semi-colon between the commands. The commands do not need to end with a semi-colon. No space needs to follow a semi-colon before the next command. There is no limit imposed upon the length of a command, or commands, but the max length may be controlled by outside factors such as ingame text message constraints. Hence why it may be advisable to enter long commands through the console. +Move than one command can be chained together by using a semi-colon between the commands. The commands do not need to end with a semi-colon. No space needs to follow a semi-colon before the next command. There is no limit imposed upon the length of a command, or commands, but the max length may be controlled by outside factors such as in-game text message constraints. Hence why it may be advisable to enter long commands through the console. See the above examples on how to enter the commands when setting up a BlockEvent. @@ -216,7 +238,7 @@ See the above examples on how to enter the commands when setting up a BlockEvent -# BlockEvents Chance +# BlockEvents Percent Chance The chance that is tied to a block event can range from 100 percent to as low as 0.0001 percent. @@ -324,19 +346,97 @@ You must enter the correct value for this triggered command as used by Token Enc # BlockEvents Blocks -Coming soon. Not yet available. +You can filter blockEvents by block types. You have to already have setup a block command to add a block filter. + + +For example if you only want a specific blockEvent to be fired when redstone is broken. + + +The following shows the available commands: + +`/mines blockEvent block` + + +You can only add and remove blocks. The commands will help step you through selecting the correct values. + + +First, if using the **block add** command, only enter the mine name and press enter. Let's assume we are working with mine A: + + +`/mines blockEvent block add a` + + +This incomplete **block add** command will show you all of the existing block events for mine A. From the list, it will show the row number for each blockEvent. + +``` +>mines blockEvent block add a + --- < Add blocks to a BlockEvent for [A] > ------ (3.3.0-alpha.12e) + Hover over values for more information and clickable actions. + * Row: 1 75.00000% [] all (sync) 'say How's it going?' + * Blocks: [cobblestone iron_ore] + * Row: 2 5.00000% [] all (inline) 'prison utils potionEffect {player} night_vision 600 2' + * Row: 3 25.00000% [] all (inline) '{msg} night vision!;prison utils potionEffect {player} night_vision 600 2' + * Row: 4 0.01000% [] all (inline) '{msg}Hey this is a test Message!' + * Row: 5 100.00000% [] all (inline) '{utilsDecay} obby {blockCoordinates} AIR 40 {mineName}' + * Blocks: [cobblestone] + Select a BlockEvent by row number to add a block + /mines blockEvent block add A [rowBlockEvent] [rowBlockName] + +``` + +Press the **-# BlockEvents +# BlockEvents ect... + + +More to be added
diff --git a/docs/prison_docs_120_setting_up_BlockConverters.md b/docs/prison_docs_120_setting_up_BlockConverters.md new file mode 100644 index 000000000..8984cc1c6 --- /dev/null +++ b/docs/prison_docs_120_setting_up_BlockConverters.md @@ -0,0 +1,111 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +# BlockConverters + + +Block Converters are a powerful new feature that is used within the Auto Features. +Block Converters provides for a very dynamic way to customize the processing of all block +behaviors within the Auto Features, such as selecting which blocks are to be processed +by the auto features (auto pickup, auto smelt, and auto blocking). + + +Block Converters really shine by being using a given block type to figure out what to +**convert** it to. These conversions are used by smelting and blocking, where is there one +block type as an input, but the output can be none, one, or more other blocks or items. + + +These conversions are powerful in their own right, but what makes them even more powerful, +is that both the input and output blocks can be selectively controlled by permissions. +This type of selectivity can provide a very dynamic result that can vary for each player. +This "filtering" can be used to give different results (blocks) to different players. +For example, the in terms of smelting or blocking, different players, because of their perms, +could get different results and quantities, including multiple items. + + + +*Documented updated: 2022-06-255* + +
+ + +# Editing Block Converters + +There are no in game commands to configure Block Converters. You must manually edit the +configuration file to set up the Block Converters. There is a possibility that a misconfiguration will +result in unexpected behavior or complete failure. Therefore, follow this documentation carefully. + + +If you have questions, please contact our discord server for help. + + +The file to edit: + +`plugins/Prison/BlockConvertersConfig.json` + + +This configuration file is in the JSON format, and therefore, if the json format is made invalid, +then none of the conifgs will be loaded. You can use an online web site to validate and fix invalid +json structures. + +
+ + + +# Block Names + + +The names used to identify the blocks, and or items, must be something that prison understands, and +what can be converted to valid bukkit item stacks so they can be given to the players. + + + +Block names are mostly tied to the names as found within the XSeries' XMaterial object. This helps +to provide a unified name, of which the bukkit names for many items and blocks have changed a number +of times between Spigot 1.8 through Spigot 1.19. Some of the bukkit names actually conflicts with +prior version's names. So this is how prison can provide consistency. If there is a custom +block named, then it will need to include the namespace, a colon, followed by the name. +Example of a custom block name: **CustomItem:compressedCobblestone**. + + + +The best way to ensure you are using the correct names, use the block search to get the names that +prison will understand. There are two different types of block search that you can use, the primary +search excludes non-blocks. + + +``` +/mines block search help +/mines block search stone 3 +``` + + +The following search includes items. Do not use items for a **keyBlockName** or the key for a +BlockConverter since it will never be used. + + +``` +/mines block searchAll help +/mines block searchAll chest +/mines block searchAll gold 2 +``` + + + + +
+ + + +# Block Converters - Enabling Auto Features and Normal Drops + + +Within the `blockConvertersConfig.json` file, are major groups of Block Converters. The group +name **autoPickupFeatures** identifies which blocks can be processed. If a block is not included +in this list, then it will be ignored. NOTE: ignored/excluded blocks may, or may not, be breakable. + + +
+ + diff --git a/docs/prison_docs_130_Prison_Mine_Bombs.md b/docs/prison_docs_130_Prison_Mine_Bombs.md new file mode 100644 index 000000000..53d4d2476 --- /dev/null +++ b/docs/prison_docs_130_Prison_Mine_Bombs.md @@ -0,0 +1,46 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +# Prison Mine Bombs + + +Prison mine bombs... + +*Note: this document is a work in progress.* + + +*Documented updated: 2022-08-06* + +
+ + +Commands: + +``` +/prison utils bomb list help +/prison utils bomb reload +/prison utils bomb give help + +/prison utils bombs help +``` + + + +
+ + +# Prison Mine Bombs Config File + +The Prison Mine Bombs use a configuration file to customize the mine bombs. There are no in-game commands to edit the settings. + +The location of the configuration file is: + +`plugins/Prison/module_conf/mines/mineBombsConfig.json` + + +If this file does not exist, you can have prison auto generate it by using any of the above mine bomb commands. The best may be + +
+
+ diff --git a/docs/prison_docs_310_guide_placeholders.md b/docs/prison_docs_310_guide_placeholders.md index d77a90ddb..1d9b8707e 100644 --- a/docs/prison_docs_310_guide_placeholders.md +++ b/docs/prison_docs_310_guide_placeholders.md @@ -7,7 +7,7 @@ This document covers different aspects of placeholders within Prison. It explains how they work, how to use them, and different ways to use them. -*Documented updated: 2021-12-03* +*Documented updated: 2022-08-14*
@@ -17,7 +17,7 @@ This document covers different aspects of placeholders within Prison. It explai Placeholders allow the sharing of data from one plugin with another plugin, and without either plugin knowing anything about each other. -On the surface they appear to be simple, but there are a lot of moving parts below the surface, and with Prison Mines, there are even more complicated things going on. +On the surface they appear to be simple, but there are a lot of moving parts below the surface, and with Prison, there are even more complicated things going on. Add in to the mix, that different plugins deal with placeholders in slightly different ways, and you can wind up with a challenge to get them to work under different circumstances. @@ -39,13 +39,36 @@ Sub-command listing of all placeholders commands: * **/prison placeholders** +> Shows a list of all of the placeholder related commands. + * **/prison placeholders list** + +> Lists all placeholders that are available, including their aliases. Placeholders are grouped by their type, of which there are 10 different kinds. Some are player specific, rank or ladder specific, mine specific, or even hybrid combinations such as player-mine were the mine stats are based upon which mine the player is in. + + * **/prison placeholders search** + +> Provides a simple search for placeholders, optionally using a player's name, and it shows the results with actual live placeholder values. Search values can be one or more word fragments. + + * **/prison placeholders test** +> Somewhat like search, but you have to provide the whole placeholder surrounded by escape characcters. Can provide more than one placeholder too. This is more like testing what you would place within a chat prefix or holographic sign. + + +* **/prison placeholders stats** + +> A new command that currently only shows what placeholders have been hitting prison and their total hit count and the total average duration to process. This tool provides a simple pre-cache to more quickly identify which is the correct placeholder to use with the raw placeholder text. This even include bad placeholder hits so the pre-cache can bypass processing of the junk, which improves server performance. Eventually this will also include a placeholder value cache. + + + * **/prison placeholders reload** +> Reloads and rebuilds all placeholders and then reregisters them. This is performed when adding or removing a new mine or rank. + + + NOTE: the `/prison placeholders reload` command only reloads and registers the placeholders with the placeholder integrations. This would be required to enable placeholders when adding a new mine, a new rank, or a new ladder. If you reload another plugin, such as papi, you may need to reload the placeholders which will re-register them. Prison has been setup to survive a papi restart, but there could still be issues. @@ -59,61 +82,114 @@ NOTE: Information on these command are provided in detail below. Prison has numerous placeholders, with number of different types. Each of these types have different internal requirements and conditions of usage. This is a high overview of the various types and their counts. -* **Player Related:** 92 including aliases + +* **Total Available Placeholders:** 294 including aliases + + +* **Player Related:** 110 including aliases * **Rank Related:** 8 including aliases * **Rankup Related:** 20 including aliases * **Player Balance Related:** 8 including aliases + * **Player Token Balance Related:** 12 including aliases + * **Player Blocks Totals Related: 4 including aliases * **Player Tool Related:** 34 including aliases * **Player Health Related:** 14 including aliases * **Player XP and Levels Related:** 6 including aliases * **Player Walk Speed:** 2 including aliases -* **Ladders Related:** 30 including aliases **times** each ladder - A LADDERS placeholder must include the ladder's name in the placeholder and therefore is static. - +* **Ladders Related:** 32 including aliases **times** each ladder + +> A LADDERS placeholder must include the ladder's name in the placeholder and therefore is static. + +> The ladder based placeholders end with `_laddername`, but they include the following possible prefixes, which may not be exclusive to ladder based placeholders. + +> Ladder placeholder prefixes: + * `prison_rank_` + * `prison_rankup_` + * `prison_player_` + + * **Ranks Related:** 22 including aliases **times** each rank - A RANKS placeholder needs to specify the Rank name as part of the placeholder. Each placeholder must specify a Rank and is static. +> A RANKS placeholder needs to specify the Rank name as part of the placeholder. Each placeholder must specify a Rank and is static. + +> The ranks based placeholders end with `_rankname` but do not require a player to work. They also have a prefix of `prison_rank__` but these prefixes and suffixes are also shared with **RankPlayers** placeholders. See them for specifics. + +> Ranks placeholder prefixes: + * `prison_rank__` * **RankPlayers Related:** 12 including aliases **times** each rank - A RANKPLAYERS placeholder is one that will change based upon the player's own Rank. Each player could have a different rank. Because of this relationship, these can only be used with instances of players such as scoreboards and chat prefixes; they will not work in holographic displays or with signs. +> A RANKPLAYERS placeholder is one that will change based upon the player's own Rank. Each player could have a different rank. Because of this relationship, these can only be used with instances of players such as scoreboards and chat prefixes; they will not work in holographic displays or with signs. + +> RankPlayers placeholders are very similar to the Rank placeholders in respect to the prefixes and suffixes, but these placeholders MUST include a player or they cannot work. Without a player, they cannot return a valid value, and therefore will return either a blank or zero. +> What makes these placeholders stand out from rank placeholders is the prefix includes `player_`. For example: -* **Mines Related:** 18 including aliases **times** each ladder +> RankPlayers placeholder prefixes: + * `prison_rank__player_` + + +> **Performance Warning:** There is a high risk of performance issues when calculating a full GUI page of items that includes the use of placeholders that are based upon the placeholders: `prison_rank__player_cost_rankname`. The reason for this is related to a progressively great number of calculations required to calculate high ranked prestige ranks. The performance impact can include processing and memory usages. + +> For example, if there are 26 default ranks, and the player is at rank A with no prestiges, then to calculate rank P4 would include the following ranks: +b --> z + p1 + a --> z + p2 + a --> z + p3 + a --> z + p4. +This results in a total of 107 ranks that must be collected, then the player's cost for each rank will have to be calculated. Then all of these must be added together to get the player's cost on rank P4. + +> So if there are thousands of prestige ranks, then the calculations will be numerous for each placeholder. * **Player Ladder Balance Related:** 32 including aliases **times** each Mine - A MINES placeholder must specify the Mine mine as part of the placeholder. Each placeholder must specify a mine and is static. +* **Mines Related:** 32 including aliases **times** each ladder + +> A MINES placeholder must specify the Mine mine as part of the placeholder. + +> The Mines related placeholders have the following prefixes, but they are also shared with the MinePlayers placeholders. +* `prison_mines_` +* `prison_top_mine_` + + + +* **MinePlayers Related:** 32 including aliases + +> A MINEPLAYERS placholder is similar to a RankPlayers placeholder in that it is dynamic and you cannot specify a mine's name with it. How it works, is that it provides the related stats for the mine in which the player is standing in. When the player leaves the mine, then these placeholders returns an empty string value (a blank). + +> The MinePLayers placeholders includ the following prefixes, but they are also similar to the Mines related placeholder too: + * `prison_player_` + * `prison_mines_` + -* **MinePlayers Related:** 34 including aliases +* **PLAYERBLOCKS:** 4 including aliases - A MINEPLAYERS placholder is similar to a RankPlayers placeholder in that it is dynamic and you cannot specify a mine's name with it. How it works, is that it provides the related stats for the mine in which the player is standing in. When the player leaves the mine, then these placeholders returns an empty string value (a blank). +> Every block type that a player breaks within a mine is tracked. These provide the stats on those blocks. -* *STATSMINES Related:** 14 including aliases +* **STATSMINES Related:** 14 including aliases - These are a work in progress, but will provide access to some mine stats such as total blocks mined. +> These list the blocks within a mine. They are referred to with a `_nnn_` notation where "nnn" is the line number -* *STATSRANKS Related:** 6 including aliases +* **STATSRANKS Related:** 6 including aliases - These are a work in progress, but will provide access to some rank stats such as top ranked player in that rank. +> Top-n stats for each rank. The rank name must be specified on the placeholder. +* **STATSPLAYERS:** 30 including aliases + +> Various placeholders for the top-n ranked players. These are over all ranks. There are a couple of shortcut placehodlders where one placeholders contain multiple fileds for easier usage. + -**Total base Placeholders:** 240 including aliases -
+
# Requirements @@ -122,11 +198,17 @@ There is always more than one way to do things, and the same goes for having mor **PlaceholderAPI** - [Setting up PlaceholderAPI](prison_docs_0xx_setting_up_PlaceholderAPI.md) - Strongly Suggested if using placeholders. + +**Holographs** - There are actual a couple of holograph display plugins. Most of the references in this document refer to Holographic Displays, but some of the newer plugins can provide the same functionality, plus many new features. +
# Placeholder Theory for Prison +*(needs updating: Prison now has 10 types of placeholders including top-n variations)* + + There are few major types of placeholders in prison: Player, Ranks, Ladders, Mines, and Stats based. With the most recent releases of prison, there have been hybrids added that are a combination of the player placeholders and with mines and ranks. For example there are now ladder based placeholder that allow targeting ranks on a specific ladder, instead of all ladders. Also there are player mine placeholders that report on the mine stats for the mine in which the player is physically located in. The player mine placeholders have no value when the player is not in a mine, and they will change as the player goes from mine to mine. There are also different types of data that are returned in placeholders. Text, numbers, formatted numbers, and bar graphs. @@ -152,7 +234,7 @@ Also, internally, prison only responds to the placeholder name without the escap
-# Placeholder Customization with Placeholder Attributes +# Placeholder Attributes - Customize almost any Prison Placeholder *Since Prison v3.2.4-alpha.2* @@ -160,10 +242,14 @@ Also, internally, prison only responds to the placeholder name without the escap Placeholders within prison can now be dynamically customized without having to make any changes to any configurations. The same placeholder can be used in multiple place, each with different configurations. This is now possible through the use of placeholder attributes and offers a large degree of customization. -The placeholder attributes is additional text that is added at the end of a placeholder but within the escape characters. The placeholder attribute always begins with a double colon `::` and each parameter is separated with a single colon `:`. Some placeholders cannot use the attributes, and not all attributes can be used on a placeholder that will work with an attribute. See additonal information below pertain to each attribute. +The **Placeholder Attributes** is additional text that is added at the end of a placeholder but within the escape characters. The placeholder attribute always begins with a double colon `::` and each parameter is separated with a single colon `:`. Some placeholders cannot use the attributes, and not all attributes can be used on a placeholder. See additional information below that pertains to each attribute. + + +As of v3.3.0-alpha.11h one placeholder can have more than one Placeholder Attribute, but they have to be of a different type. At this time, this really is not beneficial since the Placeholder Attributes are specific to a certain type of data. But this opens the door to future possibilities that are not possible currently, such as hybrid between a bar graph with a value super-imposed on top of it. -Here are a couple of basic placeholders, as they are listed, and as they would be used for a mine named **temp5**. + +The following shows how a few placeholder need to have the "minename" replaced with the actual mine's name. For these examples, we will use a mine named **temp5**. * **prison_mines_size_minename** - `{prison_mines_size_temp5}` * **prison_mines_remaining_minename** - `{prison_mines_remaining_temp5}` @@ -171,7 +257,8 @@ Here are a couple of basic placeholders, as they are listed, and as they would b * **prison_mines_timeleft_bar_minename** - `{prison_mines_timeleft_bar_temp5}` -And these are some examples of using the attributes: + +A few Examples using Placeholder Attributes: * `{prison_mines_size_temp5::nFormat:#,##0}` - **654,321** * `{prison_mines_size_temp5::nFormat:#,##0:0:none}` - **654,321** @@ -211,7 +298,7 @@ Using the command `/prison placeholders test` should be used to test and perfect -## Placeholder Attribute - Numeric Formats +## Placeholder Attribute: nFormat - Numeric Formats The Numeric Format attribute will only work on placeholders that return plain numbers. If there is a "_format" version of the placeholder, then an attribute will override the default formatting. @@ -290,7 +377,7 @@ Although it is not suggested to include color codes in the formatting of numbers -## Placeholder Attribute - Bar Graphs +## Placeholder Attribute: bar - Bar Graphs The bar placeholder attribute only works with placeholders with the word bar in them. @@ -362,7 +449,7 @@ Examples of using hex color codes in a bar graph placeholder. Try it first with -## Placeholder Attribute - Text +## Placeholder Attribute: text - Text This placeholder attribute is for text formatting the placeholder results. The only thing it does is to process the hex, hex2, and debug options. diff --git a/gradle.properties b/gradle.properties index f5658bab9..0297303c1 100644 --- a/gradle.properties +++ b/gradle.properties @@ -3,7 +3,7 @@ ## # This is actually the "correct" place to define the version for the project. ## # Used within build.gradle with ${project.version}. ## # Can be overridden on the command line: gradle -Pversion=3.2.1-alpha.3 -version=3.3.0-alpha.12 +version=3.3.0-alpha.13 diff --git a/prison-core/src/main/java/tech/mcprison/prison/Prison.java b/prison-core/src/main/java/tech/mcprison/prison/Prison.java index fbda21369..7c36a7f80 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/Prison.java +++ b/prison-core/src/main/java/tech/mcprison/prison/Prison.java @@ -44,6 +44,7 @@ import tech.mcprison.prison.store.Database; import tech.mcprison.prison.troubleshoot.TroubleshootManager; import tech.mcprison.prison.util.EventExceptionHandler; +import tech.mcprison.prison.util.PrisonStatsUtil; import tech.mcprison.prison.util.PrisonTPS; /** @@ -102,7 +103,7 @@ public class Prison private Database metaDatabase; - + private PrisonStatsUtil statsUtil; private PrisonTPS prisonTPS; @@ -174,13 +175,15 @@ public void setupJUnitInstance( Platform platform ) { *
* Note that modules should not call this method. This is solely for the implementations.
*/
- public boolean init(Platform platform, String minecraftVersion) {
+ public boolean init(Platform platform, String minecraftVersion, File dataFolder ) {
long startTime = System.currentTimeMillis();
this.platform = platform;
this.minecraftVersion = minecraftVersion;
+ this.dataFolder = dataFolder;
+
if (!initDataFolder()) {
Output.get().logInfo("&cFailure: &eInitializing the Prison Data Folders!" );
Output.get().logInfo("&e&k!=&d Prison Plugin Terminated! &e&k=!&7" );
@@ -188,6 +191,9 @@ public boolean init(Platform platform, String minecraftVersion) {
}
+ this.statsUtil = new PrisonStatsUtil();
+
+
this.prisonTPS = new PrisonTPS();
this.prisonTPS.submitAsyncTPSTask();
@@ -362,7 +368,13 @@ public void displaySystemSettings( LinkedHashMap
If the auto features settings `options.autoFeatures.isAutoFeaturesEnabled: false` is + * disabled (set to false), then this will apply to the normal drops if + * `options.normalDrop.handleNormalDropsEvents: true' is enabled (set to true). + * If both of those are set to disabled, then no blocks will be processed. + *
+ * + * @param player + * @return + */ + public Boolean isProcessAutoFeaturesAllBlocks( RankPlayer player ) { + + if ( !processAutoFeaturesAllBlocks.containsKey( player.getName() ) ) { + BlockConverterResults allBlocksBCR = getBlockConverterItemStacks( player, "*all*", 1, BlockConverterTypes.autoPickupFeatures ); + + BlockConverter allBlocks = allBlocksBCR.getBlockConverter(); + + boolean playerAllBlocks = ( allBlocks != null && allBlocks.isEnabled() ); + + processAutoFeaturesAllBlocks.put( player.getName(), playerAllBlocks ); + } + + return processAutoFeaturesAllBlocks.get( player.getName() ); + } + + } diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/BlockConvertersInitializer.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/BlockConvertersInitializer.java index 3a9502cbb..148aed76d 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/BlockConvertersInitializer.java +++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/BlockConvertersInitializer.java @@ -53,6 +53,7 @@ private void loadDefaultBlockConverters( BlockConverterTypes bcType, TreeMapThis function will take the project's data folder and construct the the path + * to the directory, if it does not exist, to where the backup files are stored. + *
+ * + * @return + */ + public File getBackupDirectoryFile() { + if ( backupDirectory == null ) { + + backupDirectory = new File( Prison.get().getDataFolder(), FILE_BACKUP_DIRECTORY_PATH ); + backupDirectory.mkdirs(); + } + + return backupDirectory; + } + + + public File getNewBackupFile( BackupTypes backupType, String fileNameNotes ) { + String notes = null; + + if ( fileNameNotes != null && fileNameNotes.trim().length() > 0 ) { + notes = "_" + fileNameNotes.replaceAll( "[^a-zA-Z0-9\\.\\-]", "_" ); + + // Notes can only be a max length of 20 characters + if ( notes.length() > 20 ) { + notes = notes.substring( 0, 20 ); + } + } + + if ( backupType != null && backupType == BackupTypes.manual && + notes != null && notes.length() > 0) { + backupType = null; + } + + String prisonVersion = Prison.get().getPlatform().getPluginVersion(); + +// SimpleDateFormat sdFmt = new SimpleDateFormat( "yyyy-MM-dd_hh-mm" ); + + String fileName = "prison_" + sdFmt.format( new Date() ) + + "_v" + prisonVersion + + ( backupType == null ? "" : "_" + backupType.name()) + + ( notes == null ? "" : notes ) + + ".zip"; + + File file = new File( getBackupDirectoryFile(), fileName ); + + return file; + } + + + public long getStartTimeNanos() { + return startTimeNanos; + } + public void setStartTimeNanos(long startTimeNanos) { + this.startTimeNanos = startTimeNanos; + } + + public Date getBackupStartDate() { + return backupStartDate; + } + public void setBackupStartDate(Date backupStartDate) { + this.backupStartDate = backupStartDate; + } + + public String getZipFilePrefix() { + return zipFilePrefix; + } + public void setZipFilePrefix(String zipFilePrefix) { + this.zipFilePrefix = zipFilePrefix; + } + + public Path getSourceDirectoryPath() { + if ( sourceDirectoryPath == null ) { + sourceDirectoryPath = Prison.get().getDataFolder().toPath(); + } + return sourceDirectoryPath; + } + + + public File getBackupDirectory() { + return backupDirectory; + } + public void setBackupDirectory(File backupDirectory) { + this.backupDirectory = backupDirectory; + } + + public ArrayListThese are the primary settings that define what the command's primary + * root will be, and what the command fallback prefix will be. + * The command fallback prefix is used when registering commands, it is + * added to the beginning of a command until the command is unique, which means + * it can be added multiple times. + *
+ * + *The value for COMMAND_PRIMARY_ROOT_COMMAND should be changed for each plugin. + *
+ * + * @author Blue + * + */ +public class DefaultSettings { + + public static final String COMMAND_PRIMARY_ROOT_COMMAND = "prison"; + public static final String COMMAND_FALLBACK_PREFIX = "prison"; + +} diff --git a/prison-core/src/main/java/tech/mcprison/prison/file/JsonFileIO.java b/prison-core/src/main/java/tech/mcprison/prison/file/JsonFileIO.java index ff65e920a..a899101e5 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/file/JsonFileIO.java +++ b/prison-core/src/main/java/tech/mcprison/prison/file/JsonFileIO.java @@ -6,12 +6,19 @@ import com.google.gson.GsonBuilder; import tech.mcprison.prison.error.ErrorManager; +import tech.mcprison.prison.internal.Player; import tech.mcprison.prison.modules.ModuleStatus; import tech.mcprison.prison.output.Output; public class JsonFileIO extends FileIO { + public static final String FILE_SUFFIX_JSON = ".json"; + public static final String FILE_PREFIX_BACKUP = ".backup_"; + public static final String FILE_SUFFIX_BACKUP = ".bu"; + public static final String FILE_SUFFIX_TEMP = ".temp"; + public static final String FILE_TIMESTAMP_FORMAT = "_yyyy-MM-dd_HH-mm-ss"; + private final Gson gson; /** @@ -35,6 +42,42 @@ public Gson getGson() return gson; } + /** + *This constructs a player file named based upon the UUID followed + * by the player's name. This format is used so it's easier to identify + * the correct player. + *
+ * + *The format should be UUID-PlayerName.json. The UUID is a shortened + * format, which should still produce a unique id. The name, when read, + * is based upon the UUID and not the player's name, which may change. + * This format includes the player's name to make it easier to identify + * who's record is whom's. + *
+ * + * @return + */ + public static String getPlayerFileName( Player player ) { + + String UUIDString = player.getUUID().toString(); + String uuidFragment = getFileNamePrefix( UUIDString ); + + return uuidFragment + "_" + player.getName() + FILE_SUFFIX_JSON; + } + + /** + *This function returns the first 13 characters of the supplied + * file name, or UUID String. The hyphen is around the 12 or 13th position, + * so it may or may not include it. + *
+ * + * @param playerFileName + * @return + */ + private static String getFileNamePrefix( String UUIDString ) { + return UUIDString.substring( 0, 14 ); + } + /** * This function will save a file as a JSON format. It will first save it as a * temp file to make sure the data can be written to the file system, then once diff --git a/prison-core/src/main/java/tech/mcprison/prison/file/ZipFileIO.java b/prison-core/src/main/java/tech/mcprison/prison/file/ZipFileIO.java new file mode 100644 index 000000000..5dbff29b5 --- /dev/null +++ b/prison-core/src/main/java/tech/mcprison/prison/file/ZipFileIO.java @@ -0,0 +1,111 @@ +package tech.mcprison.prison.file; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.zip.ZipEntry; +import java.util.zip.ZipOutputStream; + +import tech.mcprison.prison.backups.PrisonBackups; +import tech.mcprison.prison.output.Output; +import tech.mcprison.prison.util.Text; + +public class ZipFileIO { + + + public void writeToZipFileBackups( + File zipFile, + PrisonBackups pBackups ) { + + try ( + final ZipOutputStream out = new ZipOutputStream(new FileOutputStream( zipFile )); + ) { + + for (File file : pBackups.getFilesToBackup() ) { + + try { + Path targetFile = pBackups.getSourceDirectoryPath().relativize( file.toPath() ); + + String zipEntryName = pBackups.getZipFilePrefix() + "/" + targetFile.toString(); + + ZipEntry zEntry = new ZipEntry( zipEntryName ); + out.putNextEntry( zEntry ); + + + byte[] bytes = Files.readAllBytes(file.toPath()); + out.write(bytes, 0, bytes.length); + out.closeEntry(); + } + catch (IOException e) { + + pBackups.getFilesWithErrors().add( file ); + + e.printStackTrace(); + } + + } + +// // Add a stats file at the root with backup stats: + try { + String statsFileName = pBackups.getZipFilePrefix() + "_stats.txt"; + + ZipEntry zEntry = new ZipEntry( statsFileName ); + out.putNextEntry( zEntry ); + + // Basic backup stats: + writeOutput( out, pBackups.backupReport01() ); + + // Prison version: + writeOutput( out, pBackups.backupReportVersionData().toString() ); + + // List of backup files that had errors or are temporary and will be removed: + writeOutput( out, pBackups.backupReportListTemporalFiles() ); + + + writeOutput( out, pBackups.backupReportConfigsData().toString() ); + + writeOutput( out, pBackups.backupReportRanksData().toString() ); + + writeOutput( out, pBackups.backupReportMinesData().toString() ); + + writeOutput( out, pBackups.backupReportListenersData().toString() ); + + + out.closeEntry(); + } + catch (IOException e) { + + e.printStackTrace(); + } + + } + catch ( Exception e ) { + + String message = String.format( + "Error trying to build Prison backup file: %s [%s]", + zipFile.getAbsolutePath(), + e.getMessage() + ); + + Output.get().logWarn( message, e ); + } + + + } + + private void writeOutput(ZipOutputStream out, String message) { + + byte[] bytes = Text.stripColor( message ).getBytes(); + + try { + out.write(bytes, 0, bytes.length); + } + catch (IOException e) { + e.printStackTrace(); + } + } + + +} diff --git a/prison-core/src/main/java/tech/mcprison/prison/gui/PrisonCoreGuiMessages.java b/prison-core/src/main/java/tech/mcprison/prison/gui/PrisonCoreGuiMessages.java index ad76ce684..02cd410d9 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/gui/PrisonCoreGuiMessages.java +++ b/prison-core/src/main/java/tech/mcprison/prison/gui/PrisonCoreGuiMessages.java @@ -157,7 +157,7 @@ protected String guiPriceMsg( Integer price ) { protected String guiPriceMsg( String price ) { return Prison.get().getLocaleManager() - .getLocalizable( "sellall_spigot_utils__money_earned" ) + .getLocalizable( "core_gui__price" ) .withReplacements( price ) .localize(); } @@ -215,7 +215,7 @@ protected String guiValueMsg( String value ) { protected String guiPermissionMsg( String prestigeName ) { return Prison.get().getLocaleManager() - .getLocalizable( "core_gui__puermission" ) + .getLocalizable( "core_gui__permission" ) .withReplacements( prestigeName ) .localize(); } diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationManager.java b/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationManager.java index c6d19205c..96d190737 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationManager.java +++ b/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationManager.java @@ -273,7 +273,8 @@ else if ( plugins == null || plugins.size() == 0 ) { activeIntegration = true; String pluginUrl = plugin.getPluginSourceURL(); - String msg = String.format( "&a. . %s <%s> %s", plugin.getDisplayName(), + String msg = String.format( "&a. . %s <%s> %s", + plugin.getDisplayName(), ( plugin.hasIntegrated() ? "Active" : "Inactive"), ( pluginUrl == null ? "" : "&7[URL]")); FancyMessage fancy = new FancyMessage( msg ); @@ -426,4 +427,12 @@ public void removeIntegration( Integration integration ) } + public MapThis constructs a player file named based upon the UUID followed + * by the player's name. This format is used so it's easier to identify + * the correct player. + *
+ * + *The format should be UUID-PlayerName.json. The UUID is a shortened + * format, which should still produce a unique id. The name, when read, + * is based upon the UUID and not the player's name, which may change. + * This format includes the player's name to make it easier to identify + * who's record is whom's. + *
+ * + * @return + */ + public String getPlayerFileName(); public String toString(); @@ -56,7 +73,7 @@ public interface Player * * @param newDisplayName The new display name. May include colors, amp-prefixed. */ - void setDisplayName(String newDisplayName); + public void setDisplayName(String newDisplayName); /** * Adds an {@link ItemStack} to the player's inventory. diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java index bbb96b5a1..c82d190d4 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java @@ -40,6 +40,7 @@ import tech.mcprison.prison.modules.ModuleElementType; import tech.mcprison.prison.output.ChatDisplay; import tech.mcprison.prison.placeholders.Placeholders; +import tech.mcprison.prison.ranks.data.RankPlayer; import tech.mcprison.prison.store.Storage; import tech.mcprison.prison.util.Location; @@ -436,5 +437,11 @@ public void autoCreateMineLinerAssignment( ListThis constructs a player file named based upon the UUID followed + * by the player's name. This format is used so it's easier to identify + * the correct player. + *
+ * + *The format should be UUID-PlayerName.json. The UUID is a shortened + * format, which should still produce a unique id. The name, when read, + * is based upon the UUID and not the player's name, which may change. + * This format includes the player's name to make it easier to identify + * who's record is whom's. + *
+ * + * @return + */ + public String getPlayerFileName() { + + return JsonFileIO.getPlayerFileName( this ); + } + + public String getRanks() { StringBuilder sb = new StringBuilder(); @@ -374,7 +413,7 @@ public void addRank( Rank rank) { ranksRefs.put(ladderName, rank.getId()); - PlayerRank pRank = new PlayerRank( rank ); + PlayerRank pRank = createPlayerRank( rank ); ladderRanks.put( rank.getLadder(), pRank ); @@ -385,15 +424,55 @@ public void addRank( Rank rank) { // Calculate and apply the rank multipliers: recalculateRankMultipliers(); } + + /** + *This does not update the RankPlayer with the passed rank or the generated PlayerRank. + * This only crates a new PlayerRank object without setting the multiplier. + *
+ * + * @param rank + * @return + */ + public PlayerRank createPlayerRank( Rank rank ) { + PlayerRank pRank = new PlayerRank( rank, 1.0 ); + + return pRank; + } + /** + *This will calculate the total multipliers and set that multiplier + * on all of the player's current ranks. This is for their + * actual ranks and ladders. + *
+ * + */ public void recalculateRankMultipliers() { + + recalculateRankMultipliers( getLadderRanks() ); + + } + + /** + *This function will use a **targetLadderRanks** TreeMap and will + * calculate it's total multipliers for the ranks and ladders that are + * within this TreeMap. + *
+ * + *This can be used to calculate the cost of a given target rank, based + * upon just changing that target rank's ladder entry to the target rank. + *
+ * + * @param targetLadderRanks + */ + public void recalculateRankMultipliers( + TreeMapThis function will taken any rank, on any ladder, and will + * properly calculate it's multiplier (which is based upon all ladders + * and the ranks within those ladders, and the targetRank's rank cost. + *
+ * + *This is the ONLY valid way to calculate target rank costs for a player. + *
+ * + * @param targetRank + * @return + */ + public PlayerRank calculateTargetPlayerRank( Rank targetRank ) { + PlayerRank targetPlayerRank = null; + + // Can only process if the target rank is not null and it has a ladder: + if ( targetRank != null && targetRank.getLadder() != null ) { + + // Need to get the targetRank's ladder. Not all ranks have ladders. + RankLadder targetLadder = targetRank.getLadder(); + + // Create a new PlayerRank object for this target rank. + // Ignore rank cost multipliers since that will be applied later. + targetPlayerRank = new PlayerRank( targetRank ); + + // Create a new temp targetLadderRanks TreeMap: + TreeMapAlways return the default rank's position. + * This has a value of >= 0 and <= the highest rank's position on the + * default ladder. Rank positions are zero based. + *
+ * + *Since all players must have a default rank, this can never + * return a value of negative one. + *
+ * + * @return + */ + public int getRankPositonDefault() { + + int pos = getPlayerRankDefault().getRank().getPosition(); + return pos; + } + + /** + *This returns the rank position for the prestiges ladder, with + * a value of negative one if the player does not have a prestige rank. + * This has a value of >= -1 and <= the highest rank position on the + * prestiges ladder. Rank positions are zero based. + *
+ * + * @return + */ + public int getRankPositonPrestiges() { + PlayerRank rankPres = getPlayerRankPrestiges(); + + int pos = rankPres == null ? + -1 : + rankPres.getRank().getPosition(); + + return pos; + } + + public HashMapCalculates the rankScore for the player's rank on the default ladder. - * The calculation is based upon how much the next rank costs. - *
- * - */ - private void calculateRankScore() { + public PlayerRank getNextPlayerRank() { PlayerRank rankCurrent = getPlayerRankDefault(); - + + // If player does not have a default rank, then assign them one: + if ( rankCurrent == null ) { + Prison.get().getPlatform().checkPlayerDefaultRank( this ); + + rankCurrent = getPlayerRankDefault(); + } + + if ( rankCurrent == null ) { + Output.get().logError( + String.format( + "ERROR Player has no default ladder rank: %s A player should never be without a " + + "rank on the default ladder. Something corrupted prison. Contact prison support. " + + "Make sure you do not manually modify any of the config files, which can lead to corruption. ", + getName() + )); + Output.get().logError( + String.format( + "NOTE: Restarting the server could allow prison to repair players that are corrupted. " + + "Please try restarting the server to see if that fixes the problem before contacting " + + "prison's support team. Thanks!" + )); + } + Rank nRank = rankCurrent.getRank().getRankNext(); // If player does not have a next rank, then try to use the next prestige rank: @@ -1273,21 +1459,103 @@ private void calculateRankScore() { } - String rankNextCurrency = nRank == null ? "" : nRank.getCurrency(); + PlayerRank pRankNext = calculateTargetPlayerRank( nRank ); +// PlayerRank pRankNext = rankCurrent.getTargetPlayerRankForPlayer( this, nRank ); + + return pRankNext; + } + + /** + *Calculates the rankScore for the player's rank on the default ladder. + * The calculation is based upon how much the next rank costs. + *
+ * + */ + public void calculateRankScore() { + + PlayerRank pRankNext = getNextPlayerRank(); - PlayerRank pRankNext = rankCurrent.getTargetPlayerRankForPlayer( this, nRank ); + String rankNextCurrency = pRankNext == null ? "" : pRankNext.getCurrency(); double cost = pRankNext == null ? 0d : pRankNext.getRankCost(); + double balance = getBalance( rankNextCurrency ); - double score = balance; +// RankPlayerBalance cachedBalance = getCachedRankPlayerBalance( rankNextCurrency, true ); +// +// double balance = cachedBalance.getBalance(); + + calculateRankScore( rankNextCurrency, cost, balance ); + + +// PlayerRank rankCurrent = getPlayerRankDefault(); + +// Rank nRank = rankCurrent.getRank().getRankNext(); +// +// // If player does not have a next rank, then try to use the next prestige rank: +// if ( nRank == null ) { +// PlayerRank prestigeRankCurrent = getPlayerRankPrestiges(); +// +// // if they don't have a current prestige rank, then use the lowest rank: +// if ( prestigeRankCurrent == null ) { +// RankLadder rLadder = getRankLadder( RankLadder.PRESTIGES ); +// nRank = rLadder == null ? null : rLadder.getLowestRank().orElse(null); +// } +// +// if ( prestigeRankCurrent != null ) { +// nRank = prestigeRankCurrent.getRank() == null ? +// null : prestigeRankCurrent.getRank().getRankNext(); +// } +// +// } +// +// +// PlayerRank pRankNext = rankCurrent.getTargetPlayerRankForPlayer( this, nRank ); + +// String rankNextCurrency = nRank == null ? "" : nRank.getCurrency(); +// double balance = getBalance( rankNextCurrency ); + + +// double balance = getBalance( rankNextCurrency ); +// double score = balance; +// double penalty = 0d; +// +// // Do not apply the penalty if cost is zero: +// if ( cost > 0 && isHesitancyDelayPenaltyEnabled() ) { +// score = balance > cost ? cost : score; +// +// double excess = balance > cost ? balance - cost : 0d; +// penalty = excess * 0.2d; +// } +// +// score = (score - penalty); +// +// if ( cost > 0 ) { +// score /= cost * 100.0d; +// } +// +//// double balanceThreshold = cost * RANK_SCORE_BALANCE_THRESHOLD_PERCENT; +// +//// setRankScoreBalance( balance ); +//// setRankScoreCurrency( rankNextCurrency ); +//// setRankScoreBalanceThreshold( balanceThreshold ); +// setRankScore( score ); +// setRankScorePenalty( penalty ); +// +//// setRankScoreCooldown( System.currentTimeMillis() + RANK_SCORE_COOLDOWN_MS ); + } + + private void calculateRankScore( String currency, double cost, double playerBalance ) { + + double score = playerBalance; + double penalty = 0d; // Do not apply the penalty if cost is zero: if ( cost > 0 && isHesitancyDelayPenaltyEnabled() ) { - score = balance > cost ? cost : score; + score = playerBalance > cost ? cost : playerBalance; - double excess = balance > cost ? balance - cost : 0d; + double excess = playerBalance > cost ? playerBalance - cost : 0d; penalty = excess * 0.2d; } @@ -1297,40 +1565,48 @@ private void calculateRankScore() { score /= cost * 100.0d; } - double balanceThreshold = cost * RANK_SCORE_BALANCE_THRESHOLD_PERCENT; - - setRankScoreBalance( balance ); - setRankScoreCurrency( rankNextCurrency ); - setRankScoreBalanceThreshold( balanceThreshold ); setRankScore( score ); setRankScorePenalty( penalty ); - - setRankScoreCooldown( System.currentTimeMillis() + RANK_SCORE_COOLDOWN_MS ); - } - - private void checkRecalculateRankScore() { - - if ( getRankScoreCooldown() == 0L || - System.currentTimeMillis() > getRankScoreCooldown() - ) { - - double currentBalance = getBalance( getRankScoreCurrency() ); - - if ( getRankScoreBalance() != 0 && ( - currentBalance == getRankScoreBalance() || - currentBalance >= (getRankScoreBalance() - getRankScoreBalanceThreshold()) || - currentBalance <= (getRankScoreBalance() + getRankScoreBalanceThreshold() ) )) { - - // increment the cooldown since the balance is either the same, or still - // within the threshold range: - setRankScoreCooldown( System.currentTimeMillis() + RANK_SCORE_COOLDOWN_MS ); - } - else { - calculateRankScore(); - } - } + setRankScoreBalance( playerBalance ); + setRankScoreCurrency( currency ); } +// private void checkRecalculateRankScore() { +// +// calculateRankScore(); +// +//// if ( getRankScoreCooldown() == 0L || +//// System.currentTimeMillis() > getRankScoreCooldown() +//// ) { +//// +//// double currentBalance = getBalance( getRankScoreCurrency() ); +//// +//// if ( getRankScoreBalance() != 0 && ( +//// currentBalance == getRankScoreBalance() || +//// currentBalance >= (getRankScoreBalance() - getRankScoreBalanceThreshold()) || +//// currentBalance <= (getRankScoreBalance() + getRankScoreBalanceThreshold() ) )) { +//// +//// // increment the cooldown since the balance is either the same, or still +//// // within the threshold range: +//// setRankScoreCooldown( System.currentTimeMillis() + RANK_SCORE_COOLDOWN_MS ); +//// } +//// else { +//// calculateRankScore( currentBalance ); +//// } +//// } +// } + +// /** +// *By setting rankScoreCooldown to zero, it will force that player to have it's +// * rank score to be recalculated. The most expensive part is getting the player's +// * balance from Vault. +// *
+// * +// */ +// public void forcePlayerToRecalculateRankScore() { +// rankScoreCooldown = 0L; +// } + public static String printRankScoreLine1Header() { String header = String.format( "Rank %-16s %-9s %-6s %-9s %-9s %-9s", @@ -1358,7 +1634,7 @@ public String printRankScoreLine1( int rankPostion ) { String prestRankTagNc = Text.stripColor(prestRankTag); String defRankTagNc = Text.stripColor(defRankTag); - String balanceStr = PlaceholdersUtil.formattedKmbtSISize( getBalance(), dFmt, " " ); + String balanceStr = PlaceholdersUtil.formattedKmbtSISize( getRankScoreBalance(), dFmt, " " ); String sPenaltyStr = PlaceholdersUtil.formattedKmbtSISize( getRankScorePenalty(), dFmt, " " ); String message = String.format( @@ -1404,7 +1680,7 @@ public String printRankScoreLine2( int rankPostion ) { String prestRankTagNc = Text.stripColor(prestRankTag); String defRankTagNc = Text.stripColor(defRankTag); - String balanceStr = PlaceholdersUtil.formattedKmbtSISize( getBalance(), dFmt, " " ); + String balanceStr = PlaceholdersUtil.formattedKmbtSISize( getRankScoreBalance(), dFmt, " " ); // String sPenaltyStr = PlaceholdersUtil.formattedKmbtSISize( getRankScorePenalty(), dFmt, " " ); String ranks = prestRankTagNc + defRankTagNc; @@ -1443,16 +1719,17 @@ public void setRankScoreCurrency( String rankScoreCurrency ) { this.rankScoreCurrency = rankScoreCurrency; } - public double getRankScoreBalanceThreshold() { - return rankScoreBalanceThreshold; - } - public void setRankScoreBalanceThreshold( double rankScoreBalanceThreshold ) { - this.rankScoreBalanceThreshold = rankScoreBalanceThreshold; - } +// public double getRankScoreBalanceThreshold() { +// return rankScoreBalanceThreshold; +// } +// public void setRankScoreBalanceThreshold( double rankScoreBalanceThreshold ) { +// this.rankScoreBalanceThreshold = rankScoreBalanceThreshold; +// } + public double getRankScore() { // check if the rankScore needs to be reset: - checkRecalculateRankScore(); +// checkRecalculateRankScore(); return rankScore; } @@ -1467,10 +1744,10 @@ public void setRankScorePenalty( double rankScorePenalty ) { this.rankScorePenalty = rankScorePenalty; } - public long getRankScoreCooldown() { - return rankScoreCooldown; - } - public void setRankScoreCooldown( long rankScoreCooldown ) { - this.rankScoreCooldown = rankScoreCooldown; - } +// public long getRankScoreCooldown() { +// return rankScoreCooldown; +// } +// public void setRankScoreCooldown( long rankScoreCooldown ) { +// this.rankScoreCooldown = rankScoreCooldown; +// } } diff --git a/prison-core/src/main/java/tech/mcprison/prison/ranks/data/StatsRankPlayerBalanceData.java b/prison-core/src/main/java/tech/mcprison/prison/ranks/data/StatsRankPlayerBalanceData.java index 2267bb596..94cf3440e 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/ranks/data/StatsRankPlayerBalanceData.java +++ b/prison-core/src/main/java/tech/mcprison/prison/ranks/data/StatsRankPlayerBalanceData.java @@ -44,7 +44,8 @@ public void recalc( boolean isPenaltyEnabled ) { if ( rank.getRankNext() != null ) { // This calculates the target rank, and takes in to consideration the player's existing rank: - PlayerRank pRankNext = pRank.getTargetPlayerRankForPlayer( player, rank.getRankNext() ); + PlayerRank pRankNext = player.calculateTargetPlayerRank( rank.getRankNext() ); +// PlayerRank pRankNext = pRank.getTargetPlayerRankForPlayer( player, rank.getRankNext() ); //PlayerRank pRankNext = new PlayerRank( rank.getRankNext(), pRank.getRankMultiplier() ); cost = pRankNext.getRankCost(); diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/PrisonStatsUtil.java b/prison-core/src/main/java/tech/mcprison/prison/util/PrisonStatsUtil.java new file mode 100644 index 000000000..692770c62 --- /dev/null +++ b/prison-core/src/main/java/tech/mcprison/prison/util/PrisonStatsUtil.java @@ -0,0 +1,275 @@ +package tech.mcprison.prison.util; + +import java.io.BufferedReader; +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.text.DecimalFormat; +import java.text.SimpleDateFormat; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Date; +import java.util.List; + +import tech.mcprison.prison.Prison; +import tech.mcprison.prison.discord.PrisonPasteChat; +import tech.mcprison.prison.file.JsonFileIO; +import tech.mcprison.prison.output.ChatDisplay; +import tech.mcprison.prison.output.Output; + +public class PrisonStatsUtil { + + public ChatDisplay displayVersion(String options) { + + boolean isBasic = options == null || "basic".equalsIgnoreCase(options); + + ChatDisplay display = new ChatDisplay("/prison version"); + display.addText("&7Prison Version: %s", Prison.get().getPlatform().getPluginVersion()); + + display.addText("&7Running on Platform: %s", Prison.get().getPlatform().getClass().getName()); + display.addText("&7Minecraft Version: %s", Prison.get().getMinecraftVersion()); + + // System stats: + display.addText(""); + + Prison.get().displaySystemSettings(display); + + Prison.get().displaySystemTPS(display); + + display.addText(""); + + // This generates the module listing, the autoFeatures overview, + // the integrations listings, and the plugins listings. + boolean showLaddersAndRanks = true; + Prison.get().getPlatform().prisonVersionFeatures(display, isBasic, showLaddersAndRanks); + + return display; + } + + public StringBuilder getSupportSubmitVersionData() { + ChatDisplay display = displayVersion("ALL"); + StringBuilder text = display.toStringBuilder(); + return text; + } + + public StringBuilder getSupportSubmitConfigsData() { + Prison.get().getPlatform().saveResource("plugin.yml", true); + + String fileNames = "config.yml plugin.yml backups/versions.log " + + "autoFeaturesConfig.yml blockConvertersConfig.json " + + "modules.yml module_conf/mines/config.json module_conf/mines/mineBombsConfig.json " + + "SellAllConfig.yml GuiConfig.yml backpacks/backpacksconfig.yml"; + ListThis constructs a player file named based upon the UUID followed + * by the player's name. This format is used so it's easier to identify + * the correct player. + *
+ * + *The format should be UUID-PlayerName.json. The UUID is a shortened + * format, which should still produce a unique id. The name, when read, + * is based upon the UUID and not the player's name, which may change. + * This format includes the player's name to make it easier to identify + * who's record is whom's. + *
+ * + * @return + */ + public String getPlayerFileName() { + + return JsonFileIO.getPlayerFileName( this ); + } + @Override public void updateInventory() { } diff --git a/prison-core/src/test/java/tech/mcprison/prison/selection/SelectionTest.java b/prison-core/src/test/java/tech/mcprison/prison/selection/SelectionTest.java index 9e485c868..ecf00ca7d 100644 --- a/prison-core/src/test/java/tech/mcprison/prison/selection/SelectionTest.java +++ b/prison-core/src/test/java/tech/mcprison/prison/selection/SelectionTest.java @@ -21,6 +21,8 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertTrue; +import java.io.File; + import org.junit.Before; import org.junit.Rule; import org.junit.Test; @@ -47,7 +49,7 @@ public class SelectionTest { @Before public void setUp() throws Exception { TestPlatform testPlatform = new TestPlatform(temporaryFolder.newFolder("test"), false); Prison.get() - .init(testPlatform, "1.12.X-test.1"); + .init(testPlatform, "1.12.X-test.1", new File("plugins/Prison")); } @Test public void testSelection() throws Exception { diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/commands/MinesCommands.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/commands/MinesCommands.java index d24ee33da..7faefd31b 100644 --- a/prison-mines/src/main/java/tech/mcprison/prison/mines/commands/MinesCommands.java +++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/commands/MinesCommands.java @@ -29,7 +29,6 @@ import java.util.TreeMap; import tech.mcprison.prison.Prison; -import tech.mcprison.prison.PrisonCommand; import tech.mcprison.prison.chat.FancyMessage; import tech.mcprison.prison.commands.Arg; import tech.mcprison.prison.commands.Command; @@ -868,7 +867,7 @@ public void allMinesInfoDetails( StringBuilder sb ) { for ( Mine mine : mines ) { - PrisonCommand.printFooter( sb ); + Prison.get().getPrisonStatsUtil().printFooter( sb ); JumboTextFont.makeJumboFontText( mine.getName(), sb ); sb.append( "\n" ); @@ -882,7 +881,7 @@ public void allMinesInfoDetails( StringBuilder sb ) { sb.append( chatDisplay.toStringBuilder() ); } - PrisonCommand.printFooter( sb ); + Prison.get().getPrisonStatsUtil().printFooter( sb ); } @@ -1057,7 +1056,7 @@ else if ( !mineAccessByRank && tpAccessByRank ) { RowComponent row = new RowComponent(); double rtMinutes = resetTime / 60.0D; row.addTextComponent( "&3Reset time: &7%s &3Secs (&7%.2f &3Mins)", - Integer.toString(m.getResetTime()), rtMinutes ); + Integer.toString(resetTime), rtMinutes ); chatDisplay.addComponent( row ); } @@ -2884,14 +2883,16 @@ else if ( "enable".equalsIgnoreCase( mineSweeper ) && !m.isMineSweeperEnabled() @Command(identifier = "mines tp", description = "TP to the mine. Will default to the mine's " + - "spawn location if set, but can specify the target [spawn, mine]. OPs and console can " + + "spawn location if set, but can specify the target [spawn, mine]. Instead of a mine " + + "name, 'list' will show all mines you have access to. OPs and console can " + "TP other online players to a specified mine. Access for non-OPs can be setup through " + "'/mines set tpAccessByRank help` is preferred over permissions.", aliases = "mtp", altPermissions = {"access-by-rank", "mines.tp", "mines.tp.[mineName]"}) public void mineTp(CommandSender sender, @Arg(name = "mineName", def="", - description = "The name of the mine to teleport to.") String mineName, + description = "The name of the mine to teleport to, or 'list' to show all " + + "mines that you have access to.") String mineName, @Arg(name = "player", def = "", description = "Player name to TP - " + "Only console or rank command can include this parameter") String playerName, @@ -2902,6 +2903,28 @@ public void mineTp(CommandSender sender, ) { + if ( mineName != null && + "list".equals( mineName )) { + + Player player = getPlayer( sender, playerName ); + +// Player playerAlt = getPlayer( playerName ); +// +// if ( playerAlt != null ) { +// player = playerAlt; +// } + + if ( player == null ) { + Output.get().logInfo( "Mine TP List: You must either be a player, or refer to a valid player." ); + return; + } + + Prison.get().getPlatform().listAllMines( sender, player ); + + return; + } + + if ( mineName != null && ("spawn".equalsIgnoreCase( mineName ) || "mine".equalsIgnoreCase( mineName )) ) { target = mineName; @@ -3389,26 +3412,34 @@ private void generateBlockEventListing( Mine m, ChatDisplay display, boolean inc @Command(identifier = "mines blockEvent remove", description = "Removes a BlockEvent command from a mine.", onlyPlayers = false, permissions = "mines.set") public void blockEventRemove(CommandSender sender, - @Arg(name = "mineName") String mineName, - @Arg(name = "row") Integer row) { + @Arg(name = "mineName" ) String mineName, + @Arg(name = "row", def = "0") Integer row) { + + if (!performCheckMineExists(sender, mineName)) { + return; + } + + setLastMineReferenced(mineName); + + PrisonMines pMines = PrisonMines.getInstance(); + Mine m = pMines.getMine(mineName); if ( row == null || row <= 0 ) { - sender.sendMessage( - String.format("&7Please provide a valid row number greater than zero. " + + + ChatDisplay display = new ChatDisplay("BlockEvent Commands for " + m.getTag()); + display.addText("&8Hover over values for more information and clickable actions."); + generateBlockEventListing( m, display, true ); + + display.addText( + "&7Please provide a valid row number greater than zero. " + "Was row=[&b%d&7]", - (row == null ? "null" : row) )); + (row == null ? "null" : row) ); + + display.send(sender); + return; } - if (!performCheckMineExists(sender, mineName)) { - return; - } - - setLastMineReferenced(mineName); - - PrisonMines pMines = PrisonMines.getInstance(); - Mine m = pMines.getMine(mineName); - if (m.getBlockEvents() == null || m.getBlockEvents().size() == 0) { Output.get().sendInfo(sender, "The mine '%s' contains no BlockEvent commands.", m.getTag()); @@ -3448,7 +3479,7 @@ public void blockEventRemove(CommandSender sender, "For each block that is broke there will be a chance to run one of these commands. \n" + "To send messages use {msg}, {broadcast}, {actionBar}, or {title} followed by the formatted message. " + "Can use placeholders {player} and {player_uid}. Use ; between multiple commands. \n" + - "Example: &7\\Q'token give {player} 1;{msg} &7You got &31 &7token!;tpa a'\\E&3 \n" + + "Example: &7\\Q'token give {player} 1;{msg} &7You got &31 &7token!;mtp a'\\E&3 \n" + "This command defaults to no permission and 'sync' task mode; " + "see '/mines blockEvent' for more blockEvent options.", onlyPlayers = false, permissions = "mines.set", @@ -3616,20 +3647,55 @@ public void blockEventAdd(CommandSender sender, onlyPlayers = false, permissions = "mines.set") public void blockEventPercent(CommandSender sender, @Arg(name = "mineName") String mineName, - @Arg(name = "row") Integer row, + @Arg(name = "row", def = "0") Integer row, @Arg(name = "percent", - description = "Percent chance between 0.0000 and 100.0") Double chance) { + description = "Percent chance between 0.0000 and 100.0", + def = "100") Double chance) { if (!performCheckMineExists(sender, mineName)) { return; } + + setLastMineReferenced(mineName); + + PrisonMines pMines = PrisonMines.getInstance(); +// MineManager mMan = pMines.getMineManager(); + Mine m = pMines.getMine(mineName); + if ( row == null || row <= 0 ) { - sender.sendMessage( - String.format("&7Please provide a valid row number greater than zero. " + + ChatDisplay display = new ChatDisplay("BlockEvent Commands for " + m.getTag()); + display.addText("&8Hover over values for more information and clickable actions."); + generateBlockEventListing( m, display, true ); + + display.addText( + "&7Please provide a valid row number greater than zero. " + "Was row=[&b%d&7]", - (row == null ? "null" : row) )); - return; + (row == null ? "null" : row) ); + + + + String commandRoot = String.format( "" + + "/mines blockEvent percent %s", m.getName() ); + + display.addText( "&7Select a BlockEvent by row number to set the percentage" ); + + // try to "suggest" reading this command: + // mines blockEvent percentThis is the reset time for the mine, in seconds. + * A value of -1 means no timed resets. They will have to be done manually. + *
+ */ public int getResetTime() { return resetTime; } diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineScheduler.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineScheduler.java index 693eca1ca..8ded47dfa 100644 --- a/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineScheduler.java +++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineScheduler.java @@ -339,6 +339,9 @@ public void run() boolean forced = resetScheduleType == MineResetScheduleType.FORCED; + // If not a manual reset, and if the resetTime is -1, which means never reset + // based upon time, then exit and trigger the next action. This should never + // happen, since the task will never advance to this state, but just in case. if ( getResetTime() <= 0 && !forced ) { submitNextAction(); @@ -427,6 +430,8 @@ public void run() // } // + // this may be an issue for disabled resetTimes... may still need to be submitted? + // disabled resets may not need to be submitted at all. if ( getResetTime() > 0 ) { submitNextAction(); diff --git a/prison-mines/src/test/java/tech/mcprison/prison/mines/data/PrisonSortableMinesTest.java b/prison-mines/src/test/java/tech/mcprison/prison/mines/data/PrisonSortableMinesTest.java index dd87e616b..c93683e37 100644 --- a/prison-mines/src/test/java/tech/mcprison/prison/mines/data/PrisonSortableMinesTest.java +++ b/prison-mines/src/test/java/tech/mcprison/prison/mines/data/PrisonSortableMinesTest.java @@ -8,6 +8,7 @@ import org.junit.Test; +@SuppressWarnings("deprecation") public class PrisonSortableMinesTest extends PrisonSortableMines { diff --git a/prison-ranks/src/main/java/tech/mcprison/prison/ranks/FirstJoinHandler.java b/prison-ranks/src/main/java/tech/mcprison/prison/ranks/FirstJoinHandler.java index 7d546d044..a84d4be9e 100644 --- a/prison-ranks/src/main/java/tech/mcprison/prison/ranks/FirstJoinHandler.java +++ b/prison-ranks/src/main/java/tech/mcprison/prison/ranks/FirstJoinHandler.java @@ -21,7 +21,6 @@ import tech.mcprison.prison.Prison; import tech.mcprison.prison.ranks.data.RankPlayer; -import tech.mcprison.prison.ranks.data.RankPlayerFactory; import tech.mcprison.prison.ranks.events.FirstJoinEvent; /** @@ -46,17 +45,15 @@ public FirstJoinHandler() { @Subscribe public void onFirstJoin(FirstJoinEvent event) { RankPlayer player = event.getPlayer(); + + PrisonRanks.getInstance().getPlayerManager().checkPlayerDefaultRank(player); - // Try to perform the first join processing to give them the default rank: - RankPlayerFactory rankPlayerFactory = new RankPlayerFactory(); - rankPlayerFactory.firstJoin( player ); +// // Try to perform the first join processing to give them the default rank: +// RankPlayerFactory rankPlayerFactory = new RankPlayerFactory(); +// rankPlayerFactory.firstJoin( player ); +// +// PrisonRanks.getInstance().getPlayerManager().savePlayer(player); - PrisonRanks.getInstance().getPlayerManager().savePlayer(player); -// try { -// } catch (IOException e) { -// -// Output.get().logError( firstJoinErrorCouldNotSavePlayer(), e ); -// } } } diff --git a/prison-ranks/src/main/java/tech/mcprison/prison/ranks/PrisonRanks.java b/prison-ranks/src/main/java/tech/mcprison/prison/ranks/PrisonRanks.java index 732c3e872..9b585574a 100644 --- a/prison-ranks/src/main/java/tech/mcprison/prison/ranks/PrisonRanks.java +++ b/prison-ranks/src/main/java/tech/mcprison/prison/ranks/PrisonRanks.java @@ -198,12 +198,12 @@ public void enable() { } - // Hook up all players to the ranks: playerManager.connectPlayersToRanks( false ); Output.get().logInfo( "Ranks: Finished Connecting Players to Ranks." ); + // Load up the commands @@ -257,6 +257,12 @@ public void enable() { + // Start up the TopNPlayer's collections after all players have been loaded: + // NOTE: getting the instance of TopNPlayers must be done "after" player validation. + // So that thread needs to initiate it after done validating and fixing all players. +// TopNPlayers.getInstance(); + + // Check all players to see if any need to join: RanksStartupPlayerValidationsAsyncTask.submitTaskSync( this ); // checkAllPlayersForJoin(); @@ -272,7 +278,7 @@ public void checkAllPlayersForJoin() // If there is a default rank on the default ladder, then // check to see if there are any players not in prison: add them: - RankLadder defaultLadder = getLadderManager().getLadder( "default" ); + RankLadder defaultLadder = getLadderManager().getLadder( LadderManager.LADDER_DEFAULT ); if ( defaultLadder != null && defaultLadder.getRanks().size() > 0 ) { int addedPlayers = 0; int fixedPlayers = 0; @@ -295,6 +301,17 @@ public void checkAllPlayersForJoin() // If any player does not have a rank on the default ladder, then add the default // ladder and rank: Rank defaultRank = defaultLadder.getLowestRank().get(); + + if ( defaultRank == null ) { + Output.get().logInfo( + "PrisonRanks.checkAllPlayersForJoin: Warning: No default rank exists, so bypassing " + + "the player checks. There may be players online without a rank which could " + + "cause problems. Create a default rank and then restart the server to validate and " + + "repair all players."); + return; + } + + for ( RankPlayer rPlayer : playerManager.getPlayers() ) { @SuppressWarnings( "unused" ) @@ -372,8 +389,8 @@ private Collection initCollection(String collName) { * A default ladder is absolutely necessary on the server, so let's create it if it doesn't exist, this also create the prestiges ladder. */ private void createDefaultLadder() { - if ( ladderManager.getLadder("default") == null ) { - RankLadder rankLadder = ladderManager.createLadder("default"); + if ( ladderManager.getLadder(LadderManager.LADDER_DEFAULT) == null ) { + RankLadder rankLadder = ladderManager.createLadder(LadderManager.LADDER_DEFAULT); if ( rankLadder == null ) { @@ -393,8 +410,8 @@ private void createDefaultLadder() { } } - if ( ladderManager.getLadder("prestiges") == null ) { - RankLadder rankLadder = ladderManager.createLadder("prestiges"); + if ( ladderManager.getLadder(LadderManager.LADDER_PRESTIGES) == null ) { + RankLadder rankLadder = ladderManager.createLadder(LadderManager.LADDER_PRESTIGES); if ( rankLadder == null ) { @@ -456,7 +473,11 @@ public PlayerManager getPlayerManager() { } public RankLadder getDefaultLadder() { - return getLadderManager().getLadder("default"); + return getLadderManager().getLadder(LadderManager.LADDER_DEFAULT); + } + + public RankLadder getPrestigesLadder() { + return getLadderManager().getLadder(LadderManager.LADDER_PRESTIGES); } public Database getDatabase() { @@ -482,11 +503,11 @@ private int getLadderRankCount( String ladderName ) { } public int getDefaultLadderRankCount() { - return getLadderRankCount( "default" ); + return getLadderRankCount( LadderManager.LADDER_DEFAULT ); } public int getPrestigesLadderRankCount() { - return getLadderRankCount( "prestiges" ); + return getLadderRankCount( LadderManager.LADDER_PRESTIGES ); } public int getladderCount() { diff --git a/prison-ranks/src/main/java/tech/mcprison/prison/ranks/RankUtil.java b/prison-ranks/src/main/java/tech/mcprison/prison/ranks/RankUtil.java index a692f3e43..edc8a3338 100644 --- a/prison-ranks/src/main/java/tech/mcprison/prison/ranks/RankUtil.java +++ b/prison-ranks/src/main/java/tech/mcprison/prison/ranks/RankUtil.java @@ -33,7 +33,9 @@ import tech.mcprison.prison.ranks.data.RankLadder; import tech.mcprison.prison.ranks.data.RankPlayer; import tech.mcprison.prison.ranks.data.RankPlayerFactory; +import tech.mcprison.prison.ranks.data.TopNPlayers; import tech.mcprison.prison.ranks.events.RankUpEvent; +import tech.mcprison.prison.ranks.managers.LadderManager; import tech.mcprison.prison.tasks.PrisonCommandTaskData; import tech.mcprison.prison.tasks.PrisonCommandTaskData.CustomPlaceholders; @@ -315,7 +317,7 @@ private RankupResults rankupPlayer(RankupCommands command, Player player, RankPl // If ladderName is null, then assign it the default ladder: if ( ladderName == null ) { - ladderName = "default"; + ladderName = LadderManager.LADDER_DEFAULT; results.addTransaction(RankupTransactions.assigned_default_ladder); } @@ -409,7 +411,7 @@ private void rankupPlayerInternal(RankupResults results, if ( command == RankupCommands.setrank && "-remove-".equalsIgnoreCase( rankName ) ) { results.addTransaction(RankupTransactions.attempting_to_delete_ladder_from_player); - if ("default".equalsIgnoreCase( ladderName ) ) { + if (LadderManager.LADDER_DEFAULT.equalsIgnoreCase( ladderName ) ) { results.addTransaction(RankupTransactions.cannot_delete_default_ladder); } else { @@ -443,16 +445,34 @@ private void rankupPlayerInternal(RankupResults results, // This calculates the target rank, and takes in to consideration the player's existing rank: - PlayerRank pRankNext = - originalRank == null ? null : - originalRank.getTargetPlayerRankForPlayer( rankPlayer, targetRank ); + + // Warning the following won't work if the player has no default rank since it will become a + // circular reference: +// PlayerRank pRankNext = rankPlayer.getNextPlayerRank(); + + PlayerRank pRankNext = null; + + if ( originalRank == null ) { + Rank nextRank = PrisonRanks.getInstance().getDefaultLadder().getLowestRank().orElse( null ); + pRankNext = rankPlayer.createPlayerRank(nextRank); + } + else { + + pRankNext = rankPlayer.calculateTargetPlayerRank( targetRank ); + } +// originalRank.getTargetPlayerRankForPlayer( rankPlayer, targetRank ); // new PlayerRank( targetRank, originalRank.getRankMultiplier() ); // If player does not have a rank on this ladder, then grab the first rank on the ladder since they need // to be added to the ladder. if ( pRankNext == null ) { - pRankNext = rankPlayerFactory.createPlayerRank( targetRank ); + results.addTransaction( RankupStatus.RANKUP_FAILURE_RANK_DOES_NOT_EXIST, + RankupTransactions.failed_rank_not_in_ladder ); + return; + + +// pRankNext = rankPlayerFactory.createPlayerRank( targetRank ); // pRankNext = originalRank.getTargetPlayerRankForPlayer( rankPlayer, ladder.getLowestRank().get() ); } @@ -463,7 +483,9 @@ private void rankupPlayerInternal(RankupResults results, // String currency = ""; - double nextRankCost = pRankNext.getRankCost(); + double nextRankCost = pRankNext == null || pRankNext.getRankCost() == null ? + 0.0d : pRankNext.getRankCost(); + double currentRankCost = ( results.getPlayerRankOriginal() == null ? 0 : results.getPlayerRankOriginal().getRankCost() ); @@ -700,6 +722,11 @@ else if ( pForceCharge == PromoteForceCharge.refund_player) { rankPlayer.recalculateRankMultipliers(); + // Sort the Top ranked list: +// rankPlayer.forcePlayerToRecalculateRankScore(); + TopNPlayers.getInstance().updatePlayerData(rankPlayer); + + // results.addTransaction( RankupTransactions.fireRankupEvent ); // // // Nothing can cancel a RankUpEvent: @@ -789,7 +816,7 @@ private Rank calculateTargetRank(RankupCommands command, RankupResults results, return targetRank; } - else if ("default".equalsIgnoreCase( results.getLadder().getName() ) && rankName == null ) { + else if (LadderManager.LADDER_DEFAULT.equalsIgnoreCase( results.getLadder().getName() ) && rankName == null ) { OptionalThis is safe to run on anyone, even if they already are on the default ladder. + *
This is safe to run on anyone, even if they already are on the default ladder + * since it will skip processing for them. *
* *Note, this will not save the player's new rank. The save function must be
@@ -119,9 +122,15 @@ public void firstJoin( RankPlayer rankPlayer) {
Optional This function is used when setting up a RankPlayer after loading from the
+ * file system. This takes the magic numbers that are used for ranks/ladders and
+ * finds the correct matches, which results in actual Rank objects. These ranks are
+ * then saved within the RankPlayer object for each player.
+ * This function will create a PlayerRank without a player. This is to be
+ * used only with caution and where a player cannot be created, such as
+ * a command to list generic PlayerRanks.
+ * This is only used in one location:
+ * tech.mcprison.prison.ranks.commands.RanksCommands.rankInfoDetails(CommandSender, Rank, String)
+ * The PlayerState will identify
+ * @author Blue
+ *
+ */
+ public enum PlayerState {
+// unknown,
+ offline,
+ online,
+ archived;
+ }
+
+ public File getSaveFile() {
+ if ( this.saveFile == null ) {
+
+ File directory = new File( Prison.get().getDataFolder(), PATH__TOP_N_PLAYERS );
+
+ this.saveFile = new File( directory, FILE_NAME__TOP_N_PLAYERS_JSON );
+ }
+ return saveFile;
+ }
+
+ private void launchTopNPlayerUpdateAsyncTask() {
+
+ Long delayTicks = Prison.get().getPlatform().getConfigLong(
+ "topNPlayers.refresh.delay-ticks", DELAY_THIRTY_SECONDS_TICKS );
+ Long intervalTicks = Prison.get().getPlatform().getConfigLong(
+ "topNPlayers.refresh.interval-ticks", INTERVAL_FIVE_MINUTES_TICKS );
+
+
+ TopNPlayerUpdateAsyncTask.submitTaskTimerAsync( this, delayTicks, intervalTicks );
+ }
+
+ /**
+ * Upon server startup, in an asynch thread, this function should be called
+ * to load the saved data from the file system. If there is no saved data,
+ * then this function will access the PlayerManager and build an initial
+ * collection from the existing players.
+ * If any changes were made to any collections, or preexisting topN entries,
+ * then this class will be marked as dirty so this loader would know that
+ * it needs to update the save file. It will then save it changes.
+ * This adds the topN player data. This player may already be in the
+ * collection, so if they are, then this is treated more like an update.
+ * This sorts both the topNList and the archivedList.
+ * This function will add the RankPlayer data to the topN collections.
+ * This does NOT sort any of the results, so this is to be used to add a lot
+ * of entries, such as on server startup, or with updating with OnlinePlayers.
+ * See updatePlayerData() if being used with a single player, such as with rankup.
+ * This function will update, or add, a player's information within topN. and when
+ * The first thing this function does, is to calculate the rankScore for the RankPlayer.
+ * It will then add the player to the topN. When finished it will provide a
+ * simple sort of the topN results. This will allow the player
+ * who just ranked up to reflect their changes in topN without having to
+ * wait until the whole topN set is refreshed. The sorting used here will not update
+ * any of the other player's balances or status, so this has a low-cost sorting.
+ * This function will return the RankPlayer that is at the given rankPosition
+ * within the topN collection. If rankPosition is out of range, then it will return
+ * a null value.
+ * This class represent a player within the topN rankings.
+ * Since PlayerState has three values:
+ * The way that the rank scores are calculated are rather complex, but this class
+ * tries to simplify the details.
+ * The primary way topN is sorted is by **current** rank positions for both the
+ * default ladder and the prestiges ladder. For the prestiges ladder, if they do not have
+ * a current rank on that ladder, then they would have a rank-ladder position of zero.
+ *
+ * These rank position values become the first and second tier of sorting.
+ * If the player does not have a default rank, then assign it to them and
+ * then save their new settings.
+ * This function will add all the players to all of the ranks they
* are associated with.
@@ -253,9 +259,9 @@ public TreeMap This function will take the default rank (result parameter) and the rankPrestige
+ * and use them to talk the ladders to find a match for the targetRank.
+ * The result Rank that is returned from this function is only useful for
+ * internal use since it will prevent the clearing of the totalRanks list
+ * when coming out of recursion. When outside of this function, then real
+ * value is within totalRanks.
+ * This can be useful to see if a given plugin is active. The returned
+ * data, RegisteredPluginData, has additional information pertaining to the
+ * plugin. If the plugin is not found, then this will return a null value.
+ * bStats reporting bStats reporting
- * VERY, VERY IMPORTANT: Because there are no standards for adding auto-update toggles in your plugin's config, this system provides NO CHECK WITH YOUR CONFIG to make sure the user has allowed auto-updating.
- *
+// * VERY, VERY IMPORTANT: Because there are no standards for adding auto-update toggles in your plugin's config, this system provides NO CHECK WITH YOUR CONFIG to make sure the user has allowed auto-updating.
+// *
- * With default behavior, Updater will NOT verify that a remote version available on BukkitDev
- * which is not this version is indeed an "update".
- * If a version is present on BukkitDev that is not the version that is currently running,
- * Updater will assume that it is a newer version.
- * This is because there is no standard versioning scheme, and creating a calculation that can
- * determine whether a new update is actually an update is sometimes extremely complicated.
- *
- * Updater will call this method from {@link #versionCheck()} before deciding whether
- * the remote version is actually an update.
- * If you have a specific versioning scheme with which a mathematical determination can
- * be reliably made to decide whether one version is higher than another, you may
- * revise this method, using the local and remote version parameters, to execute the
- * appropriate check.
- *
- * Returning a value of false will tell the update process that this is NOT a new version.
- * Without revision, this method will always consider a remote version at all different from
- * that of the local version a new update.
- *
+// * With default behavior, Updater will NOT verify that a remote version available on BukkitDev
+// * which is not this version is indeed an "update".
+// * If a version is present on BukkitDev that is not the version that is currently running,
+// * Updater will assume that it is a newer version.
+// * This is because there is no standard versioning scheme, and creating a calculation that can
+// * determine whether a new update is actually an update is sometimes extremely complicated.
+// *
+// * Updater will call this method from {@link #versionCheck()} before deciding whether
+// * the remote version is actually an update.
+// * If you have a specific versioning scheme with which a mathematical determination can
+// * be reliably made to decide whether one version is higher than another, you may
+// * revise this method, using the local and remote version parameters, to execute the
+// * appropriate check.
+// *
+// * Returning a value of false will tell the update process that this is NOT a new version.
+// * Without revision, this method will always consider a remote version at all different from
+// * that of the local version a new update.
+// * bStats reporting This function will split up a list of active plugins in to sub-groups.
+ * This is controlled by the rangeLow through rangeHigh parameters.
+ * The parameter includeNonAlpha will include all other plugins where their
+ * names do not begin with an alpha character; this is a catch-all to prevent plugins
+ * from being omitted.
+ * The parameter pluginsUsed is a set plugins that have already been
+ * included in other reports so therefore should be omitted from these reports.
+ * Most of the new reports falls in to specific formats for report plugins.
+ * This function uses the pattern to generate the report of interest.
+ * This constructs a player file named based upon the UUID followed
+ * by the player's name. This format is used so it's easier to identify
+ * the correct player.
+ * The format should be UUID-PlayerName.json. The UUID is a shortened
+ * format, which should still produce a unique id. The name, when read,
+ * is based upon the UUID and not the player's name, which may change.
+ * This format includes the player's name to make it easier to identify
+ * who's record is whom's.
+ * This constructs a player file named based upon the UUID followed
+ * by the player's name. This format is used so it's easier to identify
+ * the correct player.
+ * The format should be UUID-PlayerName.json. The UUID is a shortened
+ * format, which should still produce a unique id. The name, when read,
+ * is based upon the UUID and not the player's name, which may change.
+ * This format includes the player's name to make it easier to identify
+ * who's record is whom's.
+ *
- * It is a BUKKIT POLICY that you include a boolean value in your config that prevents the auto-updater from running AT ALL.
- *
- * If you fail to include this option in your config, your plugin will be REJECTED when you attempt to submit it to dev.bukkit.org.
- *
- * If you are unsure about these rules, please read the plugin submission guidelines: http://goo.gl/8iU5l
- *
- * @author Gravity
- * @version 2.4
- */
+///**
+// * Check for updates on BukkitDev for a given plugin, and download the updates if needed.
+// *
+// * It is a BUKKIT POLICY that you include a boolean value in your config that prevents the auto-updater from running AT ALL.
+// *
+// * If you fail to include this option in your config, your plugin will be REJECTED when you attempt to submit it to dev.bukkit.org.
+// *
+// * If you are unsure about these rules, please read the plugin submission guidelines: http://goo.gl/8iU5l
+// *
+// * @author Gravity
+// * @version 2.4
+// */
public class Updater {
- /* Constants */
-
- // Remote file's title
- private static final String TITLE_VALUE = "name";
- // Remote file's download link
- private static final String LINK_VALUE = "downloadUrl";
- // Remote file's release type
- private static final String TYPE_VALUE = "releaseType";
- // Remote file's build version
- private static final String VERSION_VALUE = "gameVersion";
- // Path to GET
- private static final String QUERY = "/servermods/files?projectIds=";
- // Slugs will be appended to this to get to the project's RSS feed
- private static final String HOST = "https://api.curseforge.com";
- // User-agent when querying Curse
- private static final String USER_AGENT = "Updater (by Gravity)";
- // Used for locating version numbers in file names
- private static final String DELIMETER = "^v|[\\s_-]v";
- // If the version number contains one of these, don't update.
- private static final String[] NO_UPDATE_TAG = {"-DEV", "-PRE", "SNAPSHOT"};
- // Used for downloading files
- private static final int BYTE_SIZE = 1024;
- // Config key for api key
- private static final String API_KEY_CONFIG_KEY = "api-key";
- // Config key for disabling Updater
- private static final String DISABLE_CONFIG_KEY = "disable";
- // Default api key value in config
- private static final String API_KEY_DEFAULT = "PUT_API_KEY_HERE";
- // Default disable value in config
- private static final boolean DISABLE_DEFAULT = false;
-
- /* User-provided variables */
-
- // Plugin running Updater
- private final Plugin plugin;
- // Type of update check to run
- private final UpdateType type;
- // Whether to announce file downloads
- private final boolean announce;
- // The plugin file (jar)
- private final File file;
- // The folder that downloads will be placed in
- private final File updateFolder;
- // The provided callback (if any)
- private final UpdateCallback callback;
- // Project's Curse ID
- private int id = -1;
- // BukkitDev ServerMods API key
- private String apiKey = null;
-
- /* Collected from Curse API */
-
- private String versionName;
- private String versionLink;
- private String versionType;
- private String versionGameVersion;
-
- /* Update process variables */
-
- // Connection to RSS
- private URL url;
- // Updater thread
- private Thread thread;
- // Used for determining the outcome of the update process
- private Updater.UpdateResult result = Updater.UpdateResult.SUCCESS;
-
-
- /**
- * Gives the developer the result of the update process. Can be obtained by called {@link #getResult()}
- */
- public enum UpdateResult {
- /**
- * The updater found an update, and has readied it to be loaded the next time the server restarts/reloads.
- */
- SUCCESS, /**
- * The updater did not find an update, and nothing was downloaded.
- */
- NO_UPDATE, /**
- * The server administrator has disabled the updating system.
- */
- DISABLED, /**
- * The updater found an update, but was unable to download it.
- */
- FAIL_DOWNLOAD, /**
- * For some reason, the updater was unable to contact dev.bukkit.org to download the file.
- */
- FAIL_DBO, /**
- * When running the version check, the file on DBO did not contain a recognizable version.
- */
- FAIL_NOVERSION, /**
- * The id provided by the plugin running the updater was invalid and doesn't exist on DBO.
- */
- FAIL_BADID, /**
- * The server administrator has improperly configured their API key in the configuration.
- */
- FAIL_APIKEY, /**
- * The updater found an update, but because of the UpdateType being set to NO_DOWNLOAD, it wasn't downloaded.
- */
- UPDATE_AVAILABLE
- }
-
-
- /**
- * Allows the developer to specify the type of update that will be run.
- */
- public enum UpdateType {
- /**
- * Run a version check, and then if the file is out of date, download the newest version.
- */
- DEFAULT, /**
- * Don't run a version check, just find the latest update and download it.
- */
- NO_VERSION_CHECK, /**
- * Get information about the version and the download size, but don't actually download anything.
- */
- NO_DOWNLOAD
- }
-
-
- /**
- * Represents the various release types of a file on BukkitDev.
- */
- public enum ReleaseType {
- /**
- * An "alpha" file.
- */
- ALPHA, /**
- * A "beta" file.
- */
- BETA, /**
- * A "release" file.
- */
- RELEASE
- }
-
- /**
- * Initialize the updater.
- *
- * @param plugin The plugin that is checking for an update.
- * @param id The dev.bukkit.org id of the project.
- * @param file The file that the plugin is running from, get this by doing this.getFile() from within your main class.
- * @param type Specify the type of update this will be. See {@link UpdateType}
- * @param announce True if the program should announce the progress of new updates in console.
- */
- public Updater(Plugin plugin, int id, File file, UpdateType type, boolean announce) {
- this(plugin, id, file, type, null, announce);
- }
-
- /**
- * Initialize the updater with the provided callback.
- *
- * @param plugin The plugin that is checking for an update.
- * @param id The dev.bukkit.org id of the project.
- * @param file The file that the plugin is running from, get this by doing this.getFile() from within your main class.
- * @param type Specify the type of update this will be. See {@link UpdateType}
- * @param callback The callback instance to notify when the Updater has finished
- */
- public Updater(Plugin plugin, int id, File file, UpdateType type, UpdateCallback callback) {
- this(plugin, id, file, type, callback, false);
- }
-
- /**
- * Initialize the updater with the provided callback.
- *
- * @param plugin The plugin that is checking for an update.
- * @param id The dev.bukkit.org id of the project.
- * @param file The file that the plugin is running from, get this by doing this.getFile() from within your main class.
- * @param type Specify the type of update this will be. See {@link UpdateType}
- * @param callback The callback instance to notify when the Updater has finished
- * @param announce True if the program should announce the progress of new updates in console.
- */
- public Updater(Plugin plugin, int id, File file, UpdateType type, UpdateCallback callback,
- boolean announce) {
- this.plugin = plugin;
- this.type = type;
- this.announce = announce;
- this.file = file;
- this.id = id;
- this.updateFolder = this.plugin.getServer().getUpdateFolderFile();
- this.callback = callback;
-
- final File pluginFile = this.plugin.getDataFolder().getParentFile();
- final File updaterFile = new File(pluginFile, "Updater");
- final File updaterConfigFile = new File(updaterFile, "config.yml");
-
- YamlConfiguration config = new YamlConfiguration();
- config.options().header(
- "This configuration file affects all plugins using the Updater system (version 2+ - http://forums.bukkit.org/threads/96681/ )"
- + '\n'
- + "If you wish to use your API key, read http://wiki.bukkit.org/ServerMods_API and place it below."
- + '\n'
- + "Some updating systems will not adhere to the disabled value, but these may be turned off in their plugin's configuration.");
- config.addDefault(API_KEY_CONFIG_KEY, API_KEY_DEFAULT);
- config.addDefault(DISABLE_CONFIG_KEY, DISABLE_DEFAULT);
-
- if (!updaterFile.exists()) {
- this.fileIOOrError(updaterFile, updaterFile.mkdir(), true);
- }
-
- boolean createFile = !updaterConfigFile.exists();
- try {
- if (createFile) {
- this.fileIOOrError(updaterConfigFile, updaterConfigFile.createNewFile(), true);
- config.options().copyDefaults(true);
- config.save(updaterConfigFile);
- } else {
- config.load(updaterConfigFile);
- }
- } catch (final Exception e) {
- final String message;
- if (createFile) {
- message = "The updater could not create configuration at " + updaterFile
- .getAbsolutePath();
- } else {
- message =
- "The updater could not load configuration at " + updaterFile.getAbsolutePath();
- }
- this.plugin.getLogger().log(Level.SEVERE, message, e);
- }
-
- if (config.getBoolean(DISABLE_CONFIG_KEY)) {
- this.result = UpdateResult.DISABLED;
- return;
- }
-
- String key = config.getString(API_KEY_CONFIG_KEY);
- if (API_KEY_DEFAULT.equalsIgnoreCase(key) || "".equals(key)) {
- key = null;
- }
-
- this.apiKey = key;
-
- try {
- this.url = new URL(Updater.HOST + Updater.QUERY + this.id);
- } catch (final MalformedURLException e) {
- this.plugin.getLogger().log(Level.SEVERE,
- "The project ID provided for updating, " + this.id + " is invalid.", e);
- this.result = UpdateResult.FAIL_BADID;
- }
-
- if (this.result != UpdateResult.FAIL_BADID) {
- this.thread = new Thread(new UpdateRunnable());
- this.thread.start();
- } else {
- runUpdater();
- }
- }
-
- /**
- * Get the result of the update process.
- *
- * @return result of the update process.
- * @see UpdateResult
- */
- public Updater.UpdateResult getResult() {
- this.waitForThread();
- return this.result;
- }
-
- /**
- * Get the latest version's release type.
- *
- * @return latest version's release type.
- * @see ReleaseType
- */
- public ReleaseType getLatestType() {
- this.waitForThread();
- if (this.versionType != null) {
- for (ReleaseType type : ReleaseType.values()) {
- if (this.versionType.equalsIgnoreCase(type.name())) {
- return type;
- }
- }
- }
- return null;
- }
-
- /**
- * Get the latest version's game version (such as "CB 1.2.5-R1.0").
- *
- * @return latest version's game version.
- */
- public String getLatestGameVersion() {
- this.waitForThread();
- return this.versionGameVersion;
- }
-
- /**
- * Get the latest version's name (such as "Project v1.0").
- *
- * @return latest version's name.
- */
- public String getLatestName() {
- this.waitForThread();
- return this.versionName;
- }
-
- /**
- * Get the latest version's direct file link.
- *
- * @return latest version's file link.
- */
- public String getLatestFileLink() {
- this.waitForThread();
- return this.versionLink;
- }
-
- /**
- * As the result of Updater output depends on the thread's completion, it is necessary to wait for the thread to finish
- * before allowing anyone to check the result.
- */
- private void waitForThread() {
- if ((this.thread != null) && this.thread.isAlive()) {
- try {
- this.thread.join();
- } catch (final InterruptedException e) {
- this.plugin.getLogger().log(Level.SEVERE, null, e);
- }
- }
- }
-
- /**
- * Save an update from dev.bukkit.org into the server's update folder.
- *
- * @param file the name of the file to save it as.
- */
- private void saveFile(String file) {
- final File folder = this.updateFolder;
-
- deleteOldFiles();
- if (!folder.exists()) {
- this.fileIOOrError(folder, folder.mkdir(), true);
- }
- downloadFile();
-
- // Check to see if it's a zip file, if it is, unzip it.
- final File dFile = new File(folder.getAbsolutePath(), file);
- if (dFile.getName().endsWith(".zip")) {
- // Unzip
- this.unzip(dFile.getAbsolutePath());
- }
- if (this.announce) {
- this.plugin.getLogger().info("Finished updating.");
- }
- }
-
- /**
- * Download a file and save it to the specified folder.
- */
- private void downloadFile() {
- BufferedInputStream in = null;
- FileOutputStream fout = null;
- try {
- URL fileUrl = followRedirects(this.versionLink);
- final int fileLength = fileUrl.openConnection().getContentLength();
- in = new BufferedInputStream(fileUrl.openStream());
- fout = new FileOutputStream(new File(this.updateFolder, file.getName()));
-
- final byte[] data = new byte[Updater.BYTE_SIZE];
- int count;
- if (this.announce) {
- this.plugin.getLogger().info("About to download a new update: " + this.versionName);
- }
- long downloaded = 0;
- while ((count = in.read(data, 0, Updater.BYTE_SIZE)) != -1) {
- downloaded += count;
- fout.write(data, 0, count);
- final int percent = (int) ((downloaded * 100) / fileLength);
- if (this.announce && ((percent % 10) == 0)) {
- this.plugin.getLogger()
- .info("Downloading update: " + percent + "% of " + fileLength + " bytes.");
- }
- }
- } catch (Exception ex) {
- this.plugin.getLogger().log(Level.WARNING,
- "The auto-updater tried to download a new update, but was unsuccessful.", ex);
- this.result = Updater.UpdateResult.FAIL_DOWNLOAD;
- } finally {
- try {
- if (in != null) {
- in.close();
- }
- } catch (final IOException ex) {
- this.plugin.getLogger().log(Level.SEVERE, null, ex);
- }
- try {
- if (fout != null) {
- fout.close();
- }
- } catch (final IOException ex) {
- this.plugin.getLogger().log(Level.SEVERE, null, ex);
- }
- }
- }
-
- private URL followRedirects(String location) throws IOException {
- URL resourceUrl, base, next;
- HttpURLConnection conn;
- String redLoc;
- while (true) {
- resourceUrl = new URL(location);
- conn = (HttpURLConnection) resourceUrl.openConnection();
-
- conn.setConnectTimeout(15000);
- conn.setReadTimeout(15000);
- conn.setInstanceFollowRedirects(false);
- conn.setRequestProperty("User-Agent", "Mozilla/5.0...");
-
- switch (conn.getResponseCode()) {
- case HttpURLConnection.HTTP_MOVED_PERM:
- case HttpURLConnection.HTTP_MOVED_TEMP:
- redLoc = conn.getHeaderField("Location");
- base = new URL(location);
- next = new URL(base, redLoc); // Deal with relative URLs
- location = next.toExternalForm();
- continue;
- }
- break;
- }
- return conn.getURL();
- }
-
- /**
- * Remove possibly leftover files from the update folder.
- */
- private void deleteOldFiles() {
- //Just a quick check to make sure we didn't leave any files from last time...
- File[] list = listFilesOrError(this.updateFolder);
- for (final File xFile : list) {
- if (xFile.getName().endsWith(".zip")) {
- this.fileIOOrError(xFile, xFile.mkdir(), true);
- }
- }
- }
-
- /**
- * Part of Zip-File-Extractor, modified by Gravity for use with Updater.
- *
- * @param file the location of the file to extract.
- */
- private void unzip(String file) {
- final File fSourceZip = new File(file);
- try {
- final String zipPath = file.substring(0, file.length() - 4);
- ZipFile zipFile = new ZipFile(fSourceZip);
- Enumeration e = zipFile.entries();
- while (e.hasMoreElements()) {
- ZipEntry entry = e.nextElement();
- File destinationFilePath = new File(zipPath, entry.getName());
- this.fileIOOrError(destinationFilePath.getParentFile(),
- destinationFilePath.getParentFile().mkdirs(), true);
- if (!entry.isDirectory()) {
- final BufferedInputStream bis =
- new BufferedInputStream(zipFile.getInputStream(entry));
- int b;
- final byte[] buffer = new byte[Updater.BYTE_SIZE];
- final FileOutputStream fos = new FileOutputStream(destinationFilePath);
- final BufferedOutputStream bos =
- new BufferedOutputStream(fos, Updater.BYTE_SIZE);
- while ((b = bis.read(buffer, 0, Updater.BYTE_SIZE)) != -1) {
- bos.write(buffer, 0, b);
- }
- bos.flush();
- bos.close();
- bis.close();
- final String name = destinationFilePath.getName();
- if (name.endsWith(".jar") && this.pluginExists(name)) {
- File output = new File(this.updateFolder, name);
- this.fileIOOrError(output, destinationFilePath.renameTo(output), true);
- }
- }
- }
- zipFile.close();
-
- // Move any plugin data folders that were included to the right place, Bukkit won't do this for us.
- moveNewZipFiles(zipPath);
-
- } catch (final IOException e) {
- this.plugin.getLogger().log(Level.SEVERE,
- "The auto-updater tried to unzip a new update file, but was unsuccessful.", e);
- this.result = Updater.UpdateResult.FAIL_DOWNLOAD;
- } finally {
- this.fileIOOrError(fSourceZip, fSourceZip.delete(), false);
- }
- }
-
- /**
- * Find any new files extracted from an update into the plugin's data directory.
- *
- * @param zipPath path of extracted files.
- */
- private void moveNewZipFiles(String zipPath) {
- File[] list = listFilesOrError(new File(zipPath));
- for (final File dFile : list) {
- if (dFile.isDirectory() && this.pluginExists(dFile.getName())) {
- // Current dir
- final File oFile =
- new File(this.plugin.getDataFolder().getParent(), dFile.getName());
- // List of existing files in the new dir
- final File[] dList = listFilesOrError(dFile);
- // List of existing files in the current dir
- final File[] oList = listFilesOrError(oFile);
- for (File cFile : dList) {
- // Loop through all the files in the new dir
- boolean found = false;
- for (final File xFile : oList) {
- // Loop through all the contents in the current dir to see if it exists
- if (xFile.getName().equals(cFile.getName())) {
- found = true;
- break;
- }
- }
- if (!found) {
- // Move the new file into the current dir
- File output = new File(oFile, cFile.getName());
- this.fileIOOrError(output, cFile.renameTo(output), true);
- } else {
- // This file already exists, so we don't need it anymore.
- this.fileIOOrError(cFile, cFile.delete(), false);
- }
- }
- }
- this.fileIOOrError(dFile, dFile.delete(), false);
- }
- File zip = new File(zipPath);
- this.fileIOOrError(zip, zip.delete(), false);
- }
-
- /**
- * Check if the name of a jar is one of the plugins currently installed, used for extracting the correct files out of a zip.
- *
- * @param name a name to check for inside the plugins folder.
- * @return true if a file inside the plugins folder is named this.
- */
- private boolean pluginExists(String name) {
- File[] plugins = listFilesOrError(new File("plugins"));
- for (final File file : plugins) {
- if (file.getName().equals(name)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Check to see if the program should continue by evaluating whether the plugin is already updated, or shouldn't be updated.
- *
- * @return true if the version was located and is not the same as the remote's newest.
- */
- private boolean versionCheck() {
- final String title = this.versionName;
- if (this.type != UpdateType.NO_VERSION_CHECK) {
- final String localVersion = this.plugin.getDescription().getVersion();
- if (title.split(DELIMETER).length >= 2) {
- // Get the newest file's version number
- final String remoteVersion =
- title.split(DELIMETER)[title.split(DELIMETER).length - 1].split(" ")[0];
-
- if (this.hasTag(localVersion) || !this.shouldUpdate(localVersion, remoteVersion)) {
- // We already have the latest version, or this build is tagged for no-update
- this.result = Updater.UpdateResult.NO_UPDATE;
- return false;
- }
- } else {
- // The file's name did not contain the string 'vVersion'
- final String authorInfo = this.plugin.getDescription().getAuthors().isEmpty() ?
- "" :
- " (" + this.plugin.getDescription().getAuthors().get(0) + ")";
- this.plugin.getLogger().warning("The author of this plugin" + authorInfo
- + " has misconfigured their Auto Update system");
- this.plugin.getLogger()
- .warning("File versions should follow the format 'PluginName vVERSION'");
- this.plugin.getLogger().warning("Please notify the author of this error.");
- this.result = Updater.UpdateResult.FAIL_NOVERSION;
- return false;
- }
- }
- return true;
- }
-
- /**
- * If you wish to run mathematical versioning checks, edit this method.
- *