Schematics: Prepend mod path to relative schematic filepaths

doc/lua_api.txt

@@ -439,6 +439,7 @@ the global `minetest.registered_*` tables.
     * added to `minetest.registered_schematic` with the key of `schematic.name`
     * if `schematic.name` is nil, the key is the returned ID
     * if the schematic is loaded from a file, schematic.name is set to the filename
+    * the current mod path will be prepended to the schematic filename if it is a relative path
 
 * `minetest.clear_registered_biomes()`
     * clears all biomes currently registered

src/filesys.cpp

@@ -34,8 +34,9 @@ namespace fs
 
 #define _WIN32_WINNT 0x0501
 #include <windows.h>
+#include <shlwapi.h>
 
-std::vector<DirListNode> GetDirListing(std::string pathstring)
+std::vector<DirListNode> GetDirListing(const std::string &pathstring)
 {
 	std::vector<DirListNode> listing;
 
@@ -86,7 +87,7 @@ std::vector<DirListNode> GetDirListing(std::string pathstring)
 	return listing;
 }
 
-bool CreateDir(std::string path)
+bool CreateDir(const std::string &path)
 {
 	bool r = CreateDirectory(path.c_str(), NULL);
 	if(r == true)
@@ -96,12 +97,17 @@ bool CreateDir(std::string path)
 	return false;
 }
 
-bool PathExists(std::string path)
+bool PathExists(const std::string &path)
 {
 	return (GetFileAttributes(path.c_str()) != INVALID_FILE_ATTRIBUTES);
 }
 
