Electroneum
http_protocol_handler.h
Go to the documentation of this file.
1 // Copyright (c) 2006-2013, Andrey N. Sabelnikov, www.sabelnikov.net
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name of the Andrey N. Sabelnikov nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER BE LIABLE FOR ANY
19 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 //
26 
27 
28 
29 
30 #ifndef _HTTP_SERVER_H_
31 #define _HTTP_SERVER_H_
32 
33 #include <boost/optional/optional.hpp>
34 #include <string>
35 #include "net_utils_base.h"
36 #include "to_nonconst_iterator.h"
37 #include "http_auth.h"
38 #include "http_base.h"
39 
40 #undef ELECTRONEUM_DEFAULT_LOG_CATEGORY
41 #define ELECTRONEUM_DEFAULT_LOG_CATEGORY "net.http"
42 
43 namespace epee
44 {
45 namespace net_utils
46 {
47  namespace http
48  {
49 
50 
51  /************************************************************************/
52  /* */
53  /************************************************************************/
55  {
57  std::vector<std::string> m_access_control_origins;
58  boost::optional<login> m_user;
60  };
61 
62  /************************************************************************/
63  /* */
64  /************************************************************************/
65  template<class t_connection_context = net_utils::connection_context_base>
67  {
68  public:
69  typedef t_connection_context connection_context;//t_connection_context net_utils::connection_context_base connection_context;
71 
72  simple_http_connection_handler(i_service_endpoint* psnd_hndlr, config_type& config, t_connection_context& conn_context);
74 
76  {
77  return true;
78  }
79 
80  virtual bool thread_init()
81  {
82  return true;
83  }
84 
85  virtual bool thread_deinit()
86  {
87  return true;
88  }
90  {
91  return true;
92  }
93  virtual bool handle_recv(const void* ptr, size_t cb);
95 
96  private:
97  enum machine_state{
98  http_state_retriving_comand_line,
99  http_state_retriving_header,
100  http_state_retriving_body,
101  http_state_connection_close,
102  http_state_error
103  };
104 
105  enum body_transfer_type{
106  http_body_transfer_chunked,
107  http_body_transfer_measure,//mean "Content-Length" valid
108  http_body_transfer_chunked_instead_measure,
109  http_body_transfer_connection_close,
110  http_body_transfer_multipart,
111  http_body_transfer_undefined
112  };
113 
114  bool handle_buff_in(std::string& buf);
115 
116  bool analize_cached_request_header_and_invoke_state(size_t pos);
117 
118  bool handle_invoke_query_line();
119  bool parse_cached_header(http_header_info& body_info, const std::string& m_cache_to_process, size_t pos);
120  std::string::size_type match_end_of_header(const std::string& buf);
121  bool get_len_from_content_lenght(const std::string& str, size_t& len);
122  bool handle_retriving_query_body();
123  bool handle_query_measure();
124  bool set_ready_state();
125  bool slash_to_back_slash(std::string& str);
126  std::string get_file_mime_tipe(const std::string& path);
127  std::string get_response_header(const http_response_info& response);
128 
129  //major function
130  inline bool handle_request_and_send_response(const http::http_request_info& query_info);
131 
132 
133  std::string get_not_found_response_body(const std::string& URI);
134 
135  std::string m_root_path;
136  std::string m_cache;
137  machine_state m_state;
138  body_transfer_type m_body_transfer_type;
139  bool m_is_stop_handling;
140  http::http_request_info m_query_info;
141  size_t m_len_summary, m_len_remain;
142  config_type& m_config;
143  bool m_want_close;
144  size_t m_newlines;
145  protected:
147  t_connection_context& m_conn_context;
148  };
149 
150  template<class t_connection_context>
152  {
156  t_connection_context& m_conn_context) = 0;
157  virtual bool init_server_thread(){return true;}
158  virtual bool deinit_server_thread(){return true;}
159  };
160 
161  template<class t_connection_context>
163  {
165  std::function<void(size_t, uint8_t*)> rng;
166  };
167 
168  /************************************************************************/
169  /* */
170  /************************************************************************/
171 
172  template<class t_connection_context = net_utils::connection_context_base>
173  class http_custom_handler: public simple_http_connection_handler<t_connection_context>
174  {
175  public:
177 
178  http_custom_handler(i_service_endpoint* psnd_hndlr, config_type& config, t_connection_context& conn_context)
179  : simple_http_connection_handler<t_connection_context>(psnd_hndlr, config, conn_context),
180  m_config(config),
181  m_auth(m_config.m_user ? http_server_auth{*m_config.m_user, config.rng} : http_server_auth{})
182  {}
184  {
185  CHECK_AND_ASSERT_MES(m_config.m_phandler, false, "m_config.m_phandler is NULL!!!!");
186 
187  const auto auth_response = m_auth.get_response(query_info);
188  if (auth_response)
189  {
190  response = std::move(*auth_response);
191  return true;
192  }
193 
194  //fill with default values
195  response.m_mime_tipe = "text/plain";
196  response.m_response_code = 200;
197  response.m_response_comment = "OK";
198  response.m_body.clear();
199 
200  return m_config.m_phandler->handle_http_request(query_info, response, this->m_conn_context);
201  }
202 
203  virtual bool thread_init()
204  {
205  return m_config.m_phandler->init_server_thread();;
206  }
207 
208  virtual bool thread_deinit()
209  {
210  return m_config.m_phandler->deinit_server_thread();
211  }
213  {}
215  {
216  return true;
217  }
218 
219  private:
220  //simple_http_connection_handler::config_type m_stub_config;
221  config_type& m_config;
222  http_server_auth m_auth;
223  };
224  }
225 }
226 }
227 
228 #include "http_protocol_handler.inl"
229 
230 #endif //_HTTP_SERVER_H_
boost::optional< http_response_info > get_response(const http_request_info &request)
Definition: http_auth.h:79
std::function< void(size_t, uint8_t *)> rng
::std::string string
Definition: gtest-port.h:1097
virtual bool handle_recv(const void *ptr, size_t cb)
epee::misc_utils::struct_init< response_t > response
#define CHECK_AND_ASSERT_MES(expr, fail_ret_val, message)
Definition: misc_log_ex.h:181
bool handle_request(const http_request_info &query_info, http_response_info &response)
simple_http_connection_handler(i_service_endpoint *psnd_hndlr, config_type &config, t_connection_context &conn_context)
virtual bool handle_request(const http::http_request_info &query_info, http_response_info &response)
i_http_server_handler< t_connection_context > * m_phandler
const char * buf
Definition: slow_memmem.cpp:74
http_custom_handler(i_service_endpoint *psnd_hndlr, config_type &config, t_connection_context &conn_context)
const T & move(const T &t)
Definition: gtest-port.h:1317
std::vector< std::string > m_access_control_origins
Implements RFC 2617 digest auth. Digests from RFC 7616 can be added.
Definition: http_auth.h:61
virtual bool handle_http_request(const http_request_info &query_info, http_response_info &response, t_connection_context &m_conn_context)=0
custum_handler_config< t_connection_context > config_type