Fork of SandBox's original mbed-http (https://os.mbed.com/teams/sandbox/code/mbed-http/) and update for MbedOS6+ Content of TESTS folder was replaced with basic examples form original SandBox's HelloWorld
source/http_request.h
- Committer:
- Jan Jongboom
- Date:
- 2018-08-10
- Revision:
- 29:383e9bfbfbed
- Parent:
- 23:15fa2726f793
- Child:
- 32:fa4d71265625
File content as of revision 29:383e9bfbfbed:
/* * PackageLicenseDeclared: Apache-2.0 * Copyright (c) 2017 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef _HTTP_REQUEST_ #define _HTTP_REQUEST_ #include <string> #include <vector> #include <map> #include "http_parser.h" #include "http_response.h" #include "http_request_builder.h" #include "http_request_parser.h" #include "http_parsed_url.h" /** * @todo: * - Userinfo parameter is not handled */ #ifndef HTTP_RECEIVE_BUFFER_SIZE #define HTTP_RECEIVE_BUFFER_SIZE 8 * 1024 #endif /** * \brief HttpRequest implements the logic for interacting with HTTP servers. */ class HttpRequest { public: /** * HttpRequest Constructor * * @param[in] aNetwork The network interface * @param[in] aMethod HTTP method to use * @param[in] url URL to the resource * @param[in] aBodyCallback Callback on which to retrieve chunks of the response body. If not set, the complete body will be allocated on the HttpResponse object, which might use lots of memory. */ HttpRequest(NetworkInterface* aNetwork, http_method aMethod, const char* url, Callback<void(const char *at, uint32_t length)> aBodyCallback = 0) : network(aNetwork), method(aMethod), body_callback(aBodyCallback) { error = 0; response = NULL; parsed_url = new ParsedUrl(url); request_builder = new HttpRequestBuilder(method, parsed_url); socket = new TCPSocket(); we_created_socket = true; } /** * HttpRequest Constructor * * @param[in] aSocket An open TCPSocket * @param[in] aMethod HTTP method to use * @param[in] url URL to the resource * @param[in] aBodyCallback Callback on which to retrieve chunks of the response body. If not set, the complete body will be allocated on the HttpResponse object, which might use lots of memory. */ HttpRequest(TCPSocket* aSocket, http_method aMethod, const char* url, Callback<void(const char *at, uint32_t length)> aBodyCallback = 0) : socket(aSocket), method(aMethod), body_callback(aBodyCallback) { error = 0; response = NULL; network = NULL; parsed_url = new ParsedUrl(url); request_builder = new HttpRequestBuilder(method, parsed_url); we_created_socket = false; } /** * HttpRequest Constructor */ ~HttpRequest() { // should response be owned by us? Or should user free it? // maybe implement copy constructor on response... if (response) { delete response; } if (parsed_url) { delete parsed_url; } if (request_builder) { delete request_builder; } if (socket && we_created_socket) { delete socket; } } /** * Execute the request and receive the response. * This adds a Content-Length header to the request (when body_size is set), and sends the data to the server. * @param body Pointer to the body to be sent * @param body_size Size of the body to be sent * @return An HttpResponse pointer on success, or NULL on failure. * See get_error() for the error code. */ HttpResponse* send(const void* body = NULL, nsapi_size_t body_size = 0) { nsapi_size_or_error_t ret = open_socket(); if (ret != NSAPI_ERROR_OK) { error = ret; return NULL; } uint32_t request_size = 0; char* request = request_builder->build(body, body_size, request_size); ret = send_buffer(request, request_size); free(request); if (ret < 0) { error = ret; return NULL; } return create_http_response(); } /** * Execute the request and receive the response. * This sends the request through chunked-encoding. * @param body_cb Callback which generates the next chunk of the request * @return An HttpResponse pointer on success, or NULL on failure. * See get_error() for the error code. */ HttpResponse* send(Callback<const void*(uint32_t*)> body_cb) { nsapi_error_t ret; if ((ret = open_socket()) != NSAPI_ERROR_OK) { error = ret; return NULL; } set_header("Transfer-Encoding", "chunked"); uint32_t request_size = 0; char* request = request_builder->build(NULL, 0, request_size); // first... send this request headers without the body nsapi_size_or_error_t total_send_count = send_buffer(request, request_size); if (total_send_count < 0) { free(request); error = total_send_count; return NULL; } // ok... now it's time to start sending chunks... while (1) { uint32_t size; const void *buffer = body_cb(&size); if (size == 0) break; // so... size in HEX, \r\n, data, \r\n again char size_buff[10]; // if sending length of more than 8 digits, you have another problem on a microcontroller... uint32_t size_buff_size = sprintf(size_buff, "%X\r\n", size); if ((total_send_count = send_buffer(size_buff, size_buff_size)) < 0) { free(request); error = total_send_count; return NULL; } // now send the normal buffer... and then \r\n at the end total_send_count = send_buffer((char*)buffer, size); if (total_send_count < 0) { free(request); error = total_send_count; return NULL; } // and... \r\n const char* rn = "\r\n"; if ((total_send_count = send_buffer((char*)rn, 2)) < 0) { free(request); error = total_send_count; return NULL; } } // finalize...? const char* fin = "0\r\n\r\n"; if ((total_send_count = send_buffer((char*)fin, strlen(fin))) < 0) { free(request); error = total_send_count; return NULL; } free(request); return create_http_response(); } /** * Set a header for the request. * * The 'Host' and 'Content-Length' headers are set automatically. * Setting the same header twice will overwrite the previous entry. * * @param[in] key Header key * @param[in] value Header value */ void set_header(string key, string value) { request_builder->set_header(key, value); } /** * Get the error code. * * When send() fails, this error is set. */ nsapi_error_t get_error() { return error; } private: nsapi_error_t open_socket() { if (response != NULL) { // already executed this response return -2100; // @todo, make a lookup table with errors } if (we_created_socket) { nsapi_error_t open_result = socket->open(network); if (open_result != NSAPI_ERROR_OK) { return open_result; } nsapi_error_t connection_result = socket->connect(parsed_url->host(), parsed_url->port()); if (connection_result != NSAPI_ERROR_OK) { return connection_result; } } return NSAPI_ERROR_OK; } nsapi_size_or_error_t send_buffer(char* buffer, uint32_t buffer_size) { nsapi_size_or_error_t total_send_count = 0; while (total_send_count < buffer_size) { nsapi_size_or_error_t send_result = socket->send(buffer + total_send_count, buffer_size - total_send_count); if (send_result < 0) { total_send_count = send_result; break; } if (send_result == 0) { break; } total_send_count += send_result; } return total_send_count; } HttpResponse* create_http_response() { // Create a response object response = new HttpResponse(); // And a response parser HttpParser parser(response, HTTP_RESPONSE, body_callback); // Set up a receive buffer (on the heap) uint8_t* recv_buffer = (uint8_t*)malloc(HTTP_RECEIVE_BUFFER_SIZE); // TCPSocket::recv is called until we don't have any data anymore nsapi_size_or_error_t recv_ret; while ((recv_ret = socket->recv(recv_buffer, HTTP_RECEIVE_BUFFER_SIZE)) > 0) { // Pass the chunk into the http_parser uint32_t nparsed = parser.execute((const char*)recv_buffer, recv_ret); if (nparsed != recv_ret) { // printf("Parsing failed... parsed %d bytes, received %d bytes\n", nparsed, recv_ret); error = -2101; free(recv_buffer); return NULL; } if (response->is_message_complete()) { break; } } // error? if (recv_ret < 0) { error = recv_ret; free(recv_buffer); return NULL; } // When done, call parser.finish() parser.finish(); // Free the receive buffer free(recv_buffer); if (we_created_socket) { // Close the socket socket->close(); } return response; } NetworkInterface* network; TCPSocket* socket; http_method method; Callback<void(const char *at, uint32_t length)> body_callback; ParsedUrl* parsed_url; HttpRequestBuilder* request_builder; HttpResponse* response; bool we_created_socket; nsapi_error_t error; }; #endif // _HTTP_REQUEST_