de.griefed.serverpackcreator

Class ConfigurationHandler

java.lang.Object

de.griefed.serverpackcreator.ConfigurationHandler

@Component
public final class ConfigurationHandler
extends java.lang.Object

This class revolves around checking and adjusting a given instance of ConfigurationModel so it can safely be used in ServerPackHandler.run(ConfigurationModel) later.

Constructor Summary

Constructors

Constructor and Description
ConfigurationHandler(I18n injectedI18n, VersionMeta injectedVersionMeta, ApplicationProperties injectedApplicationProperties, Utilities injectedUtilities, ConfigUtilities injectedConfigUtilities, ApplicationAddons injectedApplicationAddons) Construct a new ConfigurationHandler giving you access to various config check methods.

Method Summary

Modifier and Type	Method and Description
boolean	checkConfiguration(@NotNull ConfigurationModel configurationModel, boolean quietCheck) Check the passed ConfigurationModel.
boolean	checkConfiguration(@NotNull ConfigurationModel configurationModel, @NotNull java.util.List<java.lang.String> encounteredErrors, boolean quietCheck) Check the passed ConfigurationModel.
boolean	checkConfiguration(@NotNull java.io.File configFile, boolean quietCheck) Check the passed configuration-file.
boolean	checkConfiguration(@NotNull java.io.File configFile, @NotNull ConfigurationModel configurationModel, boolean quietCheck) Check the passed configuration-file.
boolean	checkConfiguration(@NotNull java.io.File configFile, @NotNull ConfigurationModel configurationModel, @NotNull java.util.List<java.lang.String> encounteredErrors, boolean quietCheck) Check the passed configuration-file.
boolean	checkConfiguration(@NotNull java.io.File configFile, @NotNull java.util.List<java.lang.String> encounteredErrors, boolean quietCheck) Check the passed configuration-file.
boolean	checkCopyDirs(java.util.List<java.lang.String> directoriesToCopy, java.lang.String modpackDir) Checks whether the passed list of directories which are supposed to be in the modpack directory is empty, or whether all directories in the list exist in the modpack directory.
boolean	checkCopyDirs(java.util.List<java.lang.String> directoriesToCopy, java.lang.String modpackDir, java.util.List<java.lang.String> encounteredErrors) Checks whether the passed list of directories which are supposed to be in the modpack directory is empty and prints a message to the console and serverpackcreator.log if it is. Checks whether all directories in the list exist in the modpack directory and prints a message to the console and serverpackcreator.log if any one of the directories could not be found.
boolean	checkIconAndProperties(java.lang.String iconOrPropertiesPath) Checks the passed String whether it is an existing file.
boolean	checkJavaPath(java.lang.String pathToJava) Deprecated. Will be removed in Milestone 4. Java path settings have moved to the global ApplicationProperties, because the Java path setting is used for modloader installation by ServerPackCreator only.
java.lang.String	checkManifests(java.lang.String destination, ConfigurationModel configurationModel, java.util.List<java.lang.String> encounteredErrors) Check whether various manifests from various launchers exist and use them to update our ConfigurationModel and pack name.
boolean	checkModloader(java.lang.String modloader) Checks whether either Forge or Fabric were specified as the modloader.
boolean	checkModloaderVersion(java.lang.String modloader, java.lang.String modloaderVersion, java.lang.String minecraftVersion) Check the given Minecraft and modloader versions for the specified modloader.
boolean	checkModloaderVersion(java.lang.String modloader, java.lang.String modloaderVersion, java.lang.String minecraftVersion, java.util.List<java.lang.String> encounteredErrors) Check the given Minecraft and modloader versions for the specified modloader and update the passed error-list should any error be encountered.
boolean	checkModpackDir(java.lang.String modpackDir) Check the passed directory for existence and whether it is a directory, rather than a file.
boolean	checkModpackDir(java.lang.String modpackDir, java.util.List<java.lang.String> encounteredErrors) Checks whether the passed String is empty and if it is empty, prints the corresponding message to the console and serverpackcreator.log so the user knows what went wrong. Checks whether the passed String is a directory and if it is not, prints the corresponding message to the console and serverpackcreator.log so the user knows what went wrong.
boolean	checkZipArchive(java.nio.file.Path pathToZip, java.util.List<java.lang.String> encounteredErrors) Check a given ZIP-archives contents.
void	ensureScriptSettingsDefaults(ConfigurationModel configurationModel) Update the script settings and ensure the default keys, with values gathered from the passed ConfigurationModel, are present: SPC_SERVERPACKCREATOR_VERSION_SPC : ServerPackCreator version with which the scripts were created SPC_MINECRAFT_VERSION_SPC : Minecraft version of the modpack SPC_MINECRAFT_SERVER_URL_SPC : Download-URL to the Minecraft server SPC_MODLOADER_SPC : The modloader of the modpack SPC_MODLOADER_VERSION_SPC : The modloader version of the modpack SPC_JAVA_ARGS_SPC : The JVM args to be used to run the server SPC_JAVA_SPC : Path to the java installation to be used to run the server SPC_FABRIC_INSTALLER_VERSION_SPC : Most recent version of the Fabric installer at the time of creating the scripts SPC_QUILT_INSTALLER_VERSION_SPC : Most recent version of the Quilt installer at the time of creating the scripts
java.lang.String	getJavaPath(java.lang.String pathToJava) Deprecated. Will be removed in Milestone 4. Java path settings have moved to the global ApplicationProperties, because the Java path setting is used for modloader installation by ServerPackCreator only.
boolean	isDir(ConfigurationModel configurationModel, java.util.List<java.lang.String> encounteredErrors) If the in the configuration specified modpack dir is an existing directory, checks are made for valid configuration of: directories to copy to server pack, if includeServerInstallation is true path to Java executable/binary, Minecraft version, modloader and modloader version.
boolean	isZip(ConfigurationModel configurationModel, java.util.List<java.lang.String> encounteredErrors) Checks the specified ZIP-archive for validity.
void	sanitizeLinks(ConfigurationModel configurationModel) Sanitize any and all links in a given instance of ConfigurationModel modpack-directory, server-icon path, server-properties path, Java path and copy-directories entries.
boolean	testJava(java.lang.String pathToJava) Deprecated. Will be removed in Milestone 4. Java path settings have moved to the global ApplicationProperties, because the Java path setting is used for modloader installation by ServerPackCreator only.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationHandler

