Feature/auto whitelist #16

voidpointer0x00 · 2023-03-26T04:30:10Z

This PR will introduce automatic whitelisting when a player joins the game. The feature is better explained through the configuration.

VoidWhitelist/src/main/resources/config.yml

Lines 37 to 65 in 5d7ea41

    
           #   When both whitelist and auto-whitelist are enabled, the plugin will automatically 
        
           # add a joining player of selected group to the whitelist for the specified duration. 
        
           # 
        
           #   A single player can only get automatically whitelisted "max-repeats" times. 
        
           # So if it's set to 2, after the first period they will be able to get extra time. 
        
           # * It won't work the second time IF they do not meet current strategy requirements. 
        
           # 
        
           #   Strategies select a group of players who will be automatically whitelisted 
        
           # upon joining the server. 
        
           auto-whitelist: 
        
             enabled: true 
        
             #   Any value in range (-∞;0] will be treated as permanent whitelisting, 
        
             # WHICH SHOULD NOT BE USED (because then what's the point in using a whitelist?) 
        
             # 
        
             #   Any value that can not be parsed will result in disabling the automatic 
        
             # whitelisting feature until the configuration is fixed and reloaded. 
        
             duration: 7d 
        
             #   A value of zero will disable the auto whitelisting. 
        
             #   Any negative number will disable this property and players will be able to 
        
             # infinitely join the server and get whitelisted every time. 
        
             max-repeats: 1 
        
             # all — simply every joining player if the number that they've been "freely" whitelisted 
        
             #       have yet to exceed the limiting "max-repeats" property. 
        
             # 
        
             # newcomers — only those players who have never player on this server before. 
        
             #       This strategy makes use of Bukkit's #hasPlayerBefore() method that checks 
        
             #       whether the server has any data on the given player. This will always 
        
             #       be true if you disable the property «players.disable-saving» in spigot.yml 
        
             strategy: all

Aside from that, I decided that serial storage will no longer be supported by the plugin :) It was introduced in early days of development just as a very quick and simple way to setup the storage for testing purposes and was later replaced with much more useful JSON storage.

github-advanced-security · 2023-03-26T04:30:12Z

You have successfully added a new CodeQL configuration .github/workflows/codeql-analysis.yml:analyze/language:java. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

Automatic addition must be executed before the "disallow" listener, so it needs to be at a lower priority. Leaving LOWEST, NORMAL and HIGHEST priorities allows other listeners to make changes to the system.

Backwards-compatibility: use older method for parsing JsonReader

# Conflicts: # pom.xml

More work to be done to support it tho

`whitelist` table's schema was changed, the plugin will run automatic migration if old db structure is detected. This means that plugin will still work just fine, BUT anyone who used the old db schema in their projects will have to change it to keep compatibility.

Fix: update `timesAutoWhitelisted` field after auto-whitelist

This idea was just flawed :) If a person gets removed from the whitelist, their limit field would be just lost, so they would get auto whitelisted again no matter how many times they already were in the past.

voidpointer0x00 · 2023-04-15T21:03:59Z

In commit d7d0f93 permissions for /whitelist on|off were changed from voidwhitelist.whitelist.enable and voidwhitelist.whitelist.disable to voidwhitelist.whitelist.on and voidwhitelist.whitelist.off.

This commit renames configuration property `max-repeats` to `limit`, updates documentation and adds a respective config migration.

.../java/voidpointer/spigot/voidwhitelist/config/migration/WhitelistConfigMigrationFactory.java

Implement `set` and `info` commands Implement `set` and `info` commands

Refactoring: create public StrategyPredicate enum instead of factory

FileNotFoundException by experience usually indicates that Mojang has no data on the given player, meaning there is no such registered nickname.

voidpointer0x00

Looks ready, tested all the new features — works just fine. Just gotta change version and it's ready to release :)

Add YAML configuration for automatic whitelisting

7ff8ea0

voidpointer0x00 added the type: feature request New feature or request label Mar 26, 2023

voidpointer0x00 added 16 commits April 2, 2023 16:31

Refactoring: make listener method names make more sense

904ab40

Explicitly declare normal event priority

ab4e135

Caution note when setting max-repeats < 1

376fca5

0.9.4-unstable

ec3e4df

Implement auto whitelist configuration with migration

a467de5

Change event priorities for disallow & auto whitelist

c1cfd1b

Automatic addition must be executed before the "disallow" listener, so it needs to be at a lower priority. Leaving LOWEST, NORMAL and HIGHEST priorities allows other listeners to make changes to the system.

Backwards-compatibility: use older method for parsing JsonReader

344242f

Backwards-compatibility: use older method for parsing JsonReader

Backwards-compatibility: api-version 1.18->1.13

9d3d3d9

It works, TODO removed :)

3628ee2

Merge branch 'dev-j8' into feature/auto-whitelist

fb8152f

# Conflicts: # pom.xml

Implement strategy predicates

4762d7c

Implement auto-whitelist listener logic

7200e6a

Add timesAutoWhitelisted field to Whitelistable implementations

df9f4b0

More work to be done to support it tho

Fix: update timesAutoWhitelisted field after auto-whitelist

d2916b7

