gena_device.cpp

Go to the documentation of this file.

/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (c) 2012 France Telecom 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-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 <assert.h>
 
#include <gena.hpp>
#include <httpreadwrite.hpp>
#include <parsetools.hpp>
#include <ssdp_common.hpp>
#include <statcodes.hpp>
#include <unixutil.hpp>
#include <upnpapi.hpp>
#include <uuid.hpp>
#include <UpnpSubscriptionRequest.hpp>
#include <webserver.hpp>
 
#define STALE_JOBID (INVALID_JOB_ID - 1)
 
#define PRIzu "zu"
 
namespace {
 
int GeneratePropertySet(
    char** names,
    char** values,
    int count,
    DOMString* out) {
    char* buffer;
    int counter = 0;
    size_t size = 0;
 
    /*size += strlen(XML_VERSION);*/
    size += strlen(XML_PROPERTYSET_HEADER);
    size += strlen("</e:propertyset>\n\n");
    for (counter = 0; counter < count; counter++) {
        size += strlen("<e:property>\n</e:property>\n");
        size += 2 * strlen(names[counter]) + strlen(values[counter]) +
                strlen("<></>\n");
    }
 
    size_t buffer_len{size + 1};
    buffer = (char*)malloc(buffer_len);
    if (buffer == NULL)
        return UPNP_E_OUTOF_MEMORY;
    memset(buffer, 0, size + 1);
    /*
    strcpy(buffer,XML_VERSION);
    strcat(buffer, XML_PROPERTYSET_HEADER);
    */
    strcpy(buffer, XML_PROPERTYSET_HEADER);
    for (counter = 0; counter < count; counter++) {
        strcat(buffer, "<e:property>\n");
        snprintf(&buffer[strlen(buffer)], buffer_len,
                 "<%s>%s</%s>\n</e:property>\n", names[counter],
                 values[counter], names[counter]);
    }
    strcat(buffer, "</e:propertyset>\n\n");
    *out = ixmlCloneDOMString(buffer);
    free(buffer);
 
    return XML_SUCCESS;
}
 
void free_notify_struct(
    void* input) {
    notify_thread_struct* p = (notify_thread_struct*)input;
 
    (*p->reference_count)--;
    if (*p->reference_count == 0) {
        free(p->headers);
        ixmlFreeDOMString(p->propertySet);
        free(p->servId);
        free(p->UDN);
        free(p->reference_count);
    }
    free(p);
}
 
inline int notify_send_and_recv(
    uri_type* destination_url,
    membuffer* mid_msg,
    char* propertySet,
    http_parser_t* response) {
    uri_type url;
    SOCKET conn_fd;
    membuffer start_msg;
    int ret_code;
    int err_code;
    int timeout;
    SOCKINFO info;
    const char* CRLF = "\r\n";
 
    /* connect */
    UpnpPrintf(UPNP_ALL, GENA, __FILE__, __LINE__, "gena notify to: %.*s\n",
               (int)destination_url->hostport.text.size,
               destination_url->hostport.text.buff);
 
    conn_fd = http_Connect(destination_url, &url);
    if (conn_fd < 0)
        /* return UPNP error */
        return UPNP_E_SOCKET_CONNECT;
    ret_code = sock_init(&info, conn_fd);
    if (ret_code) {
        sock_destroy(&info, SD_BOTH);
        return ret_code;
    }
    /* make start line and HOST header */
    membuffer_init(&start_msg);
    if (http_MakeMessage(&start_msg, 1, 1,
                         "q"
                         "s",
                         HTTPMETHOD_NOTIFY, &url, mid_msg->buf) != 0) {
        membuffer_destroy(&start_msg);
        sock_destroy(&info, SD_BOTH);
        return UPNP_E_OUTOF_MEMORY;
    }
    timeout = GENA_NOTIFICATION_SENDING_TIMEOUT;
    /* send msg (note: end of notification will contain "\r\n" twice) */
    ret_code = http_SendMessage(&info, &timeout, "bbb", start_msg.buf,
                                start_msg.length, propertySet,
                                strlen(propertySet), CRLF, strlen(CRLF));
    if (ret_code) {
        membuffer_destroy(&start_msg);
        sock_destroy(&info, SD_BOTH);
        return ret_code;
    }
    timeout = GENA_NOTIFICATION_ANSWERING_TIMEOUT;
    ret_code = http_RecvMessage(&info, response, HTTPMETHOD_NOTIFY, &timeout,
                                &err_code);
    if (ret_code) {
        membuffer_destroy(&start_msg);
        sock_destroy(&info, SD_BOTH);
        httpmsg_destroy(&response->msg);
        return ret_code;
    }
    /* should shutdown completely when closing socket */
    sock_destroy(&info, SD_BOTH);
    membuffer_destroy(&start_msg);
 
    return UPNP_E_SUCCESS;
}
 
int genaNotify(
    char* headers,
    char* propertySet,
    subscription* sub) {
    size_t i;
    membuffer mid_msg;
    uri_type* url;
    http_parser_t response{};
    int return_code = -1;
 
    membuffer_init(&mid_msg);
    if (http_MakeMessage(&mid_msg, 1, 1,
                         "s"
                         "ssc"
                         "sdcc",
                         headers, "SID: ", sub->sid,
                         "SEQ: ", sub->ToSendEventKey) != 0) {
        membuffer_destroy(&mid_msg);
        return UPNP_E_OUTOF_MEMORY;
    }
    /* send a notify to each url until one goes thru */
    for (i = 0; i < sub->DeliveryURLs.size; i++) {
        url = &sub->DeliveryURLs.parsedURLs[i];
        return_code =
            notify_send_and_recv(url, &mid_msg, propertySet, &response);
        if (return_code == UPNP_E_SUCCESS)
            break;
    }
    membuffer_destroy(&mid_msg);
    if (return_code == UPNP_E_SUCCESS) {
        if (response.msg.status_code == HTTP_OK)
            return_code = GENA_SUCCESS;
        else {
            if (response.msg.status_code == HTTP_PRECONDITION_FAILED)
                /*Invalid SID gets removed */
                return_code = GENA_E_NOTIFY_UNACCEPTED_REMOVE_SUB;
            else
                return_code = GENA_E_NOTIFY_UNACCEPTED;
        }
        httpmsg_destroy(&response.msg);
    }
 
    return return_code;
}
 
void genaNotifyThread(
    void* input) {
    subscription* sub;
    service_info* service;
    subscription sub_copy;
    notify_thread_struct* in = (notify_thread_struct*)input;
    int return_code;
    struct Handle_Info* handle_info;
 
    /* This should be a HandleLock and not a HandleReadLock otherwise if
     * there is a lot of notifications, then multiple threads will acquire a
     * read lock and the thread which sends the notification will be blocked
     * forever on the HandleLock at the end of this function. */
    /*HandleReadLock(); */
    HandleLock();
    /* validate context */
 
    if (GetHandleInfo(in->device_handle, &handle_info) != HND_DEVICE) {
        free_notify_struct(in);
        HandleUnlock();
        return;
    }
 
    if (((service = FindServiceId(&handle_info->ServiceTable, in->servId,
                                  in->UDN)) == 0) ||
        !service->active ||
        ((sub = GetSubscriptionSID(in->sid, service)) == 0) ||
        copy_subscription(sub, &sub_copy) != HTTP_SUCCESS) {
        free_notify_struct(in);
        HandleUnlock();
        return;
    }
 
    HandleUnlock();
 
    /* send the notify */
    return_code = genaNotify(in->headers, in->propertySet, &sub_copy);
    freeSubscription(&sub_copy);
    HandleLock();
    if (GetHandleInfo(in->device_handle, &handle_info) != HND_DEVICE) {
        free_notify_struct(in);
        HandleUnlock();
        return;
    }
    /* validate context */
    if (((service = FindServiceId(&handle_info->ServiceTable, in->servId,
                                  in->UDN)) == 0) ||
        !service->active ||
        ((sub = GetSubscriptionSID(in->sid, service)) == 0)) {
        free_notify_struct(in);
        HandleUnlock();
        return;
    }
    sub->ToSendEventKey++;
    if (sub->ToSendEventKey < 0)
        /* wrap to 1 for overflow */
        sub->ToSendEventKey = 1;
 
    /* Remove head of event queue. Possibly activate next */
    {
        ListNode* node = ListHead(&sub->outgoing);
        if (node)
            ListDelNode(&sub->outgoing, node, 1);
        if (ListSize(&sub->outgoing) > 0) {
            ThreadPoolJob* job;
            ListNode* node2 = ListHead(&sub->outgoing);
            job = (ThreadPoolJob*)node2->item;
            /* The new head of queue should not have already been
               added to the pool, else something is very wrong */
            assert(job->jobId != STALE_JOBID);
 
            ThreadPoolAdd(&gSendThreadPool, job, NULL);
            job->jobId = STALE_JOBID;
        }
    }
 
    if (return_code == GENA_E_NOTIFY_UNACCEPTED_REMOVE_SUB)
        RemoveSubscriptionSID(in->sid, service);
    free_notify_struct(in);
 
    HandleUnlock();
}
 
char* AllocGenaHeaders(
    const DOMString propertySet) {
    static const char* HEADER_LINE_1 =
        "CONTENT-TYPE: text/xml; charset=\"utf-8\"\r\n";
    static const char* HEADER_LINE_2A = "CONTENT-LENGTH: ";
    static const char* HEADER_LINE_2B = "\r\n";
    static const char* HEADER_LINE_3 = "NT: upnp:event\r\n";
    static const char* HEADER_LINE_4 = "NTS: upnp:propchange\r\n";
    char* headers = NULL;
    size_t headers_size = 0;
    int line = 0;
    int rc = 0;
 
    headers_size = strlen(HEADER_LINE_1) + strlen(HEADER_LINE_2A) +
                   MAX_CONTENT_LENGTH + strlen(HEADER_LINE_2B) +
                   strlen(HEADER_LINE_3) + strlen(HEADER_LINE_4) + 1;
    headers = (char*)malloc(headers_size);
    if (headers == NULL) {
        line = __LINE__;
        goto ExitFunction;
    }
    rc = snprintf(headers, headers_size, "%s%s%" PRIzu "%s%s%s", HEADER_LINE_1,
                  HEADER_LINE_2A, strlen(propertySet) + 2, HEADER_LINE_2B,
                  HEADER_LINE_3, HEADER_LINE_4);
 
ExitFunction:
    if (headers == NULL || rc < 0 || (unsigned int)rc >= headers_size) {
        UpnpPrintf(UPNP_ALL, GENA, __FILE__, line,
                   "AllocGenaHeaders(): Error UPNP_E_OUTOF_MEMORY\n");
    }
    return headers;
}
 
int genaInitNotifyCommon(UpnpDevice_Handle device_handle, char* UDN,
                         char* servId, DOMString propertySet,
                         const Upnp_SID sid) {
    int ret = GENA_SUCCESS;
    int line = 0;
 
    int* reference_count = NULL;
    char* UDN_copy = NULL;
    char* servId_copy = NULL;
    char* headers = NULL;
    notify_thread_struct* thread_struct = NULL;
 
    subscription* sub = NULL;
    service_info* service = NULL;
    struct Handle_Info* handle_info;
    ThreadPoolJob* job = NULL;
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "GENA BEGIN INITIAL NOTIFY COMMON\n");
 
