upnpapi.hpp

Go to the documentation of this file.

#ifndef COMPA_UPNPAPI_HPP
#define COMPA_UPNPAPI_HPP
/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (C) 2011-2012 France Telecom All rights reserved.
 * Copyright (C) 2021+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
 * Redistribution only with this Copyright remark. Last modified: 2025-07-16
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * * Neither name of Intel Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************/
// Last compare with ./Pupnp source file on 2025-07-16, ver 1.14.21
#include <GenlibClientSubscription.hpp>
#include <TimerThread.hpp>
#include <VirtualDir.hpp> /* for struct VirtualDirCallbacks */
#include <service_table.hpp>
 
#define MAX_INTERFACES 256
 
#define DEV_LIMIT 200
 
#define DEFAULT_MX 5
 
#define DEFAULT_MAXAGE 1800
 
#define DEFAULT_SOAP_CONTENT_LENGTH 16000
#define MAX_SOAP_CONTENT_LENGTH (size_t)32000
 
constexpr int NUM_HANDLE{200};
 
extern size_t g_maxContentLength;
extern int g_UpnpSdkEQMaxLen;
extern int g_UpnpSdkEQMaxAge;
 
#define UPNP_TIMEOUT 30
 
enum Upnp_Handle_Type {
    HND_TABLE_INVALID = -2,
    HND_INVALID,
    HND_CLIENT,
    HND_DEVICE
};
 
 
struct Handle_Info {
    Upnp_Handle_Type HType; 
    Upnp_FunPtr Callback;   
    char* Cookie;           
    int aliasInstalled;     
 
#ifdef COMPA_HAVE_DEVICE_SSDP
    char DescURL[LINE_SIZE];      
    char LowerDescURL[LINE_SIZE]; 
    char DescXML[LINE_SIZE];      
    int MaxAge;                   
    int PowerState;               
    int SleepPeriod;       
    int RegistrationState; 
    IXML_Document*
        DescDocument;      
    IXML_NodeList* DeviceList; 
    IXML_NodeList*
        ServiceList;      
    service_table
        ServiceTable;     
    int MaxSubscriptions; 
    int MaxSubscriptionTimeOut; 
    int DeviceAf;               
#endif
 
#ifdef COMPA_HAVE_CTRLPT_SSDP
    GenlibClientSubscription* ClientSubList; 
    LinkedList SsdpSearchList;               
#endif
};
 
extern pthread_rwlock_t GlobalHndRWLock;
 
Upnp_Handle_Type GetHandleInfo(
    int Hnd,
    struct Handle_Info** HndInfo);
 
#define HandleLock() HandleWriteLock()
 
#define HandleWriteLock() pthread_rwlock_wrlock(&GlobalHndRWLock);
 
#define HandleReadLock() pthread_rwlock_rdlock(&GlobalHndRWLock);
 
#define HandleUnlock() pthread_rwlock_unlock(&GlobalHndRWLock);
 
#if 0
#define HandleWriteLock()                                                      \
    UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Trying a write lock\n");   \
    pthread_rwlock_wrlock(&GlobalHndRWLock);                                   \
    UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Write lock acquired\n")
 
#define HandleReadLock()                                                       \
    UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Trying a read lock\n");    \
    pthread_rwlock_rdlock(&GlobalHndRWLock);                                   \
    UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Read lock acquired\n")
 
#define HandleUnlock()                                                         \
    UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Trying Unlock\n");         \
    pthread_rwlock_unlock(&GlobalHndRWLock);                                   \
    UpnpPrintf(UPNP_INFO, API, __FILE__, __LINE__, "Unlocked rwlock\n")
#endif
 
Upnp_Handle_Type GetClientHandleInfo(
    int* client_handle_out,
    struct Handle_Info** HndInfo);
Upnp_Handle_Type GetDeviceHandleInfo(
    UpnpDevice_Handle start,
    int AddressFamily,
    int* device_handle_out,
    struct Handle_Info** HndInfo);
 
Upnp_Handle_Type GetDeviceHandleInfoForPath(
    const char* path,
    int AddressFamily,
    int* device_handle_out,
    struct Handle_Info** HndInfo,
    service_info** serv_info);
 
PUPNP_API extern char gIF_NAME[LINE_SIZE];
PUPNP_API extern char gIF_IPV4[INET_ADDRSTRLEN];
PUPNP_API extern char gIF_IPV4_NETMASK[INET_ADDRSTRLEN];
PUPNP_API extern char gIF_IPV6[INET6_ADDRSTRLEN];
PUPNP_API extern unsigned gIF_IPV6_PREFIX_LENGTH;
 
PUPNP_API extern char gIF_IPV6_ULA_GUA[INET6_ADDRSTRLEN];
PUPNP_API extern unsigned gIF_IPV6_ULA_GUA_PREFIX_LENGTH;
 
PUPNP_API extern unsigned gIF_INDEX;
 
PUPNP_API extern unsigned short LOCAL_PORT_V4;
PUPNP_API extern unsigned short LOCAL_PORT_V6;
PUPNP_API extern unsigned short LOCAL_PORT_V6_ULA_GUA;
 
extern Upnp_SID gUpnpSdkNLSuuid;
 
extern TimerThread gTimerThread;
extern ThreadPool gRecvThreadPool;
extern ThreadPool gSendThreadPool;
extern ThreadPool gMiniServerThreadPool;
 
typedef enum {
    SUBSCRIBE,
    UNSUBSCRIBE,
    DK_NOTIFY,
    QUERY,
    ACTION,
    STATUS,
    DEVDESCRIPTION,
    SERVDESCRIPTION,
    MINI,
    RENEW
} UpnpFunName;
 
struct UpnpNonblockParam {
    UpnpFunName FunName;
    int Handle;
    int TimeOut;
    char VarName[NAME_SIZE];
    char NewVal[NAME_SIZE];
    char DevType[NAME_SIZE];
    char DevId[NAME_SIZE];
    char ServiceType[NAME_SIZE];
    char ServiceVer[NAME_SIZE];
    char Url[NAME_SIZE];
    Upnp_SID SubsId;
    char* Cookie;
    Upnp_FunPtr Fun;
    IXML_Document* Header;
    IXML_Document* Act;
    struct DevDesc* Devdesc;
};
 
extern virtualDirList* pVirtualDirList;
extern struct VirtualDirCallbacks virtualDirCallback;
 
typedef enum { WEB_SERVER_DISABLED, WEB_SERVER_ENABLED } WebServerState;
 
#define E_HTTP_SYNTAX -6
 
void UpnpThreadDistribution(struct UpnpNonblockParam* Param);
 
void AutoAdvertise(
    void* input);
 
int PrintHandleInfo(
    UpnpClient_Handle Hnd);
 
extern WebServerState bWebServerState;
 
extern WebCallback_HostValidate gWebCallback_HostValidate;
 
extern void* gWebCallback_HostValidateCookie;
 
extern int gAllowLiteralHostRedirection;
 
#endif /* COMPA_UPNPAPI_HPP */