VirtualBox

source: vbox/trunk/src/VBox/Runtime/common/rest/RTCRestClientApiBase.cpp@ 93115

Last change on this file since 93115 was 93115, checked in by vboxsync, 3 years ago

scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.1 KB
Line 
1/* $Id: RTCRestClientApiBase.cpp 93115 2022-01-01 11:31:46Z vboxsync $ */
2/** @file
3 * IPRT - C++ REST, RTCRestClientApiBase implementation.
4 */
5
6/*
7 * Copyright (C) 2018-2022 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*********************************************************************************************************************************
29* Header Files *
30*********************************************************************************************************************************/
31#define LOG_GROUP RTLOGGROUP_REST
32#include <iprt/cpp/restclient.h>
33
34#include <iprt/assert.h>
35#include <iprt/ctype.h>
36#include <iprt/errcore.h>
37#include <iprt/http.h>
38#include <iprt/log.h>
39#include <iprt/uri.h>
40
41
42/**
43 * Default constructor.
44 */
45RTCRestClientApiBase::RTCRestClientApiBase() RT_NOEXCEPT
46 : m_hHttp(NIL_RTHTTP)
47{
48}
49
50
51/**
52 * The destructor.
53 */
54RTCRestClientApiBase::~RTCRestClientApiBase()
55{
56 if (m_hHttp != NIL_RTHTTP)
57 {
58 int rc = RTHttpDestroy(m_hHttp);
59 AssertRC(rc);
60 m_hHttp = NIL_RTHTTP;
61 }
62}
63
64
65int RTCRestClientApiBase::setCAFile(const char *pcszCAFile) RT_NOEXCEPT
66{
67 return m_strCAFile.assignNoThrow(pcszCAFile);
68}
69
70
71int RTCRestClientApiBase::setCAFile(const RTCString &strCAFile) RT_NOEXCEPT
72{
73 return m_strCAFile.assignNoThrow(strCAFile);
74}
75
76
77const char *RTCRestClientApiBase::getServerUrl(void) const RT_NOEXCEPT
78{
79 if (m_strServerUrl.isEmpty())
80 return getDefaultServerUrl();
81 return m_strServerUrl.c_str();
82}
83
84
85int RTCRestClientApiBase::setServerUrl(const char *a_pszUrl) RT_NOEXCEPT
86{
87#ifdef RT_STRICT
88 if (a_pszUrl)
89 {
90 RTURIPARSED Parsed;
91 int rc = RTUriParse(a_pszUrl, &Parsed);
92 AssertRC(rc);
93 }
94#endif
95
96 return m_strServerUrl.assignNoThrow(a_pszUrl);
97}
98
99
100int RTCRestClientApiBase::setServerUrlPart(const char *a_pszServerUrl, size_t a_offDst, size_t a_cchDst,
101 const char *a_pszSrc, size_t a_cchSrc) RT_NOEXCEPT
102{
103 if ( a_cchDst == a_cchSrc
104 && memcmp(&a_pszServerUrl[0], a_pszSrc, a_cchSrc) == 0)
105 return VINF_SUCCESS;
106
107 if (m_strServerUrl.isEmpty())
108 {
109 int rc = m_strServerUrl.assignNoThrow(a_pszServerUrl);
110 AssertRCReturn(rc, rc);
111 }
112 return m_strServerUrl.replaceNoThrow(a_offDst, a_cchDst, a_pszSrc, a_cchSrc);
113}
114
115
116int RTCRestClientApiBase::setServerScheme(const char *a_pszScheme) RT_NOEXCEPT
117{
118 /*
119 * Validate.
120 */
121 AssertReturn(a_pszScheme, VERR_INVALID_POINTER);
122 size_t const cchScheme = strlen(a_pszScheme);
123 AssertReturn(cchScheme > 0, VERR_INVALID_PARAMETER);
124 Assert(cchScheme < 16);
125#ifdef RT_STRICT
126 for (size_t i = 0; i < cchScheme; i++)
127 Assert(RT_C_IS_ALNUM(a_pszScheme[i]));
128#endif
129
130 /*
131 * Parse, compare & replace.
132 */
133 RTURIPARSED Parsed;
134 const char *pszUrl = getServerUrl();
135 int rc = RTUriParse(pszUrl, &Parsed);
136 AssertRCReturn(rc, rc);
137 return setServerUrlPart(pszUrl, 0, Parsed.cchScheme, a_pszScheme, cchScheme);
138}
139
140
141int RTCRestClientApiBase::setServerAuthority(const char *a_pszAuthority) RT_NOEXCEPT
142{
143 /*
144 * Validate.
145 */
146 AssertReturn(a_pszAuthority, VERR_INVALID_POINTER);
147 size_t const cchAuthority = strlen(a_pszAuthority);
148 AssertReturn(cchAuthority > 0, VERR_INVALID_PARAMETER);
149 Assert(memchr(a_pszAuthority, '/', cchAuthority) == NULL);
150 Assert(memchr(a_pszAuthority, '\\', cchAuthority) == NULL);
151 Assert(memchr(a_pszAuthority, '#', cchAuthority) == NULL);
152 Assert(memchr(a_pszAuthority, '?', cchAuthority) == NULL);
153
154 /*
155 * Parse, compare & replace.
156 */
157 RTURIPARSED Parsed;
158 const char *pszUrl = getServerUrl();
159 int rc = RTUriParse(pszUrl, &Parsed);
160 AssertRCReturn(rc, rc);
161 return setServerUrlPart(pszUrl, Parsed.offAuthority, Parsed.cchAuthority, a_pszAuthority, cchAuthority);
162}
163
164
165int RTCRestClientApiBase::setServerBasePath(const char *a_pszBasePath) RT_NOEXCEPT
166{
167 /*
168 * Validate.
169 */
170 AssertReturn(a_pszBasePath, VERR_INVALID_POINTER);
171 size_t const cchBasePath = strlen(a_pszBasePath);
172 AssertReturn(cchBasePath > 0, VERR_INVALID_PARAMETER);
173 Assert(memchr(a_pszBasePath, '?', cchBasePath) == NULL);
174 Assert(memchr(a_pszBasePath, '#', cchBasePath) == NULL);
175
176 /*
177 * Parse, compare & replace.
178 */
179 RTURIPARSED Parsed;
180 const char *pszUrl = getServerUrl();
181 int rc = RTUriParse(pszUrl, &Parsed);
182 AssertRCReturn(rc, rc);
183 return setServerUrlPart(pszUrl, Parsed.offPath, Parsed.cchPath, a_pszBasePath, cchBasePath);
184}
185
186
187int RTCRestClientApiBase::reinitHttpInstance() RT_NOEXCEPT
188{
189 if (m_hHttp != NIL_RTHTTP)
190 return RTHttpReset(m_hHttp, 0 /*fFlags*/);
191
192 int rc = RTHttpCreate(&m_hHttp);
193 if (RT_SUCCESS(rc) && m_strCAFile.isNotEmpty())
194 rc = RTHttpSetCAFile(m_hHttp, m_strCAFile.c_str());
195
196 if (RT_FAILURE(rc) && m_hHttp != NIL_RTHTTP)
197 {
198 RTHttpDestroy(m_hHttp);
199 m_hHttp = NIL_RTHTTP;
200 }
201 return rc;
202}
203
204
205int RTCRestClientApiBase::xmitReady(RTHTTP a_hHttp, RTCString const &a_rStrFullUrl, RTHTTPMETHOD a_enmHttpMethod,
206 RTCString const &a_rStrXmitBody, uint32_t a_fFlags) RT_NOEXCEPT
207{
208 RT_NOREF(a_hHttp, a_rStrFullUrl, a_enmHttpMethod, a_rStrXmitBody, a_fFlags);
209 return VINF_SUCCESS;
210}
211
212
213int RTCRestClientApiBase::doCall(RTCRestClientRequestBase const &a_rRequest, RTHTTPMETHOD a_enmHttpMethod,
214 RTCRestClientResponseBase *a_pResponse, const char *a_pszMethod, uint32_t a_fFlags) RT_NOEXCEPT
215{
216 LogFlow(("doCall: %s %s\n", a_pszMethod, RTHttpMethodToStr(a_enmHttpMethod)));
217
218
219 /*
220 * Reset the response object (allowing reuse of such) and check the request
221 * object for assignment errors.
222 */
223 int rc;
224 RTHTTP hHttp = NIL_RTHTTP;
225
226 a_pResponse->reset();
227 if (!a_rRequest.hasAssignmentErrors())
228 {
229 /*
230 * Initialize the HTTP instance.
231 */
232 rc = reinitHttpInstance();
233 if (RT_SUCCESS(rc))
234 {
235 hHttp = m_hHttp;
236 Assert(hHttp != NIL_RTHTTP);
237
238 /*
239 * Prepare the response side.
240 */
241 rc = a_pResponse->receivePrepare(hHttp);
242 if (RT_SUCCESS(rc))
243 {
244 /*
245 * Prepare the request for the transmission.
246 */
247 RTCString strExtraPath;
248 RTCString strQuery;
249 RTCString strXmitBody;
250 rc = a_rRequest.xmitPrepare(&strExtraPath, &strQuery, hHttp, &strXmitBody);
251 if (RT_SUCCESS(rc))
252 {
253 /*
254 * Construct the full URL.
255 */
256 RTCString strFullUrl;
257 rc = strFullUrl.assignNoThrow(getServerUrl());
258 if (strExtraPath.isNotEmpty())
259 {
260 if (!strExtraPath.startsWith("/") && !strFullUrl.endsWith("/") && RT_SUCCESS(rc))
261 rc = strFullUrl.appendNoThrow('/');
262 if (RT_SUCCESS(rc))
263 rc = strFullUrl.appendNoThrow(strExtraPath);
264 strExtraPath.setNull();
265 }
266 if (strQuery.isNotEmpty())
267 {
268 Assert(strQuery.startsWith("?"));
269 rc = strFullUrl.appendNoThrow(strQuery);
270 strQuery.setNull();
271 }
272 if (RT_SUCCESS(rc))
273 {
274 rc = xmitReady(hHttp, strFullUrl, a_enmHttpMethod, strXmitBody, a_fFlags);
275 if (RT_SUCCESS(rc))
276 {
277 /*
278 * Perform HTTP request.
279 */
280 uint32_t uHttpStatus = 0;
281 size_t cbBody = 0;
282 void *pvBody = NULL;
283 rc = RTHttpPerform(hHttp, strFullUrl.c_str(), a_enmHttpMethod,
284 strXmitBody.c_str(), strXmitBody.length(),
285 &uHttpStatus, NULL /*ppvHdrs*/, NULL /*pcbHdrs*/, &pvBody, &cbBody);
286 if (RT_SUCCESS(rc))
287 {
288 a_rRequest.xmitComplete(uHttpStatus, hHttp);
289
290 /*
291 * Do response processing.
292 */
293 a_pResponse->receiveComplete(uHttpStatus, hHttp);
294 a_pResponse->consumeBody((const char *)pvBody, cbBody);
295 if (pvBody)
296 RTHttpFreeResponse(pvBody);
297 a_pResponse->receiveFinal();
298
299 return a_pResponse->getStatus();
300 }
301 }
302 }
303 }
304 a_rRequest.xmitComplete(rc, hHttp);
305 }
306 }
307 }
308 else
309 rc = VERR_NO_MEMORY;
310
311 a_pResponse->receiveComplete(rc, hHttp);
312 RT_NOREF_PV(a_pszMethod);
313
314 return a_pResponse->getStatus();
315}
316
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette