Merge pull request #28 from cuberite/ScenarioRelativeRedirect

Scenario relative paths

Author: madmaxoft

APIImpl/File.lua

@@ -33,7 +33,7 @@ return
 		assert(a_DstFileName ~= "")
 		local isSuccess, msg = utils.copyFile(a_SrcFileName, a_DstFileName)
 		if not(isSuccess) then
-			a_Simulator.logger.debug("cFile:Copy failed: %s", msg)
+			a_Simulator.logger:debug("cFile:Copy failed: %s", msg)
 		end
 		return isSuccess
 	end,

Options.lua

@@ -23,6 +23,7 @@ The options object contains the following fields:
 	pluginFiles            - array-table of filenames for all plugin files to check. Each item already includes pluginPath
 	pluginPath             - path to the plugin's files
 	scenarioFileName       - filename to load as scenario file
+	scenarioPath           - path to the scenario file (used for relative FS redirection)
 	shouldClearObjects     - bool specifying whether API objects should be cleared after each callback (thus detecting potential use-after-callback)
 	shouldGCObjects        - bool specifying whether API objects should be GC-ed after each callback (thus detecting storage-after-callback)
 	prefillSymbolPatterns  - array-table of patterns used to fill the sandbox of the plugin
@@ -145,6 +146,12 @@ local optionProcessor =
 			)
 		end
 		a_Options.scenarioFileName = a_Args[a_Idx + 1]
+		local idxLastSlash = string.find(a_Options.scenarioFileName, "/[^/]*$")
+		if (idxLastSlash) then
+			a_Options.scenarioPath = string.sub(a_Options.scenarioFileName, 1, idxLastSlash)
+		else
+			a_Options.scenarioPath = ""
+		end
 		if not(a_Options.scenarioFileName) then
 			error(string.format("Invalid option \"-s\" (%d), expected a scenario filename following it.", a_Idx))
 		end

ScenarioFiles.md

@@ -32,15 +32,15 @@ Note that the scenario needs to explicitly specify when to load / initialize the
 The following actions can be used in a scenario:
 
 ## redirect
-Adds redirection for files and folders. Any Cuberite API that takes a file or folder first checks if there's any redirection for the path. If the beginning of a path to be used matches any of the redirects given, the appropriate part of the path will be replaced. For example, consider a redirect of `["a/b/"] = "c/d/"`, the following table sums up the redirection performed:
+Adds redirection for files and folders. Any Cuberite API that takes a file or folder first checks if there's any redirection for the path. If the beginning of a path to be used matches any of the redirects given, the appropriate part of the path will be replaced. The redirected paths are relative to the scenario file's folder. For example, consider a redirect of `["a/b/"] = "c/d/"` and the scenario file being used is `tests/scenario.lua`, the following table sums up the redirection performed:
 
 Path used by plugin | Path actually used | Notes
 --------------------|--------------------|------
 a.txt               | a.txt              | Partial matches are ignored
 a/b.txt             | a/b.txt            | Not matching the full redirect path
-a/b/z.txt           | c/d/z.txt          | Redirect performed
+a/b/z.txt           | tests/c/d/z.txt    | Redirect performed
 c/a/b/z.txt         | c/a/b/z.txt        | Not matching the *beginning* of the path
-c/../a/b/z.txt      | c/d/z.txt          | Redirect takes into account relative paths
+e/../a/b/z.txt      | tests/c/d/z.txt    | Redirect takes into account collapsed relative paths
 c/d/../a/b/z.txt    | c/a/b/z.txt        | Relative path collapsed, but not matching the *beginning* of the path
 
 Takes a dictionary table which maps old paths to new paths as its parameter. Note that paths always use a slash, even on Windows! Also note that most paths cannot be used in the simple Lua table key format, but will need to use the brackets instead:
