Skip to content

Commit 5dfb098

Browse files
benwoo1110benwoo1110
committed
Add support for cloning unloaded worlds
1 parent 6c50bfb commit 5dfb098

8 files changed

Lines changed: 136 additions & 46 deletions

File tree

‎src/main/java/org/mvplugins/multiverse/core/commands/CloneCommand.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import org.mvplugins.multiverse.core.command.flag.ParsedCommandFlags;
2121
import org.mvplugins.multiverse.core.locale.MVCorei18n;
2222
import org.mvplugins.multiverse.core.locale.message.MessageReplacement.Replace;
23-
import org.mvplugins.multiverse.core.world.LoadedMultiverseWorld;
23+
import org.mvplugins.multiverse.core.world.MultiverseWorld;
2424
import org.mvplugins.multiverse.core.world.WorldManager;
2525
import org.mvplugins.multiverse.core.world.options.CloneWorldOptions;
2626

@@ -48,7 +48,7 @@ void onCloneCommand(
4848

4949
@Syntax("<world>")
5050
@Description("{@@mv-core.clone.world.description}")
51-
LoadedMultiverseWorld world,
51+
MultiverseWorld world,
5252

5353
@Syntax("<new-world-name>")
5454
@Description("{@@mv-core.clone.newWorld.description}")
@@ -114,7 +114,7 @@ private final static class LegacyAlias extends CloneCommand implements LegacyAli
114114

115115
@Override
116116
@CommandAlias("mvcl|mvclone")
117-
void onCloneCommand(MVCommandIssuer issuer, LoadedMultiverseWorld world, String newWorldName, String[] flags) {
117+
void onCloneCommand(MVCommandIssuer issuer, MultiverseWorld world, String newWorldName, String[] flags) {
118118
super.onCloneCommand(issuer, world, newWorldName, flags);
119119
}
120120
}

‎src/main/java/org/mvplugins/multiverse/core/event/world/MVWorldClonedEvent.java‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,36 @@
11
package org.mvplugins.multiverse.core.event.world;
22

33
import org.bukkit.event.HandlerList;
4+
import org.jetbrains.annotations.ApiStatus;
45
import org.jetbrains.annotations.NotNull;
6+
import org.jetbrains.annotations.Nullable;
57
import org.mvplugins.multiverse.core.world.LoadedMultiverseWorld;
8+
import org.mvplugins.multiverse.core.world.MultiverseWorld;
69

710
/**
811
* Called when a world has been successfully cloned.
912
*/
1013
public final class MVWorldClonedEvent extends MultiverseWorldEvent<LoadedMultiverseWorld> {
1114
private static final HandlerList HANDLERS = new HandlerList();
1215

13-
private final LoadedMultiverseWorld fromWorld;
16+
private final MultiverseWorld fromWorld;
1417

15-
public MVWorldClonedEvent(LoadedMultiverseWorld world, LoadedMultiverseWorld fromWorld) {
18+
public MVWorldClonedEvent(LoadedMultiverseWorld world, MultiverseWorld fromWorld) {
1619
super(world);
1720
this.fromWorld = fromWorld;
1821
}
1922

20-
public LoadedMultiverseWorld getFromWorld() {
23+
/**
24+
* @deprecated Cloning can be done from unloaded worlds as well. Use {@link #getSourceWorld()} instead.
25+
*/
26+
@Deprecated(forRemoval = true, since = "5.6")
27+
@ApiStatus.ScheduledForRemoval(inVersion = "6.0")
28+
public @Nullable LoadedMultiverseWorld getFromWorld() {
29+
return fromWorld.asLoadedWorld().getOrNull();
30+
}
31+
32+
@ApiStatus.AvailableSince("5.6")
33+
public @NotNull MultiverseWorld getSourceWorld() {
2134
return fromWorld;
2235
}
2336

@@ -37,5 +50,4 @@ public LoadedMultiverseWorld getFromWorld() {
3750
public static HandlerList getHandlerList() {
3851
return HANDLERS;
3952
}
40-
4153
}

‎src/main/java/org/mvplugins/multiverse/core/locale/MVCorei18n.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,7 @@ public enum MVCorei18n implements MessageKeyProvider {
292292
CLONEWORLD_WORLDEXISTFOLDER,
293293
CLONEWORLD_WORLDEXISTUNLOADED,
294294
CLONEWORLD_WORLDEXISTLOADED,
295+
CLONEWORLD_FROMWORLDFOLDERINVALID,
295296
CLONEWORLD_COPYFAILED,
296297

297298
CREATEWORLD_INVALIDWORLDNAME,

‎src/main/java/org/mvplugins/multiverse/core/world/WorldManager.java‎

Lines changed: 56 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@
2020
import io.vavr.control.Try;
2121
import jakarta.inject.Inject;
2222
import org.bukkit.Bukkit;
23+
import org.bukkit.GameRule;
2324
import org.bukkit.Location;
2425
import org.bukkit.World;
26+
import org.bukkit.WorldBorder;
2527
import org.bukkit.WorldCreator;
2628
import org.bukkit.WorldType;
2729
import org.bukkit.plugin.PluginManager;
@@ -719,18 +721,19 @@ public Attempt<LoadedMultiverseWorld, CloneFailureReason> cloneWorld(@NotNull Cl
719721
.mapAttempt(validatedOptions -> {
720722
ImportWorldOptions importWorldOptions = ImportWorldOptions
721723
.worldName(validatedOptions.newWorldName())
722-
.biome(validatedOptions.world().getBiome())
723-
.environment(validatedOptions.world().getEnvironment())
724-
.generator(validatedOptions.world().getGenerator());
724+
.biome(validatedOptions.fromWorld().getBiome())
725+
.environment(validatedOptions.fromWorld().getEnvironment())
726+
.generator(validatedOptions.fromWorld().getGenerator());
725727
return importWorld(importWorldOptions).transform(CloneFailureReason.IMPORT_FAILED);
726728
})
727729
.onSuccess(newWorld -> {
728730
cloneWorldTransferData(options, newWorld);
729731
if (options.keepWorldConfig()) {
730-
newWorld.setSpawnLocation(options.world().getSpawnLocation());
732+
// Special case for spawn location as it's considered a hidden config
733+
newWorld.setSpawnLocation(options.fromWorld().getSpawnLocation());
731734
}
732735
saveWorldsConfig();
733-
pluginManager.callEvent(new MVWorldClonedEvent(newWorld, options.world()));
736+
pluginManager.callEvent(new MVWorldClonedEvent(newWorld, options.fromWorld()));
734737
});
735738
}
736739

@@ -752,19 +755,24 @@ private Attempt<CloneWorldOptions, CloneFailureReason> cloneWorldValidateWorld(
752755
if (worldNameChecker.hasWorldFolder(newWorldName)) {
753756
return worldActionResult(CloneFailureReason.WORLD_EXIST_FOLDER, newWorldName);
754757
}
758+
if (!worldNameChecker.isValidWorldFolder(options.fromWorld().getName())) {
759+
return worldActionResult(CloneFailureReason.FROM_WORLD_FOLDER_INVALID, options.fromWorld().getName());
760+
}
755761
return worldActionResult(options);
756762
}
757763

758764
private Attempt<CloneWorldOptions, CloneFailureReason> cloneWorldCopyFolder(@NotNull CloneWorldOptions options) {
759765
if (options.saveBukkitWorld()) {
760-
Logging.finer("Saving bukkit world before cloning: " + options.world().getName());
761-
options.world().getBukkitWorld().peek(this::saveWorldWithFlush);
766+
options.fromWorld().asLoadedWorld().peek(loadedWorld -> {
767+
Logging.finer("Saving world before cloning: " + loadedWorld.getName());
768+
loadedWorld.getBukkitWorld().peek(this::saveWorldWithFlush);
769+
});
762770
}
763-
File worldFolder = options.world().getBukkitWorld().map(World::getWorldFolder).get();
771+
File worldFolder = new File(Bukkit.getWorldContainer(), options.fromWorld().getName());
764772
File newWorldFolder = new File(Bukkit.getWorldContainer(), options.newWorldName());
765773
return fileUtils.copyFolder(worldFolder, newWorldFolder, CLONE_IGNORE_FILES).fold(
766774
exception -> worldActionResult(CloneFailureReason.COPY_FAILED,
767-
options.world().getName(), exception),
775+
options.fromWorld().getName(), exception),
768776
success -> worldActionResult(options));
769777
}
770778

@@ -780,25 +788,30 @@ private void saveWorldWithFlush(World world) {
780788
}
781789

782790
private void cloneWorldTransferData(@NotNull CloneWorldOptions options, @NotNull LoadedMultiverseWorld newWorld) {
783-
DataTransfer<LoadedMultiverseWorld> dataTransfer = transferData(options, options.world());
784-
dataTransfer.pasteAllTo(newWorld);
785-
}
786-
787-
private DataTransfer<LoadedMultiverseWorld> transferData(
788-
@NotNull KeepWorldSettingsOptions options, @NotNull LoadedMultiverseWorld world) {
789-
DataTransfer<LoadedMultiverseWorld> dataTransfer = new DataTransfer<>();
790-
791791
if (options.keepWorldConfig()) {
792-
dataTransfer.addDataStore(new WorldConfigStore(), world);
793-
}
794-
if (options.keepGameRule()) {
795-
dataTransfer.addDataStore(new GameRulesStore(), world);
796-
}
797-
if (options.keepWorldBorder()) {
798-
dataTransfer.addDataStore(new WorldBorderStore(), world);
792+
new DataTransfer<MultiverseWorld>()
793+
.addDataStore(new WorldConfigStore<>(), options.fromWorld())
794+
.pasteAllTo(newWorld);
799795
}
800796

801-
return dataTransfer;
797+
newWorld.getBukkitWorld().peek(bukkitWorld -> {
798+
if (!options.keepWorldBorder()) {
799+
WorldBorder worldBorder = bukkitWorld.getWorldBorder();
800+
worldBorder.reset();
801+
}
802+
803+
if (!options.keepGameRule()) {
804+
Arrays.stream(bukkitWorld.getGameRules())
805+
.map(gameRuleName -> GameRule.getByName(gameRuleName))
806+
.filter(Objects::nonNull)
807+
.forEach(gameRule -> {
808+
Object gameRuleDefault = bukkitWorld.getGameRuleDefault(gameRule);
809+
if (gameRuleDefault != null) {
810+
bukkitWorld.setGameRule(gameRule, gameRuleDefault);
811+
}
812+
});
813+
}
814+
});
802815
}
803816

804817
/**
@@ -809,7 +822,7 @@ private DataTransfer<LoadedMultiverseWorld> transferData(
809822
*/
810823
public Attempt<LoadedMultiverseWorld, RegenFailureReason> regenWorld(@NotNull RegenWorldOptions options) {
811824
LoadedMultiverseWorld world = options.world();
812-
DataTransfer<LoadedMultiverseWorld> dataTransfer = transferData(options, world);
825+
DataTransfer<LoadedMultiverseWorld> dataTransfer = regenWorldTransferData(options, world);
813826
boolean shouldKeepSpawnLocation = options.keepWorldConfig() && options.seed() == world.getSeed();
814827
Location spawnLocation = world.getSpawnLocation();
815828

@@ -837,6 +850,23 @@ public Attempt<LoadedMultiverseWorld, RegenFailureReason> regenWorld(@NotNull Re
837850
});
838851
}
839852

853+
private DataTransfer<LoadedMultiverseWorld> regenWorldTransferData(
854+
@NotNull KeepWorldSettingsOptions options, @NotNull LoadedMultiverseWorld world) {
855+
DataTransfer<LoadedMultiverseWorld> dataTransfer = new DataTransfer<>();
856+
857+
if (options.keepWorldConfig()) {
858+
dataTransfer.addDataStore(new WorldConfigStore<>(), world);
859+
}
860+
if (options.keepGameRule()) {
861+
dataTransfer.addDataStore(new GameRulesStore(), world);
862+
}
863+
if (options.keepWorldBorder()) {
864+
dataTransfer.addDataStore(new WorldBorderStore(), world);
865+
}
866+
867+
return dataTransfer;
868+
}
869+
840870
private <T, F extends FailureReason> Attempt<T, F> worldActionResult(@NotNull T value) {
841871
return Attempt.success(value);
842872
}

‎src/main/java/org/mvplugins/multiverse/core/world/helpers/DataStore.java‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
import org.jvnet.hk2.annotations.Service;
1111
import org.mvplugins.multiverse.core.config.handle.StringPropertyHandle;
1212
import org.mvplugins.multiverse.core.world.LoadedMultiverseWorld;
13+
import org.mvplugins.multiverse.core.world.MultiverseWorld;
1314

1415
/**
1516
* A data store for storing and restoring data from an object.
@@ -90,14 +91,14 @@ private <T> Try<Void> setGameRuleValue(World world, GameRule<T> gameRule, Object
9091
/**
9192
* A {@link DataStore} for storing and restoring world properties for a multiverse world.
9293
*/
93-
class WorldConfigStore implements DataStore<LoadedMultiverseWorld> {
94+
class WorldConfigStore<T extends MultiverseWorld> implements DataStore<T> {
9495
private Map<String, Object> configMap;
9596

9697
/**
9798
* {@inheritDoc}
9899
*/
99100
@Override
100-
public WorldConfigStore copyFrom(LoadedMultiverseWorld world) {
101+
public WorldConfigStore<T> copyFrom(T world) {
101102
this.configMap = new HashMap<>();
102103
StringPropertyHandle worldPropertyHandler = world.getStringPropertyHandle();
103104
worldPropertyHandler.getAllPropertyNames().forEach(name -> worldPropertyHandler.getProperty(name)
@@ -111,7 +112,7 @@ public WorldConfigStore copyFrom(LoadedMultiverseWorld world) {
111112
* {@inheritDoc}
112113
*/
113114
@Override
114-
public WorldConfigStore pasteTo(LoadedMultiverseWorld world) {
115+
public WorldConfigStore<T> pasteTo(T world) {
115116
if (configMap == null) {
116117
return this;
117118
}

‎src/main/java/org/mvplugins/multiverse/core/world/options/CloneWorldOptions.java‎

Lines changed: 45 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,88 @@
11
package org.mvplugins.multiverse.core.world.options;
22

3+
import org.jetbrains.annotations.ApiStatus;
34
import org.jetbrains.annotations.NotNull;
45
import org.mvplugins.multiverse.core.world.LoadedMultiverseWorld;
6+
import org.mvplugins.multiverse.core.world.MultiverseWorld;
57

68
/**
79
* Options for customizing the cloning of a world.
810
*/
911
public final class CloneWorldOptions implements KeepWorldSettingsOptions {
1012

13+
/**
14+
* Creates a new {@link CloneWorldOptions} instance with the given loaded world.
15+
*
16+
* @param fromWorld The loaded world to clone.
17+
* @param newWorldName The name of the new world.
18+
* @return A new {@link CloneWorldOptions} instance.
19+
*
20+
* @deprecated Cloning can be done from unloaded worlds as well. Use {@link #fromTo(MultiverseWorld, String)} instead.
21+
*/
22+
@Deprecated(forRemoval = true, since = "5.6")
23+
@ApiStatus.ScheduledForRemoval(inVersion = "6.0")
24+
public static @NotNull CloneWorldOptions fromTo(@NotNull LoadedMultiverseWorld fromWorld, @NotNull String newWorldName) {
25+
return new CloneWorldOptions(fromWorld, newWorldName);
26+
}
27+
1128
/**
1229
* Creates a new {@link CloneWorldOptions} instance with the given world.
1330
*
14-
* @param world The world to clone.
31+
* @param fromWorld The world to clone.
1532
* @param newWorldName The name of the new world.
1633
* @return A new {@link CloneWorldOptions} instance.
34+
*
35+
* @since 5.6
1736
*/
18-
public static CloneWorldOptions fromTo(LoadedMultiverseWorld world, String newWorldName) {
19-
return new CloneWorldOptions(world, newWorldName);
37+
@ApiStatus.AvailableSince("5.6")
38+
public static @NotNull CloneWorldOptions fromTo(@NotNull MultiverseWorld fromWorld, @NotNull String newWorldName) {
39+
return new CloneWorldOptions(fromWorld, newWorldName);
2040
}
2141

22-
private final LoadedMultiverseWorld world;
42+
private final MultiverseWorld fromWorld;
2343
private final String newWorldName;
2444
private boolean keepGameRule = true;
2545
private boolean keepWorldConfig = true;
2646
private boolean saveBukkitWorld = true;
2747

2848
private boolean keepWorldBorder = true;
2949

30-
CloneWorldOptions(LoadedMultiverseWorld world, String newWorldName) {
31-
this.world = world;
50+
CloneWorldOptions(MultiverseWorld fromWorld, String newWorldName) {
51+
this.fromWorld = fromWorld;
3252
this.newWorldName = newWorldName;
3353
}
3454

3555
/**
36-
* Gets the world to clone.
56+
* Gets the loaded world to clone.
3757
*
3858
* @return The world to clone.
59+
*
60+
* @deprecated Cloning can be done from unloaded worlds as well. Use {@link #fromWorld()} instead.
3961
*/
62+
@Deprecated(forRemoval = true, since = "5.6")
63+
@ApiStatus.ScheduledForRemoval(inVersion = "6.0")
4064
public LoadedMultiverseWorld world() {
41-
return world;
65+
return fromWorld.asLoadedWorld().getOrNull();
66+
}
67+
68+
/**
69+
* Gets the loaded world to clone.
70+
*
71+
* @return The world to clone.
72+
*
73+
* @since 5.6
74+
*/
75+
@ApiStatus.AvailableSince("5.6")
76+
public @NotNull MultiverseWorld fromWorld() {
77+
return fromWorld;
4278
}
4379

4480
/**
4581
* Gets the name of the new world.
4682
*
4783
* @return The name of the new world.
4884
*/
49-
public String newWorldName() {
85+
public @NotNull String newWorldName() {
5086
return newWorldName;
5187
}
5288

‎src/main/java/org/mvplugins/multiverse/core/world/reasons/CloneFailureReason.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import co.aikar.locales.MessageKey;
44
import co.aikar.locales.MessageKeyProvider;
55

6+
import org.jetbrains.annotations.ApiStatus;
67
import org.mvplugins.multiverse.core.locale.MVCorei18n;
78
import org.mvplugins.multiverse.core.utils.result.FailureReason;
89

@@ -30,6 +31,14 @@ public enum CloneFailureReason implements FailureReason {
3031
*/
3132
WORLD_EXIST_LOADED(MVCorei18n.CLONEWORLD_WORLDEXISTLOADED),
3233

34+
/**
35+
* The source world folder is invalid.
36+
*
37+
* @since 5.6
38+
*/
39+
@ApiStatus.AvailableSince("5.6")
40+
FROM_WORLD_FOLDER_INVALID(MVCorei18n.CLONEWORLD_FROMWORLDFOLDERINVALID),
41+
3342
/**
3443
* Failed to copy the world folder contents.
3544
*/

‎src/main/resources/multiverse-core_en.properties‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,7 @@ mv-core.cloneworld.invalidworldname=World '{world}' contains invalid characters!
273273
mv-core.cloneworld.worldexistfolder=World '{world}' exists in server folders! You need to delete it first before cloning.
274274
mv-core.cloneworld.worldexistunloaded=World '{world}' already exists and it's unloaded! You need to delete it first before cloning.
275275
mv-core.cloneworld.worldexistloaded=World '{world}' already exists! You need to delete it first before cloning.
276+
mv-core.cloneworld.fromworldfolderinvalid=Source world '{world}' folder contents does not seem to be a valid world! Make sure contains at least a 'level.dat' file.
276277
mv-core.cloneworld.copyfailed=Failed to copy world to '{world}': {error}\n&fSee console for more details.
277278

278279
mv-core.createworld.invalidworldname=World '{world}' contains invalid characters!
@@ -288,7 +289,7 @@ mv-core.deleteworld.failedtodeletefolder=Failed to delete world folder '{world}'
288289
mv-core.importworld.invalidworldname=World '{world}' contains invalid characters!
289290
mv-core.importworld.worldexistunloaded=World '{world}' already exists, but it's not loaded!&f Type '&a/mv load {world}&f' if you wish to load it.
290291
mv-core.importworld.worldexistloaded=World '{world}' already exists!
291-
mv-core.importworld.worldfolderinvalid=World '{world}' folder contents does not seem to be a valid world!\n&cIf the server software does something different with world folders, or you are very certain the world is valid, use '&3--skip-folder-check&c' flag.
292+
mv-core.importworld.worldfolderinvalid=World '{world}' folder contents does not seem to be a valid world! Make sure contains at least a 'level.dat' file.\n&cIf the server software does something different with world folders, or you are very certain the world is valid, use '&3--skip-folder-check&c' flag.
292293
mv-core.importworld.bukkitenvironmentmismatch=Environment mismatch detected!&f The world '{world}' is already loaded with environment '{bukkitEnvironment}', but Multiverse is trying to import it with environment '{mvEnvironment}'.
293294

294295
mv-core.loadworld.worldalreadyloading=World '{world}' is already loading! Please wait...

0 commit comments

Comments
 (0)