    job = (ThreadPoolJob*)malloc(sizeof(ThreadPoolJob));
    if (job == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
        goto ExitFunction;
    }
    memset(job, 0, sizeof(ThreadPoolJob));
 
    reference_count = (int*)malloc(sizeof(int));
    if (reference_count == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
        goto ExitFunction;
    }
    *reference_count = 0;
 
    UDN_copy = strdup(UDN);
    if (UDN_copy == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
        goto ExitFunction;
    }
 
    servId_copy = strdup(servId);
    if (servId_copy == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
        goto ExitFunction;
    }
 
    HandleLock();
 
    if (GetHandleInfo(device_handle, &handle_info) != HND_DEVICE) {
        line = __LINE__;
        ret = GENA_E_BAD_HANDLE;
        goto ExitFunction;
    }
 
    service = FindServiceId(&handle_info->ServiceTable, servId, UDN);
    if (service == NULL) {
        line = __LINE__;
        ret = GENA_E_BAD_SERVICE;
        goto ExitFunction;
    }
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "FOUND SERVICE IN INIT NOTFY: UDN %s, ServID: %s", UDN, servId);
 
    sub = GetSubscriptionSID(sid, service);
    if (sub == NULL || sub->active) {
        line = __LINE__;
        ret = GENA_E_BAD_SID;
        goto ExitFunction;
    }
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "FOUND SUBSCRIPTION IN INIT NOTIFY: SID %s", sid);
    sub->active = 1;
 
    headers = AllocGenaHeaders(propertySet);
    if (headers == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
        goto ExitFunction;
    }
 
    /* schedule thread for initial notification */
 
    thread_struct = (notify_thread_struct*)malloc(sizeof(notify_thread_struct));
    if (thread_struct == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
    } else {
        *reference_count = 1;
        thread_struct->servId = servId_copy;
        thread_struct->UDN = UDN_copy;
        thread_struct->headers = headers;
        thread_struct->propertySet = propertySet;
        memset(thread_struct->sid, 0, sizeof(thread_struct->sid));
        strncpy(thread_struct->sid, sid, sizeof(thread_struct->sid) - 1);
        thread_struct->ctime = time(0);
        thread_struct->reference_count = reference_count;
        thread_struct->device_handle = device_handle;
 
        TPJobInit(job, (UPnPsdk::start_routine)genaNotifyThread, thread_struct);
        TPJobSetFreeFunction(job, (free_routine)free_notify_struct);
        TPJobSetPriority(job, MED_PRIORITY);
 
        ret = ThreadPoolAdd(&gSendThreadPool, job, NULL);
        if (ret != 0) {
            if (ret == EOUTOFMEM) {
                line = __LINE__;
                ret = UPNP_E_OUTOF_MEMORY;
            }
        } else {
            ListNode* node = ListAddTail(&sub->outgoing, job);
            if (node != NULL) {
                ((ThreadPoolJob*)node->item)->jobId = STALE_JOBID;
                line = __LINE__;
                ret = GENA_SUCCESS;
            } else {
                line = __LINE__;
                ret = UPNP_E_OUTOF_MEMORY;
            }
        }
    }
 