@@ -98,7 +98,7 @@ b b a
 b b b
 ```
 
-Takes a dictionary table as its parameter. The `playerName` value specifies the player to impersonate for the commands. The `choices` specifies an array of strings that are used for the parameters. The 'maxLen' specifies the maximum number of parameters, the optional `minLen` (default: 0) specifies the minimum number of parameters. 
+Takes a dictionary table as its parameter. The `playerName` value specifies the player to impersonate for the commands. The `choices` specifies an array of strings that are used for the parameters. The 'maxLen' specifies the maximum number of parameters, the optional `minLen` (default: 0) specifies the minimum number of parameters.
 
 If, at the time the action is executed, the specified player is not connected, the Checker aborts with an error message.
 

Simulator.lua

@@ -1382,7 +1382,9 @@ function Simulator:redirectPath(a_Path)
 	-- If there is a matching entry in the redirects, use it:
 	local match = self.redirects[a_Path]
 	if (match) then
-		return match
+		local res = self.options.scenarioPath .. match
+		self.logger:trace(string.format("Redirecting \"%s\" to \"%s\".", a_Path, res))
+		return res
 	end
 
 	-- If there is a full foldername match, use it:
@@ -1391,13 +1393,17 @@ function Simulator:redirectPath(a_Path)
 	while (true) do
 		idx = a_Path:find("/", idx + 1)  -- find the next slash
 		if not(idx) then
+			-- No redirection match
 			return a_Path
 		end
 		local match = self.redirects[a_Path:sub(1, idx)]  -- check the path up to the current slash for redirects:
 		if (match) then
-			return match .. a_Path.sub(idx + 1)
+			local res = self.options.scenarioPath .. match .. a_Path.sub(idx + 1)
+			self.logger:trace(string.format("Redirecting \"%s\" to \"%s\".", a_Path, res))
+			return res
 		end
 	end
+	assert(false, "Should never get here, the above is an infinite loop with return points")
 end
 
 

tests/Gallery/FuzzCommands.cfg

@@ -0,0 +1,67 @@
+
+-- This is an example configuration file. It uses Lua syntax to describe individual galleries and other settings
+-- This file will be copied over to $/Server/Galleries.example.cfg to give the server admins a skeleton to work on
+
+
+
+
+
+Galleries =
+{
+	{
+		-- Name of the gallery, as used in the commands
+		Name = "first";
+
+		-- Name of the world for which the gallery is defined.
+		WorldName = "world";
+
+		-- Dimensions of the gallery
+		MinX = 100;
+		MinZ = 100;
+		MaxX = 200;
+		MaxZ = 10000;
+
+		-- The areas don't have a template, use the current world's contents instead:
+		AreaSizeX = 16,
+		AreaSizeZ = 16,
+
+		-- Edge of each area that is "public", i. e. non-buildable even by area's owner.
+		-- This is so that the AreaTemplate may include e. g. sidewalks that will be preserved
+		-- Setting this to N means that N blocks from each area's edge are protected, i. e. sidewalk of width 2 * N
+		AreaEdge = 2;
+
+		-- Strategy used for allocating the areas in the gallery.
+		-- Represents the direction and the order in which areas are allocated out of the gallery
+		-- "x+z+" means first increment X, then (when MaxX is reached) increment z and start over with x from MinX.
+		-- Other possible values: "x-z+", "x+z-", "x-z-", "z+x+", "z+x-", "z-x+", "z-x-".
+		FillStrategy = "x+z+";
+
+		-- The biome to use for the gallery areas
+		-- Only used when AreaTemplate is valid.
+		-- If not set, no biome is forced (the world generator provides the default biome)
+		Biome = "Jungle";
+	};
+};
+
+
+
+
+
+Config =
+{
+	-- The prefix, under which all the plugin's commands are registered.
+	-- All commands use this prefix, space, and an additional verb, like "list" or "claim"
+	-- CommandPrefix = "/gal";
+
+	-- Allow building outside galleries for regular users
+	-- When set to false, only users with the "gallery.admin.buildoutside" permission can build outside the galleries
+	AllowBuildOutsideGalleries = false;
+
+	-- WorldEdit usage outside the galleries
+	-- When set to false, only players with the "gallery.admin.worldeditoutside" permission can use WE outside the galleries
+	AllowWEOutsideGalleries = false;
+};
+
+
+
+

tests/Gallery/FuzzCommands.lua

@@ -11,9 +11,9 @@ scenario
 	name = "Fuzz all commands",
 	redirect -- Redirect files / folders
 	{
-		["Galleries.cfg"] = "tests/Gallery/FuzzCommands.cfg",
-		["Galleries.example.cfg"] = "tests/Gallery/FuzzCommands.example.cfg",
-		["Galleries.sqlite"] = "tests/Gallery/FuzzCommands.sqlite",
+		["Galleries.cfg"] = "FuzzCommands.cfg",
+		["Galleries.example.cfg"] = "FuzzCommands.example.cfg",
+		["Galleries.sqlite"] = "FuzzCommands.sqlite",
 	},
 	world  -- Create a world
 	{