summaryrefslogtreecommitdiffstats
path: root/src/Bindings
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/Bindings/AllToLua.pkg1
-rw-r--r--src/Bindings/CMakeLists.txt3
-rw-r--r--src/Bindings/ManualBindings.cpp282
-rw-r--r--src/Bindings/PluginLua.cpp64
-rw-r--r--src/Bindings/PluginLua.h15
-rw-r--r--src/Bindings/PluginManager.cpp17
-rw-r--r--src/Bindings/PluginManager.h3
-rw-r--r--src/Bindings/WebPlugin.cpp152
-rw-r--r--src/Bindings/WebPlugin.h80
9 files changed, 263 insertions, 354 deletions
diff --git a/src/Bindings/AllToLua.pkg b/src/Bindings/AllToLua.pkg
index 991ed0ddd..6ca9c8658 100644
--- a/src/Bindings/AllToLua.pkg
+++ b/src/Bindings/AllToLua.pkg
@@ -38,7 +38,6 @@ $cfile "LuaFunctions.h"
$cfile "PluginManager.h"
$cfile "Plugin.h"
$cfile "PluginLua.h"
-$cfile "WebPlugin.h"
$cfile "LuaWindow.h"
$cfile "../BlockID.h"
diff --git a/src/Bindings/CMakeLists.txt b/src/Bindings/CMakeLists.txt
index 10cda1efb..4f25f2cf4 100644
--- a/src/Bindings/CMakeLists.txt
+++ b/src/Bindings/CMakeLists.txt
@@ -23,7 +23,6 @@ SET (SRCS
Plugin.cpp
PluginLua.cpp
PluginManager.cpp
- WebPlugin.cpp
)
SET (HDRS
@@ -44,7 +43,6 @@ SET (HDRS
Plugin.h
PluginLua.h
PluginManager.h
- WebPlugin.h
tolua++.h
)
@@ -66,7 +64,6 @@ set(BINDING_DEPENDENCIES
../Bindings/Plugin.h
../Bindings/PluginLua.h
../Bindings/PluginManager.h
- ../Bindings/WebPlugin.h
../BiomeDef.h
../BlockArea.h
../BlockEntities/BeaconEntity.h
diff --git a/src/Bindings/ManualBindings.cpp b/src/Bindings/ManualBindings.cpp
index 9945929d0..bd781f766 100644
--- a/src/Bindings/ManualBindings.cpp
+++ b/src/Bindings/ManualBindings.cpp
@@ -1702,47 +1702,71 @@ static int tolua_SetObjectCallback(lua_State * tolua_S)
-static int tolua_cPluginLua_AddWebTab(lua_State * tolua_S)
+// Callback class used for the WebTab:
+class cWebTabCallback:
+ public cWebAdmin::cWebTabCallback
{
- cLuaState LuaState(tolua_S);
- cPluginLua * self = nullptr;
+public:
+ /** The Lua callback to call to generate the page contents. */
+ cLuaState::cCallback m_Callback;
- if (!LuaState.GetStackValue(1, self))
+ virtual bool Call(
+ const HTTPRequest & a_Request,
+ const AString & a_UrlPath,
+ AString & a_Content,
+ AString & a_ContentType
+ ) override
{
- LOGWARNING("cPluginLua:AddWebTab: invalid self as first argument");
- return 0;
+ AString content, contentType;
+ return m_Callback.Call(&a_Request, a_UrlPath, cLuaState::Return, a_Content, a_ContentType);
}
+};
- tolua_Error tolua_err;
- tolua_err.array = 0;
- tolua_err.index = 3;
- tolua_err.type = "function";
- std::string Title;
- int Reference = LUA_REFNIL;
- if (LuaState.CheckParamString(2) && LuaState.CheckParamFunction(3))
+
+
+static int tolua_cPluginLua_AddWebTab(lua_State * tolua_S)
+{
+ // OBSOLETE, use cWebAdmin:AddWebTab() instead!
+ // Function signature:
+ // cPluginLua:AddWebTab(Title, CallbackFn, [UrlPath])
+
+ // TODO: Warn about obsolete API usage
+ // Only implement after merging the new API change and letting some time for changes in the plugins
+
+ // Check params:
+ cLuaState LuaState(tolua_S);
+ cPluginLua * self = cManualBindings::GetLuaPlugin(tolua_S);
+ if (self == nullptr)
{
- Reference = luaL_ref(tolua_S, LUA_REGISTRYINDEX);
- LuaState.GetStackValue(2, Title);
+ return 0;
}
- else
+ if (
+ !LuaState.CheckParamString(2) ||
+ !LuaState.CheckParamFunction(3) ||
+ // Optional string as param 4
+ !LuaState.CheckParamEnd(5)
+ )
{
- return cManualBindings::tolua_do_error(tolua_S, "#ferror calling function '#funcname#'", &tolua_err);
+ return 0;
}
- if (Reference != LUA_REFNIL)
+ // Read the params:
+ AString title, urlPath;
+ auto callback = std::make_shared<cWebTabCallback>();
+ if (!LuaState.GetStackValues(2, title, callback->m_Callback))
{
- if (!self->AddWebTab(Title.c_str(), tolua_S, Reference))
- {
- luaL_unref(tolua_S, LUA_REGISTRYINDEX, Reference);
- }
+ LOGWARNING("cPlugin:AddWebTab(): Cannot read required parameters");
+ return 0;
}
- else
+ if (!LuaState.GetStackValue(4, urlPath))
{
- LOGWARNING("cPluginLua:AddWebTab: invalid function reference in 2nd argument (Title: \"%s\")", Title.c_str());
+ urlPath = cWebAdmin::GetURLEncodedString(title);
}
+ cRoot::Get()->GetWebAdmin()->AddWebTab(title, urlPath, self->GetName(), callback);
+
return 0;
}
@@ -2107,22 +2131,68 @@ static int tolua_cUrlParser_ParseAuthorityPart(lua_State * a_LuaState)
-static int tolua_cWebAdmin_GetPlugins(lua_State * tolua_S)
+static int tolua_cWebAdmin_AddWebTab(lua_State * tolua_S)
+{
+ // Function signatures:
+ // cWebAdmin:AddWebTab(Title, UrlPath, CallbackFn)
+
+ // Check params:
+ cLuaState LuaState(tolua_S);
+ cPluginLua * self = cManualBindings::GetLuaPlugin(tolua_S);
+ if (self == nullptr)
+ {
+ return 0;
+ }
+ if (
+ // Don't care whether the first param is a cWebAdmin instance or class
+ !LuaState.CheckParamString(2, 3) ||
+ !LuaState.CheckParamFunction(4) ||
+ !LuaState.CheckParamEnd(5)
+ )
+ {
+ return 0;
+ }
+
+ // Read the params:
+ AString title, urlPath;
+ auto callback = std::make_shared<cWebTabCallback>();
+ if (!LuaState.GetStackValues(2, title, urlPath, callback->m_Callback))
+ {
+ LOGWARNING("cWebAdmin:AddWebTab(): Cannot read required parameters");
+ return 0;
+ }
+
+ cRoot::Get()->GetWebAdmin()->AddWebTab(title, urlPath, self->GetName(), callback);
+
+ return 0;
+}
+
+
+
+
+
+static int tolua_cWebAdmin_GetAllWebTabs(lua_State * tolua_S)
{
- cWebAdmin * self = reinterpret_cast<cWebAdmin *>(tolua_tousertype(tolua_S, 1, nullptr));
+ // Function signature:
+ // cWebAdmin:GetAllWebTabs() -> { {"PluginName", "UrlPath", "Title"}, {"PluginName", "UrlPath", "Title"}, ...}
- const cWebAdmin::PluginList & AllPlugins = self->GetPlugins();
+ // Don't care about params at all
- lua_createtable(tolua_S, static_cast<int>(AllPlugins.size()), 0);
+ auto webTabs = cRoot::Get()->GetWebAdmin()->GetAllWebTabs();
+ lua_createtable(tolua_S, static_cast<int>(webTabs.size()), 0);
int newTable = lua_gettop(tolua_S);
int index = 1;
- cWebAdmin::PluginList::const_iterator iter = AllPlugins.begin();
- while (iter != AllPlugins.end())
- {
- const cWebPlugin * Plugin = *iter;
- tolua_pushusertype(tolua_S, reinterpret_cast<void *>(const_cast<cWebPlugin*>(Plugin)), "const cWebPlugin");
+ cLuaState L(tolua_S);
+ for (const auto & wt: webTabs)
+ {
+ lua_createtable(tolua_S, 0, 3);
+ L.Push(wt->m_PluginName);
+ lua_setfield(tolua_S, -2, "PluginName");
+ L.Push(wt->m_UrlPath);
+ lua_setfield(tolua_S, -2, "UrlPath");
+ L.Push(wt->m_Title);
+ lua_setfield(tolua_S, -2, "Title");
lua_rawseti(tolua_S, newTable, index);
- ++iter;
++index;
}
return 1;
@@ -2132,14 +2202,14 @@ static int tolua_cWebAdmin_GetPlugins(lua_State * tolua_S)
-/** Binding for cWebAdmin::GetHTMLEscapedString.
+/** Binding for cWebAdmin::GetBaseURL.
Manual code required because ToLua generates an extra return value */
-static int tolua_AllToLua_cWebAdmin_GetHTMLEscapedString(lua_State * tolua_S)
+static int tolua_cWebAdmin_GetBaseURL(lua_State * tolua_S)
{
// Check the param types:
cLuaState S(tolua_S);
if (
- !S.CheckParamUserTable(1, "cWebAdmin") ||
+ // Don't care whether the first param is a cWebAdmin instance or class
!S.CheckParamString(2) ||
!S.CheckParamEnd(3)
)
@@ -2152,7 +2222,7 @@ static int tolua_AllToLua_cWebAdmin_GetHTMLEscapedString(lua_State * tolua_S)
S.GetStackValue(2, Input);
// Convert and return:
- S.Push(cWebAdmin::GetHTMLEscapedString(Input));
+ S.Push(cWebAdmin::GetBaseURL(Input));
return 1;
}
@@ -2160,14 +2230,14 @@ static int tolua_AllToLua_cWebAdmin_GetHTMLEscapedString(lua_State * tolua_S)
-/** Binding for cWebAdmin::GetURLEncodedString.
+/** Binding for cWebAdmin::GetContentTypeFromFileExt.
Manual code required because ToLua generates an extra return value */
-static int tolua_AllToLua_cWebAdmin_GetURLEncodedString(lua_State * tolua_S)
+static int tolua_cWebAdmin_GetContentTypeFromFileExt(lua_State * tolua_S)
{
// Check the param types:
cLuaState S(tolua_S);
if (
- !S.CheckParamUserTable(1, "cWebAdmin") ||
+ // Don't care whether the first param is a cWebAdmin instance or class
!S.CheckParamString(2) ||
!S.CheckParamEnd(3)
)
@@ -2180,7 +2250,7 @@ static int tolua_AllToLua_cWebAdmin_GetURLEncodedString(lua_State * tolua_S)
S.GetStackValue(2, Input);
// Convert and return:
- S.Push(cWebAdmin::GetURLEncodedString(Input));
+ S.Push(cWebAdmin::GetContentTypeFromFileExt(Input));
return 1;
}
@@ -2188,20 +2258,112 @@ static int tolua_AllToLua_cWebAdmin_GetURLEncodedString(lua_State * tolua_S)
-static int tolua_cWebPlugin_GetTabNames(lua_State * tolua_S)
+/** Binding for cWebAdmin::GetHTMLEscapedString.
+Manual code required because ToLua generates an extra return value */
+static int tolua_cWebAdmin_GetHTMLEscapedString(lua_State * tolua_S)
{
- // Returns a map of (SafeTitle -> Title) for the plugin's web tabs.
- auto self = reinterpret_cast<cWebPlugin *>(tolua_tousertype(tolua_S, 1, nullptr));
- auto TabNames = self->GetTabNames();
- lua_newtable(tolua_S);
- int index = 1;
- for (auto itr = TabNames.cbegin(), end = TabNames.cend(); itr != end; ++itr)
+ // Check the param types:
+ cLuaState S(tolua_S);
+ if (
+ // Don't care whether the first param is a cWebAdmin instance or class
+ !S.CheckParamString(2) ||
+ !S.CheckParamEnd(3)
+ )
{
- tolua_pushstring(tolua_S, itr->second.c_str()); // Because the SafeTitle is supposed to be unique, use it as key
- tolua_pushstring(tolua_S, itr->first.c_str());
- lua_rawset(tolua_S, -3);
- ++index;
+ return 0;
}
+
+ // Get the parameters:
+ AString Input;
+ S.GetStackValue(2, Input);
+
+ // Convert and return:
+ S.Push(cWebAdmin::GetHTMLEscapedString(Input));
+ return 1;
+}
+
+
+
+
+
+/** Binding for cWebAdmin::GetPage. */
+static int tolua_cWebAdmin_GetPage(lua_State * tolua_S)
+{
+ /*
+ Function signature:
+ cWebAdmin:GetPage(a_HTTPRequest) ->
+ {
+ Content = "", // Content generated by the plugin
+ ContentType = "", // Content type generated by the plugin (default: "text/html")
+ UrlPath = "", // URL path of the tab
+ TabTitle = "", // Tab's title, as register via cWebAdmin:AddWebTab()
+ PluginName = "", // Plugin's API name
+ PluginFolder = "", // Plugin's folder name (display name)
+ }
+ */
+
+ // Check the param types:
+ cLuaState S(tolua_S);
+ if (
+ // Don't care about first param, whether it's cWebAdmin instance or class
+ !S.CheckParamUserType(2, "HTTPRequest") ||
+ !S.CheckParamEnd(3)
+ )
+ {
+ return 0;
+ }
+
+ // Get the parameters:
+ HTTPRequest * request = nullptr;
+ if (!S.GetStackValue(2, request))
+ {
+ LOGWARNING("cWebAdmin:GetPage(): Cannot read the HTTPRequest parameter.");
+ return 0;
+ }
+
+ // Generate the page and push the results as a dictionary-table:
+ auto page = cRoot::Get()->GetWebAdmin()->GetPage(*request);
+ lua_createtable(S, 0, 6);
+ S.Push(page.Content);
+ lua_setfield(S, -2, "Content");
+ S.Push(page.ContentType);
+ lua_setfield(S, -2, "ContentType");
+ S.Push(page.TabUrlPath);
+ lua_setfield(S, -2, "UrlPath");
+ S.Push(page.TabTitle);
+ lua_setfield(S, -2, "TabTitle");
+ S.Push(page.PluginName);
+ lua_setfield(S, -2, "PluginName");
+ S.Push(cPluginManager::Get()->GetPluginFolderName(page.PluginName));
+ lua_setfield(S, -2, "PluginFolder");
+ return 1;
+}
+
+
+
+
+
+/** Binding for cWebAdmin::GetURLEncodedString.
+Manual code required because ToLua generates an extra return value */
+static int tolua_cWebAdmin_GetURLEncodedString(lua_State * tolua_S)
+{
+ // Check the param types:
+ cLuaState S(tolua_S);
+ if (
+ // Don't care whether the first param is a cWebAdmin instance or class
+ !S.CheckParamString(2) ||
+ !S.CheckParamEnd(3)
+ )
+ {
+ return 0;
+ }
+
+ // Get the parameters:
+ AString Input;
+ S.GetStackValue(2, Input);
+
+ // Convert and return:
+ S.Push(cWebAdmin::GetURLEncodedString(Input));
return 1;
}
@@ -3655,13 +3817,13 @@ void cManualBindings::Bind(lua_State * tolua_S)
tolua_endmodule(tolua_S);
tolua_beginmodule(tolua_S, "cWebAdmin");
- tolua_function(tolua_S, "GetHTMLEscapedString", tolua_AllToLua_cWebAdmin_GetHTMLEscapedString);
- tolua_function(tolua_S, "GetPlugins", tolua_cWebAdmin_GetPlugins);
- tolua_function(tolua_S, "GetURLEncodedString", tolua_AllToLua_cWebAdmin_GetURLEncodedString);
- tolua_endmodule(tolua_S);
-
- tolua_beginmodule(tolua_S, "cWebPlugin");
- tolua_function(tolua_S, "GetTabNames", tolua_cWebPlugin_GetTabNames);
+ tolua_function(tolua_S, "AddWebTab", tolua_cWebAdmin_AddWebTab);
+ tolua_function(tolua_S, "GetAllWebTabs", tolua_cWebAdmin_GetAllWebTabs);
+ tolua_function(tolua_S, "GetBaseURL", tolua_cWebAdmin_GetBaseURL);
+ tolua_function(tolua_S, "GetContentTypeFromFileExt", tolua_cWebAdmin_GetContentTypeFromFileExt);
+ tolua_function(tolua_S, "GetHTMLEscapedString", tolua_cWebAdmin_GetHTMLEscapedString);
+ tolua_function(tolua_S, "GetPage", tolua_cWebAdmin_GetPage);
+ tolua_function(tolua_S, "GetURLEncodedString", tolua_cWebAdmin_GetURLEncodedString);
tolua_endmodule(tolua_S);
tolua_beginmodule(tolua_S, "HTTPRequest");
diff --git a/src/Bindings/PluginLua.cpp b/src/Bindings/PluginLua.cpp
index a266e6223..9b2d48b33 100644
--- a/src/Bindings/PluginLua.cpp
+++ b/src/Bindings/PluginLua.cpp
@@ -15,6 +15,8 @@
#include "../CommandOutput.h"
#include "PluginManager.h"
#include "../Item.h"
+#include "../Root.h"
+#include "../WebAdmin.h"
extern "C"
{
@@ -66,7 +68,7 @@ void cPluginLua::Close(void)
// Remove the command bindings and web tabs:
ClearCommands();
ClearConsoleCommands();
- ClearTabs();
+ ClearWebTabs();
// Notify and remove all m_Resettables (unlock the m_CriticalSection while resetting them):
cResettablePtrs resettables;
@@ -205,7 +207,7 @@ bool cPluginLua::Load(void)
void cPluginLua::Unload(void)
{
- ClearTabs();
+ ClearWebTabs();
super::Unload();
Close();
}
@@ -2126,51 +2128,6 @@ void cPluginLua::AddResettable(cPluginLua::cResettablePtr a_Resettable)
-AString cPluginLua::HandleWebRequest(const HTTPRequest & a_Request)
-{
- // Find the tab to use for the request:
- auto TabName = GetTabNameForRequest(a_Request);
- AString SafeTabTitle = TabName.second;
- if (SafeTabTitle.empty())
- {
- return "";
- }
- auto Tab = GetTabBySafeTitle(SafeTabTitle);
- if (Tab == nullptr)
- {
- return "";
- }
-
- // Get the page content from the plugin:
- cCSLock Lock(m_CriticalSection);
- AString Contents = Printf("WARNING: WebPlugin tab '%s' did not return a string!", Tab->m_Title.c_str());
- if (!m_LuaState.Call(Tab->m_UserData, &a_Request, cLuaState::Return, Contents))
- {
- return "Lua encountered error while processing the page request";
- }
- return Contents;
-}
-
-
-
-
-
-bool cPluginLua::AddWebTab(const AString & a_Title, lua_State * a_LuaState, int a_FunctionReference)
-{
- cCSLock Lock(m_CriticalSection);
- if (a_LuaState != m_LuaState)
- {
- LOGERROR("Only allowed to add a tab to a WebPlugin of your own Plugin!");
- return false;
- }
- AddNewWebTab(a_Title, a_FunctionReference);
- return true;
-}
-
-
-
-
-
void cPluginLua::BindCommand(const AString & a_Command, int a_FnRef)
{
ASSERT(m_Commands.find(a_Command) == m_Commands.end());
@@ -2227,6 +2184,19 @@ void cPluginLua::CallbackWindowSlotChanged(int a_FnRef, cWindow & a_Window, int
+void cPluginLua::ClearWebTabs(void)
+{
+ auto webAdmin = cRoot::Get()->GetWebAdmin();
+ if (webAdmin != nullptr) // can be nullptr when shutting down the server
+ {
+ webAdmin->RemoveAllPluginWebTabs(m_Name);
+ }
+}
+
+
+
+
+
////////////////////////////////////////////////////////////////////////////////
// cPluginLua::cResettable:
diff --git a/src/Bindings/PluginLua.h b/src/Bindings/PluginLua.h
index db6612671..dac782a43 100644
--- a/src/Bindings/PluginLua.h
+++ b/src/Bindings/PluginLua.h
@@ -10,7 +10,6 @@
#pragma once
#include "Plugin.h"
-#include "WebPlugin.h"
#include "LuaState.h"
// Names for the global variables through which the plugin is identified in its LuaState
@@ -29,8 +28,7 @@ class cWindow;
// tolua_begin
class cPluginLua :
- public cPlugin,
- public cWebPlugin
+ public cPlugin
{
typedef cPlugin super;
@@ -181,14 +179,6 @@ public:
/** Returns true if the plugin contains the function for the specified hook type, using the old-style registration (#121) */
bool CanAddOldStyleHook(int a_HookType);
- // cWebPlugin overrides
- virtual const AString GetWebTitle(void) const override {return GetName(); }
- virtual AString HandleWebRequest(const HTTPRequest & a_Request) override;
-
- /** Adds a new web tab to webadmin.
- Displaying the tab calls the referenced function. */
- bool AddWebTab(const AString & a_Title, lua_State * a_LuaState, int a_FunctionReference); // Exported in ManualBindings.cpp
-
/** Binds the command to call the function specified by a Lua function reference. Simply adds to CommandMap. */
void BindCommand(const AString & a_Command, int a_FnRef);
@@ -270,6 +260,9 @@ protected:
/** Releases all Lua references, notifies and removes all m_Resettables[] and closes the m_LuaState. */
void Close(void);
+
+ /** Removes all WebTabs currently registered for this plugin from the WebAdmin. */
+ void ClearWebTabs(void);
} ; // tolua_export
diff --git a/src/Bindings/PluginManager.cpp b/src/Bindings/PluginManager.cpp
index 5b3ef7803..203450505 100644
--- a/src/Bindings/PluginManager.cpp
+++ b/src/Bindings/PluginManager.cpp
@@ -1965,6 +1965,23 @@ bool cPluginManager::ForEachPlugin(cPluginCallback & a_Callback)
+AString cPluginManager::GetPluginFolderName(const AString & a_PluginName)
+{
+ // TODO: Implement locking for plugins
+ for (auto & plugin: m_Plugins)
+ {
+ if (plugin->GetName() == a_PluginName)
+ {
+ return plugin->GetFolderName();
+ }
+ }
+ return AString();
+}
+
+
+
+
+
void cPluginManager::AddHook(cPlugin * a_Plugin, int a_Hook)
{
if (a_Plugin == nullptr)
diff --git a/src/Bindings/PluginManager.h b/src/Bindings/PluginManager.h
index f3f0b6d0b..a97582fbe 100644
--- a/src/Bindings/PluginManager.h
+++ b/src/Bindings/PluginManager.h
@@ -332,6 +332,9 @@ public:
Returns true if all plugins have been reported, false if the callback has aborted the enumeration by returning true. */
bool ForEachPlugin(cPluginCallback & a_Callback);
+ /** Returns the name of the folder (cPlugin::GetFolderName()) from which the specified plugin was loaded. */
+ AString GetPluginFolderName(const AString & a_PluginName); // tolua_export
+
/** Returns the path where individual plugins' folders are expected.
The path doesn't end in a slash. */
static AString GetPluginsPath(void) { return FILE_IO_PREFIX + AString("Plugins"); } // tolua_export
diff --git a/src/Bindings/WebPlugin.cpp b/src/Bindings/WebPlugin.cpp
deleted file mode 100644
index 1eca7de93..000000000
--- a/src/Bindings/WebPlugin.cpp
+++ /dev/null
@@ -1,152 +0,0 @@
-
-#include "Globals.h" // NOTE: MSVC stupidness requires this to be the same across all modules
-
-#include "WebPlugin.h"
-#include "../WebAdmin.h"
-#include "../Root.h"
-
-
-
-
-
-cWebPlugin::cWebPlugin()
-{
- cWebAdmin * WebAdmin = cRoot::Get()->GetWebAdmin();
- if (WebAdmin != nullptr)
- {
- WebAdmin->AddPlugin(this);
- }
-}
-
-
-
-
-
-cWebPlugin::~cWebPlugin()
-{
- ASSERT(m_Tabs.empty()); // Has ClearTabs() been called?
-
- // Remove from WebAdmin:
- cWebAdmin * WebAdmin = cRoot::Get()->GetWebAdmin();
- if (WebAdmin != nullptr)
- {
- WebAdmin->RemovePlugin(this);
- }
-}
-
-
-
-
-
-cWebPlugin::cTabNames cWebPlugin::GetTabNames(void) const
-{
- std::list< std::pair<AString, AString>> NameList;
- for (auto itr = m_Tabs.cbegin(), end = m_Tabs.cend(); itr != end; ++itr)
- {
- NameList.push_back(std::make_pair((*itr)->m_Title, (*itr)->m_SafeTitle));
- }
- return NameList;
-}
-
-
-
-
-
-cWebPlugin::cTabPtr cWebPlugin::GetTabBySafeTitle(const AString & a_SafeTitle) const
-{
- cCSLock Lock(m_CSTabs);
- for (auto itr = m_Tabs.cbegin(), end = m_Tabs.cend(); itr != end; ++itr)
- {
- if ((*itr)->m_SafeTitle == a_SafeTitle)
- {
- return *itr;
- }
- }
- return nullptr;
-}
-
-
-
-
-
-std::pair<AString, AString> cWebPlugin::GetTabNameForRequest(const HTTPRequest & a_Request)
-{
- AStringVector Split = StringSplit(a_Request.Path, "/");
- if (Split.empty())
- {
- return std::make_pair(AString(), AString());
- }
-
- cCSLock Lock(m_CSTabs);
- cTabPtr Tab;
- if (Split.size() > 2) // If we got the tab name, show that page
- {
- for (auto itr = m_Tabs.cbegin(), end = m_Tabs.cend(); itr != end; ++itr)
- {
- if ((*itr)->m_SafeTitle.compare(Split[2]) == 0) // This is the one!
- {
- return std::make_pair((*itr)->m_Title, (*itr)->m_SafeTitle);
- }
- }
- // Tab name not found, display an "empty" page:
- return std::make_pair(AString(), AString());
- }
-
- // Show the first tab:
- if (!m_Tabs.empty())
- {
- return std::make_pair(m_Tabs.front()->m_SafeTitle, m_Tabs.front()->m_SafeTitle);
- }
-
- // No tabs at all:
- return std::make_pair(AString(), AString());
-}
-
-
-
-
-AString cWebPlugin::SafeString(const AString & a_String)
-{
- AString RetVal;
- auto len = a_String.size();
- RetVal.reserve(len);
- for (size_t i = 0; i < len; ++i)
- {
- char c = a_String[i];
- if (c == ' ')
- {
- c = '_';
- }
- RetVal.push_back(c);
- }
- return RetVal;
-}
-
-
-
-
-
-void cWebPlugin::AddNewWebTab(const AString & a_Title, int a_UserData)
-{
- auto Tab = std::make_shared<cTab>(a_Title, a_UserData);
- cCSLock Lock(m_CSTabs);
- m_Tabs.push_back(Tab);
-}
-
-
-
-
-
-void cWebPlugin::ClearTabs(void)
-{
- // Remove the webadmin tabs:
- cTabPtrs Tabs;
- {
- cCSLock Lock(m_CSTabs);
- std::swap(Tabs, m_Tabs);
- }
-}
-
-
-
-
diff --git a/src/Bindings/WebPlugin.h b/src/Bindings/WebPlugin.h
deleted file mode 100644
index 6dc8db801..000000000
--- a/src/Bindings/WebPlugin.h
+++ /dev/null
@@ -1,80 +0,0 @@
-
-#pragma once
-
-struct HTTPRequest;
-
-
-
-
-
-// tolua_begin
-class cWebPlugin
-{
-public:
- // tolua_end
-
- struct cTab
- {
- AString m_Title;
- AString m_SafeTitle;
- int m_UserData;
-
- cTab(const AString & a_Title, int a_UserData):
- m_Title(a_Title),
- m_SafeTitle(cWebPlugin::SafeString(a_Title)),
- m_UserData(a_UserData)
- {
- }
- };
-
- typedef SharedPtr<cTab> cTabPtr;
- typedef std::list<cTabPtr> cTabPtrs;
- typedef std::list<std::pair<AString, AString>> cTabNames;
-
-
- cWebPlugin();
-
- virtual ~cWebPlugin();
-
- // tolua_begin
-
- /** Returns the title of the plugin, as it should be presented in the webadmin's pages tree. */
- virtual const AString GetWebTitle(void) const = 0;
-
- /** Sanitizes the input string, replacing spaces with underscores. */
- static AString SafeString(const AString & a_String);
-
- // tolua_end
-
- virtual AString HandleWebRequest(const HTTPRequest & a_Request) = 0;
-
- /** Adds a new web tab with the specified contents. */
- void AddNewWebTab(const AString & a_Title, int a_UserData);
-
- /** Removes all the tabs. */
- void ClearTabs(void);
-
- /** Returns all the tabs that this plugin has registered. */
- const cTabPtrs & GetTabs(void) const { return m_Tabs; }
-
- /** Returns all of the tabs that this plugin has registered. */
- cTabNames GetTabNames(void) const; // Exported in ManualBindings.cpp
-
- /** Returns the tab that has the specified SafeTitle.
- Returns nullptr if no such tab. */
- cTabPtr GetTabBySafeTitle(const AString & a_SafeTitle) const;
-
- std::pair<AString, AString> GetTabNameForRequest(const HTTPRequest & a_Request);
-
-private:
- /** All tabs that this plugin has registered.
- Protected against multithreaded access by m_CSTabs. */
- cTabPtrs m_Tabs;
-
- /** Protects m_Tabs against multithreaded access. */
- mutable cCriticalSection m_CSTabs;
-}; // tolua_export
-
-
-
-
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-14 08:41:55 +0100