1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*****************************************************************
|
| Platinum - HTTP Helper
|
| Copyright (c) 2004-2010, Plutinosoft, LLC.
| All rights reserved.
| http://www.plutinosoft.com
|
| This program is free software; you can redistribute it and/or
| modify it under the terms of the GNU General Public License
| as published by the Free Software Foundation; either version 2
| of the License, or (at your option) any later version.
|
| OEMs, ISVs, VARs and other distributors that combine and
| distribute commercially licensed software with Platinum software
| and do not wish to distribute the source code for the commercially
| licensed software under version 2, or (at your option) any later
| version, of the GNU General Public License (the "GPL") must enter
| into a commercial license agreement with Plutinosoft, LLC.
| licensing@plutinosoft.com
|
| This program is distributed in the hope that it will be useful,
| but WITHOUT ANY WARRANTY; without even the implied warranty of
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
| GNU General Public License for more details.
|
| You should have received a copy of the GNU General Public License
| along with this program; see the file LICENSE.txt. If not, write to
| the Free Software Foundation, Inc.,
| 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
| http://www.gnu.org/licenses/gpl-2.0.html
|
****************************************************************/
/** @file
HTTP utilities
*/
#ifndef _PLT_HTTP_H_
#define _PLT_HTTP_H_
/*----------------------------------------------------------------------
| includes
+---------------------------------------------------------------------*/
#include "Neptune.h"
#include "PltVersion.h"
/*----------------------------------------------------------------------
| constants
+---------------------------------------------------------------------*/
#if !defined(PLT_HTTP_DEFAULT_USER_AGENT)
#define PLT_HTTP_DEFAULT_USER_AGENT "UPnP/1.0 DLNADOC/1.50 Platinum/" PLT_PLATINUM_SDK_VERSION_STRING
#endif
#if !defined(PLT_HTTP_DEFAULT_SERVER)
#define PLT_HTTP_DEFAULT_SERVER "UPnP/1.0 DLNADOC/1.50 Platinum/" PLT_PLATINUM_SDK_VERSION_STRING
#endif
/*----------------------------------------------------------------------
| types
+---------------------------------------------------------------------*/
typedef enum {
PLT_DEVICE_UNKNOWN,
PLT_DEVICE_XBOX,
PLT_DEVICE_PS3,
PLT_DEVICE_WMP,
PLT_DEVICE_SONOS,
PLT_DEVICE_MAC,
PLT_DEVICE_WINDOWS,
PLT_DEVICE_VLC
} PLT_DeviceSignature;
/*----------------------------------------------------------------------
| PLT_HttpHelper
+---------------------------------------------------------------------*/
/**
The PLT_HttpHelper class is a set of utility functions for manipulating
HTTP headers, entities and messages.
*/
class PLT_HttpHelper {
public:
static bool IsConnectionKeepAlive(NPT_HttpMessage& message);
static bool IsBodyStreamSeekable(NPT_HttpMessage& message);
static NPT_Result ToLog(NPT_LoggerReference logger, int level, const char* prefix, NPT_HttpRequest* request);
static NPT_Result ToLog(NPT_LoggerReference logger, int level, const char* prefix, const NPT_HttpRequest& request);
static NPT_Result ToLog(NPT_LoggerReference logger, int level, const char* prefix, NPT_HttpResponse* response);
static NPT_Result ToLog(NPT_LoggerReference logger, int level, const char* prefix, const NPT_HttpResponse& response);
static NPT_Result GetContentType(const NPT_HttpMessage& message, NPT_String& type);
static NPT_Result GetContentLength(const NPT_HttpMessage& message, NPT_LargeSize& len);
static NPT_Result GetHost(const NPT_HttpRequest& request, NPT_String& value);
static void SetHost(NPT_HttpRequest& request, const char* host);
static PLT_DeviceSignature GetDeviceSignature(const NPT_HttpRequest& request);
static NPT_Result SetBody(NPT_HttpMessage& message, NPT_String& text, NPT_HttpEntity** entity = NULL);
static NPT_Result SetBody(NPT_HttpMessage& message, const char* text, NPT_HttpEntity** entity = NULL);
static NPT_Result SetBody(NPT_HttpMessage& message, const void* body, NPT_LargeSize len, NPT_HttpEntity** entity = NULL);
static NPT_Result SetBody(NPT_HttpMessage& message, NPT_InputStreamReference stream, NPT_HttpEntity** entity = NULL);
static NPT_Result GetBody(const NPT_HttpMessage& message, NPT_String& body);
static NPT_Result ParseBody(const NPT_HttpMessage& message, NPT_XmlElementNode*& xml);
static void SetBasicAuthorization(NPT_HttpRequest& request, const char* username, const char* password);
};
/*----------------------------------------------------------------------
| PLT_HttpRequestContext
+---------------------------------------------------------------------*/
/**
The PLT_HttpRequestContext class holds information about the request sent, the
local & remote ip addresses and ports associated with a connection. It is used
mostly when processing a HTTP response.
*/
class PLT_HttpRequestContext : public NPT_HttpRequestContext {
public:
// constructors and destructor
PLT_HttpRequestContext(const NPT_HttpRequest& request) :
m_Request(request) {}
PLT_HttpRequestContext(const NPT_HttpRequest& request, const NPT_HttpRequestContext& context) :
NPT_HttpRequestContext(&context.GetLocalAddress(), &context.GetRemoteAddress()),
m_Request(request) {}
virtual ~PLT_HttpRequestContext() {}
const NPT_HttpRequest& GetRequest() const { return m_Request; }
PLT_DeviceSignature GetDeviceSignature() { return PLT_HttpHelper::GetDeviceSignature(m_Request); }
private:
const NPT_HttpRequest& m_Request;
};
/*----------------------------------------------------------------------
| macros
+---------------------------------------------------------------------*/
#if defined(NPT_CONFIG_ENABLE_LOGGING)
#define PLT_LOG_HTTP_MESSAGE_L(_logger, _level, _prefix, _msg) \
PLT_HttpHelper::ToLog((_logger), (_level), (_prefix), (_msg))
#define PLT_LOG_HTTP_MESSAGE(_level, _prefix, _msg) \
PLT_HttpHelper::ToLog((_NPT_LocalLogger), (_level), (_prefix), (_msg))
#else /* NPT_CONFIG_ENABLE_LOGGING */
#define PLT_LOG_HTTP_MESSAGE_L(_logger, _level, _prefix, _msg)
#define PLT_LOG_HTTP_MESSAGE(_level, _prefix, _msg)
#endif /* NPT_CONFIG_ENABLE_LOGGING */
/*----------------------------------------------------------------------
| PLT_HttpRequestHandler
+---------------------------------------------------------------------*/
/**
The PLT_HttpRequestHandler class delegates the handling of the response of a
received HTTP request by a HTTP Server.
*/
class PLT_HttpRequestHandler : public NPT_HttpRequestHandler
{
public:
PLT_HttpRequestHandler(NPT_HttpRequestHandler* delegate) :
m_Delegate(delegate) {}
virtual ~PLT_HttpRequestHandler() {}
// NPT_HttpRequestHandler methods
NPT_Result SetupResponse(NPT_HttpRequest& request,
const NPT_HttpRequestContext& context,
NPT_HttpResponse& response) {
return m_Delegate->SetupResponse(request, context, response);
}
private:
NPT_HttpRequestHandler* m_Delegate;
};
#endif /* _PLT_HTTP_H_ */
|