cuberite-2a/Server/Plugins/APIDump/Classes/WebAdmin.lua

return
{
	cWebAdmin =
	{
		Desc = "",
		Functions =
		{
			AddWebTab =
			{
				IsStatic = true,
				Params =
				{
					{
						Name = "Title",
						Type = "string",
					},
					{
						Name = "UrlPath",
						Type = "string",
					},
					{
						Name = "HandlerFn",
						Type = "function",
					},
				},
				Notes = "Adds a new web tab to webadmin. The tab uses \"Title\" as its display string and is identified in the URL using the UrlPath (https://server.domain.com/webadmin/{PluginName}/{UrlPath}). The HandlerFn is the callback function that is called when the admin accesses the page, it has the following signature:<br/><pre class=\"prettyprint lang-lua\">function ({{HTTPRequest|a_Request}}, a_UrlPath)<br/>  return Content, ContentType<br/>end</pre> URLPath must not contain a '/', the recommendation is to use only 7-bit-clean ASCII character set.",
			},
			GetAllWebTabs =
			{
				IsStatic = true,
				Returns =
				{
					{
						Type = "table",
					},
				},
				Notes = "Returns an array-table with each item describing a web tab, for all web tabs registered in the WebAdmin, for all plugins. The returned table has the following format:<br/><pre class=\"prettyprint lang-lua\">{<br/>  {<br/>    PluginName = \"Plugin's API name\",<br/>    UrlPath = \"UrlPath given to AddWebTab\",<br/>    Title = \"Title given to AddWebTab\",<br/>  },<br/>  ...<br/>}",
			},
			GetBaseURL =
			{
				IsStatic = true,
				Params =
				{
					{
						Name = "URL",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "Returns the string that is the path of the base webadmin (\"../../../webadmin\") relative to the given URL.",
			},
			GetContentTypeFromFileExt =
			{
				IsStatic = true,
				Params =
				{
					{
						Name = "FileExt",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "Returns the content-type that should be used for files with the specified extension (without the dot), such as \"text/plain\" for the \"txt\" extension. If the extension is not known, returns an empty string.",
			},
			GetHTMLEscapedString =
			{
				IsStatic = true,
				Params =
				{
					{
						Name = "Input",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "Gets the HTML-escaped representation of a requested string. This is useful for user input and game data that is not guaranteed to be escaped already.",
			},
			GetPage =
			{
				IsStatic = true,
				Params =
				{
					{
						Name = "Request",
						Type = "HTTPRequest",
					},
				},
				Returns =
				{
					{
						Type = "table",
					},
				},
				Notes = "Returns the (inner HTML) page contents for the specified request. Calls the appropriate WebTab handler registered via AddWebTab() and returns the information from that plugin wrapped in a table with the following structure:<br/><pre class=\"prettyprint lang-lua\">{<br/>  Content = \"\",      -- Content returned by the plugin<br/>  ContentType = \"\",  -- Content type returned by the plugin, or \"text/html\" if none returned<br/>  UrlPath = \"\",      -- UrlPath decoded from the request<br/>  TabTitle = \"\",     -- Title of the tab that handled the request, as given to AddWebTab()<br/>  PluginName = \"\",   -- API name of the plugin that handled the request<br/>  PluginFolder = \"\", -- Folder name (= display name) of the plugin that handled the request<br/>}</pre>This function is mainly used in the webadmin template file.",
			},
			GetPorts =
			{
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "Returns a comma-separated list of ports on which the webadmin is configured to listen. Note that this list does include ports that may currently be unavailable (another server was already listening on them prior to launching Cuberite).",
			},
			GetURLEncodedString =
			{
				IsStatic = true,
				ObsoletedBy = "cUrlParser:UrlEncode",
				Params =
				{
					{
						Name = "Input",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "<b>OBSOLETE</b> - use {{cUrlParser}}:UrlEncode() instead.<br/>Returns the string given to it escaped by URL encoding, which makes the string suitable for transmission in an URL. Invalid characters are turned into \"%xy\" values.",
			},
			Reload =
			{
				Notes = "Reloads the webadmin's config - the allowed logins, the template script and the login page. Note that reloading will not change the \"enabled\" state of the server, and it will not update listening ports. Existing WebTabs will be kept registered even after the reload.",
			},
		},
	},
	HTTPFormData =
	{
		Desc = "This class stores data for one form element for a {{HTTPRequest|HTTP request}}.",
		Variables =
		{
			Name =
			{
				Type = "string",
				Notes = "Name of the form element",
			},
			Type =
			{
				Type = "string",
				Notes = "Type of the data (usually empty)",
			},
			Value =
			{
				Type = "string",
				Notes = "Value of the form element. Contains the raw data as sent by the browser.",
			},
		},
	},
	HTTPRequest =
	{
		Desc = [[
			This class encapsulates all the data that is sent to the WebAdmin through one HTTP request. Plugins
			receive this class as a parameter to the function handling the web requests, as registered in the
			{{cPluginLua}}:AddWebPage().
		]],
		Constants =
		{
			Params =
			{
				Notes = "Map-table of parameters given to the request in the URL (?param=value); if a form uses GET method, this is the same as FormData. For each parameter given as \"param=value\", there is an entry in the table with \"param\" as its key and \"value\" as its value.",
			},
			FormData =
			{
				Notes = "Array-table of {{HTTPFormData}}, contains the values of individual form elements submitted by the client",
			},
			PostParams =
			{
				Notes = "Map-table of data posted through a FORM - either a GET or POST method. Logically the same as FormData, but in a map-table format (for each parameter given as \"param=value\", there is an entry in the table with \"param\" as its key and \"value\" as its value).",
			},
		},
		Variables =
		{
			Method =
			{
				Type = "string",
				Notes = "The HTTP method used to make the request. Usually GET or POST.",
			},
			Path =
			{
				Type = "string",
				Notes = "The Path part of the URL (excluding the parameters)",
			},
			URL =
			{
				Type = "string",
				Notes = "The entire URL used for the request.",
			},
			Username =
			{
				Type = "string",
				Notes = "Name of the logged-in user.",
			},
		},
	},
	HTTPTemplateRequest =
	{
		Desc = [[
This class is used only in the WebAdmin template script as the parameter to the function that provides the template.
		]],
		Variables =
		{
			Request =
			{
				Type = "HTTPRequest",
				Notes = "The request for which the template is being built.",
			},
		},
	},
}