@Autowired
public ConfigurationHandler(I18n injectedI18n,
                                       VersionMeta injectedVersionMeta,
                                       ApplicationProperties injectedApplicationProperties,
                                       Utilities injectedUtilities,
                                       ConfigUtilities injectedConfigUtilities,
                                       ApplicationAddons injectedApplicationAddons)
                                throws java.io.IOException

Construct a new ConfigurationHandler giving you access to various config check methods.

Parameters:

injectedI18n - Instance of I18n required for localized log messages.

injectedApplicationProperties - Instance of ApplicationProperties required for various different things.

injectedVersionMeta - Instance of VersionMeta required for everything version-related.

injectedUtilities - Instance of Utilities.

injectedConfigUtilities - Instance of ConfigUtilities.

injectedApplicationAddons - Instance of ApplicationAddons.

Throws:

java.io.IOException - if the VersionMeta could not be instantiated.

Method Detail

checkConfiguration

public boolean checkConfiguration(@NotNull
                                  @NotNull java.io.File configFile,
                                  @NotNull
                                  @NotNull java.util.List<java.lang.String> encounteredErrors,
                                  boolean quietCheck)

Check the passed configuration-file. If any check returns true then the server pack will not be created. In order to find out which check failed, the user has to check their serverpackcreator.log in the logs-directory.
Does not create a modpack if a CurseForge project and file is specified.

Parameters:

configFile - The configuration file to check. Must either be an existing file to load a configuration from or null if you want to use the passed configuration model.

encounteredErrors - A list of errors encountered during configuration checks which gets printed to the console and log after all checks have run. Gives the user more detail on what went wrong at which part of their configuration. Can be used to display the errors, if any were encountered, in a UI or be printed into the console or whatever have you.

quietCheck - Whether the configuration should be printed to the console and logs. Pass false to quietly check the configuration.

Returns:

false if the configuration has passed all tests.

checkConfiguration

public boolean checkConfiguration(@NotNull
                                  @NotNull java.io.File configFile,
                                  boolean quietCheck)

Check the passed configuration-file. If any check returns true then the server pack will not be created. In order to find out which check failed, the user has to check their serverpackcreator.log in the logs-directory.

Parameters:

configFile - The configuration file to check. Must either be an existing file to load a configuration from or null if you want to use the passed configuration model.

quietCheck - Whether the configuration should be printed to the console and logs. Pass false to quietly check the configuration.

Returns:

false if the configuration has passed all tests.

checkConfiguration

public boolean checkConfiguration(@NotNull
                                  @NotNull java.io.File configFile,
                                  @NotNull
                                  @NotNull ConfigurationModel configurationModel,
                                  boolean quietCheck)

