aboutsummaryrefslogtreecommitdiffstats
//=============================================================================
//
//   File : WanConnectionService.cpp
//   Creation date : Fri Aug 08 18:00:00 2008 GMT by Fabio Bas
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2008 Fabio Bas (ctrlaltca at gmail dot com)
//
//   This program is FREE software. You can redistribute it and/or
//   modify it under the terms of the GNU General Public License
//   as published by the Free Software Foundation; either version 2
//   of the License, or (at your option) any later version.
//
//   This program is distributed in the HOPE that it will be USEFUL,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU General Public License for more details.
//
//   You should have received a copy of the GNU General Public License
//   along with this program. If not, write to the Free Software Foundation,
//   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//   Original Copyright follows:
//=============================================================================

/***************************************************************************
                          WanConnectionService.cpp -  description
                             -------------------
    begin                : Mon Jul 25 2005
    copyright            : (C) 2005 by Diederik van der Boor
    email                : vdboor --at-- codingdomain.com
 ***************************************************************************/

#include "WanConnectionService.h"
#include <QDebug>

namespace UPnP
{

	// The constructor
	WanConnectionService::WanConnectionService(const ServiceParameters & params)
	    : Service(params), m_bNatEnabled(false)
	{
	}

	// The destructor
	WanConnectionService::~WanConnectionService()
	    = default;

	// Add a port mapping
	void WanConnectionService::addPortMapping(const QString & protocol, const QString & remoteHost, int externalPort,
	    const QString & internalClient, int internalPort, const QString & description,
	    bool enabled, int leaseDuration)
	{
		QMap<QString, QString> arguments;
		arguments["NewProtocol"] = protocol;
		arguments["NewRemoteHost"] = remoteHost;
		arguments["NewExternalPort"] = QString::number(externalPort);
		arguments["NewInternalClient"] = internalClient;
		arguments["NewInternalPort"] = QString::number(internalPort);
		arguments["NewPortMappingDescription"] = description;
		arguments["NewEnabled"] = QString::number(enabled ? 1 : 0);
		arguments["NewLeaseDuration"] = QString::number(leaseDuration);
		callAction("AddPortMapping", arguments, "m");
	}

	// Delete a port mapping
	void WanConnectionService::deletePortMapping(const QString & protocol, const QString & remoteHost, int externalPort)
	{
		QMap<QString, QString> arguments;
		arguments["NewProtocol"] = protocol;
		arguments["NewRemoteHost"] = remoteHost;
		arguments["NewExternalPort"] = QString::number(externalPort);
		callAction("DeletePortMapping", arguments, "m");
	}

	// Return the external IP address
	QString WanConnectionService::getExternalIpAddress() const
	{
		return m_szExternalIpAddress;
	}

	// Return true if NAT is enabled
	bool WanConnectionService::getNatEnabled() const
	{
		return m_bNatEnabled;
	}

	// Return the port mappings
	const KviPointerList<PortMapping> & WanConnectionService::getPortMappings() const
	{
		return m_lPortMappings;
	}

	// The control point received a response to callAction()
	void WanConnectionService::gotActionResponse(const QString & responseType, const QMap<QString, QString> & resultValues)
	{
		qDebug() << "UPnP::WanConnectionService: parsing action response:"
		         << " type='" << responseType << "'." << Qt::endl;

		// Check the message type
		if(responseType == "GetExternalIPAddressResponse")
		{
			// Get the external IP address from the response
			m_szExternalIpAddress = resultValues["NewExternalIPAddress"];

			qDebug() << "UPnP::WanConnectionService: externalIp='" << m_szExternalIpAddress << "'." << Qt::endl;
		}
		else if(responseType == "GetNATRSIPStatusResponse")
		{
			// Get the nat status from the response
			m_bNatEnabled = (resultValues["NewNATEnabled"] == "1");

			qDebug() << "UPnP::WanConnectionService: natEnabled=" << m_bNatEnabled << "." << Qt::endl;
		}
		else if(responseType == "GetGenericPortMappingEntryResponse")
		{
			// Find a place to store the data
			PortMapping * map = new PortMapping;

			// Get the port mapping data from the response
			map->enabled = (resultValues["NewEnabled"] == "1");
			map->externalPort = resultValues["NewExternalPort"].toInt();
			map->internalClient = resultValues["NewInternalClient"];
			map->internalPort = resultValues["NewInternalPort"].toInt();
			map->leaseDuration = resultValues["NewLeaseDuration"].toInt();
			map->description = resultValues["NewPortMappingDescription"];
			map->protocol = resultValues["NewProtocol"];
			map->remoteHost = resultValues["NewRemoteHost"];

			// Register the mapping
			m_lPortMappings.append(map);

			qDebug() << "UPnP::WanConnectionService - Received mapping: " << map->protocol << " " << map->remoteHost << ":" << map->externalPort
			         << " to " << map->internalClient << ":" << map->internalPort
			         << "    max " << map->leaseDuration << "s '" << map->description << "' " << (map->enabled ? "enabled" : "disabled") << Qt::endl;
		}
		else if(responseType == "AddPortMappingResponse")
		{
			qDebug() << "UPnP::WanConnectionService - Received mapping enabled" << Qt::endl;
		}
		else if(responseType == "DeletePortMappingResponse")
		{
			qDebug() << "UPnP::WanConnectionService - Received mapping disabled" << Qt::endl;
		}
		else
		{
			qDebug() << "UPnP::WanConnectionService - Unexpected response type"
			         << " '" << responseType << "' encountered." << Qt::endl;
		}
	}

	// Query for the external IP address
	void WanConnectionService::queryExternalIpAddress()
	{
		callAction("GetExternalIPAddress", "u");
	}

	// Query for the Nat status
	void WanConnectionService::queryNatEnabled()
	{
		callAction("GetNATRSIPStatus", "u");
	}

	// Query for a port mapping entry
	void WanConnectionService::queryPortMappingEntry(int index)
	{
		QMap<QString, QString> arguments;
		arguments["NewPortMappingIndex"] = QString::number(index);
		callAction("GetGenericPortMappingEntry", arguments, "m");
	}

} // End of namespace