Added clientside support for require (only for pure lua modules)

Author: darkdreamingdan

Client/mods/deathmatch/logic/lua/CLuaMain.cpp

@@ -42,6 +42,8 @@ CLuaMain::CLuaMain ( CLuaManager* pLuaManager, CResource* pResourceOwner, bool b
 
     m_pResource = pResourceOwner;
 
+    m_iPackageLoadedRef = -1;
+
     m_bEnableOOP = bEnableOOP;
 
     CClientPerfStatLuaMemory::GetSingleton ()->OnLuaMainCreate ( this );
@@ -150,6 +152,9 @@ void CLuaMain::InitVM ( void )
     luaopen_debug ( m_luaVM );
     luaopen_utf8 ( m_luaVM );
 
+    // Initialize packages system
+    InitPackageStorage(m_luaVM);
+
     // Initialize security restrictions. Very important to prevent lua trojans and viruses!
     InitSecurity();
 
@@ -207,7 +212,7 @@ void CLuaMain::InstructionCountHook ( lua_State* luaVM, lua_Debug* pDebug )
 }
 
 
-bool CLuaMain::LoadScriptFromBuffer ( const char* cpInBuffer, unsigned int uiInSize, const char* szFileName )
+bool CLuaMain::LoadScriptFromBuffer(const char* cpInBuffer, unsigned int uiInSize, const char* szFileName, bool bClearReturnValues)
 {
     SString strNiceFilename = ConformResourcePath( szFileName );
 
@@ -272,7 +277,7 @@ bool CLuaMain::LoadScriptFromBuffer ( const char* cpInBuffer, unsigned int uiInS
                 g_pClientGame->GetScriptDebugging()->LogPCallError( m_luaVM, strRes, true );
             }
             // Cleanup any return values
-            if ( lua_gettop ( m_luaVM ) > luaSavedTop )
+            if ( bClearReturnValues && lua_gettop ( m_luaVM ) > luaSavedTop )
                 lua_settop( m_luaVM, luaSavedTop );
             return true;
         }
@@ -571,3 +576,147 @@ int CLuaMain::OnUndump( const char* p, size_t n )
     }
     return 1;
 }
+
+
+///////////////////////////////////////////////////////////////
+//
+// CLuaMain::InitPackageStorage
+//
+// Create a table for storage of Lua packages - stored in the Lua VM
+//
+///////////////////////////////////////////////////////////////
+void CLuaMain::InitPackageStorage(lua_State* L)
+{
+    lua_newtable(L);                                            // stack: [tbl_new]
+    lua_pushstring(L, "loaded");                                // stack: [tbl_new,"loaded"]
+    lua_newtable(L);                                            // stack: [tbl_new,"loaded",tbl_new2]
+
+    // We push our default Lua libs are loaded packages
+    std::vector<const char*> szDefaultLibs = { "math", "string", "table", "debug", "utf8" };
+    for (auto it : szDefaultLibs)
+    {
+        lua_pushstring(L, it);                                  // stack: [tbl_new,"loaded",tbl_new2,"math"]
+        lua_getglobal(L, it);                                   // stack: [tbl_new,"loaded",tbl_new2,"math",_G.math]
+        lua_settable(L, -3);                                    // stack: [tbl_new,"loaded",tbl_new2]
+    }
+
+    // Keep our package.loaded table safely in registry
+    m_iPackageLoadedRef = luaL_ref(L, LUA_REGISTRYINDEX);       // stack: [tbl_new,"loaded"]
+    lua_rawgeti(L, LUA_REGISTRYINDEX, m_iPackageLoadedRef);     // stack: [tbl_new,"loaded",tbl_new2]
+
+    // Finally, store our original table as global package.loaded
+    lua_settable(L, -3);                                        // stack: [tbl_new]
+    lua_setglobal(L, "package");                                // stack: []
+}
+
+///////////////////////////////////////////////////////////////
+//
+// CLuaMain::SetPackage
+//
+// Set the top most value as a package (No pop)
+//
+///////////////////////////////////////////////////////////////
+void CLuaMain::SetPackage(lua_State* L, SString &strName)
+{
+    if (m_iPackageLoadedRef < 0)
+        return;
+    // We set varPkg, which is already on the stack, into package.loaded.moduleName = varPkg.
+    // stack: [varPkg]
+    int iPkg = luaL_ref(L, LUA_REGISTRYINDEX);              // stack: []
+    lua_rawgeti(L, LUA_REGISTRYINDEX, m_iPackageLoadedRef); // [tbl_loaded]
+
+
+    lua_pushstring(L, strName.c_str());                     // stack: [tbl_loaded,"moduleName"]
+    lua_rawgeti(L, LUA_REGISTRYINDEX, iPkg);                // stack: [tbl_loaded,"moduleName",varPkg]
+    lua_rawset(L, -3);                                      // stack: [tbl_loaded]
+    lua_pop(L, 2);                                          // stack: []
+    lua_rawgeti(L, LUA_REGISTRYINDEX, iPkg);                // stack: [varPkg]
+
+    // Cleanup our used registry entry, i.e. REGISTRY[i] = nil.
+    lua_pushnil(L);                                         // stack: [varPkg,nil]
+    lua_rawseti(L, LUA_REGISTRYINDEX, iPkg);                // stack: [varPkg]
+}
+
+///////////////////////////////////////////////////////////////
+//
+// CLuaMain::GetPackage
+//
+// Push the value of a package of name to the stack
+//
+///////////////////////////////////////////////////////////////
+void CLuaMain::GetPackage(lua_State* L, SString &strName)
+{
+    if (m_iPackageLoadedRef < 0)
+        return;
+
+    lua_rawgeti(L, LUA_REGISTRYINDEX, m_iPackageLoadedRef); // stack: [tbl_loaded]
+    lua_pushstring(L, strName.c_str());                     // stack: [tbl_loaded,"moduleName"]
+    lua_rawget(L, -2);                                      // stack: [tbl_loaded,varPkg]
+    lua_remove(L, -2);                                      // stack: [varPkg]
+}
+
+///////////////////////////////////////////////////////////////
+//
+// CLuaMain::LoadLuaLib
+//
+// Load a Lua lib of a given name
+//
+///////////////////////////////////////////////////////////////
+bool CLuaMain::LoadLuaLib(lua_State *L, SString strName, SString &strError)
+{
+    SString strPath = strName;
+    // Name format shouldn't include slashes.  Subdirs are dots.
+    ReplaceOccurrencesInString(strPath, "\\", "");
+    ReplaceOccurrencesInString(strPath, "/", "");
+    ReplaceOccurrencesInString(strPath, ".", "/");
+
+    SString strResPath = m_pResource->GetResourceDirectoryPath(ACCESS_PUBLIC, "");
+
+    std::vector < char > buffer;
+    // Try <resource>/?.lua
+    SString strFilePath = PathJoin(strResPath, strPath + ".lua");
+    if (FileExists(strFilePath))
+        FileLoad(strFilePath, buffer);
+    else
+    {
+        // Don't use a format string for safety, so we construct the error by hand
+        strError += "error loading module " + strName + " from file " + strFilePath +
+            ":\n\t The specified module could not be found";
+
+        // Try <resource>/?/init.lua
+        strFilePath = PathJoin(strResPath, strPath, "init.lua");
+        if (FileExists(strFilePath))
+            FileLoad(strFilePath, buffer);
+        else
+        {
+            strError += "\n";
+            strError += "error loading module " + strName + " from file " + strFilePath +
+                ":\n\t The specified module could not be found";
+            return false;
+        }
+    }
+
+    if (buffer.size() > 0)
+    {
+        int luaSavedTop = lua_gettop(L);
+        LoadScriptFromBuffer(&buffer.at(0), buffer.size(), strFilePath.c_str(), false);
+        // Only keep the first return value
+        if (lua_gettop(L) > luaSavedTop)
+            lua_settop(L, luaSavedTop + 1);
+
+        if (lua_type(L, -1) == LUA_TNIL)
+        {
+            strError += "error loading module " + strName + " from file " + strFilePath +
+                ":\n\t Module didn't return a value";
+            return false;
+        }
+
+        SetPackage(L, strName);  // Store our package into package.loaded
+        return true;
+    }
+    else
+        strError += "error loading module " + strName + " from file " + strFilePath +
+        ":\n\t Error loading script file";
+
+    return false;
+}