Check the passed configuration-file. If any check returns true then the server pack will not be created. In order to find out which check failed, the user has to check their serverpackcreator.log in the logs-directory.

Parameters:

configFile - The configuration file to check. Must either be an existing file to load a configuration from or null if you want to use the passed configuration model.

configurationModel - Instance of a configuration of a modpack. Can be used to further display or use any information within, as it may be changed or otherwise altered by this method.

quietCheck - Whether the configuration should be printed to the console and logs. Pass false to quietly check the configuration.

Returns:

false if the configuration has passed all tests.

checkConfiguration

public boolean checkConfiguration(@NotNull
                                  @NotNull ConfigurationModel configurationModel,
                                  boolean quietCheck)

Check the passed ConfigurationModel. If any check returns true then the server pack will not be created. In order to find out which check failed, the user has to check their serverpackcreator.log in the logs-directory.

Parameters:

configurationModel - Instance of a configuration of a modpack. Can be used to further display or use any information within, as it may be changed or otherwise altered by this method.

quietCheck - Whether the configuration should be printed to the console and logs. Pass false to quietly check the configuration.

Returns:

false if the configuration has passed all tests.

checkConfiguration

public boolean checkConfiguration(@NotNull
                                  @NotNull java.io.File configFile,
                                  @NotNull
                                  @NotNull ConfigurationModel configurationModel,
                                  @NotNull
                                  @NotNull java.util.List<java.lang.String> encounteredErrors,
                                  boolean quietCheck)

Check the passed configuration-file. If any check returns true then the server pack will not be created. In order to find out which check failed, the user has to check their serverpackcreator.log in the logs-directory.

Parameters:

configFile - The configuration file to check. Must either be an existing file to load a configuration from or null if you want to use the passed configuration model.

configurationModel - Instance of a configuration of a modpack. Can be used to further display or use any information within, as it may be changed or otherwise altered by this method.

encounteredErrors - A list of errors encountered during configuration checks which gets printed to the console and log after all checks have run. Gives the user more detail on what went wrong at which part of their configuration. Can be used to display the errors, if any were encountered, in a UI or be printed into the console or whatever have you.

quietCheck - Whether the configuration should be printed to the console and logs. Pass false to quietly check the configuration.

Returns:

false if the configuration has passed all tests.

checkConfiguration

public boolean checkConfiguration(@NotNull
                                  @NotNull ConfigurationModel configurationModel,
                                  @NotNull
                                  @NotNull java.util.List<java.lang.String> encounteredErrors,
                                  boolean quietCheck)

Check the passed ConfigurationModel. If any check returns true then the server pack will not be created. In order to find out which check failed, the user has to check their serverpackcreator.log in the logs-directory.
The passed String List encounteredErrors can be used to display the errors, if any were encountered, in a UI or be printed into the console or whatever have you.
The passed ConfigurationModel can be used to further display or use any information within, as it may be changed or otherwise altered by this method.

Parameters:

configurationModel - Instance of a configuration of a modpack. Can be used to further display or use any information within, as it may be changed or otherwise altered by this method.

encounteredErrors - A list of errors encountered during configuration checks which gets printed to the console and log after all checks have run. Gives the user more detail on what went wrong at which part of their configuration. Can be used to display the errors, if any were encountered, in a UI or be printed into the console or whatever have you.

quietCheck - Whether the configuration should be printed to the console and logs. Pass false to quietly check the configuration.

Returns:

false if all checks are passed.

isDir

public boolean isDir(ConfigurationModel configurationModel,
                     java.util.List<java.lang.String> encounteredErrors)

If the in the configuration specified modpack dir is an existing directory, checks are made for valid configuration of: directories to copy to server pack, if includeServerInstallation is true path to Java executable/binary, Minecraft version, modloader and modloader version.

Parameters:

configurationModel - An instance of ConfigurationModel which contains the configuration of the modpack.

encounteredErrors - A list to which all encountered errors are saved to.

Returns:

true if an error is found during configuration check.

isZip

public boolean isZip(ConfigurationModel configurationModel,
                     java.util.List<java.lang.String> encounteredErrors)
              throws java.io.IOException

Checks the specified ZIP-archive for validity. In order for a modpack ZIP-archive to be considered valid, it needs to contain the mods and config folders at minimum. If any of manifest.json, minecraftinstance.json or config.json are available, gather as much information from them as possible.

Parameters:

configurationModel - Instance of ConfigurationModel with a server pack configuration.

