1 files changed, 106 insertions, 3 deletions

diff --git a/src/modules/upnp/libkviupnp.cpp b/src/modules/upnp/libkviupnp.cpp
index f75bbfb33..8faabb44c 100644
--- a/src/modules/upnp/libkviupnp.cpp
+++ b/src/modules/upnp/libkviupnp.cpp
@@ -25,6 +25,7 @@
 #include "kvi_settings.h"
 #include "kvi_module.h"
 #include "kvi_string.h"
+#include "kvi_netutils.h"
 
 #include "manager.h"
 
@@ -32,7 +33,24 @@
 // Let's be so:)
 UPnP::Manager* g_pManager = 0;
 
-
+/*
+	@doc: upnp.getExternalIpAddress
+	@type:
+		function
+	@title:
+		$upnp.getExternalIpAddress
+	@short:
+		Return the external ip address using UPnP
+	@syntax:
+		<string> $upnp.getExternalIpAddress()
+	@description:
+		During the loading of the UPnP module, KVIrc searches the gateway of your local network. If a gateway is found, KVIrc requests it the external Ip address associated to the router and caches it.[br]
+		Using this function you can get this cached value.[br]
+		Take care that if no gateway have been found or it returned no external Ip address (this can happens if its upstream  (wan) link is not connected), this function returns an empty string.[br]
+		It's better to check is a gateway has been found using [fnc]$upnp.isGatewayAvailable[/fnc] before using this function.
+	@seealso:
+		[fnc]$upnp.isGatewayAvailable[/fnc]
+*/
 static bool upnp_kvs_fnc_getExternalIpAddress(KviKvsModuleFunctionCall * c)
 {
 	if(g_pManager)
@@ -42,6 +60,21 @@ static bool upnp_kvs_fnc_getExternalIpAddress(KviKvsModuleFunctionCall * c)
 	return true;
 }
 
+
+/*
+	@doc: upnp.isGatewayAvailable
+	@type:
+		function
+	@title:
+		$upnp.isGatewayAvailable
+	@short:
+		Returns if a UPnP-capable gateway has been found on the local network
+	@syntax:
+		<bool> $upnp.isGatewayAvailable()
+	@description:
+		Returns if a UPnP-capable gateway has been found on the local network.[br]
+		If this function returns false (0), no other command or function from the upnp module will work.
+*/
 static bool upnp_kvs_fnc_isGatewayAvailable(KviKvsModuleFunctionCall * c)
 {
         if (g_pManager)
@@ -51,8 +84,77 @@ static bool upnp_kvs_fnc_isGatewayAvailable(KviKvsModuleFunctionCall * c)
 	return true;
 }
 
-static bool upnp_kvs_cmd_test(KviKvsModuleCommandCall * c)
+/*
+	@doc: upnp.addPortMapping
+	@type:
+		command
+	@title:
+		upnp.addPortMapping
+	@short:
+		Add a port mapping to gateway using UPnP
+	@syntax:
+		upnp.addPortMapping [-a=<fake address>] <port>
+	@switches:
+		!sw: -a=<fake address> | --fake-address=<fake address>
+		Send the <fake address> as target for the port mapping
+		If this switch is not given, the request will contain the real IP address of the listening
+		interface.[br]
+	@description:
+		Makes a request to the gateway of the local network using UPnP; the request asks the gateway to add an entry in its port mapping table.[br]
+		If the gateway accepts the request, it will forward packets received on <port> on its external (wan) ip address to the host KVIrc is running at, on the same <port>.
+		Depending on vendors, this is called with different names: Port forwarding, SUA, Virtual Server, PAT, ...
+		It's better to check is a gateway has been found using [fnc]$upnp.isGatewayAvailable[/fnc] before using this function.
+	@seealso:
+		[fnc]$upnp.isGatewayAvailable[/fnc], [cmd]upnp.delPortMapping[/cmd]
+*/
+static bool upnp_kvs_cmd_addPortMapping(KviKvsModuleCommandCall * c)
 {
+	int iPort;
+	QString szLocalIp;
+	KviKvsVariant * pSw;
+
+	KVSM_PARAMETERS_BEGIN(c)
+		KVSM_PARAMETER("port",KVS_PT_INT,0,iPort)
+	KVSM_PARAMETERS_END(c)
+
+	if(pSw = c->switches()->find('a',"fake-address"))
+	{
+		pSw->asString(szLocalIp);
+	} else {
+		kvi_getLocalHostAddress(szLocalIp);
+	}
+
+	g_pManager->addPortMapping("TCP", "", iPort, szLocalIp, iPort, "KVIrc UPnP module", true, 0);
+	return true;
+}
+
+/*
+	@doc: upnp.delPortMapping
+	@type:
+		command
+	@title:
+		upnp.delPortMapping
+	@short:
+		Delete a port mapping on the gateway using UPnP
+	@syntax:
+		upnp.delPortMapping <port>
+	@description:
+		Makes a request to the gateway of the local network using UPnP; the request asks the gateway to delete an entry in its port mapping table.[br]
+		If the gateway accepts the request, it will stop forward packets received on <port>.
+		It's better to check is a gateway has been found using [fnc]$upnp.isGatewayAvailable[/fnc] before using this function.[br]
+		Of course, such a port mapping have to be added using [cmd]upnp.addPortMapping[/cmd] before it can be deleted.
+	@seealso:
+		[fnc]$upnp.isGatewayAvailable[/fnc], [cmd]upnp.addPortMapping[/cmd]
+*/
+static bool upnp_kvs_cmd_delPortMapping(KviKvsModuleCommandCall * c)
+{
+	int iPort;
+
+	KVSM_PARAMETERS_BEGIN(c)
+		KVSM_PARAMETER("port",KVS_PT_INT,0,iPort)
+	KVSM_PARAMETERS_END(c)
+
+	g_pManager->deletePortMapping("TCP", "", iPort);
 	return true;
 }
 
@@ -63,7 +165,8 @@ static bool upnp_module_init(KviModule * m)
 
 	KVSM_REGISTER_FUNCTION(m,"isGatewayAvailable",upnp_kvs_fnc_isGatewayAvailable);
 	KVSM_REGISTER_FUNCTION(m,"getExternalIpAddress",upnp_kvs_fnc_getExternalIpAddress);
-	KVSM_REGISTER_SIMPLE_COMMAND(m,"test",upnp_kvs_cmd_test);
+	KVSM_REGISTER_SIMPLE_COMMAND(m,"addPortMapping",upnp_kvs_cmd_addPortMapping);
+	KVSM_REGISTER_SIMPLE_COMMAND(m,"delPortMapping",upnp_kvs_cmd_delPortMapping);
 
 	return true;
 }