Skip to content

Commit

Permalink
Merge pull request #99597 from Faless/upnp/custom_instance
Browse files Browse the repository at this point in the history 
[UPNP] Allow disabling UPNP implementation on the Web
  • Loading branch information
@Repiteo
Repiteo committed Nov 25, 2024
2 parents 20d4755 + 0df602a commit 29e6ef4
Show file tree
Hide file tree
Showing 10 changed files with 734 additions and 488 deletions.
2 changes: 1 addition & 1 deletion modules/upnp/SCsub
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ env_upnp = env_modules.Clone()

thirdparty_obj = []

if env["builtin_miniupnpc"]:
if env["builtin_miniupnpc"] and env["platform"] != "web":
thirdparty_dir = "#thirdparty/miniupnpc/"
thirdparty_sources = [
"igd_desc_parse.c",
Expand Down
14 changes: 12 additions & 2 deletions modules/upnp/register_types.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,25 @@
#include "upnp.h"
#include "upnp_device.h"

#ifndef WEB_ENABLED
#include "upnp_device_miniupnp.h"
#include "upnp_miniupnp.h"
#endif

#include "core/error/error_macros.h"

void initialize_upnp_module(ModuleInitializationLevel p_level) {
if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) {
return;
}

GDREGISTER_CLASS(UPNP);
GDREGISTER_CLASS(UPNPDevice);
ClassDB::register_custom_instance_class<UPNP>();
ClassDB::register_custom_instance_class<UPNPDevice>();

#ifndef WEB_ENABLED
UPNPMiniUPNP::make_default();
UPNPDeviceMiniUPNP::make_default();
#endif
}