encounteredErrors - A list of errors encountered during configuration checks.

Returns:

false when no errors were encountered.

Throws:

java.io.IOException - if an error occurred trying to move the server pack directory.

checkManifests

public java.lang.String checkManifests(java.lang.String destination,
                                       ConfigurationModel configurationModel,
                                       java.util.List<java.lang.String> encounteredErrors)

Check whether various manifests from various launchers exist and use them to update our ConfigurationModel and pack name.

Parameters:

destination - The destination in which the manifests are.

configurationModel - The ConfigurationModel to update.

encounteredErrors - A list of errors encountered during configuration checks, to be added to in case an error is encountered during manifest checks.

Returns:

The name of the modpack currently being checked. null if the name could not be acquired.

checkZipArchive

public boolean checkZipArchive(java.nio.file.Path pathToZip,
                               java.util.List<java.lang.String> encounteredErrors)

Check a given ZIP-archives contents. If the ZIP-archive only contains one directory, or if it contains neither the mods nor the config directories, consider it invalid.

Parameters:

pathToZip - Path to the ZIP-file to check.

encounteredErrors - List of encountered errors for further processing, like printing to logs or display in GUI or whatever you want, really.

Returns:

Boolean. false if the ZIP-archive is considered valid.

ensureScriptSettingsDefaults

public void ensureScriptSettingsDefaults(ConfigurationModel configurationModel)

Update the script settings and ensure the default keys, with values gathered from the passed ConfigurationModel, are present:

1. SPC_SERVERPACKCREATOR_VERSION_SPC : ServerPackCreator version with which the scripts were created
2. SPC_MINECRAFT_VERSION_SPC : Minecraft version of the modpack
3. SPC_MINECRAFT_SERVER_URL_SPC : Download-URL to the Minecraft server
4. SPC_MODLOADER_SPC : The modloader of the modpack
5. SPC_MODLOADER_VERSION_SPC : The modloader version of the modpack
6. SPC_JAVA_ARGS_SPC : The JVM args to be used to run the server
7. SPC_JAVA_SPC : Path to the java installation to be used to run the server
8. SPC_FABRIC_INSTALLER_VERSION_SPC : Most recent version of the Fabric installer at the time of creating the scripts
9. SPC_QUILT_INSTALLER_VERSION_SPC : Most recent version of the Quilt installer at the time of creating the scripts

Parameters:

configurationModel - Model in which to ensure the default key-value pairs are present.

sanitizeLinks

public void sanitizeLinks(ConfigurationModel configurationModel)

Sanitize any and all links in a given instance of ConfigurationModel modpack-directory, server-icon path, server-properties path, Java path and copy-directories entries.

Parameters:

configurationModel - Instance of ConfigurationModel in which to sanitize links to their respective destinations.

checkModpackDir

public boolean checkModpackDir(java.lang.String modpackDir)

Check the passed directory for existence and whether it is a directory, rather than a file.

Parameters:

modpackDir - The modpack directory.

Returns:

Boolean. Returns true if the directory exists.

checkModpackDir

public boolean checkModpackDir(java.lang.String modpackDir,
                               java.util.List<java.lang.String> encounteredErrors)

Checks whether the passed String is empty and if it is empty, prints the corresponding message to the console and serverpackcreator.log so the user knows what went wrong.
Checks whether the passed String is a directory and if it is not, prints the corresponding message to the console and serverpackcreator.log so the user knows what went wrong.

Parameters:

modpackDir - String. The path to the modpack directory to check whether it is empty and whether it is a directory.

encounteredErrors - List String. A list to which all encountered errors are saved to.

Returns:

Boolean. Returns true if the directory exists.

checkCopyDirs

public boolean checkCopyDirs(java.util.List<java.lang.String> directoriesToCopy,
                             java.lang.String modpackDir)

Checks whether the passed list of directories which are supposed to be in the modpack directory is empty, or whether all directories in the list exist in the modpack directory. If the user specified a source/file;destination/file-combination, it is checked whether the specified source-file exists on the host.

Parameters:

directoriesToCopy - List String. The list of directories, or source/file;destination/file-combinations, to check for existence. source/file;destination/file-combinations must be absolute paths to the source-file.

modpackDir - String. The path to the modpack directory in which to check for existence of the passed list of directories.

Returns:

Boolean. Returns true if every directory was found in the modpack directory. If any single one was not found, false is returned.

checkCopyDirs

