upnpapi.h

Go to the documentation of this file.

/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (C) 2011-2012 France Telecom All rights reserved.
 *
 * 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.
 *
 ******************************************************************************/
 
#ifndef UPNPAPI_H
#define UPNPAPI_H

 
#include "GenlibClientSubscription.h"
#include "TimerThread.h"
#include "VirtualDir.h" /* for struct VirtualDirCallbacks */
#include "service_table.h"
 
#define MAX_INTERFACES 256
 
#define DEV_LIMIT 200
 
#define DEFAULT_MX 5
 
#define DEFAULT_MAXAGE 1800
 
#define DEFAULT_SOAP_CONTENT_LENGTH 64000
 
#define NUM_HANDLE 200
 
extern size_t g_maxContentLength;
extern int g_UpnpSdkEQMaxLen;
extern int g_UpnpSdkEQMaxAge;
 
/* 30-second timeout */
#define UPNP_TIMEOUT 30
 
typedef enum
{
        HND_INVALID = -1,
        HND_CLIENT,
        HND_DEVICE
} Upnp_Handle_Type;
 
/* Data to be stored in handle table for */
struct Handle_Info
{
        Upnp_Handle_Type HType;
        Upnp_FunPtr Callback;
        char *Cookie;
        int aliasInstalled;
 
        /* Device Only */
#ifdef INCLUDE_DEVICE_APIS
        char DescURL[LINE_SIZE];
        char LowerDescURL[LINE_SIZE];
        char DescXML[LINE_SIZE];
        /* Advertisement timeout */
        int MaxAge;
        /* Power State as defined by UPnP Low Power. */
        int PowerState;
        /* Sleep Period as defined by UPnP Low Power. */
        int SleepPeriod;
        /* Registration State as defined by UPnP Low Power. */
        int RegistrationState;
        IXML_Document *DescDocument;
        IXML_NodeList *DeviceList;
        IXML_NodeList *ServiceList;
        service_table ServiceTable;
        int MaxSubscriptions;
        int MaxSubscriptionTimeOut;
        int DeviceAf;
#endif
 
        /* Client only */
#ifdef INCLUDE_CLIENT_APIS
        GenlibClientSubscription *ClientSubList;
        LinkedList SsdpSearchList;
#endif
};
 
extern ithread_rwlock_t GlobalHndRWLock;

static enum Upnp_LogLevel_e debug_handle = UPNP_NEVER;
#if defined(__GNUC__)
        #pragma GCC diagnostic push
        #pragma GCC diagnostic ignored "-Wunused-function"
#endif
Upnp_Handle_Type GetHandleInfo(
        int Hnd,
        struct Handle_Info **HndInfo);
 
static void HandleUnlock(const char *file, int line)
{
        UpnpPrintf(debug_handle, API, file, line, "Trying Unlock\n");
        ithread_rwlock_unlock(&GlobalHndRWLock);
        UpnpPrintf(debug_handle, API, file, line, "Unlocked rwlock\n");
}
 
static void HandleReadLock(const char *file, int line)
{
        UpnpPrintf(debug_handle, API, file, line, "Trying a read lock\n");
        ithread_rwlock_rdlock(&GlobalHndRWLock);
        UpnpPrintf(debug_handle, API, file, line, "Read lock acquired\n");
}
 
static void HandleWriteLock(const char *file, int line)
{
        UpnpPrintf(debug_handle, API, file, line, "Trying a write lock\n");
        ithread_rwlock_wrlock(&GlobalHndRWLock);
        UpnpPrintf(debug_handle, API, file, line, "Write lock acquired\n");
}
 
static void HandleLock(const char *file, int line)
{
        HandleWriteLock(file, line);
}
#if defined(__GNUC__)
        #pragma GCC diagnostic pop
#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);
 
extern char gIF_NAME[LINE_SIZE];
extern char gIF_IPV4[INET_ADDRSTRLEN];
extern char gIF_IPV4_NETMASK[INET_ADDRSTRLEN];
extern char gIF_IPV6[INET6_ADDRSTRLEN];
extern unsigned gIF_IPV6_PREFIX_LENGTH;
 
extern char gIF_IPV6_ULA_GUA[INET6_ADDRSTRLEN];
extern unsigned gIF_IPV6_ULA_GUA_PREFIX_LENGTH;
 
extern unsigned gIF_INDEX;
 
extern unsigned short LOCAL_PORT_V4;
extern unsigned short LOCAL_PORT_V6;
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

int UpnpGetIfInfo(
        const char *IfName);

void UpnpSetIfAddrStrings(int valid_v4_addr_found,
        const struct in_addr *v4_addr,
        const struct in_addr *v4_netmask,
        char *out_v4,
        size_t out_v4_len,
        char *out_v4_netmask,
        size_t out_v4_netmask_len,
        int valid_v6_addr_found,
        const struct in6_addr *v6_addr,
        char *out_v6,
        size_t out_v6_len);
 
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 /* UPNPAPI_H */