ExitFunction:
    if (ret != GENA_SUCCESS) {
        free(job);
        free(thread_struct);
        free(headers);
        ixmlFreeDOMString(propertySet);
        free(servId_copy);
        free(UDN_copy);
        free(reference_count);
    }
 
    HandleUnlock();
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, line,
               "GENA END INITIAL NOTIFY COMMON, ret = %d\n", ret);
 
    return ret;
}
 
void maybeDiscardEvents(LinkedList* listp) {
    time_t now = time(0L);
    notify_thread_struct* ntsp;
    ThreadPoolJob* p;
 
    while (ListSize(listp) > 1) {
        ListNode* node = ListHead(listp);
        /* The first candidate is the second event: first non-active */
        if (node == 0 || (node = node->next) == 0) {
            /* Major inconsistency, really, should abort here. */
            fprintf(stderr, "gena_device: maybeDiscardEvents: "
                            "list is inconsistent\n");
            break;
        }
 
        p = (ThreadPoolJob*)node->item;
        ntsp = (notify_thread_struct*)(p->arg);
        if (ListSize(listp) > g_UpnpSdkEQMaxLen ||
            now - ntsp->ctime > g_UpnpSdkEQMaxAge) {
            free_notify_struct(ntsp);
            free(node->item);
            ListDelNode(listp, node, 0);
        } else {
            /* If the list is smaller than the max and the oldest
             * task is young enough, stop pruning */
            break;
        }
    }
}
 