-bool IsDir(std::string path)
+bool IsPathAbsolute(const std::string &path)
+{
+	return !PathIsRelative(path.c_str());
+}
+
+bool IsDir(const std::string &path)
 {
 	DWORD attr = GetFileAttributes(path.c_str());
 	return (attr != INVALID_FILE_ATTRIBUTES &&
@@ -113,7 +119,7 @@ bool IsDirDelimiter(char c)
 	return c == '/' || c == '\\';
 }
 
-bool RecursiveDelete(std::string path)
+bool RecursiveDelete(const std::string &path)
 {
 	infostream<<"Recursively deleting \""<<path<<"\""<<std::endl;
 
@@ -158,7 +164,7 @@ bool RecursiveDelete(std::string path)
 	return true;
 }
 
-bool DeleteSingleFileOrEmptyDirectory(std::string path)
+bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
 {
 	DWORD attr = GetFileAttributes(path.c_str());
 	bool is_directory = (attr != INVALID_FILE_ATTRIBUTES &&
@@ -199,7 +205,7 @@ std::string TempPath()
 #include <sys/wait.h>
 #include <unistd.h>
 
-std::vector<DirListNode> GetDirListing(std::string pathstring)
+std::vector<DirListNode> GetDirListing(const std::string &pathstring)
 {
 	std::vector<DirListNode> listing;
 
@@ -252,7 +258,7 @@ std::vector<DirListNode> GetDirListing(std::string pathstring)
 	return listing;
 }
 
-bool CreateDir(std::string path)
+bool CreateDir(const std::string &path)
 {
 	int r = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
 	if(r == 0)
@@ -268,13 +274,18 @@ bool CreateDir(std::string path)
 	}
 }
 
-bool PathExists(std::string path)
+bool PathExists(const std::string &path)
 {
 	struct stat st;
 	return (stat(path.c_str(),&st) == 0);
 }
 
-bool IsDir(std::string path)
+bool IsPathAbsolute(const std::string &path)
+{
+	return path[0] == '/';
+}
+
+bool IsDir(const std::string &path)
 {
 	struct stat statbuf;
 	if(stat(path.c_str(), &statbuf))
@@ -287,7 +298,7 @@ bool IsDirDelimiter(char c)
 	return c == '/';
 }
 
-bool RecursiveDelete(std::string path)
+bool RecursiveDelete(const std::string &path)
 {
 	/*
 		Execute the 'rm' command directly, by fork() and execve()
@@ -333,7 +344,7 @@ bool RecursiveDelete(std::string path)
 	}
 }
 
-bool DeleteSingleFileOrEmptyDirectory(std::string path)
+bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
 {
 	if(IsDir(path)){
 		bool did = (rmdir(path.c_str()) == 0);
@@ -370,7 +381,7 @@ std::string TempPath()
 
 #endif
 
-void GetRecursiveSubPaths(std::string path, std::vector<std::string> &dst)
+void GetRecursiveSubPaths(const std::string &path, std::vector<std::string> &dst)
 {
 	std::vector<DirListNode> content = GetDirListing(path);
 	for(unsigned int  i=0; i<content.size(); i++){
@@ -398,7 +409,7 @@ bool DeletePaths(const std::vector<std::string> &paths)
 	return success;
 }
 
-bool RecursiveDeleteContent(std::string path)
+bool RecursiveDeleteContent(const std::string &path)
 {
 	infostream<<"Removing content of \""<<path<<"\""<<std::endl;
 	std::vector<DirListNode> list = GetDirListing(path);
@@ -417,7 +428,7 @@ bool RecursiveDeleteContent(std::string path)
 	return true;
 }
 
-bool CreateAllDirs(std::string path)
+bool CreateAllDirs(const std::string &path)
 {
 
 	std::vector<std::string> tocreate;
@@ -435,7 +446,7 @@ bool CreateAllDirs(std::string path)
 	return true;
 }
 
-bool CopyFileContents(std::string source, std::string target)
+bool CopyFileContents(const std::string &source, const std::string &target)
 {
 	FILE *sourcefile = fopen(source.c_str(), "rb");
 	if(sourcefile == NULL){
@@ -489,7 +500,7 @@ bool CopyFileContents(std::string source, std::string target)
 	return retval;
 }
 
-bool CopyDir(std::string source, std::string target)
+bool CopyDir(const std::string &source, const std::string &target)
 {
 	if(PathExists(source)){
 		if(!PathExists(target)){
@@ -519,7 +530,7 @@ bool CopyDir(std::string source, std::string target)
 	}
 }
 
-bool PathStartsWith(std::string path, std::string prefix)
+bool PathStartsWith(const std::string &path, const std::string &prefix)
 {
 	size_t pathsize = path.size();
 	size_t pathpos = 0;
@@ -569,7 +580,7 @@ bool PathStartsWith(std::string path, std::string prefix)
 	}
 }
 
-std::string RemoveLastPathComponent(std::string path,
+std::string RemoveLastPathComponent(const std::string &path,
 		std::string *removed, int count)
 {
 	if(removed)

src/filesys.h

@@ -40,22 +40,25 @@ struct DirListNode
 	std::string name;
 	bool dir;
 };
-std::vector<DirListNode> GetDirListing(std::string path);
+
+std::vector<DirListNode> GetDirListing(const std::string &path);
 
 // Returns true if already exists
-bool CreateDir(std::string path);
+bool CreateDir(const std::string &path);
 
-bool PathExists(std::string path);
+bool PathExists(const std::string &path);
 
-bool IsDir(std::string path);
+bool IsPathAbsolute(const std::string &path);
+
+bool IsDir(const std::string &path);
 
 bool IsDirDelimiter(char c);
 
 // Only pass full paths to this one. True on success.
 // NOTE: The WIN32 version returns always true.
-bool RecursiveDelete(std::string path);
+bool RecursiveDelete(const std::string &path);
 
-bool DeleteSingleFileOrEmptyDirectory(std::string path);
+bool DeleteSingleFileOrEmptyDirectory(const std::string &path);
 
 // Returns path to temp directory, can return "" on error
 std::string TempPath();
@@ -63,34 +66,34 @@ std::string TempPath();
 /* Multiplatform */
 
 // The path itself not included
-void GetRecursiveSubPaths(std::string path, std::vector<std::string> &dst);
+void GetRecursiveSubPaths(const std::string &path, std::vector<std::string> &dst);
 
 // Tries to delete all, returns false if any failed
 bool DeletePaths(const std::vector<std::string> &paths);
 
 // Only pass full paths to this one. True on success.
-bool RecursiveDeleteContent(std::string path);
+bool RecursiveDeleteContent(const std::string &path);
 
 // Create all directories on the given path that don't already exist.
-bool CreateAllDirs(std::string path);
+bool CreateAllDirs(const std::string &path);
 
 // Copy a regular file
-bool CopyFileContents(std::string source, std::string target);
+bool CopyFileContents(const std::string &source, const std::string &target);
 
 // Copy directory and all subdirectories
 // Omits files and subdirectories that start with a period
-bool CopyDir(std::string source, std::string target);
+bool CopyDir(const std::string &source, const std::string &target);
 
 // Check if one path is prefix of another
 // For example, "/tmp" is a prefix of "/tmp" and "/tmp/file" but not "/tmp2"
 // Ignores case differences and '/' vs. '\\' on Windows
-bool PathStartsWith(std::string path, std::string prefix);
+bool PathStartsWith(const std::string &path, const std::string &prefix);
 
 // Remove last path component and the dir delimiter before and/or after it,
 // returns "" if there is only one path component.
 // removed: If non-NULL, receives the removed component(s).
 // count: Number of components to remove
-std::string RemoveLastPathComponent(std::string path,
+std::string RemoveLastPathComponent(const std::string &path,
                std::string *removed = NULL, int count = 1);
 
 // Remove "." and ".." path components and for every ".." removed, remove

src/script/lua_api/l_base.cpp

@@ -20,8 +20,11 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "lua_api/l_base.h"
 #include "lua_api/l_internal.h"
 #include "cpp_api/s_base.h"
+#include <mods.h>
+#include <server.h>
 
-ScriptApiBase* ModApiBase::getScriptApiBase(lua_State *L) {
+ScriptApiBase *ModApiBase::getScriptApiBase(lua_State *L)
+{
 	// Get server from registry
 	lua_getfield(L, LUA_REGISTRYINDEX, "scriptapi");
 	ScriptApiBase *sapi_ptr = (ScriptApiBase*) lua_touserdata(L, -1);
@@ -29,23 +32,42 @@ ScriptApiBase* ModApiBase::getScriptApiBase(lua_State *L) {
 	return sapi_ptr;
 }
 
-Server* ModApiBase::getServer(lua_State *L) {
+Server *ModApiBase::getServer(lua_State *L)
+{
 	return getScriptApiBase(L)->getServer();
 }
 
-Environment* ModApiBase::getEnv(lua_State *L) {
+Environment *ModApiBase::getEnv(lua_State *L)
+{
 	return getScriptApiBase(L)->getEnv();
 }
 
-GUIEngine* ModApiBase::getGuiEngine(lua_State *L) {
+GUIEngine *ModApiBase::getGuiEngine(lua_State *L)
+{
 	return getScriptApiBase(L)->getGuiEngine();
 }
 
-bool ModApiBase::registerFunction(lua_State *L,
-		const char *name,
-		lua_CFunction fct,
-		int top
-		) {
+std::string ModApiBase::getCurrentModPath(lua_State *L)
+{
+	lua_getfield(L, LUA_REGISTRYINDEX, "current_modname");
+	const char *current_modname = lua_tostring(L, -1);
+	if (!current_modname)
+		return ".";
+
+	const ModSpec *mod = getServer(L)->getModSpec(current_modname);
+	if (!mod)
+		return ".";
+
+	return mod->path;
+}
+
+
+bool ModApiBase::registerFunction(
+	lua_State *L,
+	const char *name,
+	lua_CFunction fct,
+	int top)
+{
 	//TODO check presence first!
 
 	lua_pushstring(L,name);

src/script/lua_api/l_base.h

@@ -35,11 +35,12 @@ class GUIEngine;
 
 class ModApiBase {
 
-protected:
+public:
 	static ScriptApiBase*   getScriptApiBase(lua_State *L);
 	static Server*          getServer(lua_State *L);
 	static Environment*     getEnv(lua_State *L);
 	static GUIEngine*       getGuiEngine(lua_State *L);
+	static std::string      getCurrentModPath(lua_State *L);
 
 	// Get an arbitrary subclass of ScriptApiBase
 	// by using dynamic_cast<> on getScriptApiBase()

src/script/lua_api/l_mapgen.cpp

@@ -32,6 +32,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "mg_schematic.h"
 #include "mapgen_v5.h"
 #include "mapgen_v7.h"
+#include "filesys.h"
 #include "settings.h"
 #include "log.h"
 
@@ -142,7 +143,12 @@ Schematic *load_schematic(lua_State *L, int index,
 		return NULL;
 	} else if (lua_isstring(L, index)) {
 		schem = SchematicManager::create(SCHEMATIC_NORMAL);
-		if (!schem->loadSchematicFromFile(lua_tostring(L, index),
+
+		std::string filepath = lua_tostring(L, index);
+		if (!fs::IsPathAbsolute(filepath))
+			filepath = ModApiBase::getCurrentModPath(L) + DIR_DELIM + filepath;
+
+		if (!schem->loadSchematicFromFile(filepath.c_str(),
 				schemmgr->getNodeDef(), replace_names)) {
 			delete schem;
 			return NULL;