Fix: update `timesAutoWhitelisted` field after auto-whitelist

Implement V3 JSON update

f9979c5

voidpointer0x00 self-assigned this Apr 3, 2023

voidpointer0x00 added 10 commits April 4, 2023 11:09

Fix: invert #hasPlayedBefore()

1d2cd26

Rephrase logging message a bit

1ab081a

Fix: timesAutoWhitelisted was left unchanged on #add()

1489310

Rollback new timesAutoWhitelisted field invention

95515ac

This idea was just flawed :) If a person gets removed from the whitelist, their limit field would be just lost, so they would get auto whitelisted again no matter how many times they already were in the past.

Change description for max-repeats property

09d4b9c

Rewrite docs for #isDateExpirable(Date)

2cf4e25

Remove TODO

6e7724a

Introduce AutoWhitelistService

9ceb166

Fix: use public getter for whitelist field

c54fb8d

Use AutoWhitelistService type

4392698

voidpointer0x00 added 2 commits April 16, 2023 02:17

Change default strategy newcomers -> all

c86ab3e

Refactoring: rename max-repeats -> limit

7900f5d

This commit renames configuration property `max-repeats` to `limit`, updates documentation and adds a respective config migration.

voidpointer0x00 commented Apr 15, 2023

View reviewed changes

.../java/voidpointer/spigot/voidwhitelist/config/migration/WhitelistConfigMigrationFactory.java Outdated Show resolved Hide resolved

voidpointer0x00 added 23 commits April 16, 2023 17:34

Remove TODO comment

21dd836

Refactoring: migration factory -> repository

38be624

Delete WhitelistImportEvent class

7ba1fe9

Fix: send args message instead of fail onNotEnoughArgs

a81494f

Add support for player-details placeholder

3a2b598

Implement on/off commands

6caabfc

Implement set and info commands

246c1f9

Implement `set` and `info` commands Implement `set` and `info` commands

Refactoring: create public StrategyPredicate enum instead of factory

4b2c032

Refactoring: create public StrategyPredicate enum instead of factory

Remove 10 years cap

0024929

Fix: dependency not found

6c6facf

Add description & permissions for all the new auto-whitelist commands

b21ff51

Fix: send the messages (they just ignored)

b538b01

Add {player} to invalid args message

7995068

Handle FileNotFoundException differently

8e0e62b

FileNotFoundException by experience usually indicates that Mojang has no data on the given player, meaning there is no such registered nickname.

Fix: send the message (previously it was just ignored)

0c88335

Set newTimesAutoWhitelisted value to {new} placeholder

28cb864

Fix: use createOrUpdate() instead of update()

54d49a9

Implement configuration related commands

1ce52e1

Remove second consecutive space character

c30cf2c

Add translation for new messages

b6a7d7a

Refactoring: remove "number" from TimesAutoWhitelisted

51fe03d

Fix: remove ' char in logging message (breaks placeholders)

7874457

Also run config migrations on reload command

96c78fc

voidpointer0x00 commented Apr 17, 2023

View reviewed changes

unstable->stable

4251375

voidpointer0x00 merged commit 4977a15 into dev-j8 Apr 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/auto whitelist #16

Feature/auto whitelist #16

voidpointer0x00 commented Mar 26, 2023 •

edited

Loading

github-advanced-security bot commented Mar 26, 2023

voidpointer0x00 commented Apr 15, 2023

voidpointer0x00 left a comment

	# When both whitelist and auto-whitelist are enabled, the plugin will automatically
	# add a joining player of selected group to the whitelist for the specified duration.
	#
	# A single player can only get automatically whitelisted "max-repeats" times.
	# So if it's set to 2, after the first period they will be able to get extra time.
	# * It won't work the second time IF they do not meet current strategy requirements.
	#
	# Strategies select a group of players who will be automatically whitelisted
	# upon joining the server.
	auto-whitelist:
	enabled: true
	# Any value in range (-∞;0] will be treated as permanent whitelisting,
	# WHICH SHOULD NOT BE USED (because then what's the point in using a whitelist?)
	#
	# Any value that can not be parsed will result in disabling the automatic
	# whitelisting feature until the configuration is fixed and reloaded.
	duration: 7d
	# A value of zero will disable the auto whitelisting.
	# Any negative number will disable this property and players will be able to
	# infinitely join the server and get whitelisted every time.
	max-repeats: 1
	# all — simply every joining player if the number that they've been "freely" whitelisted
	# have yet to exceed the limiting "max-repeats" property.
	#
	# newcomers — only those players who have never player on this server before.
	# This strategy makes use of Bukkit's #hasPlayerBefore() method that checks
	# whether the server has any data on the given player. This will always
	# be true if you disable the property «players.disable-saving» in spigot.yml
	strategy: all

Feature/auto whitelist #16

Feature/auto whitelist #16

Conversation

voidpointer0x00 commented Mar 26, 2023 • edited Loading

github-advanced-security bot commented Mar 26, 2023

voidpointer0x00 commented Apr 15, 2023

voidpointer0x00 left a comment

Choose a reason for hiding this comment

voidpointer0x00 commented Mar 26, 2023 •

edited

Loading