int genaNotifyAllCommon(UpnpDevice_Handle device_handle, char* UDN,
                        char* servId, DOMString propertySet) {
    int ret = GENA_SUCCESS;
    int line = 0;
 
    int* reference_count = NULL;
    char* UDN_copy = NULL;
    char* servId_copy = NULL;
    char* headers = NULL;
    notify_thread_struct* thread_s = NULL;
 
    subscription* finger = NULL;
    service_info* service = NULL;
    struct Handle_Info* handle_info;
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "GENA BEGIN NOTIFY ALL COMMON\n");
 
    /* Keep this allocation first */
    reference_count = (int*)malloc(sizeof(int));
    if (reference_count == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
        goto ExitFunction;
    }
    *reference_count = 0;
 
    UDN_copy = strdup(UDN);
    if (UDN_copy == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
        goto ExitFunction;
    }
 
    servId_copy = strdup(servId);
    if (servId_copy == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
        goto ExitFunction;
    }
 
    headers = AllocGenaHeaders(propertySet);
    if (headers == NULL) {
        line = __LINE__;
        ret = UPNP_E_OUTOF_MEMORY;
        goto ExitFunction;
    }
 
    HandleLock();
 
    if (GetHandleInfo(device_handle, &handle_info) != HND_DEVICE) {
        line = __LINE__;
        ret = GENA_E_BAD_HANDLE;
    } else {
        service = FindServiceId(&handle_info->ServiceTable, servId, UDN);
        if (service != NULL) {
            finger = GetFirstSubscription(service);
            while (finger) {
                ThreadPoolJob* job = NULL;
                ListNode* node;
 
                thread_s =
                    (notify_thread_struct*)malloc(sizeof(notify_thread_struct));
                if (thread_s == NULL) {
                    line = __LINE__;
                    ret = UPNP_E_OUTOF_MEMORY;
                    break;
                }
 
                (*reference_count)++;
                thread_s->reference_count = reference_count;
                thread_s->UDN = UDN_copy;
                thread_s->servId = servId_copy;
                thread_s->headers = headers;
                thread_s->propertySet = propertySet;
                strncpy(thread_s->sid, finger->sid, sizeof thread_s->sid);
                thread_s->sid[sizeof thread_s->sid - 1] = 0;
                thread_s->ctime = time(0);
                thread_s->device_handle = device_handle;
 
                maybeDiscardEvents(&finger->outgoing);
                job = (ThreadPoolJob*)malloc(sizeof(ThreadPoolJob));
                if (!job) {
                    free(thread_s);
                    line = __LINE__;
                    ret = UPNP_E_OUTOF_MEMORY;
                    break;
                }
                memset(job, 0, sizeof(ThreadPoolJob));
                TPJobInit(job, (UPnPsdk::start_routine)genaNotifyThread,
                          thread_s);
                TPJobSetFreeFunction(job, (free_routine)free_notify_struct);
                TPJobSetPriority(job, MED_PRIORITY);
                node = ListAddTail(&finger->outgoing, job);
 
                /* If there is only one element on the list
                   (which we just
                   added), need to kickstart the threadpool */
                if (ListSize(&finger->outgoing) == 1) {
                    ret = ThreadPoolAdd(&gSendThreadPool, job, NULL);
                    if (ret != 0) {
                        line = __LINE__;
                        if (ret == EOUTOFMEM) {
                            line = __LINE__;
                            ret = UPNP_E_OUTOF_MEMORY;
                        }
                        break;
                    }
                    if (node) {
                        ((ThreadPoolJob*)(node->item))->jobId = STALE_JOBID;
                    }
                }
                finger = GetNextSubscription(service, finger);
            }
        } else {
            line = __LINE__;
            ret = GENA_E_BAD_SERVICE;
        }
    }
 
ExitFunction:
    /* The only case where we want to free memory here is if the
       struct was never queued. Else, let the normal cleanup take place.
       reference_count is allocated first so it's ok to do nothing if it's 0
    */
    if (reference_count && *reference_count == 0) {
        free(headers);
        ixmlFreeDOMString(propertySet);
        free(servId_copy);
        free(UDN_copy);
        free(reference_count);
    }
 
    HandleUnlock();
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, line,
               "GENA END NOTIFY ALL COMMON, ret = %d\n", ret);
 
    return ret;
}
 