public boolean checkCopyDirs(java.util.List<java.lang.String> directoriesToCopy,
                             java.lang.String modpackDir,
                             java.util.List<java.lang.String> encounteredErrors)

Checks whether the passed list of directories which are supposed to be in the modpack directory is empty and prints a message to the console and serverpackcreator.log if it is.
Checks whether all directories in the list exist in the modpack directory and prints a message to the console and serverpackcreator.log if any one of the directories could not be found. If the user specified a source/file;destination/file-combination, it is checked whether the specified source-file exists on the host.

Parameters:

directoriesToCopy - List String. The list of directories, or source/file;destination/file-combinations, to check for existence. source/file;destination/file-combinations must be absolute paths to the source-file.

modpackDir - String. The path to the modpack directory in which to check for existence of the passed list of directories.

encounteredErrors - List String. A list to which all encountered errors are saved to.

Returns:

Boolean. Returns true if every directory was found in the modpack directory. If any single one was not found, false is returned.

checkIconAndProperties

public boolean checkIconAndProperties(java.lang.String iconOrPropertiesPath)

Checks the passed String whether it is an existing file. If the passed String is empty, then ServerPackCreator will treat it as the user being fine with the default files and return the corresponding boolean.

Parameters:

iconOrPropertiesPath - The path to the custom server-icon.png or server.properties file to check.

Returns:

Boolean. True if the file exists or an empty String was passed, false if a file was specified, but the file was not found.

checkJavaPath

@Deprecated
public boolean checkJavaPath(java.lang.String pathToJava)

Deprecated. Will be removed in Milestone 4. Java path settings have moved to the global ApplicationProperties, because the Java path setting is used for modloader installation by ServerPackCreator only.

Check whether the given path is a valid Java specification.

Parameters:

pathToJava - Path to the Java executable

Returns:

Boolean. Returns true if the path is valid.

testJava

@Deprecated
public boolean testJava(java.lang.String pathToJava)

Deprecated. Will be removed in Milestone 4. Java path settings have moved to the global ApplicationProperties, because the Java path setting is used for modloader installation by ServerPackCreator only.

Test for a valid Java specification by trying to run java -version. If the command goes through without errors, it is considered a correct specification.

Parameters:

pathToJava - Path to the java executable/binary.

Returns:

true if the specified file is a valid Java executable/binary.

getJavaPath

@Deprecated
public java.lang.String getJavaPath(java.lang.String pathToJava)

Deprecated. Will be removed in Milestone 4. Java path settings have moved to the global ApplicationProperties, because the Java path setting is used for modloader installation by ServerPackCreator only.

Check the given path to a Java installation for validity and return it, if it is valid. If the passed path is a UNIX symlink or Windows lnk, it is resolved, then returned. If the passed path is considered invalid, the system default is acquired and returned.

Parameters:

pathToJava - The path to check for whether it is a valid Java installation.

Returns:

String. Returns the path to the Java installation. If user input was incorrect, SPC will try to acquire the path automatically.

checkModloader

public boolean checkModloader(java.lang.String modloader)

Checks whether either Forge or Fabric were specified as the modloader.

Parameters:

modloader - Check as case-insensitive for Forge or Fabric.

Returns:

Boolean. Returns true if the specified modloader is either Forge or Fabric. False if neither.

checkModloaderVersion

public boolean checkModloaderVersion(java.lang.String modloader,
                                     java.lang.String modloaderVersion,
                                     java.lang.String minecraftVersion)

Check the given Minecraft and modloader versions for the specified modloader.

Parameters:

modloader - The passed modloader which determines whether the check for Forge or Fabric is called.

modloaderVersion - The version of the modloader which is checked against the corresponding modloaders manifest.

minecraftVersion - The version of Minecraft used for checking the Forge version.

Returns:

Returns true if the specified modloader version was found in the corresponding manifest.

checkModloaderVersion

public boolean checkModloaderVersion(java.lang.String modloader,
                                     java.lang.String modloaderVersion,
                                     java.lang.String minecraftVersion,
                                     java.util.List<java.lang.String> encounteredErrors)

Check the given Minecraft and modloader versions for the specified modloader and update the passed error-list should any error be encountered.

Parameters:

modloader - String. The passed modloader which determines whether the check for Forge or Fabric is called.

modloaderVersion - String. The version of the modloader which is checked against the corresponding modloaders manifest.

minecraftVersion - String. The version of Minecraft used for checking the Forge version.

encounteredErrors - List of encountered errors to add to in case of errors.

Returns:

Boolean. Returns true if the specified modloader version was found in the corresponding manifest.