345 lines
17 KiB
Java
345 lines
17 KiB
Java
/*
|
|
* This file is part of ComputerCraft - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2019. Do not distribute without permission.
|
|
* Send enquiries to dratcliffe@gmail.com
|
|
*/
|
|
|
|
package dan200.computercraft.shared;
|
|
|
|
import com.google.common.base.CaseFormat;
|
|
import com.google.common.base.Converter;
|
|
import dan200.computercraft.ComputerCraft;
|
|
import dan200.computercraft.api.turtle.event.TurtleAction;
|
|
import dan200.computercraft.core.apis.AddressPredicate;
|
|
import dan200.computercraft.core.apis.http.websocket.Websocket;
|
|
import net.minecraftforge.common.ForgeConfigSpec;
|
|
import net.minecraftforge.eventbus.api.SubscribeEvent;
|
|
import net.minecraftforge.fml.ModLoadingContext;
|
|
import net.minecraftforge.fml.common.Mod;
|
|
import net.minecraftforge.fml.config.ModConfig;
|
|
|
|
import java.util.Arrays;
|
|
import java.util.Collections;
|
|
import java.util.List;
|
|
import java.util.concurrent.TimeUnit;
|
|
|
|
import static dan200.computercraft.ComputerCraft.DEFAULT_HTTP_BLACKLIST;
|
|
import static dan200.computercraft.ComputerCraft.DEFAULT_HTTP_WHITELIST;
|
|
import static net.minecraftforge.common.ForgeConfigSpec.Builder;
|
|
import static net.minecraftforge.common.ForgeConfigSpec.ConfigValue;
|
|
|
|
@Mod.EventBusSubscriber( modid = ComputerCraft.MOD_ID, bus = Mod.EventBusSubscriber.Bus.MOD )
|
|
public final class Config
|
|
{
|
|
private static final int MODEM_MAX_RANGE = 100000;
|
|
|
|
private static final String TRANSLATION_PREFIX = "gui.computercraft.config.";
|
|
|
|
private static ConfigValue<Integer> computerSpaceLimit;
|
|
private static ConfigValue<Integer> floppySpaceLimit;
|
|
private static ConfigValue<Integer> maximumFilesOpen;
|
|
private static ConfigValue<Boolean> disableLua51Features;
|
|
private static ConfigValue<String> defaultComputerSettings;
|
|
private static ConfigValue<Boolean> debugEnabled;
|
|
private static ConfigValue<Boolean> logComputerErrors;
|
|
|
|
private static ConfigValue<Integer> computerThreads;
|
|
private static ConfigValue<Long> maxMainGlobalTime;
|
|
private static ConfigValue<Long> maxMainComputerTime;
|
|
|
|
private static ConfigValue<Boolean> httpEnabled;
|
|
private static ConfigValue<Boolean> httpWebsocketEnabled;
|
|
private static ConfigValue<List<? extends String>> httpWhitelist;
|
|
private static ConfigValue<List<? extends String>> httpBlacklist;
|
|
|
|
private static ConfigValue<Integer> httpTimeout;
|
|
private static ConfigValue<Integer> httpMaxRequests;
|
|
private static ConfigValue<Long> httpMaxDownload;
|
|
private static ConfigValue<Long> httpMaxUpload;
|
|
private static ConfigValue<Integer> httpMaxWebsockets;
|
|
private static ConfigValue<Integer> httpMaxWebsocketMessage;
|
|
|
|
private static ConfigValue<Boolean> commandBlockEnabled;
|
|
private static ConfigValue<Integer> modemRange;
|
|
private static ConfigValue<Integer> modemHighAltitudeRange;
|
|
private static ConfigValue<Integer> modemRangeDuringStorm;
|
|
private static ConfigValue<Integer> modemHighAltitudeRangeDuringStorm;
|
|
private static ConfigValue<Integer> maxNotesPerTick;
|
|
|
|
private static ConfigValue<Boolean> turtlesNeedFuel;
|
|
private static ConfigValue<Integer> turtleFuelLimit;
|
|
private static ConfigValue<Integer> advancedTurtleFuelLimit;
|
|
private static ConfigValue<Boolean> turtlesObeyBlockProtection;
|
|
private static ConfigValue<Boolean> turtlesCanPush;
|
|
private static ConfigValue<List<? extends String>> turtleDisabledActions;
|
|
|
|
private static final ForgeConfigSpec spec;
|
|
|
|
private Config() {}
|
|
|
|
static
|
|
{
|
|
Builder builder = new Builder();
|
|
|
|
{ // General computers
|
|
computerSpaceLimit = builder
|
|
.comment( "The disk space limit for computers and turtles, in bytes" )
|
|
.translation( TRANSLATION_PREFIX + "computer_space_limit" )
|
|
.define( "computer_space_limit", ComputerCraft.computerSpaceLimit );
|
|
|
|
floppySpaceLimit = builder
|
|
.comment( "The disk space limit for floppy disks, in bytes" )
|
|
.translation( TRANSLATION_PREFIX + "floppy_space_limit" )
|
|
.define( "floppy_space_limit", ComputerCraft.floppySpaceLimit );
|
|
|
|
maximumFilesOpen = builder
|
|
.comment( "Set how many files a computer can have open at the same time. Set to 0 for unlimited." )
|
|
.translation( TRANSLATION_PREFIX + "maximum_open_files" )
|
|
.defineInRange( "maximum_open_files", ComputerCraft.maximumFilesOpen, 0, Integer.MAX_VALUE );
|
|
|
|
disableLua51Features = builder
|
|
.comment( "Set this to true to disable Lua 5.1 functions that will be removed in a future update. " +
|
|
"Useful for ensuring forward compatibility of your programs now." )
|
|
.define( "disable_lua51_features", ComputerCraft.disable_lua51_features );
|
|
|
|
defaultComputerSettings = builder
|
|
.comment( "A comma separated list of default system settings to set on new computers. Example: " +
|
|
"\"shell.autocomplete=false,lua.autocomplete=false,edit.autocomplete=false\" will disable all " +
|
|
"autocompletion" )
|
|
.define( "default_computer_settings", ComputerCraft.default_computer_settings );
|
|
|
|
debugEnabled = builder
|
|
.comment( "Enable Lua's debug library. This is sandboxed to each computer, so is generally safe to be used by players." )
|
|
.define( "debug_enabled", ComputerCraft.debug_enable );
|
|
|
|
logComputerErrors = builder
|
|
.comment( "Log exceptions thrown by peripherals and other Lua objects.\n" +
|
|
"This makes it easier for mod authors to debug problems, but may result in log spam should people use buggy methods." )
|
|
.define( "log_computer_errors", ComputerCraft.logPeripheralErrors );
|
|
}
|
|
|
|
{
|
|
builder.comment( "Controls execution behaviour of computers. This is largely intended for fine-tuning " +
|
|
"servers, and generally shouldn't need to be touched" );
|
|
builder.push( "execution" );
|
|
|
|
computerThreads = builder
|
|
.comment( "Set the number of threads computers can run on. A higher number means more computers can run " +
|
|
"at once, but may induce lag.\n" +
|
|
"Please note that some mods may not work with a thread count higher than 1. Use with caution." )
|
|
.worldRestart()
|
|
.defineInRange( "computer_threads", ComputerCraft.computer_threads, 1, Integer.MAX_VALUE );
|
|
|
|
maxMainGlobalTime = builder
|
|
.comment( "The maximum time that can be spent executing tasks in a single tick, in milliseconds.\n" +
|
|
"Note, we will quite possibly go over this limit, as there's no way to tell how long a will take " +
|
|
"- this aims to be the upper bound of the average time." )
|
|
.defineInRange( "max_main_global_time", TimeUnit.NANOSECONDS.toMillis( ComputerCraft.maxMainGlobalTime ), 1, Long.MAX_VALUE );
|
|
|
|
maxMainComputerTime = builder
|
|
.comment( "The ideal maximum time a computer can execute for in a tick, in milliseconds.\n" +
|
|
"Note, we will quite possibly go over this limit, as there's no way to tell how long a will take " +
|
|
"- this aims to be the upper bound of the average time." )
|
|
.defineInRange( "max_main_computer_time", TimeUnit.NANOSECONDS.toMillis( ComputerCraft.maxMainComputerTime ), 1, Long.MAX_VALUE );
|
|
|
|
builder.pop();
|
|
}
|
|
|
|
{ // HTTP
|
|
builder.comment( "Controls the HTTP API" );
|
|
builder.push( "http" );
|
|
|
|
httpEnabled = builder
|
|
.comment( "Enable the \"http\" API on Computers (see \"http_whitelist\" and \"http_blacklist\" for more " +
|
|
"fine grained control than this)" )
|
|
.define( "enabled", ComputerCraft.http_enable );
|
|
|
|
httpWebsocketEnabled = builder
|
|
.comment( "Enable use of http websockets. This requires the \"http_enable\" option to also be true." )
|
|
.define( "websocket_enabled", ComputerCraft.http_websocket_enable );
|
|
|
|
httpWhitelist = builder
|
|
.comment( "A list of wildcards for domains or IP ranges that can be accessed through the \"http\" API on Computers.\n" +
|
|
"Set this to \"*\" to access to the entire internet. Example: \"*.pastebin.com\" will restrict access to just subdomains of pastebin.com.\n" +
|
|
"You can use domain names (\"pastebin.com\"), wilcards (\"*.pastebin.com\") or CIDR notation (\"127.0.0.0/8\")." )
|
|
.defineList( "whitelist", Arrays.asList( DEFAULT_HTTP_WHITELIST ), x -> true );
|
|
|
|
httpBlacklist = builder
|
|
.comment( "A list of wildcards for domains or IP ranges that cannot be accessed through the \"http\" API on Computers.\n" +
|
|
"If this is empty then all whitelisted domains will be accessible. Example: \"*.github.com\" will block access to all subdomains of github.com.\n" +
|
|
"You can use domain names (\"pastebin.com\"), wilcards (\"*.pastebin.com\") or CIDR notation (\"127.0.0.0/8\")." )
|
|
.defineList( "blacklist", Arrays.asList( DEFAULT_HTTP_BLACKLIST ), x -> true );
|
|
|
|
httpTimeout = builder
|
|
.comment( "The period of time (in milliseconds) to wait before a HTTP request times out. Set to 0 for unlimited." )
|
|
.defineInRange( "timeout", ComputerCraft.httpTimeout, 0, Integer.MAX_VALUE );
|
|
|
|
httpMaxRequests = builder
|
|
.comment( "The number of http requests a computer can make at one time. Additional requests will be queued, and sent when the running requests have finished. Set to 0 for unlimited." )
|
|
.defineInRange( "max_requests", ComputerCraft.httpMaxRequests, 0, Integer.MAX_VALUE );
|
|
|
|
httpMaxDownload = builder
|
|
.comment( "The maximum size (in bytes) that a computer can download in a single request. Note that responses may receive more data than allowed, but this data will not be returned to the client." )
|
|
.defineInRange( "max_download", ComputerCraft.httpMaxDownload, 0, Long.MAX_VALUE );
|
|
|
|
httpMaxUpload = builder
|
|
.comment( "The maximum size (in bytes) that a computer can upload in a single request. This includes headers and POST text." )
|
|
.defineInRange( "max_upload", ComputerCraft.httpMaxUpload, 0, Long.MAX_VALUE );
|
|
|
|
httpMaxWebsockets = builder
|
|
.comment( "The number of websockets a computer can have open at one time. Set to 0 for unlimited." )
|
|
.defineInRange( "max_websockets", ComputerCraft.httpMaxWebsockets, 1, Integer.MAX_VALUE );
|
|
|
|
httpMaxWebsocketMessage = builder
|
|
.comment( "The maximum size (in bytes) that a computer can send or receive in one websocket packet." )
|
|
.defineInRange( "max_websocket_message", ComputerCraft.httpMaxWebsocketMessage, 0, Websocket.MAX_MESSAGE_SIZE );
|
|
|
|
builder.pop();
|
|
}
|
|
|
|
{ // Peripherals
|
|
builder.comment( "Various options relating to peripherals." );
|
|
builder.push( "peripheral" );
|
|
|
|
commandBlockEnabled = builder
|
|
.comment( "Enable Command Block peripheral support" )
|
|
.define( "command_block_enabled", ComputerCraft.enableCommandBlock );
|
|
|
|
modemRange = builder
|
|
.comment( "The range of Wireless Modems at low altitude in clear weather, in meters" )
|
|
.defineInRange( "modem_range", ComputerCraft.modem_range, 0, MODEM_MAX_RANGE );
|
|
|
|
modemHighAltitudeRange = builder
|
|
.comment( "The range of Wireless Modems at maximum altitude in clear weather, in meters" )
|
|
.defineInRange( "modem_high_altitude_range", ComputerCraft.modem_highAltitudeRange, 0, MODEM_MAX_RANGE );
|
|
|
|
modemRangeDuringStorm = builder
|
|
.comment( "The range of Wireless Modems at low altitude in stormy weather, in meters" )
|
|
.defineInRange( "modem_range_during_storm", ComputerCraft.modem_rangeDuringStorm, 0, MODEM_MAX_RANGE );
|
|
|
|
modemHighAltitudeRangeDuringStorm = builder
|
|
.comment( "The range of Wireless Modems at maximum altitude in stormy weather, in meters" )
|
|
.defineInRange( "modem_high_altitude_range_during_storm", ComputerCraft.modem_highAltitudeRangeDuringStorm, 0, MODEM_MAX_RANGE );
|
|
|
|
maxNotesPerTick = builder
|
|
.comment( "Maximum amount of notes a speaker can play at once" )
|
|
.defineInRange( "max_notes_per_tick", ComputerCraft.maxNotesPerTick, 1, Integer.MAX_VALUE );
|
|
|
|
builder.pop();
|
|
}
|
|
|
|
{ // Turtles
|
|
builder.comment( "Various options relating to turtles." );
|
|
builder.push( "turtle" );
|
|
|
|
turtlesNeedFuel = builder
|
|
.comment( "Set whether Turtles require fuel to move" )
|
|
.define( "need_fuel", ComputerCraft.turtlesNeedFuel );
|
|
|
|
turtleFuelLimit = builder
|
|
.comment( "The fuel limit for Turtles" )
|
|
.defineInRange( "normal_fuel_limit", ComputerCraft.turtleFuelLimit, 0, Integer.MAX_VALUE );
|
|
|
|
advancedTurtleFuelLimit = builder
|
|
.comment( "The fuel limit for Advanced Turtles" )
|
|
.defineInRange( "advanced_fuel_limit", ComputerCraft.advancedTurtleFuelLimit, 0, Integer.MAX_VALUE );
|
|
|
|
turtlesObeyBlockProtection = builder
|
|
.comment( "If set to true, Turtles will be unable to build, dig, or enter protected areas (such as near the server spawn point)" )
|
|
.define( "obey_block_protection", ComputerCraft.turtlesObeyBlockProtection );
|
|
|
|
turtlesCanPush = builder
|
|
.comment( "If set to true, Turtles will push entities out of the way instead of stopping if there is space to do so" )
|
|
.define( "can_push", ComputerCraft.turtlesCanPush );
|
|
|
|
turtleDisabledActions = builder
|
|
.comment( "A list of turtle actions which are disabled." )
|
|
.defineList( "disabled_actions", Collections.emptyList(), x -> x instanceof String && getAction( (String) x ) != null );
|
|
|
|
builder.pop();
|
|
}
|
|
|
|
spec = builder.build();
|
|
}
|
|
|
|
public static void load()
|
|
{
|
|
ModLoadingContext.get().registerConfig( ModConfig.Type.COMMON, spec );
|
|
}
|
|
|
|
public static void sync()
|
|
{
|
|
// General
|
|
ComputerCraft.computerSpaceLimit = computerSpaceLimit.get();
|
|
ComputerCraft.floppySpaceLimit = floppySpaceLimit.get();
|
|
ComputerCraft.maximumFilesOpen = maximumFilesOpen.get();
|
|
ComputerCraft.disable_lua51_features = disableLua51Features.get();
|
|
ComputerCraft.default_computer_settings = defaultComputerSettings.get();
|
|
ComputerCraft.debug_enable = debugEnabled.get();
|
|
ComputerCraft.computer_threads = computerThreads.get();
|
|
ComputerCraft.logPeripheralErrors = logComputerErrors.get();
|
|
|
|
// Execution
|
|
ComputerCraft.computer_threads = computerThreads.get();
|
|
ComputerCraft.maxMainGlobalTime = TimeUnit.MILLISECONDS.toNanos( maxMainGlobalTime.get() );
|
|
ComputerCraft.maxMainComputerTime = TimeUnit.MILLISECONDS.toNanos( maxMainComputerTime.get() );
|
|
|
|
// HTTP
|
|
ComputerCraft.http_enable = httpEnabled.get();
|
|
ComputerCraft.http_websocket_enable = httpWebsocketEnabled.get();
|
|
ComputerCraft.http_whitelist = new AddressPredicate( httpWhitelist.get() );
|
|
ComputerCraft.http_blacklist = new AddressPredicate( httpBlacklist.get() );
|
|
|
|
ComputerCraft.httpTimeout = httpTimeout.get();
|
|
ComputerCraft.httpMaxRequests = httpMaxRequests.get();
|
|
ComputerCraft.httpMaxDownload = httpMaxDownload.get();
|
|
ComputerCraft.httpMaxUpload = httpMaxUpload.get();
|
|
ComputerCraft.httpMaxWebsockets = httpMaxWebsockets.get();
|
|
ComputerCraft.httpMaxWebsocketMessage = httpMaxWebsocketMessage.get();
|
|
|
|
// Peripheral
|
|
ComputerCraft.enableCommandBlock = commandBlockEnabled.get();
|
|
ComputerCraft.maxNotesPerTick = maxNotesPerTick.get();
|
|
ComputerCraft.modem_range = modemRange.get();
|
|
ComputerCraft.modem_highAltitudeRange = modemHighAltitudeRange.get();
|
|
ComputerCraft.modem_rangeDuringStorm = modemRangeDuringStorm.get();
|
|
ComputerCraft.modem_highAltitudeRangeDuringStorm = modemHighAltitudeRangeDuringStorm.get();
|
|
|
|
// Turtles
|
|
ComputerCraft.turtlesNeedFuel = turtlesNeedFuel.get();
|
|
ComputerCraft.turtleFuelLimit = turtleFuelLimit.get();
|
|
ComputerCraft.advancedTurtleFuelLimit = advancedTurtleFuelLimit.get();
|
|
ComputerCraft.turtlesObeyBlockProtection = turtlesObeyBlockProtection.get();
|
|
ComputerCraft.turtlesCanPush = turtlesCanPush.get();
|
|
|
|
ComputerCraft.turtleDisabledActions.clear();
|
|
for( String value : turtleDisabledActions.get() ) ComputerCraft.turtleDisabledActions.add( getAction( value ) );
|
|
}
|
|
|
|
@SubscribeEvent
|
|
public static void sync( ModConfig.Loading event )
|
|
{
|
|
sync();
|
|
}
|
|
|
|
@SubscribeEvent
|
|
public static void sync( ModConfig.ConfigReloading event )
|
|
{
|
|
sync();
|
|
}
|
|
|
|
private static final Converter<String, String> converter = CaseFormat.LOWER_CAMEL.converterTo( CaseFormat.UPPER_UNDERSCORE );
|
|
|
|
private static TurtleAction getAction( String value )
|
|
{
|
|
try
|
|
{
|
|
return TurtleAction.valueOf( converter.convert( value ) );
|
|
}
|
|
catch( IllegalArgumentException e )
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
}
|