int respond_ok(
    SOCKINFO* info,
    int time_out,
    subscription* sub,
    http_message_t* request) {
    int major;
    int minor;
    membuffer response;
    int return_code;
    char timeout_str[100];
    int upnp_timeout = UPNP_TIMEOUT;
    int rc = 0;
 
    http_CalcResponseVersion(request->major_version, request->minor_version,
                             &major, &minor);
 
    if (time_out >= 0) {
        rc = snprintf(timeout_str, sizeof(timeout_str), "TIMEOUT: Second-%d",
                      time_out);
    } else {
        memset(timeout_str, 0, sizeof(timeout_str));
        strncpy(timeout_str, "TIMEOUT: Second-infinite",
                sizeof(timeout_str) - 1);
    }
    if (rc < 0 || (unsigned int)rc >= sizeof(timeout_str)) {
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        return UPNP_E_OUTOF_MEMORY;
    }
 
    membuffer_init(&response);
    response.size_inc = 30;
    if (http_MakeMessage(&response, major, minor,
                         "R"
                         "D"
                         "S"
                         "N"
                         "Xc"
                         "ssc"
                         "scc",
                         HTTP_OK, (off_t)0, X_USER_AGENT, "SID: ", sub->sid,
                         timeout_str) != 0) {
        membuffer_destroy(&response);
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        return UPNP_E_OUTOF_MEMORY;
    }
 
    return_code = http_SendMessage(info, &upnp_timeout, "b", response.buf,
                                   response.length);
 
    membuffer_destroy(&response);
 
    return return_code;
}
 
} // namespace
 
 
int genaUnregisterDevice(UpnpDevice_Handle device_handle) {
    int ret = 0;
    struct Handle_Info* handle_info;
 
    HandleLock();
    if (GetHandleInfo(device_handle, &handle_info) != HND_DEVICE) {
        UpnpPrintf(UPNP_CRITICAL, GENA, __FILE__, __LINE__,
                   "genaUnregisterDevice: BAD Handle: %d\n", device_handle);
        ret = GENA_E_BAD_HANDLE;
    } else {
        freeServiceTable(&handle_info->ServiceTable);
        ret = UPNP_E_SUCCESS;
    }
    HandleUnlock();
 
    return ret;
}
 
void freeSubscriptionQueuedEvents(subscription* sub) {
    if (ListSize(&sub->outgoing) > 0) {
        /* The first event is discarded without dealing
           notify_thread_struct: there is a mirror ThreadPool entry for
           this one, and it will take care of the refcount etc. Other
           entries must be fully cleaned-up here */
        int first = 1;
        ListNode* node = ListHead(&sub->outgoing);
        while (node) {
            ThreadPoolJob* job = (ThreadPoolJob*)node->item;
            if (first) {
                first = 0;
            } else {
                free_notify_struct((notify_thread_struct*)job->arg);
            }
            free(node->item);
            ListDelNode(&sub->outgoing, node, 0);
            node = ListHead(&sub->outgoing);
        }
    }
}
 
 
int genaInitNotify(UpnpDevice_Handle device_handle, char* UDN, char* servId,
                   char** VarNames, char** VarValues, int var_count,
                   const Upnp_SID sid) {
    int ret = GENA_SUCCESS;
    int line = 0;
    DOMString propertySet = NULL;
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "GENA BEGIN INITIAL NOTIFY\n");
 
    if (var_count <= 0) {
        line = __LINE__;
        ret = GENA_SUCCESS;
        goto ExitFunction;
    }
 
    ret = GeneratePropertySet(VarNames, VarValues, var_count, &propertySet);
    if (ret != XML_SUCCESS) {
        line = __LINE__;
        goto ExitFunction;
    }
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "GENERATED PROPERTY SET IN INIT NOTIFY: %s", propertySet);
 
    ret = genaInitNotifyCommon(device_handle, UDN, servId, propertySet, sid);
 
ExitFunction:
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, line,
               "GENA END INITIAL NOTIFY, ret = %d\n", ret);
 
    return ret;
}
 
int genaInitNotifyExt(UpnpDevice_Handle device_handle, char* UDN, char* servId,
                      IXML_Document* PropSet, const Upnp_SID sid) {
    int ret = GENA_SUCCESS;
    int line = 0;
 
    DOMString propertySet = NULL;
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "GENA BEGIN INITIAL NOTIFY EXT\n");
 
    if (PropSet == 0) {
        line = __LINE__;
        ret = GENA_SUCCESS;
        goto ExitFunction;
    }
 
    propertySet = ixmlPrintNode((IXML_Node*)PropSet);
    if (propertySet == NULL) {
        line = __LINE__;
        ret = UPNP_E_INVALID_PARAM;
        goto ExitFunction;
    }
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "GENERATED PROPERTY SET IN INIT EXT NOTIFY: %s", propertySet);
 
    ret = genaInitNotifyCommon(device_handle, UDN, servId, propertySet, sid);
 
ExitFunction:
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, line,
               "GENA END INITIAL NOTIFY EXT, ret = %d\n", ret);
 
    return ret;
}
 
int genaNotifyAllExt(UpnpDevice_Handle device_handle, char* UDN, char* servId,
                     IXML_Document* PropSet) {
    int ret = GENA_SUCCESS;
    int line = 0;
 
    DOMString propertySet = NULL;
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "GENA BEGIN NOTIFY ALL EXT\n");
 
    propertySet = ixmlPrintNode((IXML_Node*)PropSet);
    if (propertySet == NULL) {
        line = __LINE__;
        ret = UPNP_E_INVALID_PARAM;
        goto ExitFunction;
    }
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "GENERATED PROPERTY SET IN EXT NOTIFY: %s", propertySet);
 
    ret = genaNotifyAllCommon(device_handle, UDN, servId, propertySet);
 
ExitFunction:
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, line,
               "GENA END NOTIFY ALL EXT, ret = %d\n", ret);
 
    return ret;
}
 
int genaNotifyAll(UpnpDevice_Handle device_handle, char* UDN, char* servId,
                  char** VarNames, char** VarValues, int var_count) {
    int ret = GENA_SUCCESS;
    int line = 0;
 
    DOMString propertySet = NULL;
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__, "GENA BEGIN NOTIFY ALL\n");
 
    ret = GeneratePropertySet(VarNames, VarValues, var_count, &propertySet);
    if (ret != XML_SUCCESS) {
        line = __LINE__;
        goto ExitFunction;
    }
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "GENERATED PROPERTY SET IN EXT NOTIFY: %s", propertySet);
 
    ret = genaNotifyAllCommon(device_handle, UDN, servId, propertySet);
 