Client/mods/deathmatch/logic/lua/CLuaMain.h

@@ -44,7 +44,7 @@ class CLuaMain //: public CClient
                                     CLuaMain                ( class CLuaManager* pLuaManager, CResource* pResourceOwner, bool bEnableOOP );
                                     ~CLuaMain               ( void );
 
-    bool                            LoadScriptFromBuffer    ( const char* cpBuffer, unsigned int uiSize, const char* szFileName );
+    bool                            LoadScriptFromBuffer    ( const char* cpBuffer, unsigned int uiSize, const char* szFileName, bool bClearReturnValues = true );
     bool                            LoadScript              ( const char* szLUAScript );
     void                            UnloadScript            ( void );
 
@@ -80,6 +80,11 @@ class CLuaMain //: public CClient
     static int                      LuaLoadBuffer           ( lua_State *L, const char *buff, size_t sz, const char *name );
     static int                      OnUndump                ( const char* p, size_t n );
 
+    void                            InitPackageStorage(lua_State* L);  // Create a psuedo package.loaded table
+    void                            GetPackage(lua_State *L, SString &strName); // Push the package value to the top of the stack
+    void                            SetPackage(lua_State *L, SString &strName); // Set the package to the value at the top of the stack
+    bool                            LoadLuaLib(lua_State *L, SString strName, SString &strError); // Load a lua library of a given name
+
     bool                            IsOOPEnabled            ( void )                        { return m_bEnableOOP; }
 private:
     void                            InitSecurity            ( void );
@@ -90,6 +95,7 @@ class CLuaMain //: public CClient
 
     lua_State*                      m_luaVM;
     CLuaTimerManager*               m_pLuaTimerManager;
+    int                             m_iPackageLoadedRef;
 
     bool                            m_bBeingDeleted; // prevent it being deleted twice
 

Shared/mods/deathmatch/logic/luadefs/CLuaUtilDefs.cpp

@@ -565,7 +565,6 @@ int CLuaUtilDefs::PregMatch ( lua_State* luaVM )
 
 int CLuaUtilDefs::Require(lua_State* luaVM)
 {
-#ifndef MTA_CLIENT
     //  table require ( string name )
     SString strMod;
 
@@ -587,17 +586,16 @@ int CLuaUtilDefs::Require(lua_State* luaVM)
         if (pLuaMain->LoadLuaLib(luaVM, strMod,strError))        // stack: ["moduleName",pkgLuaMod/nil]
             return 1;
         strError += "\n";
-
+#ifndef MTA_CLIENT
         // Check if a C library exists
         if (pLuaMain->LoadClib(luaVM, strMod,strError))          // stack: ["moduleName",fncModule/nil]
             return 1;
+#endif
         m_pScriptDebugging->LogCustom(luaVM, strError);
-
-        lua_pop(luaVM,2);                               // stack: []
     }
     else
         m_pScriptDebugging->LogCustom(luaVM, argStream.GetFullErrorMessage());
-#endif
+
     lua_pushboolean(luaVM, false);
     return 1;
 }