soap_device: Doxygen and code reformat.
This commit is contained in:
Marcelo Roberto Jimenez
parent
57e9584f4e
commit
0977f8864d
@ -32,31 +32,25 @@
|
||||
#ifndef SOAPLIB_H
|
||||
#define SOAPLIB_H
|
||||
|
||||
/*!
|
||||
* \file
|
||||
*/
|
||||
|
||||
/* SOAP module API to be called in Upnp-Dk API */
|
||||
|
||||
|
||||
/****************************************************************************
|
||||
* Function: soap_device_callback
|
||||
*
|
||||
* Parameters:
|
||||
* IN http_parser_t *parser: Parsed request received by the device
|
||||
* IN http_message_t* request: HTTP request
|
||||
* INOUT SOCKINFO *info: socket info
|
||||
*
|
||||
* Description: This is a callback called by minisever after receiving
|
||||
* the request from the control point. This function will start
|
||||
* processing the request. It calls handle_invoke_action to handle the
|
||||
* SOAP action
|
||||
*
|
||||
* Return: void
|
||||
*
|
||||
* Note:
|
||||
****************************************************************************/
|
||||
/*!
|
||||
* \brief This is a callback called by minisever after receiving the request
|
||||
* from the control point. This function will start processing the request.
|
||||
* It calls handle_invoke_action to handle the SOAP action.
|
||||
*/
|
||||
void soap_device_callback(
|
||||
IN http_parser_t *parser,
|
||||
IN http_message_t* request,
|
||||
INOUT SOCKINFO *info);
|
||||
/*! [in] Parsed request received by the device. */
|
||||
http_parser_t *parser,
|
||||
/*! [in] HTTP request. */
|
||||
http_message_t *request,
|
||||
/*! [in,out] Socket info. */
|
||||
SOCKINFO *info);
|
||||
|
||||
|
||||
/****************************************************************************
|
||||
|
||||
@ -38,12 +38,6 @@
|
||||
#ifdef INCLUDE_DEVICE_APIS
|
||||
#if EXCLUDE_SOAP == 0
|
||||
|
||||
#define SOAP_BODY "Body"
|
||||
#define SOAP_URN "http:/""/schemas.xmlsoap.org/soap/envelope/"
|
||||
|
||||
#define QUERY_STATE_VAR_URN "urn:schemas-upnp-org:control-1-0"
|
||||
|
||||
|
||||
#include "ActionRequest.h"
|
||||
#include "httpparser.h"
|
||||
#include "httpreadwrite.h"
|
||||
@ -70,8 +64,11 @@
|
||||
#define SOAP_INVALID_VAR 404
|
||||
#define SOAP_ACTION_FAILED 501
|
||||
|
||||
static const char *Soap_Invalid_Action = "Invalid Action";
|
||||
static const char *SOAP_BODY = "Body";
|
||||
static const char *SOAP_URN = "http:/""/schemas.xmlsoap.org/soap/envelope/";
|
||||
static const char *QUERY_STATE_VAR_URN = "urn:schemas-upnp-org:control-1-0";
|
||||
|
||||
static const char *Soap_Invalid_Action = "Invalid Action";
|
||||
/*static const char* Soap_Invalid_Args = "Invalid Args"; */
|
||||
static const char *Soap_Action_Failed = "Action Failed";
|
||||
static const char *Soap_Invalid_Var = "Invalid Var";
|
||||
@ -154,25 +151,17 @@ static UPNP_INLINE int get_request_type(
|
||||
return 0;
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : send_error_response
|
||||
*
|
||||
* Parameters :
|
||||
* IN SOCKINFO *info : socket info
|
||||
* IN int error_code : error code
|
||||
* IN const char* err_msg : error message
|
||||
* IN http_message_t* hmsg : HTTP request
|
||||
*
|
||||
* Description : This function sends SOAP error response
|
||||
*
|
||||
* Return : void
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
static void
|
||||
send_error_response( IN SOCKINFO * info,
|
||||
/*!
|
||||
* \brief Sends SOAP error response.
|
||||
*/
|
||||
static void send_error_response(
|
||||
/*! [in] Socket info. */
|
||||
IN SOCKINFO *info,
|
||||
/*! [in] Error code. */
|
||||
IN int error_code,
|
||||
/*! [in] Error message. */
|
||||
IN const char *err_msg,
|
||||
/*! [in] HTTP request. */
|
||||
IN http_message_t *hmsg)
|
||||
{
|
||||
off_t content_length;
|
||||
@ -191,24 +180,29 @@ send_error_response( IN SOCKINFO * info,
|
||||
"<detail>\n"
|
||||
"<UPnPError xmlns=\"urn:schemas-upnp-org:control-1-0\">\n"
|
||||
"<errorCode>";
|
||||
const char *mid_body = "</errorCode>\n" "<errorDescription>";
|
||||
const char *mid_body =
|
||||
"</errorCode>\n"
|
||||
"<errorDescription>";
|
||||
const char *end_body =
|
||||
"</errorDescription>\n"
|
||||
"</UPnPError>\n"
|
||||
"</detail>\n" "</s:Fault>\n" "</s:Body>\n" "</s:Envelope>\n";
|
||||
"</detail>\n"
|
||||
"</s:Fault>\n"
|
||||
"</s:Body>\n"
|
||||
"</s:Envelope>\n";
|
||||
char err_code_str[30];
|
||||
membuffer headers;
|
||||
|
||||
sprintf(err_code_str, "%d", error_code);
|
||||
/* calc body len */
|
||||
content_length = (off_t) (strlen(start_body) + strlen(err_code_str) +
|
||||
strlen(mid_body) + strlen(err_msg) + strlen(end_body));
|
||||
strlen(mid_body) + strlen(err_msg) +
|
||||
strlen(end_body));
|
||||
http_CalcResponseVersion(hmsg->major_version, hmsg->minor_version,
|
||||
&major, &minor);
|
||||
/* make headers */
|
||||
membuffer_init(&headers);
|
||||
if (http_MakeMessage(
|
||||
&headers, major, minor,
|
||||
if (http_MakeMessage(&headers, major, minor,
|
||||
"RNsDsSXcc" "sssss",
|
||||
500,
|
||||
content_length,
|
||||
@ -218,7 +212,8 @@ send_error_response( IN SOCKINFO * info,
|
||||
start_body, err_code_str, mid_body, err_msg,
|
||||
end_body) != 0) {
|
||||
membuffer_destroy(&headers);
|
||||
return; /* out of mem */
|
||||
/* out of mem */
|
||||
return;
|
||||
}
|
||||
/* send err msg */
|
||||
http_SendMessage(info, &timeout_secs, "b",
|
||||
@ -226,24 +221,16 @@ send_error_response( IN SOCKINFO * info,
|
||||
membuffer_destroy(&headers);
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : send_var_query_response
|
||||
*
|
||||
* Parameters :
|
||||
* IN SOCKINFO *info : socket info
|
||||
* IN const char* var_value : value of the state variable
|
||||
* IN http_message_t* hmsg : HTTP request
|
||||
*
|
||||
* Description : This function sends response of get var status
|
||||
*
|
||||
* Return : void
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
static UPNP_INLINE void
|
||||
send_var_query_response( IN SOCKINFO * info,
|
||||
IN const char *var_value,
|
||||
IN http_message_t * hmsg )
|
||||
/*!
|
||||
* \brief Sends response of get var status.
|
||||
*/
|
||||
static UPNP_INLINE void send_var_query_response(
|
||||
/*! [in] Socket info. */
|
||||
SOCKINFO *info,
|
||||
/*! [in] Value of the state variable. */
|
||||
const char *var_value,
|
||||
/*! [in] HTTP request. */
|
||||
http_message_t *hmsg)
|
||||
{
|
||||
off_t content_length;
|
||||
int timeout_secs = SOAP_TIMEOUT;
|
||||
@ -258,8 +245,7 @@ send_var_query_response( IN SOCKINFO * info,
|
||||
"xmlns:u=\"urn:schemas-upnp-org:control-1-0\">\n" "<return>";
|
||||
const char *end_body =
|
||||
"</return>\n"
|
||||
"</u:QueryStateVariableResponse>\n"
|
||||
"</s:Body>\n" "</s:Envelope>\n";
|
||||
"</u:QueryStateVariableResponse>\n" "</s:Body>\n" "</s:Envelope>\n";
|
||||
membuffer response;
|
||||
|
||||
http_CalcResponseVersion(hmsg->major_version, hmsg->minor_version,
|
||||
@ -268,8 +254,7 @@ send_var_query_response( IN SOCKINFO * info,
|
||||
strlen(end_body));
|
||||
/* make headers */
|
||||
membuffer_init(&response);
|
||||
if (http_MakeMessage(
|
||||
&response, major, minor,
|
||||
if (http_MakeMessage(&response, major, minor,
|
||||
"RNsDsSXcc" "sss",
|
||||
HTTP_OK,
|
||||
content_length,
|
||||
@ -278,7 +263,8 @@ send_var_query_response( IN SOCKINFO * info,
|
||||
X_USER_AGENT,
|
||||
start_body, var_value, end_body) != 0) {
|
||||
membuffer_destroy(&response);
|
||||
return; /* out of mem */
|
||||
/* out of mem */
|
||||
return;
|
||||
}
|
||||
/* send msg */
|
||||
http_SendMessage(info, &timeout_secs, "b",
|
||||
@ -286,26 +272,18 @@ send_var_query_response( IN SOCKINFO * info,
|
||||
membuffer_destroy(&response);
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : get_action_node
|
||||
/*!
|
||||
* \brief Separates the action node from the root DOM node.
|
||||
*
|
||||
* Parameters :
|
||||
* IN IXML_Document *TempDoc : The root DOM node.
|
||||
* IN char *NodeName : IXML_Node name to be searched.
|
||||
* OUT IXML_Document ** RespNode : Response/Output node.
|
||||
*
|
||||
* Description : This function separates the action node from
|
||||
* the root DOM node.
|
||||
*
|
||||
* Return : static UPNP_INLINE int
|
||||
* 0 if successful, or -1 if fails.
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
static UPNP_INLINE int
|
||||
get_action_node( IN IXML_Document * TempDoc,
|
||||
IN char *NodeName,
|
||||
OUT IXML_Document ** RespNode )
|
||||
* \return 0 if successful, or -1 if fails.
|
||||
*/
|
||||
static UPNP_INLINE int get_action_node(
|
||||
/*! [in] The root DOM node. */
|
||||
IXML_Document *TempDoc,
|
||||
/*! [in] IXML_Node name to be searched. */
|
||||
char *NodeName,
|
||||
/*! [out] Response/Output node. */
|
||||
IXML_Document **RespNode)
|
||||
{
|
||||
IXML_Node *EnvpNode = NULL;
|
||||
IXML_Node *BodyNode = NULL;
|
||||
@ -317,46 +295,32 @@ get_action_node( IN IXML_Document * TempDoc,
|
||||
|
||||
UpnpPrintf(UPNP_INFO, SOAP, __FILE__, __LINE__,
|
||||
"get_action_node(): node name =%s\n ", NodeName);
|
||||
|
||||
*RespNode = NULL;
|
||||
|
||||
/* Got the Envelope node here */
|
||||
EnvpNode = ixmlNode_getFirstChild((IXML_Node *) TempDoc);
|
||||
if( EnvpNode == NULL ) {
|
||||
if (!EnvpNode)
|
||||
goto error_handler;
|
||||
}
|
||||
|
||||
nl = ixmlElement_getElementsByTagNameNS((IXML_Element *)EnvpNode,
|
||||
"*", "Body");
|
||||
|
||||
if( nl == NULL ) {
|
||||
if (!nl)
|
||||
goto error_handler;
|
||||
}
|
||||
|
||||
BodyNode = ixmlNodeList_item(nl, 0);
|
||||
|
||||
if( BodyNode == NULL ) {
|
||||
if (!BodyNode)
|
||||
goto error_handler;
|
||||
}
|
||||
/* Got action node here */
|
||||
ActNode = ixmlNode_getFirstChild(BodyNode);
|
||||
if( ActNode == NULL ) {
|
||||
if (!ActNode)
|
||||
goto error_handler;
|
||||
}
|
||||
/* Test whether this is the action node */
|
||||
nodeName = ixmlNode_getNodeName(ActNode);
|
||||
if( nodeName == NULL ) {
|
||||
if (!nodeName)
|
||||
goto error_handler;
|
||||
}
|
||||
|
||||
if( strstr( nodeName, NodeName ) == NULL ) {
|
||||
if (!strstr(nodeName, NodeName))
|
||||
goto error_handler;
|
||||
} else {
|
||||
else {
|
||||
ActNodeName = ixmlPrintNode(ActNode);
|
||||
if( ActNodeName == NULL ) {
|
||||
if (!ActNodeName)
|
||||
goto error_handler;
|
||||
}
|
||||
|
||||
ret_code = ixmlParseBufferEx(ActNodeName, RespNode);
|
||||
if (ret_code != IXML_SUCCESS) {
|
||||
ixmlFreeDOMString(ActNodeName);
|
||||
@ -364,37 +328,27 @@ get_action_node( IN IXML_Document * TempDoc,
|
||||
goto error_handler;
|
||||
}
|
||||
}
|
||||
|
||||
ret_code = 0; /* success */
|
||||
/* success */
|
||||
ret_code = 0;
|
||||
|
||||
error_handler:
|
||||
|
||||
ixmlFreeDOMString(ActNodeName);
|
||||
|
||||
if (nl)
|
||||
ixmlNodeList_free(nl);
|
||||
return ret_code;
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : check_soap_body
|
||||
/*!
|
||||
* \brief Checks the soap body xml came in the SOAP request.
|
||||
*
|
||||
* Parameters :
|
||||
* IN IXML_Document *doc : soap body xml document
|
||||
* IN const char *urn :
|
||||
* IN const char *actionName : Name of the requested action
|
||||
*
|
||||
* Description : This function checks the soap body xml came in the
|
||||
* SOAP request.
|
||||
*
|
||||
* Return : int
|
||||
* UPNP_E_SUCCESS if successful else returns appropriate error
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
static int
|
||||
check_soap_body( IN IXML_Document * doc,
|
||||
* \return UPNP_E_SUCCESS if successful else returns appropriate error.
|
||||
*/
|
||||
static int check_soap_body(
|
||||
/* [in] soap body xml document. */
|
||||
IN IXML_Document *doc,
|
||||
/* [in] URN. */
|
||||
IN const char *urn,
|
||||
/* [in] Name of the requested action. */
|
||||
IN const char *actionName)
|
||||
{
|
||||
IXML_NodeList *nl = NULL;
|
||||
@ -402,11 +356,9 @@ check_soap_body( IN IXML_Document * doc,
|
||||
IXML_Node *actionNode = NULL;
|
||||
const DOMString ns = NULL;
|
||||
const DOMString name = NULL;
|
||||
|
||||
int ret_code = UPNP_E_INVALID_ACTION;
|
||||
|
||||
nl = ixmlDocument_getElementsByTagNameNS(doc, SOAP_URN, SOAP_BODY);
|
||||
|
||||
if (nl) {
|
||||
bodyNode = ixmlNodeList_item(nl, 0);
|
||||
if (bodyNode) {
|
||||
@ -414,39 +366,31 @@ check_soap_body( IN IXML_Document * doc,
|
||||
if (actionNode) {
|
||||
ns = ixmlNode_getNamespaceURI(actionNode);
|
||||
name = ixmlNode_getLocalName(actionNode);
|
||||
if (name && ns &&
|
||||
if (name &&
|
||||
ns &&
|
||||
!strcmp(actionName, name) &&
|
||||
!strcmp( urn, ns ) ) {
|
||||
!strcmp(urn, ns))
|
||||
ret_code = UPNP_E_SUCCESS;
|
||||
}
|
||||
}
|
||||
}
|
||||
ixmlNodeList_free(nl);
|
||||
}
|
||||
return ret_code;
|
||||
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : check_soap_action_header
|
||||
/*!
|
||||
* \brief Checks the HTTP header of the SOAP request coming from the
|
||||
* control point.
|
||||
*
|
||||
* Parameters :
|
||||
* IN http_message_t *request : HTTP request
|
||||
* IN const char *urn :
|
||||
* OUT char **actionName : name of the SOAP action
|
||||
*
|
||||
* Description : This function checks the HTTP header of the SOAP request
|
||||
* coming from the control point
|
||||
*
|
||||
* Return : static int
|
||||
* UPNP_E_SUCCESS if successful else returns appropriate error
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
static int
|
||||
check_soap_action_header( IN http_message_t * request,
|
||||
IN const char *urn,
|
||||
OUT char **actionName )
|
||||
* \return UPNP_E_SUCCESS if successful else returns appropriate error.
|
||||
*/
|
||||
static int check_soap_action_header(
|
||||
/*! [in] HTTP request. */
|
||||
http_message_t * request,
|
||||
/*! [in] URN. */
|
||||
const char *urn,
|
||||
/*! [out] Name of the SOAP action. */
|
||||
char **actionName)
|
||||
{
|
||||
memptr header_name;
|
||||
http_header_t *soap_action_header = NULL;
|
||||
@ -516,44 +460,37 @@ check_soap_action_header( IN http_message_t * request,
|
||||
return ret_code;
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : get_device_info
|
||||
/*!
|
||||
* \brief Retrives all the information needed to process the incoming SOAP
|
||||
* request. It finds the device and service info and also the callback
|
||||
* function to hand-over the request to the device application.
|
||||
*
|
||||
* Parameters :
|
||||
* IN http_message_t* request : HTTP request
|
||||
* IN int isQuery : flag for a querry
|
||||
* IN IXML_Document *actionDoc : action request document
|
||||
* OUT UpnpString *device_udn : Device UDN string
|
||||
* OUT UpnpString *service_id : Service ID string
|
||||
* OUT Upnp_FunPtr *callback : callback function of the device
|
||||
* application
|
||||
* OUT void** cookie : cookie stored by device application
|
||||
*
|
||||
* Description : This function retrives all the information needed to
|
||||
* process the incoming SOAP request. It finds the device and service info
|
||||
* and also the callback function to hand-over the request to the device
|
||||
* application.
|
||||
*
|
||||
* Return : int
|
||||
* UPNP_E_SUCCESS if successful else returns appropriate error
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
static int
|
||||
get_device_info( IN http_message_t *request,
|
||||
IN int isQuery,
|
||||
IN IXML_Document *actionDoc,
|
||||
IN int AddressFamily,
|
||||
* \return UPNP_E_SUCCESS if successful else returns appropriate error.
|
||||
*/
|
||||
static int get_device_info(
|
||||
/*! [in] HTTP request. */
|
||||
http_message_t *request,
|
||||
/*! [in] flag for a querry. */
|
||||
int isQuery,
|
||||
/*! [in] Action request document. */
|
||||
IXML_Document *actionDoc,
|
||||
/*! [in] . */
|
||||
int AddressFamily,
|
||||
/*! [out] Device UDN string. */
|
||||
OUT UpnpString *device_udn,
|
||||
OUT UpnpString *service_id,
|
||||
OUT Upnp_FunPtr *callback,
|
||||
OUT void **cookie )
|
||||
/*! [out] Service ID string. */
|
||||
UpnpString *service_id,
|
||||
/*! [out] callback function of the device application. */
|
||||
Upnp_FunPtr *callback,
|
||||
/*! [out] cookie stored by device application. */
|
||||
void **cookie)
|
||||
{
|
||||
struct Handle_Info *device_info;
|
||||
int device_hnd;
|
||||
service_info *serv_info;
|
||||
char save_char;
|
||||
int ret_code = -1; /* error by default */
|
||||
/* error by default */
|
||||
int ret_code = -1;
|
||||
const char *control_url;
|
||||
char *actionName = NULL;
|
||||
|
||||
@ -564,44 +501,37 @@ get_device_info( IN http_message_t *request,
|
||||
|
||||
HandleLock();
|
||||
|
||||
if( GetDeviceHandleInfo( AddressFamily,
|
||||
&device_hnd, &device_info ) != HND_DEVICE ) {
|
||||
if (GetDeviceHandleInfo(AddressFamily, &device_hnd,
|
||||
&device_info) != HND_DEVICE)
|
||||
goto error_handler;
|
||||
}
|
||||
|
||||
if( ( serv_info =
|
||||
FindServiceControlURLPath( &device_info->ServiceTable,
|
||||
control_url ) ) == NULL ) {
|
||||
serv_info = FindServiceControlURLPath(
|
||||
&device_info->ServiceTable, control_url);
|
||||
if (!serv_info)
|
||||
goto error_handler;
|
||||
}
|
||||
|
||||
if (isQuery) {
|
||||
ret_code = check_soap_action_header( request, QUERY_STATE_VAR_URN,
|
||||
&actionName );
|
||||
if( ( ret_code != UPNP_E_SUCCESS )
|
||||
&& ( ret_code != UPNP_E_OUTOF_MEMORY ) ) {
|
||||
ret_code = check_soap_action_header(request,
|
||||
QUERY_STATE_VAR_URN, &actionName);
|
||||
if (ret_code != UPNP_E_SUCCESS &&
|
||||
ret_code != UPNP_E_OUTOF_MEMORY) {
|
||||
ret_code = UPNP_E_INVALID_ACTION;
|
||||
goto error_handler;
|
||||
}
|
||||
/* check soap body */
|
||||
ret_code =
|
||||
check_soap_body( actionDoc, QUERY_STATE_VAR_URN, actionName );
|
||||
ret_code = check_soap_body(actionDoc, QUERY_STATE_VAR_URN,
|
||||
actionName);
|
||||
free(actionName);
|
||||
if( ret_code != UPNP_E_SUCCESS ) {
|
||||
if (ret_code != UPNP_E_SUCCESS)
|
||||
goto error_handler;
|
||||
}
|
||||
} else {
|
||||
ret_code = check_soap_action_header(request,
|
||||
serv_info->serviceType,
|
||||
&actionName );
|
||||
if( ( ret_code != UPNP_E_SUCCESS )
|
||||
&& ( ret_code != UPNP_E_OUTOF_MEMORY ) ) {
|
||||
serv_info->serviceType, &actionName);
|
||||
if (ret_code != UPNP_E_SUCCESS &&
|
||||
ret_code != UPNP_E_OUTOF_MEMORY) {
|
||||
ret_code = UPNP_E_INVALID_SERVICE;
|
||||
goto error_handler;
|
||||
}
|
||||
/* check soap body */
|
||||
ret_code =
|
||||
check_soap_body( actionDoc, serv_info->serviceType,
|
||||
ret_code = check_soap_body(actionDoc, serv_info->serviceType,
|
||||
actionName);
|
||||
free(actionName);
|
||||
if (ret_code != UPNP_E_SUCCESS) {
|
||||
@ -609,43 +539,33 @@ get_device_info( IN http_message_t *request,
|
||||
goto error_handler;
|
||||
}
|
||||
}
|
||||
|
||||
UpnpString_set_String(device_udn, serv_info->UDN);
|
||||
UpnpString_set_String(service_id, serv_info->serviceId);
|
||||
*callback = device_info->Callback;
|
||||
*cookie = device_info->Cookie;
|
||||
|
||||
ret_code = 0;
|
||||
|
||||
error_handler:
|
||||
((char *)control_url)[request->uri.pathquery.size] = save_char; /* restore */
|
||||
/* restore */
|
||||
((char *)control_url)[request->uri.pathquery.size] = save_char;
|
||||
HandleUnlock();
|
||||
return ret_code;
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : send_action_response
|
||||
*
|
||||
* Parameters :
|
||||
* IN SOCKINFO *info : socket info
|
||||
* IN IXML_Document *action_resp : The response document
|
||||
* IN http_message_t* request : action request document
|
||||
*
|
||||
* Description : This function sends the SOAP response
|
||||
*
|
||||
* Return : void
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
static UPNP_INLINE void
|
||||
send_action_response( IN SOCKINFO * info,
|
||||
IN IXML_Document * action_resp,
|
||||
IN http_message_t * request )
|
||||
/*!
|
||||
* \brief Sends the SOAP action response.
|
||||
*/
|
||||
static UPNP_INLINE void send_action_response(
|
||||
/*! [in] Socket info. */
|
||||
SOCKINFO *info,
|
||||
/*! [in] The response document. */
|
||||
IXML_Document *action_resp,
|
||||
/*! [in] Action request document. */
|
||||
http_message_t *request)
|
||||
{
|
||||
char *xml_response = NULL;
|
||||
membuffer headers;
|
||||
int major,
|
||||
minor;
|
||||
int major, minor;
|
||||
int err_code;
|
||||
off_t content_length;
|
||||
int ret_code;
|
||||
@ -658,8 +578,8 @@ send_action_response( IN SOCKINFO * info,
|
||||
static const char *end_body = "</s:Body> </s:Envelope>";
|
||||
|
||||
/* init */
|
||||
http_CalcResponseVersion( request->major_version,
|
||||
request->minor_version, &major, &minor );
|
||||
http_CalcResponseVersion(request->major_version, request->minor_version,
|
||||
&major, &minor);
|
||||
membuffer_init(&headers);
|
||||
err_code = UPNP_E_OUTOF_MEMORY; /* one error only */
|
||||
/* get xml */
|
||||
@ -669,18 +589,17 @@ send_action_response( IN SOCKINFO * info,
|
||||
content_length = (off_t)(strlen(start_body) + strlen(xml_response) +
|
||||
strlen(end_body));
|
||||
/* make headers */
|
||||
if (http_MakeMessage(
|
||||
&headers, major, minor,
|
||||
if (http_MakeMessage(&headers, major, minor,
|
||||
"RNsDsSXcc",
|
||||
HTTP_OK, /* status code */
|
||||
content_length,
|
||||
ContentTypeHeader,
|
||||
"EXT:\r\n",
|
||||
X_USER_AGENT) != 0 ) {
|
||||
"EXT:\r\n", X_USER_AGENT) != 0) {
|
||||
goto error_handler;
|
||||
}
|
||||
/* send whole msg */
|
||||
ret_code = http_SendMessage( info, &timeout_secs, "bbbb",
|
||||
ret_code = http_SendMessage(
|
||||
info, &timeout_secs, "bbbb",
|
||||
headers.buf, headers.length,
|
||||
start_body, strlen(start_body),
|
||||
xml_response, strlen(xml_response),
|
||||
@ -702,23 +621,16 @@ error_handler:
|
||||
}
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : get_var_name
|
||||
/*!
|
||||
* \brief Finds the name of the state variable asked in the SOAP request.
|
||||
*
|
||||
* Parameters :
|
||||
* IN IXML_Document *TempDoc : Document containing variable request
|
||||
* OUT char* VarName : Name of the state varible
|
||||
*
|
||||
* Description : This function finds the name of the state variable
|
||||
* asked in the SOAP request.
|
||||
*
|
||||
* Return : int
|
||||
* returns 0 if successful else returns -1.
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
static UPNP_INLINE int
|
||||
get_var_name( IN IXML_Document * TempDoc,
|
||||
OUT char *VarName )
|
||||
* \return 0 if successful else returns -1.
|
||||
*/
|
||||
static UPNP_INLINE int get_var_name(
|
||||
/*! [in] Document containing variable request. */
|
||||
IXML_Document *TempDoc,
|
||||
/*! [out] Name of the state varible. */
|
||||
char *VarName)
|
||||
{
|
||||
IXML_Node *EnvpNode = NULL;
|
||||
IXML_Node *BodyNode = NULL;
|
||||
@ -731,62 +643,41 @@ get_var_name( IN IXML_Document * TempDoc,
|
||||
|
||||
/* Got the Envelop node here */
|
||||
EnvpNode = ixmlNode_getFirstChild((IXML_Node *) TempDoc);
|
||||
if( EnvpNode == NULL ) {
|
||||
if (EnvpNode == NULL)
|
||||
goto error_handler;
|
||||
}
|
||||
/* Got Body here */
|
||||
BodyNode = ixmlNode_getFirstChild(EnvpNode);
|
||||
if( BodyNode == NULL ) {
|
||||
if (BodyNode == NULL)
|
||||
goto error_handler;
|
||||
}
|
||||
/* Got action node here */
|
||||
StNode = ixmlNode_getFirstChild(BodyNode);
|
||||
if( StNode == NULL ) {
|
||||
if (StNode == NULL)
|
||||
goto error_handler;
|
||||
}
|
||||
/* Test whether this is the action node */
|
||||
StNodeName = ixmlNode_getNodeName(StNode);
|
||||
if( StNodeName == NULL || strstr( StNodeName,
|
||||
"QueryStateVariable" ) == NULL ) {
|
||||
if (StNodeName == NULL ||
|
||||
strstr(StNodeName, "QueryStateVariable") == NULL)
|
||||
goto error_handler;
|
||||
}
|
||||
|
||||
VarNameNode = ixmlNode_getFirstChild(StNode);
|
||||
if( VarNameNode == NULL ) {
|
||||
if (VarNameNode == NULL)
|
||||
goto error_handler;
|
||||
}
|
||||
|
||||
VarNode = ixmlNode_getFirstChild(VarNameNode);
|
||||
Temp = ixmlNode_getNodeValue(VarNode);
|
||||
linecopy(VarName, Temp);
|
||||
|
||||
UpnpPrintf(UPNP_INFO, SOAP, __FILE__, __LINE__,
|
||||
"Received query for variable name %s\n",
|
||||
VarName );
|
||||
"Received query for variable name %s\n", VarName);
|
||||
|
||||
ret_val = 0; /* success */
|
||||
/* success */
|
||||
ret_val = 0;
|
||||
|
||||
error_handler:
|
||||
return ret_val;
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : handle_query_variable
|
||||
*
|
||||
* Parameters :
|
||||
* IN SOCKINFO *info : Socket info
|
||||
* IN http_message_t* request : HTTP request
|
||||
* IN IXML_Document *xml_doc : Document containing the variable request
|
||||
* SOAP message
|
||||
*
|
||||
* Description : This action handles the SOAP requests to querry the
|
||||
* state variables. This functionality has been deprecated in
|
||||
* the UPnP V1.0 architecture
|
||||
*
|
||||
* Return : void
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
/*!
|
||||
* \brief Handles the SOAP requests to querry the state variables.
|
||||
* This functionality has been deprecated in the UPnP V1.0 architecture.
|
||||
*/
|
||||
static UPNP_INLINE void handle_query_variable(
|
||||
IN SOCKINFO *info,
|
||||
IN http_message_t *request,
|
||||
@ -800,40 +691,34 @@ static UPNP_INLINE void handle_query_variable(
|
||||
int err_code;
|
||||
|
||||
if (get_var_name(xml_doc, var_name) != 0) {
|
||||
send_error_response(info, SOAP_INVALID_VAR, Soap_Invalid_Var, request);
|
||||
|
||||
send_error_response(info, SOAP_INVALID_VAR,
|
||||
Soap_Invalid_Var, request);
|
||||
return;
|
||||
}
|
||||
/* get info for event */
|
||||
err_code = get_device_info(
|
||||
request, 1, xml_doc,
|
||||
err_code = get_device_info(request, 1, xml_doc,
|
||||
info->foreign_sockaddr.ss_family,
|
||||
(UpnpString *)UpnpStateVarRequest_get_DevUDN(variable),
|
||||
(UpnpString *)UpnpStateVarRequest_get_ServiceID(variable),
|
||||
&soap_event_callback,
|
||||
&cookie);
|
||||
&soap_event_callback, &cookie);
|
||||
if (err_code != 0) {
|
||||
send_error_response(info, SOAP_INVALID_VAR, Soap_Invalid_Var, request);
|
||||
|
||||
send_error_response(info, SOAP_INVALID_VAR,
|
||||
Soap_Invalid_Var, request);
|
||||
return;
|
||||
}
|
||||
|
||||
UpnpStateVarRequest_set_ErrCode(variable, UPNP_E_SUCCESS);
|
||||
UpnpStateVarRequest_strcpy_StateVarName(variable, var_name);
|
||||
UpnpStateVarRequest_set_CtrlPtIPAddr(variable, &info->foreign_sockaddr);
|
||||
|
||||
/* send event */
|
||||
soap_event_callback(UPNP_CONTROL_GET_VAR_REQUEST, variable, cookie);
|
||||
|
||||
UpnpPrintf(UPNP_INFO, SOAP, __FILE__, __LINE__,
|
||||
"Return from callback for var request\n");
|
||||
|
||||
/* validate, and handle result */
|
||||
if (UpnpStateVarRequest_get_CurrentVal(variable) == NULL) {
|
||||
err_code = SOAP_ACTION_FAILED;
|
||||
err_str = Soap_Action_Failed;
|
||||
send_error_response(info, SOAP_INVALID_VAR, Soap_Invalid_Var, request);
|
||||
|
||||
send_error_response(info, SOAP_INVALID_VAR, Soap_Invalid_Var,
|
||||
request);
|
||||
return;
|
||||
}
|
||||
if (UpnpStateVarRequest_get_ErrCode(variable) != UPNP_E_SUCCESS) {
|
||||
@ -853,28 +738,18 @@ static UPNP_INLINE void handle_query_variable(
|
||||
UpnpStateVarRequest_delete(variable);
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : handle_invoke_action
|
||||
*
|
||||
* Parameters :
|
||||
* IN SOCKINFO *info : Socket info
|
||||
* IN http_message_t* request : HTTP Request
|
||||
* IN memptr action_name : Name of the SOAP Action
|
||||
* IN IXML_Document *xml_doc : document containing the SOAP action
|
||||
* request
|
||||
*
|
||||
* Description : This functions handle the SOAP action request. It checks
|
||||
* the integrity of the SOAP action request and gives the call back to
|
||||
* the device application.
|
||||
*
|
||||
* Return : void
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
static void
|
||||
handle_invoke_action( IN SOCKINFO * info,
|
||||
/*!
|
||||
* \brief Handles the SOAP action request. It checks the integrity of the SOAP
|
||||
* action request and gives the call back to the device application.
|
||||
*/
|
||||
static void handle_invoke_action(
|
||||
/*! [in] Socket info. */
|
||||
IN SOCKINFO *info,
|
||||
/*! [in] HTTP Request. */
|
||||
IN http_message_t *request,
|
||||
/*! [in] Name of the SOAP Action. */
|
||||
IN memptr action_name,
|
||||
/*! [in] Document containing the SOAP action request. */
|
||||
IN IXML_Document *xml_doc)
|
||||
{
|
||||
char save_char;
|
||||
@ -891,27 +766,23 @@ handle_invoke_action( IN SOCKINFO * info,
|
||||
/* null-terminate */
|
||||
save_char = action_name.buf[action_name.length];
|
||||
action_name.buf[action_name.length] = '\0';
|
||||
|
||||
/* set default error */
|
||||
err_code = SOAP_INVALID_ACTION;
|
||||
err_str = Soap_Invalid_Action;
|
||||
|
||||
/* get action node */
|
||||
if (get_action_node(xml_doc, action_name.buf, &actionRequestDoc) == -1) {
|
||||
if (get_action_node(xml_doc, action_name.buf, &actionRequestDoc) == -1)
|
||||
goto error_handler;
|
||||
}
|
||||
/* get device info for action event */
|
||||
err_code = get_device_info(request,
|
||||
0,
|
||||
xml_doc,
|
||||
info->foreign_sockaddr.ss_family,
|
||||
devUDN,
|
||||
serviceID, &soap_event_callback, &cookie);
|
||||
serviceID,
|
||||
&soap_event_callback, &cookie);
|
||||
|
||||
if (err_code != UPNP_E_SUCCESS) {
|
||||
if (err_code != UPNP_E_SUCCESS)
|
||||
goto error_handler;
|
||||
}
|
||||
|
||||
UpnpActionRequest_set_ErrCode(action, UPNP_E_SUCCESS);
|
||||
UpnpActionRequest_strcpy_ErrStr(action, "");
|
||||
UpnpActionRequest_strcpy_ActionName(action, action_name.buf);
|
||||
@ -919,11 +790,8 @@ handle_invoke_action( IN SOCKINFO * info,
|
||||
UpnpActionRequest_set_ServiceID(action, serviceID);
|
||||
UpnpActionRequest_set_ActionRequest(action, actionRequestDoc);
|
||||
UpnpActionRequest_set_CtrlPtIPAddr(action, &info->foreign_sockaddr);
|
||||
|
||||
UpnpPrintf(UPNP_INFO, SOAP, __FILE__, __LINE__, "Calling Callback\n");
|
||||
|
||||
soap_event_callback(UPNP_CONTROL_ACTION_REQUEST, action, cookie);
|
||||
|
||||
err_code = UpnpActionRequest_get_ErrCode(action);
|
||||
if (err_code != UPNP_E_SUCCESS) {
|
||||
err_str = UpnpActionRequest_get_ErrStr_cstr(action);
|
||||
@ -942,39 +810,31 @@ handle_invoke_action( IN SOCKINFO * info,
|
||||
}
|
||||
/* send response */
|
||||
send_action_response(info, actionResultDoc, request);
|
||||
|
||||
err_code = 0;
|
||||
|
||||
/* error handling and cleanup */
|
||||
error_handler:
|
||||
action_name.buf[action_name.length] = save_char; /* restore */
|
||||
/* restore */
|
||||
action_name.buf[action_name.length] = save_char;
|
||||
if (err_code != 0)
|
||||
send_error_response(info, err_code, err_str, request);
|
||||
|
||||
UpnpString_delete(serviceID);
|
||||
UpnpString_delete(devUDN);
|
||||
UpnpActionRequest_delete(action);
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Function : soap_device_callback
|
||||
*
|
||||
* Parameters :
|
||||
* IN http_parser_t *parser : Parsed request received by the device
|
||||
* IN http_message_t* request : HTTP request
|
||||
* INOUT SOCKINFO *info : socket info
|
||||
*
|
||||
* Description : This is a callback called by minisever after receiving
|
||||
* the request from the control point. This function will start
|
||||
* processing the request. It calls handle_invoke_action to handle the
|
||||
* SOAP action
|
||||
*
|
||||
* Return : void
|
||||
*
|
||||
* Note :
|
||||
****************************************************************************/
|
||||
void soap_device_callback(IN http_parser_t *parser, IN http_message_t *request,
|
||||
INOUT SOCKINFO *info)
|
||||
/*!
|
||||
* \brief This is a callback called by minisever after receiving the request
|
||||
* from the control point. This function will start processing the request.
|
||||
* It calls handle_invoke_action to handle the SOAP action.
|
||||
*/
|
||||
void soap_device_callback(
|
||||
/*! [in] Parsed request received by the device. */
|
||||
http_parser_t *parser,
|
||||
/*! [in] HTTP request. */
|
||||
http_message_t *request,
|
||||
/*! [in,out] Socket info. */
|
||||
SOCKINFO *info)
|
||||
{
|
||||
int err_code;
|
||||
const char *err_str;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user