ExitFunction:
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, line,
               "GENA END NOTIFY ALL, ret = %d\n", ret);
 
    return ret;
}
 
int gena_validate_delivery_urls(
    SOCKINFO* info,
    URL_list* url_list) {
    size_t i = 0;
    struct in_addr genaAddr4;
    struct in_addr genaNetmask;
    struct sockaddr_in* deliveryAddr4 = NULL;
    struct in6_addr genaAddr6Lla;
    struct in6_addr genaAddr6UlaGua;
    struct in6_addr* genaAddr6 = NULL;
    unsigned int if_prefix;
    struct sockaddr_in6* deliveryAddr6 = NULL;
    char deliveryAddrString[INET6_ADDRSTRLEN];
 
    if (info == NULL || url_list == NULL) {
        return 0;
    }
 
    switch (info->foreign_sockaddr.ss_family) {
    case AF_INET:
        if (!inet_pton(AF_INET, gIF_IPV4, &genaAddr4)) {
            return -1;
        }
 
        if (!inet_pton(AF_INET, gIF_IPV4_NETMASK, &genaNetmask)) {
            return -1;
        }
 
        for (i = 0; i < url_list->size; i++) {
            deliveryAddr4 = (struct sockaddr_in*)&url_list->parsedURLs[i]
                                .hostport.IPaddress;
            if ((deliveryAddr4->sin_addr.s_addr & genaNetmask.s_addr) !=
                (genaAddr4.s_addr & genaNetmask.s_addr)) {
                inet_ntop(AF_INET, &deliveryAddr4->sin_addr, deliveryAddrString,
                          sizeof(deliveryAddrString));
                UpnpPrintf(UPNP_CRITICAL, GENA, __FILE__, __LINE__,
                           "DeliveryURL %s is invalid.\n"
                           "It is not in the expected network "
                           "segment (IPv4: %s, netmask: %s)\n",
                           deliveryAddrString, gIF_IPV4, gIF_IPV4_NETMASK);
                return -1;
            }
        }
        break;
    case AF_INET6:
        if (!inet_pton(AF_INET6, gIF_IPV6, &genaAddr6Lla)) {
            return -1;
        }
 
        if (!inet_pton(AF_INET6, gIF_IPV6_ULA_GUA, &genaAddr6UlaGua)) {
            return -1;
        }
 
        for (i = 0; i < url_list->size; i++) {
            deliveryAddr6 = (struct sockaddr_in6*)&url_list->parsedURLs[i]
                                .hostport.IPaddress;
            if (IN6_IS_ADDR_LINKLOCAL(&deliveryAddr6->sin6_addr)) {
                genaAddr6 = &genaAddr6Lla;
                if_prefix = gIF_IPV6_PREFIX_LENGTH;
            } else {
                genaAddr6 = &genaAddr6UlaGua;
                if_prefix = gIF_IPV6_ULA_GUA_PREFIX_LENGTH;
            }
            /* We assume that IPv6 prefix is a multiple of 8 */
            if (memcmp(deliveryAddr6->sin6_addr.s6_addr, genaAddr6->s6_addr,
                       if_prefix / 8)) {
                inet_ntop(AF_INET6, &deliveryAddr6->sin6_addr,
                          deliveryAddrString, sizeof(deliveryAddrString));
                UpnpPrintf(UPNP_CRITICAL, GENA, __FILE__, __LINE__,
                           "DeliveryURL %s is invalid.\n"
                           "It is not in the expected network "
                           "segment (IPv6: %s, prefix: %d)\n",
                           deliveryAddrString,
                           IN6_IS_ADDR_LINKLOCAL(&deliveryAddr6->sin6_addr)
                               ? gIF_IPV6
                               : gIF_IPV6_ULA_GUA,
                           if_prefix);
                return -1;
            }
        }
        break;
    }
    return 0;
}
 
