Improve Bans API. Add Whitelist API #954
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -29,7 +29,7 @@ | |||
| * using an {@link Enum}. | |||
| * | |||
| * <p>All implementing classes, including those not listed in the catalog | |||
| * specified by the {@link org.spongepowered.api.util.annotation.CatalogedBy | |||
| * specified by the {@link org.spongepowered.api.util.annnotation.CatalogedBy | |||
Aaron1011
force-pushed
the
feature/new-bans
branch
from
17f0d1b
to
bcd2154
Compare
| @@ -44,7 +44,7 @@ | |||
| String SUBJECTS_ROLE_TEMPLATE = "role-template"; | |||
|
|
|||
| /** | |||
| * Returns the permissions level that describes users. User identifiers are | |||
| * Returns the permissions level that describes users. Profile identifiers are | |||
Aaron1011
force-pushed
the
feature/new-bans
branch
2 times, most recently
from
f8de336
to
3b6cfb3
Compare
|
Closed in 7089fbd |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SpongeAPI | SpongeCommon
This PR improves the Bans API, correcting several issues preventing it from being implemented properly.
Notable changes:
BanTypeenum has been replaced with the standard pseudo-enum classes (BanTypeandBanTypes)GameProfiles instead ofUsers. AUserhas associated world data, which is not applicable forBans.GameProfileorInetAddresscan have exactly one ban. The previous concept of multiple bans per user/IP was a significant departure from Vanilla, and had no real use-casesBanDataandWhitelistDatareferences have been removed. This was a redundant way of accessing theBanService, and made it too easy for plugins to overwrite existing bans.Ban#getStartDatehas been changed toBan#getCreatedDate. While the date is present in Vanilla, it only serves as an informational value. Making it function as a proper start date would break Vanilla compatibility, or introduce a disparity between the internal handling of Bans versus theBanServiceWhitelistService. This is much simpler thanBanService, as Vanilla whitelist entries lack the complexity of ban entries (no start/expiration date, source, orInetAddresstarget)ClientConnectionEvent.Loginis now fired already cancelled, if the player would be unable to join due to a ban/lack of whitelist/server being full.Both
BanServiceandWhitelistServicefully support replacement. However,SimpleServiceManagerstill needs to be updated to allow services to be replaced.TODO:
ClientConnectionEvent.Join. This could be in the form of a specificCauseobject (similar toSpawnCause), or 'getOriginalXXX, getXXX, setXXXmethods on the event.