Add Floodgate integration to LuckPerms

[Camotoy]

Addresses #2236.

This commit adds integration with Floodgate and allows for users to be marked valid without lenient username checking. This has been tested on a Paper instance, and Bungee + Velocity run (though I am not sure how to test them). /lp user <user> info also specifies if a user is Floodgate.

TODO:

• A Java account running the /lp user <user> info command sees the username suggestion as invalid, but the command still runs. This seems specific to LuckPerms.
• Floodgate may get an API overhaul - one of the reasons this is marked as WIP.

[lucko]

Looks good so far - let me know when it's ready to be considered for merge. :)

[Camotoy]

Awesome, great to hear! The Floodgate rewrite seems to be around the corner so this will likely wait until then.

[Peda1996]

Any news yet?

[Camotoy]

Floodgate 2.0's API is mostly finished, but we're not sure about an ETA.

[CodeDoctorDE]

And?

[Camotoy]

Just an update that I have not forgotten about this! We have code for the rewrite: https://github.com/Tim203/Floodgate and I'll get back to this once that has entered a testing phase.

[DwifteJB]

Eta? I can't wait for this!

[DwifteJB]

Building @DoctorMacc's Repo and testing it on 1.16.3.

[ericgcollyer]

Also quite excited. Thanks for your work ok this @DoctorMacc

[acanthii]

Currently doesn't build :/

Error log: https://pastebin.com/FsUSX62G

[Camotoy]

This has been updated to the latest commit of Master, and the repository for Floodgate has been updated. The rewrite is still incoming but the code here is for the released build of Floodgate.

[incredimike]

I just built this successfully and works as expected on my paper server. Thank you!

[lucko]

I've just refactored most of the uuid/username lookup & validation code: 53fb46e

This is now all exposed in our API, so other plugins can more easily integrate with our checks instead of having to patch support in across the places where it is implemented in LP.

So -- the changes added in this PR can now be more succinctly implemented with the following code:

import net.luckperms.api.LuckPerms;
import net.luckperms.api.event.EventBus;
import net.luckperms.api.event.player.lookup.UniqueIdDetermineTypeEvent;
import net.luckperms.api.event.player.lookup.UsernameValidityCheckEvent;
import org.geysermc.floodgate.FloodgateAPI;

import java.util.regex.Pattern;

public class FloodgateHook {

    private final Pattern pattern;

    public FloodgateHook(LuckPerms luckPerms, String floodgatePrefix) {
        if (floodgatePrefix == null || floodgatePrefix.isEmpty()) {
            this.pattern = Pattern.compile("[a-zA-Z0-9_]*");
        } else {
            String pattern = String.format("\\%s?[a-zA-Z0-9_]*", Pattern.quote(floodgatePrefix));
            this.pattern = Pattern.compile(pattern);
        }

        EventBus eventBus = luckPerms.getEventBus();
        eventBus.subscribe(UniqueIdDetermineTypeEvent.class, this::onUuidTypeDetermine);
        eventBus.subscribe(UsernameValidityCheckEvent.class, this::onUsernameCheck);
    }

    private void onUuidTypeDetermine(UniqueIdDetermineTypeEvent e) {
        if (FloodgateAPI.isBedrockPlayer(e.getUniqueId())) {
            e.setType("floodgate");
        }
    }

    private void onUsernameCheck(UsernameValidityCheckEvent e) {
        if (!e.isValid() && this.pattern.matcher(e.getUsername()).matches()) {
            e.setValid(true);
        }
    }
}

I'm still ok with this being placed in LuckPerms, so long as it can be done in a neat & tidy way.

Alternatively, if there is a common module in Floodgate, it might be better suited living there?

[Camotoy]

There is a common module in Floodgate, yes.

I'll deliberate on how to best handle this. Thanks for the heads-up!

[Snivine]

how is this going? is still WIP?

[Camotoy]

Yes, as I plan on waiting until the Floodgate rewrite to complete.

[Fernthedev]

Hope it's going well. Any updates?

[tadhgboyle]

Small nitpick, why is this GREEN rather than DARK_GREEN as the other options are?

[Camotoy]

Just to differentiate it from the other options.

[Camotoy]

@Fernthedev no updates, and the Floodgate rewrite has been making progress but alas it is not here quite yet.

[PappoYT]

Hello, I'm interested in this update.
Are there any news about? TY

[Camotoy]

The Floodgate rewrite is probably actually coming out soon for realsies.

The Floodgate rewrite seems to be around the corner

July 16, 2020 :P

[Camotoy]

OK, the Floodgate rewrite is finally out for testing. However, with the suggestion Lucko proposed, the changes in Floodgate 2.0, and me not wanting to deal with merge conflicts, I'm going to close this and make a new PR soon.