void gena_process_subscription_request(SOCKINFO* info,
                                       http_message_t* request) {
    UpnpSubscriptionRequest* request_struct = UpnpSubscriptionRequest_new();
    Upnp_SID temp_sid;
    int return_code = 1;
    int time_out = 1801;
    service_info* service;
    subscription* sub;
    uuid_upnp uid;
    struct Handle_Info* handle_info;
    void* cookie;
    Upnp_FunPtr callback_fun;
    UpnpDevice_Handle device_handle;
    memptr nt_hdr;
    char* event_url_path = NULL;
    memptr callback_hdr;
    memptr timeout_hdr;
    int rc = 0;
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "Subscription Request Received:\n");
 
    if (httpmsg_find_hdr(request, HDR_NT, &nt_hdr) == NULL) {
        error_respond(info, HTTP_BAD_REQUEST, request);
        goto exit_function;
    }
 
    /* check NT header */
    /* Windows Millenium Interoperability: */
    /* we accept either upnp:event, or upnp:propchange for the NT header */
    if (memptr_cmp_nocase(&nt_hdr, "upnp:event") != 0) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        goto exit_function;
    }
 
    /* if a SID is present then the we have a bad request "incompatible
     * headers" */
    if (httpmsg_find_hdr(request, HDR_SID, NULL) != NULL) {
        error_respond(info, HTTP_BAD_REQUEST, request);
        goto exit_function;
    }
    /* look up service by eventURL */
    event_url_path =
        str_alloc(request->uri.pathquery.buff, request->uri.pathquery.size);
    if (event_url_path == NULL) {
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        goto exit_function;
    }
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "SubscriptionRequest for event URL path: %s\n", event_url_path);
 
    HandleLock();
 
    if (GetDeviceHandleInfoForPath(
            event_url_path, info->foreign_sockaddr.ss_family, &device_handle,
            &handle_info, &service) != HND_DEVICE) {
        free(event_url_path);
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        HandleUnlock();
        goto exit_function;
    }
    free(event_url_path);
 
    if (service == NULL || !service->active) {
        error_respond(info, HTTP_NOT_FOUND, request);
        HandleUnlock();
        goto exit_function;
    }
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "Subscription Request: Number of Subscriptions already %d\n "
               "Max Subscriptions allowed: %d\n",
               service->TotalSubscriptions, handle_info->MaxSubscriptions);
 
    /* too many subscriptions */
    if (handle_info->MaxSubscriptions != -1 &&
        service->TotalSubscriptions >= handle_info->MaxSubscriptions) {
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        HandleUnlock();
        goto exit_function;
    }
    /* generate new subscription */
    sub = (subscription*)malloc(sizeof(subscription));
    if (sub == NULL) {
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        HandleUnlock();
        goto exit_function;
    }
    sub->ToSendEventKey = 0;
    sub->active = 0;
    sub->next = NULL;
    sub->DeliveryURLs.size = 0;
    sub->DeliveryURLs.URLs = NULL;
    sub->DeliveryURLs.parsedURLs = NULL;
    if (ListInit(&sub->outgoing, 0, free) != 0) {
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        HandleUnlock();
        goto exit_function;
    }
 
    /* check for valid callbacks */
    if (httpmsg_find_hdr(request, HDR_CALLBACK, &callback_hdr) == NULL) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        freeSubscriptionList(sub);
        HandleUnlock();
        goto exit_function;
    }
    return_code = create_url_list(&callback_hdr, &sub->DeliveryURLs);
    if (return_code == 0) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        freeSubscriptionList(sub);
        HandleUnlock();
        goto exit_function;
    }
    if (return_code == UPNP_E_OUTOF_MEMORY) {
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        freeSubscriptionList(sub);
        HandleUnlock();
        goto exit_function;
    }
    return_code = gena_validate_delivery_urls(info, &sub->DeliveryURLs);
    if (return_code != 0) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        freeSubscriptionList(sub);
        HandleUnlock();
        goto exit_function;
    }
    /* set the timeout */
    if (httpmsg_find_hdr(request, HDR_TIMEOUT, &timeout_hdr) != NULL) {
        if (matchstr(timeout_hdr.buf, timeout_hdr.length, "%iSecond-%d%0",
                     &time_out) == PARSE_OK) {
            /* nothing */
        } else if (memptr_cmp_nocase(&timeout_hdr, "Second-infinite") == 0) {
            /* infinite timeout */
            time_out = -1;
        } else {
            /* default is > 1800 seconds */
            time_out = DEFAULT_TIMEOUT;
        }
    }
    /* replace infinite timeout with max timeout, if possible */
    if (handle_info->MaxSubscriptionTimeOut != -1) {
        if (time_out == -1 || time_out > handle_info->MaxSubscriptionTimeOut) {
            time_out = handle_info->MaxSubscriptionTimeOut;
        }
    }
    if (time_out >= 0) {
        sub->expireTime = time(NULL) + time_out;
    } else {
        /* infinite time */
        sub->expireTime = 0;
    }
 
    /* generate SID */
    uuid_create(&uid);
    upnp_uuid_unpack(&uid, temp_sid);
    rc = snprintf(sub->sid, sizeof(sub->sid), "uuid:%s", temp_sid);
 
    /* respond OK */
    if (rc < 0 || (unsigned int)rc >= sizeof(sub->sid) ||
        (respond_ok(info, time_out, sub, request) != UPNP_E_SUCCESS)) {
        freeSubscriptionList(sub);
        HandleUnlock();
        goto exit_function;
    }
    /* add to subscription list */
    sub->next = service->subscriptionList;
    service->subscriptionList = sub;
    service->TotalSubscriptions++;
 
    /* finally generate callback for init table dump */
    UpnpSubscriptionRequest_strcpy_ServiceId(request_struct,
                                             service->serviceId);
    UpnpSubscriptionRequest_strcpy_UDN(request_struct, service->UDN);
    UpnpSubscriptionRequest_strcpy_SID(request_struct, sub->sid);
 
    /* copy callback */
    callback_fun = handle_info->Callback;
    cookie = handle_info->Cookie;
 
    HandleUnlock();
 
    /* make call back with request struct */
    /* in the future should find a way of mainting that the handle */
    /* is not unregistered in the middle of a callback */
    callback_fun(UPNP_EVENT_SUBSCRIPTION_REQUEST, request_struct, cookie);
 
exit_function:
    UpnpSubscriptionRequest_delete(request_struct);
}
 
