Add support for Lua packages

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

@@ -38,6 +38,8 @@ CLuaMain::CLuaMain(CLuaManager* pLuaManager, CResource* pResourceOwner, bool bEn
 
     m_pResource = pResourceOwner;
 
+    m_iPackageLoadedRef = -1;
+
     m_bEnableOOP = bEnableOOP;
 
     CClientPerfStatLuaMemory::GetSingleton()->OnLuaMainCreate(this);
@@ -158,6 +160,9 @@ void CLuaMain::InitVM()
     luaopen_utf8(m_luaVM);
     luaopen_os(m_luaVM);
 
+    // Initialize packages system
+    InitPackageStorage(m_luaVM);
+
     // Initialize security restrictions. Very important to prevent lua trojans and viruses!
     InitSecurity();
 
@@ -212,7 +217,8 @@ 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);
 
@@ -276,7 +282,7 @@ bool CLuaMain::LoadScriptFromBuffer(const char* cpInBuffer, unsigned int uiInSiz
                 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;
         }

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

@@ -40,7 +40,7 @@ class CLuaMain            //: public CClient
     CLuaMain(class CLuaManager* pLuaManager, CResource* pResourceOwner, bool bEnableOOP);
     ~CLuaMain();
 
-    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();
 
@@ -79,6 +79,11 @@ class CLuaMain            //: public CClient
 
     bool IsOOPEnabled() { return m_bEnableOOP; }
 
+    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, bool& bEmpty);    // Load a lua library of a given name
+
 private:
     void InitSecurity();
 
@@ -88,6 +93,7 @@ class CLuaMain            //: public CClient
 
     lua_State*        m_luaVM;
     CLuaTimerManager* m_pLuaTimerManager;
+    int               m_iPackageLoadedRef;
 
     bool m_bBeingDeleted;            // prevent it being deleted twice
 

Server/mods/deathmatch/logic/CAccessControlListManager.cpp

@@ -141,6 +141,10 @@ bool CAccessControlListManager::Load()
                             {
                                 pRight = pACL->AddRight(&szRightName[8], CAccessControlListRight::RIGHT_TYPE_GENERAL, bAccess);
                             }
+                            else if (StringBeginsWith(szRightName, "module."))
+                            {
+                                pRight = pACL->AddRight(&szRightName[7], CAccessControlListRight::RIGHT_TYPE_MODULE, bAccess);
+                            }
                             else
                                 continue;
 
@@ -536,6 +540,11 @@ const char* CAccessControlListManager::ExtractRightName(const char* szRightName,
         eType = CAccessControlListRight::RIGHT_TYPE_GENERAL;
         return szRightName + 8;
     }
+    else if ( StringBeginsWith( szRightName, "module." ) )
+    {
+        eType = CAccessControlListRight::RIGHT_TYPE_MODULE;
+        return szRightName + 7;
+    }
 
     // Failed
     return NULL;

Server/mods/deathmatch/logic/CAccessControlListRight.h

@@ -23,7 +23,8 @@ class CAccessControlListRight
         RIGHT_TYPE_COMMAND,
         RIGHT_TYPE_FUNCTION,
         RIGHT_TYPE_RESOURCE,
-        RIGHT_TYPE_GENERAL
+        RIGHT_TYPE_GENERAL,
+        RIGHT_TYPE_MODULE
     };
 
 public:

Server/mods/deathmatch/logic/lua/CLuaFunctionParseHelpers.cpp

@@ -239,6 +239,7 @@ ADD_ENUM(CAccessControlListRight::RIGHT_TYPE_COMMAND, "command")
 ADD_ENUM(CAccessControlListRight::RIGHT_TYPE_FUNCTION, "function")
 ADD_ENUM(CAccessControlListRight::RIGHT_TYPE_RESOURCE, "resource")
 ADD_ENUM(CAccessControlListRight::RIGHT_TYPE_GENERAL, "general")
+ADD_ENUM(CAccessControlListRight::RIGHT_TYPE_MODULE, "module")
 IMPLEMENT_ENUM_END("right-type")
 
 IMPLEMENT_ENUM_BEGIN(CElement::EElementType)

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