void uninitialize_upnp_module(ModuleInitializationLevel p_level) {
Expand Down
299 changes: 1 addition & 298 deletions modules/upnp/upnp.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,298 +30,7 @@

#include "upnp.h"

#include <miniwget.h>
#include <upnpcommands.h>

#include <stdlib.h>

bool UPNP::is_common_device(const String &dev) const {
return dev.is_empty() ||
dev.contains("InternetGatewayDevice") ||
dev.contains("WANIPConnection") ||
dev.contains("WANPPPConnection") ||
dev.contains("rootdevice");
}

int UPNP::discover(int timeout, int ttl, const String &device_filter) {
ERR_FAIL_COND_V_MSG(timeout < 0, UPNP_RESULT_INVALID_PARAM, "The response's wait time can't be negative.");
ERR_FAIL_COND_V_MSG(ttl < 0 || ttl > 255, UPNP_RESULT_INVALID_PARAM, "The time-to-live must be set between 0 and 255 (inclusive).");

devices.clear();

int error = 0;
struct UPNPDev *devlist;

CharString cs = discover_multicast_if.utf8();
const char *m_if = cs.length() ? cs.get_data() : nullptr;
if (is_common_device(device_filter)) {
devlist = upnpDiscover(timeout, m_if, nullptr, discover_local_port, discover_ipv6, ttl, &error);
} else {
devlist = upnpDiscoverAll(timeout, m_if, nullptr, discover_local_port, discover_ipv6, ttl, &error);
}

if (error != UPNPDISCOVER_SUCCESS) {
switch (error) {
case UPNPDISCOVER_SOCKET_ERROR:
return UPNP_RESULT_SOCKET_ERROR;
case UPNPDISCOVER_MEMORY_ERROR:
return UPNP_RESULT_MEM_ALLOC_ERROR;
default:
return UPNP_RESULT_UNKNOWN_ERROR;
}
}

if (!devlist) {
return UPNP_RESULT_NO_DEVICES;
}

struct UPNPDev *dev = devlist;

while (dev) {
if (device_filter.is_empty() || strstr(dev->st, device_filter.utf8().get_data())) {
add_device_to_list(dev, devlist);
}

dev = dev->pNext;
}

freeUPNPDevlist(devlist);

return UPNP_RESULT_SUCCESS;
}

void UPNP::add_device_to_list(UPNPDev *dev, UPNPDev *devlist) {
Ref<UPNPDevice> new_device;
new_device.instantiate();

new_device->set_description_url(dev->descURL);
new_device->set_service_type(dev->st);

parse_igd(new_device, devlist);

devices.push_back(new_device);
}

char *UPNP::load_description(const String &url, int *size, int *status_code) const {
return (char *)miniwget(url.utf8().get_data(), size, 0, status_code);
}

void UPNP::parse_igd(Ref<UPNPDevice> dev, UPNPDev *devlist) {
int size = 0;
int status_code = -1;
char *xml = load_description(dev->get_description_url(), &size, &status_code);

if (status_code != 200) {
dev->set_igd_status(UPNPDevice::IGD_STATUS_HTTP_ERROR);
return;
}

if (!xml || size < 1) {
dev->set_igd_status(UPNPDevice::IGD_STATUS_HTTP_EMPTY);
return;
}

struct UPNPUrls urls = {};
struct IGDdatas data;

parserootdesc(xml, size, &data);
free(xml);
xml = nullptr;

GetUPNPUrls(&urls, &data, dev->get_description_url().utf8().get_data(), 0);

char addr[16];
#if MINIUPNPC_API_VERSION >= 18
int i = UPNP_GetValidIGD(devlist, &urls, &data, (char *)&addr, 16, nullptr, 0);
#else
int i = UPNP_GetValidIGD(devlist, &urls, &data, (char *)&addr, 16);
#endif

if (i != 1) {
FreeUPNPUrls(&urls);

switch (i) {
case 0:
dev->set_igd_status(UPNPDevice::IGD_STATUS_NO_IGD);
return;
case 2:
dev->set_igd_status(UPNPDevice::IGD_STATUS_DISCONNECTED);
return;
case 3:
dev->set_igd_status(UPNPDevice::IGD_STATUS_UNKNOWN_DEVICE);
return;
default:
dev->set_igd_status(UPNPDevice::IGD_STATUS_UNKNOWN_ERROR);
return;
}
}

if (urls.controlURL[0] == '\0') {
FreeUPNPUrls(&urls);
dev->set_igd_status(UPNPDevice::IGD_STATUS_INVALID_CONTROL);
return;
}

dev->set_igd_control_url(urls.controlURL);
dev->set_igd_service_type(data.first.servicetype);
dev->set_igd_our_addr(addr);
dev->set_igd_status(UPNPDevice::IGD_STATUS_OK);

FreeUPNPUrls(&urls);
}

int UPNP::upnp_result(int in) {
switch (in) {
case UPNPCOMMAND_SUCCESS:
return UPNP_RESULT_SUCCESS;
case UPNPCOMMAND_UNKNOWN_ERROR:
return UPNP_RESULT_UNKNOWN_ERROR;
case UPNPCOMMAND_INVALID_ARGS:
return UPNP_RESULT_INVALID_ARGS;
case UPNPCOMMAND_HTTP_ERROR:
return UPNP_RESULT_HTTP_ERROR;
case UPNPCOMMAND_INVALID_RESPONSE:
return UPNP_RESULT_INVALID_RESPONSE;
case UPNPCOMMAND_MEM_ALLOC_ERROR:
return UPNP_RESULT_MEM_ALLOC_ERROR;

case 402:
return UPNP_RESULT_INVALID_ARGS;
case 403:
return UPNP_RESULT_NOT_AUTHORIZED;
case 501:
return UPNP_RESULT_ACTION_FAILED;
case 606:
return UPNP_RESULT_NOT_AUTHORIZED;
case 714:
return UPNP_RESULT_NO_SUCH_ENTRY_IN_ARRAY;
case 715:
return UPNP_RESULT_SRC_IP_WILDCARD_NOT_PERMITTED;
case 716:
return UPNP_RESULT_EXT_PORT_WILDCARD_NOT_PERMITTED;
case 718:
return UPNP_RESULT_CONFLICT_WITH_OTHER_MAPPING;
case 724:
return UPNP_RESULT_SAME_PORT_VALUES_REQUIRED;
case 725:
return UPNP_RESULT_ONLY_PERMANENT_LEASE_SUPPORTED;
case 726:
return UPNP_RESULT_REMOTE_HOST_MUST_BE_WILDCARD;
case 727:
return UPNP_RESULT_EXT_PORT_MUST_BE_WILDCARD;
case 728:
return UPNP_RESULT_NO_PORT_MAPS_AVAILABLE;
case 729:
return UPNP_RESULT_CONFLICT_WITH_OTHER_MECHANISM;
case 732:
return UPNP_RESULT_INT_PORT_WILDCARD_NOT_PERMITTED;
case 733:
return UPNP_RESULT_INCONSISTENT_PARAMETERS;
}

return UPNP_RESULT_UNKNOWN_ERROR;
}

int UPNP::get_device_count() const {
return devices.size();
}

Ref<UPNPDevice> UPNP::get_device(int index) const {
ERR_FAIL_INDEX_V(index, devices.size(), nullptr);

return devices.get(index);
}

void UPNP::add_device(Ref<UPNPDevice> device) {
ERR_FAIL_COND(device.is_null());

devices.push_back(device);
}

void UPNP::set_device(int index, Ref<UPNPDevice> device) {
ERR_FAIL_INDEX(index, devices.size());
ERR_FAIL_COND(device.is_null());

devices.set(index, device);
}

void UPNP::remove_device(int index) {
ERR_FAIL_INDEX(index, devices.size());

devices.remove_at(index);
}

void UPNP::clear_devices() {
devices.clear();
}

Ref<UPNPDevice> UPNP::get_gateway() const {
ERR_FAIL_COND_V_MSG(devices.is_empty(), nullptr, "Couldn't find any UPNPDevices.");

for (int i = 0; i < devices.size(); i++) {
Ref<UPNPDevice> dev = get_device(i);

if (dev.is_valid() && dev->is_valid_gateway()) {
return dev;
}
}

return nullptr;
}

void UPNP::set_discover_multicast_if(const String &m_if) {
discover_multicast_if = m_if;
}

String UPNP::get_discover_multicast_if() const {
return discover_multicast_if;
}

void UPNP::set_discover_local_port(int port) {
discover_local_port = port;
}

int UPNP::get_discover_local_port() const {
return discover_local_port;
}

void UPNP::set_discover_ipv6(bool ipv6) {
discover_ipv6 = ipv6;
}

bool UPNP::is_discover_ipv6() const {
return discover_ipv6;
}

String UPNP::query_external_address() const {
Ref<UPNPDevice> dev = get_gateway();

if (dev.is_null()) {
return "";
}

return dev->query_external_address();
}

int UPNP::add_port_mapping(int port, int port_internal, String desc, String proto, int duration) const {
Ref<UPNPDevice> dev = get_gateway();

if (dev.is_null()) {
return UPNP_RESULT_NO_GATEWAY;
}

return dev->add_port_mapping(port, port_internal, desc, proto, duration);
}

int UPNP::delete_port_mapping(int port, String proto) const {
Ref<UPNPDevice> dev = get_gateway();

if (dev.is_null()) {
return UPNP_RESULT_NO_GATEWAY;
}

return dev->delete_port_mapping(port, proto);
}
UPNP *(*UPNP::_create)(bool p_notify_postinitialize) = nullptr;

void UPNP::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_device_count"), &UPNP::get_device_count);
Expand Down Expand Up @@ -382,9 +91,3 @@ void UPNP::_bind_methods() {
BIND_ENUM_CONSTANT(UPNP_RESULT_NO_DEVICES);
BIND_ENUM_CONSTANT(UPNP_RESULT_UNKNOWN_ERROR);
}

UPNP::UPNP() {
}

UPNP::~UPNP() {
}
Loading

0 comments on commit 29e6ef4

Please sign in to comment.