void gena_process_subscription_renewal_request(SOCKINFO* info,
                                               http_message_t* request) {
    Upnp_SID sid;
    subscription* sub;
    int time_out = 1801;
    service_info* service;
    struct Handle_Info* handle_info;
    UpnpDevice_Handle device_handle;
    memptr temp_hdr;
    membuffer event_url_path;
    memptr timeout_hdr;
 
    /* if a CALLBACK or NT header is present, then it is an error */
    if (httpmsg_find_hdr(request, HDR_CALLBACK, NULL) != NULL ||
        httpmsg_find_hdr(request, HDR_NT, NULL) != NULL) {
        error_respond(info, HTTP_BAD_REQUEST, request);
        return;
    }
    /* get SID */
    if (httpmsg_find_hdr(request, HDR_SID, &temp_hdr) == NULL ||
        temp_hdr.length > SID_SIZE) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        return;
    }
    memcpy(sid, temp_hdr.buf, temp_hdr.length);
    sid[temp_hdr.length] = '\0';
 
    /* lookup service by eventURL */
    membuffer_init(&event_url_path);
    if (membuffer_append(&event_url_path, request->uri.pathquery.buff,
                         request->uri.pathquery.size) != 0) {
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        return;
    }
 
    HandleLock();
 
    if (GetDeviceHandleInfoForPath(
            event_url_path.buf, info->foreign_sockaddr.ss_family,
            &device_handle, &handle_info, &service) != HND_DEVICE) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        membuffer_destroy(&event_url_path);
        HandleUnlock();
        return;
    }
    membuffer_destroy(&event_url_path);
 
    /* get subscription */
    if (service == NULL || !service->active ||
        ((sub = GetSubscriptionSID(sid, service)) == NULL)) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        HandleUnlock();
        return;
    }
 
    UpnpPrintf(UPNP_INFO, GENA, __FILE__, __LINE__,
               "Renew request: Number of subscriptions already: %d\n "
               "Max Subscriptions allowed:%d\n",
               service->TotalSubscriptions, handle_info->MaxSubscriptions);
    /* too many subscriptions */
    if (handle_info->MaxSubscriptions != -1 &&
        service->TotalSubscriptions > handle_info->MaxSubscriptions) {
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        RemoveSubscriptionSID(sub->sid, service);
        HandleUnlock();
        return;
    }
    /* set the timeout */
    if (httpmsg_find_hdr(request, HDR_TIMEOUT, &timeout_hdr) != NULL) {
        if (matchstr(timeout_hdr.buf, timeout_hdr.length, "%iSecond-%d%0",
                     &time_out) == PARSE_OK) {
 
            /*nothing */
 
        } else if (memptr_cmp_nocase(&timeout_hdr, "Second-infinite") == 0) {
 
            time_out = -1; /* inifinite timeout */
 
        } else {
            time_out = DEFAULT_TIMEOUT; /* default is > 1800 seconds */
        }
    }
 
    /* replace infinite timeout with max timeout, if possible */
    if (handle_info->MaxSubscriptionTimeOut != -1) {
        if (time_out == -1 || time_out > handle_info->MaxSubscriptionTimeOut) {
            time_out = handle_info->MaxSubscriptionTimeOut;
        }
    }
 
    if (time_out == -1) {
        sub->expireTime = 0;
    } else {
        sub->expireTime = time(NULL) + time_out;
    }
 
    if (respond_ok(info, time_out, sub, request) != UPNP_E_SUCCESS) {
        RemoveSubscriptionSID(sub->sid, service);
    }
 
    HandleUnlock();
}
 
void gena_process_unsubscribe_request(SOCKINFO* info, http_message_t* request) {
    Upnp_SID sid;
    service_info* service;
    struct Handle_Info* handle_info;
    UpnpDevice_Handle device_handle;
 
    memptr temp_hdr;
    membuffer event_url_path;
 
    /* if a CALLBACK or NT header is present, then it is an error */
    if (httpmsg_find_hdr(request, HDR_CALLBACK, NULL) != NULL ||
        httpmsg_find_hdr(request, HDR_NT, NULL) != NULL) {
        error_respond(info, HTTP_BAD_REQUEST, request);
        return;
    }
    /* get SID */
    if (httpmsg_find_hdr(request, HDR_SID, &temp_hdr) == NULL ||
        temp_hdr.length > SID_SIZE) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        return;
    }
    memcpy(sid, temp_hdr.buf, temp_hdr.length);
    sid[temp_hdr.length] = '\0';
 
    /* lookup service by eventURL */
    membuffer_init(&event_url_path);
    if (membuffer_append(&event_url_path, request->uri.pathquery.buff,
                         request->uri.pathquery.size) != 0) {
        error_respond(info, HTTP_INTERNAL_SERVER_ERROR, request);
        return;
    }
 
    HandleLock();
 
    if (GetDeviceHandleInfoForPath(
            event_url_path.buf, info->foreign_sockaddr.ss_family,
            &device_handle, &handle_info, &service) != HND_DEVICE) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        membuffer_destroy(&event_url_path);
        HandleUnlock();
        return;
    }
    membuffer_destroy(&event_url_path);
 
    /* validate service */
    if (service == NULL || !service->active ||
        GetSubscriptionSID(sid, service) == NULL) {
        error_respond(info, HTTP_PRECONDITION_FAILED, request);
        HandleUnlock();
        return;
    }
 
    RemoveSubscriptionSID(sid, service);
    error_respond(info, HTTP_OK, request); /* success */
 
    HandleUnlock();
}