gena.hpp

Go to the documentation of this file.

#ifndef COMPA_GENA_HPP
#define COMPA_GENA_HPP
/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (C) 2022+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
 * Redistribution only with this Copyright remark. Last modified: 2025-06-12
 *
 * 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.
 *
 ******************************************************************************/
#include <time.h>
 
#include <client_table.hpp>
#include <httpparser.hpp>
#include <sock.hpp>
 
#define XML_VERSION "<?xml version='1.0' encoding='ISO-8859-1' ?>\n"
#define XML_PROPERTYSET_HEADER                                                 \
    "<e:propertyset xmlns:e=\"urn:schemas-upnp-org:event-1-0\">\n"
 
#define UNABLE_MEMORY "HTTP/1.1 500 Internal Server Error\r\n\r\n"
#define UNABLE_SERVICE_UNKNOWN "HTTP/1.1 404 Not Found\r\n\r\n"
#define UNABLE_SERVICE_NOT_ACCEPT "HTTP/1.1 503 Service Not Available\r\n\r\n"
 
#define NOT_IMPLEMENTED "HTTP/1.1 501 Not Implemented\r\n\r\n"
#define BAD_REQUEST "HTTP/1.1 400 Bad Request\r\n\r\n"
#define INVALID_NT BAD_CALLBACK
#define BAD_CALLBACK "HTTP/1.1 412 Precondition Failed\r\n\r\n"
#define HTTP_OK_CRLF "HTTP/1.1 200 OK\r\n\r\n"
#define HTTP_OK_STR "HTTP/1.1 200 OK\r\n"
#define INVALID_SID BAD_CALLBACK
#define MISSING_SID BAD_CALLBACK
#define MAX_CONTENT_LENGTH 20
#define MAX_SECONDS 10
#define MAX_EVENTS 20
#define MAX_PORT_SIZE 10
 
#define GENA_E_BAD_RESPONSE UPNP_E_BAD_RESPONSE
#define GENA_E_BAD_SERVICE UPNP_E_INVALID_SERVICE
#define GENA_E_SUBSCRIPTION_UNACCEPTED UPNP_E_SUBSCRIBE_UNACCEPTED
#define GENA_E_BAD_SID UPNP_E_INVALID_SID
#define GENA_E_UNSUBSCRIBE_UNACCEPTED UPNP_E_UNSUBSCRIBE_UNACCEPTED
#define GENA_E_NOTIFY_UNACCEPTED UPNP_E_NOTIFY_UNACCEPTED
#define GENA_E_NOTIFY_UNACCEPTED_REMOVE_SUB -9
#define GENA_E_BAD_HANDLE UPNP_E_INVALID_HANDLE
 
#define XML_ERROR -5
#define XML_SUCCESS UPNP_E_SUCCESS
#define GENA_SUCCESS UPNP_E_SUCCESS
 
#define CALLBACK_SUCCESS 0
#define DEFAULT_TIMEOUT 1801
 
typedef struct NOTIFY_THREAD_STRUCT {
    char* headers;
    DOMString propertySet;
    char* servId;
    char* UDN;
    Upnp_SID sid;
    time_t ctime;
    int* reference_count;
    UpnpDevice_Handle device_handle;
} notify_thread_struct;
 
int clientSubscribeMutexInit();
 
int clientSubscribeMutexDestroy();
 
void genaCallback(
    http_parser_t* parser,
    http_message_t* request,
    SOCKINFO* info);
 
#ifdef COMPA_HAVE_CTRLPT_SSDP
int genaSubscribe(
    UpnpClient_Handle client_handle,
    const UpnpString* PublisherURL,
    int* TimeOut,
    UpnpString* out_sid);
#endif
 
#ifdef COMPA_HAVE_CTRLPT_SSDP
int genaUnSubscribe(
    UpnpClient_Handle client_handle,
    const UpnpString* in_sid);
#endif
 
#ifdef COMPA_HAVE_CTRLPT_SSDP
int genaUnregisterClient(
    UpnpClient_Handle client_handle);
#endif
 
/*
 * DEVICE
 */
 
#ifdef COMPA_HAVE_DEVICE_SSDP
int genaUnregisterDevice(
    UpnpDevice_Handle device_handle);
#endif
 
#ifdef COMPA_HAVE_CTRLPT_SSDP
int genaRenewSubscription(
    UpnpClient_Handle client_handle,
    const UpnpString* in_sid,
    int* TimeOut);
#endif
 
#ifdef COMPA_HAVE_DEVICE_SSDP
int genaNotifyAll(
    UpnpDevice_Handle device_handle,
    char* UDN,
    char* servId,
    char** VarNames,
    char** VarValues,
    int var_count);
#endif
 
#ifdef COMPA_HAVE_DEVICE_SSDP
int genaNotifyAllExt(
    UpnpDevice_Handle device_handle,
    char* UDN,
    char* servId,
    IXML_Document* PropSet);
#endif
 
#ifdef COMPA_HAVE_DEVICE_SSDP
int genaInitNotify(
    UpnpDevice_Handle device_handle,
    char* UDN,
    char* servId,
    char** VarNames,
    char** VarValues,
    int var_count,
    const Upnp_SID sid);
#endif
 
#ifdef COMPA_HAVE_DEVICE_SSDP
int genaInitNotifyExt(
    UpnpDevice_Handle device_handle,
    char* UDN,
    char* servId,
    IXML_Document* PropSet,
    const Upnp_SID sid);
#endif
 
void error_respond(
    SOCKINFO* info, 
    int error_code, 
    http_message_t* hmsg 
);
 
#endif /* COMPA_GENA_HPP */