@@ -123,7 +123,6 @@ void CLuaMain::InitSecurity()
 
     lua_register(m_luaVM, "dofile", CLuaUtilDefs::DisabledFunction);
     lua_register(m_luaVM, "loadfile", CLuaUtilDefs::DisabledFunction);
-    lua_register(m_luaVM, "require", CLuaUtilDefs::DisabledFunction);
     lua_register(m_luaVM, "loadlib", CLuaUtilDefs::DisabledFunction);
     lua_register(m_luaVM, "getfenv", CLuaUtilDefs::DisabledFunction);
     lua_register(m_luaVM, "newproxy", CLuaUtilDefs::DisabledFunction);
@@ -187,6 +186,9 @@ void CLuaMain::InitVM()
     luaopen_utf8(m_luaVM);
     luaopen_os(m_luaVM);
 
+    // Initialize packages system
+    InitPackageStorage(m_luaVM);
+
     // Initialize security restrictions. Very important to prevent lua trojans and viruses!
     InitSecurity();
 
@@ -241,7 +243,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);
 
@@ -311,7 +313,7 @@ bool CLuaMain::LoadScriptFromBuffer(const char* cpInBuffer, unsigned int uiInSiz
                 g_pGame->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;
         }
@@ -661,3 +663,53 @@ int CLuaMain::OnUndump(const char* p, size_t n)
     }
     return 1;
 }
+
+///////////////////////////////////////////////////////////////
+//
+// CLuaMain::LoadClib
+//
+// Load a C lib of a given name
+//
+///////////////////////////////////////////////////////////////
+bool CLuaMain::LoadClib(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, ".", "/");
+
+    strPath = PathJoin(g_pServerInterface->GetModManager()->GetServerPath(), SERVER_BIN_PATH_MOD, "modules", strPath);
+
+#ifdef WIN32
+    strPath += ".dll";
+#else
+    strPath += ".so";
+#endif
+
+    if (!FileExists(strPath))
+    {
+        strError += "#3: " + ConformPath(strPath, "modules/");
+        return false;
+    }
+
+    // Check ACL permissions
+    if (!g_pGame->GetACLManager()->CanObjectUseRight(m_pResource->GetName().c_str(), CAccessControlListGroupObject::OBJECT_TYPE_RESOURCE, "*",
+                                                     CAccessControlListRight::RIGHT_TYPE_MODULE, false) &&
+        !g_pGame->GetACLManager()->CanObjectUseRight(m_pResource->GetName().c_str(), CAccessControlListGroupObject::OBJECT_TYPE_RESOURCE, strName.c_str(),
+                                                     CAccessControlListRight::RIGHT_TYPE_MODULE, false))
+    {
+        strError = "could not load module '" + strName + "' from file " + ConformPath(strPath, "modules/") + ":\n\t ACL access denied.  Grant \"module." +
+                   strName + "\" right to resource " + m_pResource->GetName();
+        return false;
+    }
+
+    if (!luaL_loader_C(L, strName.c_str(), strPath.c_str()) || lua_type(L, -1) == LUA_TNIL)
+    {
+        strError = "failed to load module '" + strName + "' from file " + ConformPath(strPath, "modules/");
+        return false;
+    }
+
+    SetPackage(L, strName);
+    return true;
+}

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

@@ -46,7 +46,7 @@ class CLuaMain            //: public CClient
 
     ~CLuaMain();
 
-    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();
 
@@ -109,6 +109,12 @@ 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, bool& bEmpty);    // Load a lua library of a given name
+    bool LoadClib(lua_State* L, SString strName, SString& strError);                    // Load a C Lib of a given name
+
 private:
     void InitSecurity();
     void InitClasses(lua_State* luaVM);
@@ -123,6 +129,7 @@ class CLuaMain            //: public CClient
 
     lua_State*        m_luaVM;
     CLuaTimerManager* m_pLuaTimerManager;
+    int               m_iPackageLoadedRef;
 
     class CResource*     m_pResource;
     class CResourceFile* m_pResourceFile;