connection_impl.hpp 76 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375
  1. /*
  2. * Copyright (c) 2014, Peter Thorson. 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 WebSocket++ Project 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"
  16. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18. * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON 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. #ifndef WEBSOCKETPP_CONNECTION_IMPL_HPP
  28. #define WEBSOCKETPP_CONNECTION_IMPL_HPP
  29. #include <websocketpp/processors/hybi00.hpp>
  30. #include <websocketpp/processors/hybi07.hpp>
  31. #include <websocketpp/processors/hybi08.hpp>
  32. #include <websocketpp/processors/hybi13.hpp>
  33. #include <websocketpp/processors/processor.hpp>
  34. #include <websocketpp/common/platforms.hpp>
  35. #include <websocketpp/common/system_error.hpp>
  36. #include <algorithm>
  37. #include <exception>
  38. #include <sstream>
  39. #include <string>
  40. #include <utility>
  41. #include <vector>
  42. namespace websocketpp {
  43. namespace istate = session::internal_state;
  44. template <typename config>
  45. void connection<config>::set_termination_handler(
  46. termination_handler new_handler)
  47. {
  48. m_alog->write(log::alevel::devel,
  49. "connection set_termination_handler");
  50. //scoped_lock_type lock(m_connection_state_lock);
  51. m_termination_handler = new_handler;
  52. }
  53. template <typename config>
  54. std::string const & connection<config>::get_origin() const {
  55. //scoped_lock_type lock(m_connection_state_lock);
  56. return m_processor->get_origin(m_request);
  57. }
  58. template <typename config>
  59. size_t connection<config>::get_buffered_amount() const {
  60. //scoped_lock_type lock(m_connection_state_lock);
  61. return m_send_buffer_size;
  62. }
  63. template <typename config>
  64. session::state::value connection<config>::get_state() const {
  65. //scoped_lock_type lock(m_connection_state_lock);
  66. return m_state;
  67. }
  68. template <typename config>
  69. lib::error_code connection<config>::send(std::string const & payload,
  70. frame::opcode::value op)
  71. {
  72. message_ptr msg = m_msg_manager->get_message(op,payload.size());
  73. msg->append_payload(payload);
  74. msg->set_compressed(true);
  75. return send(msg);
  76. }
  77. template <typename config>
  78. lib::error_code connection<config>::send(void const * payload, size_t len,
  79. frame::opcode::value op)
  80. {
  81. message_ptr msg = m_msg_manager->get_message(op,len);
  82. msg->append_payload(payload,len);
  83. return send(msg);
  84. }
  85. template <typename config>
  86. lib::error_code connection<config>::send(typename config::message_type::ptr msg)
  87. {
  88. if (m_alog->static_test(log::alevel::devel)) {
  89. m_alog->write(log::alevel::devel,"connection send");
  90. }
  91. {
  92. scoped_lock_type lock(m_connection_state_lock);
  93. if (m_state != session::state::open) {
  94. return error::make_error_code(error::invalid_state);
  95. }
  96. }
  97. message_ptr outgoing_msg;
  98. bool needs_writing = false;
  99. if (msg->get_prepared()) {
  100. outgoing_msg = msg;
  101. scoped_lock_type lock(m_write_lock);
  102. write_push(outgoing_msg);
  103. needs_writing = !m_write_flag && !m_send_queue.empty();
  104. } else {
  105. outgoing_msg = m_msg_manager->get_message();
  106. if (!outgoing_msg) {
  107. return error::make_error_code(error::no_outgoing_buffers);
  108. }
  109. scoped_lock_type lock(m_write_lock);
  110. lib::error_code ec = m_processor->prepare_data_frame(msg,outgoing_msg);
  111. if (ec) {
  112. return ec;
  113. }
  114. write_push(outgoing_msg);
  115. needs_writing = !m_write_flag && !m_send_queue.empty();
  116. }
  117. if (needs_writing) {
  118. transport_con_type::dispatch(lib::bind(
  119. &type::write_frame,
  120. type::get_shared()
  121. ));
  122. }
  123. return lib::error_code();
  124. }
  125. template <typename config>
  126. void connection<config>::ping(std::string const& payload, lib::error_code& ec) {
  127. if (m_alog->static_test(log::alevel::devel)) {
  128. m_alog->write(log::alevel::devel,"connection ping");
  129. }
  130. {
  131. scoped_lock_type lock(m_connection_state_lock);
  132. if (m_state != session::state::open) {
  133. std::stringstream ss;
  134. ss << "connection::ping called from invalid state " << m_state;
  135. m_alog->write(log::alevel::devel,ss.str());
  136. ec = error::make_error_code(error::invalid_state);
  137. return;
  138. }
  139. }
  140. message_ptr msg = m_msg_manager->get_message();
  141. if (!msg) {
  142. ec = error::make_error_code(error::no_outgoing_buffers);
  143. return;
  144. }
  145. ec = m_processor->prepare_ping(payload,msg);
  146. if (ec) {return;}
  147. // set ping timer if we are listening for one
  148. if (m_pong_timeout_handler) {
  149. // Cancel any existing timers
  150. if (m_ping_timer) {
  151. m_ping_timer->cancel();
  152. }
  153. if (m_pong_timeout_dur > 0) {
  154. m_ping_timer = transport_con_type::set_timer(
  155. m_pong_timeout_dur,
  156. lib::bind(
  157. &type::handle_pong_timeout,
  158. type::get_shared(),
  159. payload,
  160. lib::placeholders::_1
  161. )
  162. );
  163. }
  164. if (!m_ping_timer) {
  165. // Our transport doesn't support timers
  166. m_elog->write(log::elevel::warn,"Warning: a pong_timeout_handler is \
  167. set but the transport in use does not support timeouts.");
  168. }
  169. }
  170. bool needs_writing = false;
  171. {
  172. scoped_lock_type lock(m_write_lock);
  173. write_push(msg);
  174. needs_writing = !m_write_flag && !m_send_queue.empty();
  175. }
  176. if (needs_writing) {
  177. transport_con_type::dispatch(lib::bind(
  178. &type::write_frame,
  179. type::get_shared()
  180. ));
  181. }
  182. ec = lib::error_code();
  183. }
  184. template<typename config>
  185. void connection<config>::ping(std::string const & payload) {
  186. lib::error_code ec;
  187. ping(payload,ec);
  188. if (ec) {
  189. throw exception(ec);
  190. }
  191. }
  192. template<typename config>
  193. void connection<config>::handle_pong_timeout(std::string payload,
  194. lib::error_code const & ec)
  195. {
  196. if (ec) {
  197. if (ec == transport::error::operation_aborted) {
  198. // ignore, this is expected
  199. return;
  200. }
  201. m_elog->write(log::elevel::devel,"pong_timeout error: "+ec.message());
  202. return;
  203. }
  204. if (m_pong_timeout_handler) {
  205. m_pong_timeout_handler(m_connection_hdl,payload);
  206. }
  207. }
  208. template <typename config>
  209. void connection<config>::pong(std::string const& payload, lib::error_code& ec) {
  210. if (m_alog->static_test(log::alevel::devel)) {
  211. m_alog->write(log::alevel::devel,"connection pong");
  212. }
  213. {
  214. scoped_lock_type lock(m_connection_state_lock);
  215. if (m_state != session::state::open) {
  216. std::stringstream ss;
  217. ss << "connection::pong called from invalid state " << m_state;
  218. m_alog->write(log::alevel::devel,ss.str());
  219. ec = error::make_error_code(error::invalid_state);
  220. return;
  221. }
  222. }
  223. message_ptr msg = m_msg_manager->get_message();
  224. if (!msg) {
  225. ec = error::make_error_code(error::no_outgoing_buffers);
  226. return;
  227. }
  228. ec = m_processor->prepare_pong(payload,msg);
  229. if (ec) {return;}
  230. bool needs_writing = false;
  231. {
  232. scoped_lock_type lock(m_write_lock);
  233. write_push(msg);
  234. needs_writing = !m_write_flag && !m_send_queue.empty();
  235. }
  236. if (needs_writing) {
  237. transport_con_type::dispatch(lib::bind(
  238. &type::write_frame,
  239. type::get_shared()
  240. ));
  241. }
  242. ec = lib::error_code();
  243. }
  244. template<typename config>
  245. void connection<config>::pong(std::string const & payload) {
  246. lib::error_code ec;
  247. pong(payload,ec);
  248. if (ec) {
  249. throw exception(ec);
  250. }
  251. }
  252. template <typename config>
  253. void connection<config>::close(close::status::value const code,
  254. std::string const & reason, lib::error_code & ec)
  255. {
  256. if (m_alog->static_test(log::alevel::devel)) {
  257. m_alog->write(log::alevel::devel,"connection close");
  258. }
  259. // Truncate reason to maximum size allowable in a close frame.
  260. std::string tr(reason,0,std::min<size_t>(reason.size(),
  261. frame::limits::close_reason_size));
  262. scoped_lock_type lock(m_connection_state_lock);
  263. if (m_state != session::state::open) {
  264. ec = error::make_error_code(error::invalid_state);
  265. return;
  266. }
  267. ec = this->send_close_frame(code,tr,false,close::status::terminal(code));
  268. }
  269. template<typename config>
  270. void connection<config>::close(close::status::value const code,
  271. std::string const & reason)
  272. {
  273. lib::error_code ec;
  274. close(code,reason,ec);
  275. if (ec) {
  276. throw exception(ec);
  277. }
  278. }
  279. /// Trigger the on_interrupt handler
  280. /**
  281. * This is thread safe if the transport is thread safe
  282. */
  283. template <typename config>
  284. lib::error_code connection<config>::interrupt() {
  285. m_alog->write(log::alevel::devel,"connection connection::interrupt");
  286. return transport_con_type::interrupt(
  287. lib::bind(
  288. &type::handle_interrupt,
  289. type::get_shared()
  290. )
  291. );
  292. }
  293. template <typename config>
  294. void connection<config>::handle_interrupt() {
  295. if (m_interrupt_handler) {
  296. m_interrupt_handler(m_connection_hdl);
  297. }
  298. }
  299. template <typename config>
  300. lib::error_code connection<config>::pause_reading() {
  301. m_alog->write(log::alevel::devel,"connection connection::pause_reading");
  302. return transport_con_type::dispatch(
  303. lib::bind(
  304. &type::handle_pause_reading,
  305. type::get_shared()
  306. )
  307. );
  308. }
  309. /// Pause reading handler. Not safe to call directly
  310. template <typename config>
  311. void connection<config>::handle_pause_reading() {
  312. m_alog->write(log::alevel::devel,"connection connection::handle_pause_reading");
  313. m_read_flag = false;
  314. }
  315. template <typename config>
  316. lib::error_code connection<config>::resume_reading() {
  317. m_alog->write(log::alevel::devel,"connection connection::resume_reading");
  318. return transport_con_type::dispatch(
  319. lib::bind(
  320. &type::handle_resume_reading,
  321. type::get_shared()
  322. )
  323. );
  324. }
  325. /// Resume reading helper method. Not safe to call directly
  326. template <typename config>
  327. void connection<config>::handle_resume_reading() {
  328. m_read_flag = true;
  329. read_frame();
  330. }
  331. template <typename config>
  332. bool connection<config>::get_secure() const {
  333. //scoped_lock_type lock(m_connection_state_lock);
  334. return m_uri->get_secure();
  335. }
  336. template <typename config>
  337. std::string const & connection<config>::get_host() const {
  338. //scoped_lock_type lock(m_connection_state_lock);
  339. return m_uri->get_host();
  340. }
  341. template <typename config>
  342. std::string const & connection<config>::get_resource() const {
  343. //scoped_lock_type lock(m_connection_state_lock);
  344. return m_uri->get_resource();
  345. }
  346. template <typename config>
  347. uint16_t connection<config>::get_port() const {
  348. //scoped_lock_type lock(m_connection_state_lock);
  349. return m_uri->get_port();
  350. }
  351. template <typename config>
  352. uri_ptr connection<config>::get_uri() const {
  353. //scoped_lock_type lock(m_connection_state_lock);
  354. return m_uri;
  355. }
  356. template <typename config>
  357. void connection<config>::set_uri(uri_ptr uri) {
  358. //scoped_lock_type lock(m_connection_state_lock);
  359. m_uri = uri;
  360. }
  361. template <typename config>
  362. std::string const & connection<config>::get_subprotocol() const {
  363. return m_subprotocol;
  364. }
  365. template <typename config>
  366. std::vector<std::string> const &
  367. connection<config>::get_requested_subprotocols() const {
  368. return m_requested_subprotocols;
  369. }
  370. template <typename config>
  371. void connection<config>::add_subprotocol(std::string const & value,
  372. lib::error_code & ec)
  373. {
  374. if (m_is_server) {
  375. ec = error::make_error_code(error::client_only);
  376. return;
  377. }
  378. // If the value is empty or has a non-RFC2616 token character it is invalid.
  379. if (value.empty() || std::find_if(value.begin(),value.end(),
  380. http::is_not_token_char) != value.end())
  381. {
  382. ec = error::make_error_code(error::invalid_subprotocol);
  383. return;
  384. }
  385. m_requested_subprotocols.push_back(value);
  386. }
  387. template <typename config>
  388. void connection<config>::add_subprotocol(std::string const & value) {
  389. lib::error_code ec;
  390. this->add_subprotocol(value,ec);
  391. if (ec) {
  392. throw exception(ec);
  393. }
  394. }
  395. template <typename config>
  396. void connection<config>::select_subprotocol(std::string const & value,
  397. lib::error_code & ec)
  398. {
  399. if (!m_is_server) {
  400. ec = error::make_error_code(error::server_only);
  401. return;
  402. }
  403. if (value.empty()) {
  404. ec = lib::error_code();
  405. return;
  406. }
  407. std::vector<std::string>::iterator it;
  408. it = std::find(m_requested_subprotocols.begin(),
  409. m_requested_subprotocols.end(),
  410. value);
  411. if (it == m_requested_subprotocols.end()) {
  412. ec = error::make_error_code(error::unrequested_subprotocol);
  413. return;
  414. }
  415. m_subprotocol = value;
  416. }
  417. template <typename config>
  418. void connection<config>::select_subprotocol(std::string const & value) {
  419. lib::error_code ec;
  420. this->select_subprotocol(value,ec);
  421. if (ec) {
  422. throw exception(ec);
  423. }
  424. }
  425. template <typename config>
  426. std::string const &
  427. connection<config>::get_request_header(std::string const & key) const {
  428. return m_request.get_header(key);
  429. }
  430. template <typename config>
  431. std::string const &
  432. connection<config>::get_request_body() const {
  433. return m_request.get_body();
  434. }
  435. template <typename config>
  436. std::string const &
  437. connection<config>::get_response_header(std::string const & key) const {
  438. return m_response.get_header(key);
  439. }
  440. // TODO: EXCEPTION_FREE
  441. template <typename config>
  442. void connection<config>::set_status(http::status_code::value code)
  443. {
  444. if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
  445. throw exception("Call to set_status from invalid state",
  446. error::make_error_code(error::invalid_state));
  447. }
  448. m_response.set_status(code);
  449. }
  450. // TODO: EXCEPTION_FREE
  451. template <typename config>
  452. void connection<config>::set_status(http::status_code::value code,
  453. std::string const & msg)
  454. {
  455. if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
  456. throw exception("Call to set_status from invalid state",
  457. error::make_error_code(error::invalid_state));
  458. }
  459. m_response.set_status(code,msg);
  460. }
  461. // TODO: EXCEPTION_FREE
  462. template <typename config>
  463. void connection<config>::set_body(std::string const & value) {
  464. if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
  465. throw exception("Call to set_status from invalid state",
  466. error::make_error_code(error::invalid_state));
  467. }
  468. m_response.set_body(value);
  469. }
  470. // TODO: EXCEPTION_FREE
  471. template <typename config>
  472. void connection<config>::append_header(std::string const & key,
  473. std::string const & val)
  474. {
  475. if (m_is_server) {
  476. if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
  477. // we are setting response headers for an incoming server connection
  478. m_response.append_header(key,val);
  479. } else {
  480. throw exception("Call to append_header from invalid state",
  481. error::make_error_code(error::invalid_state));
  482. }
  483. } else {
  484. if (m_internal_state == istate::USER_INIT) {
  485. // we are setting initial headers for an outgoing client connection
  486. m_request.append_header(key,val);
  487. } else {
  488. throw exception("Call to append_header from invalid state",
  489. error::make_error_code(error::invalid_state));
  490. }
  491. }
  492. }
  493. // TODO: EXCEPTION_FREE
  494. template <typename config>
  495. void connection<config>::replace_header(std::string const & key,
  496. std::string const & val)
  497. {
  498. if (m_is_server) {
  499. if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
  500. // we are setting response headers for an incoming server connection
  501. m_response.replace_header(key,val);
  502. } else {
  503. throw exception("Call to replace_header from invalid state",
  504. error::make_error_code(error::invalid_state));
  505. }
  506. } else {
  507. if (m_internal_state == istate::USER_INIT) {
  508. // we are setting initial headers for an outgoing client connection
  509. m_request.replace_header(key,val);
  510. } else {
  511. throw exception("Call to replace_header from invalid state",
  512. error::make_error_code(error::invalid_state));
  513. }
  514. }
  515. }
  516. // TODO: EXCEPTION_FREE
  517. template <typename config>
  518. void connection<config>::remove_header(std::string const & key)
  519. {
  520. if (m_is_server) {
  521. if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
  522. // we are setting response headers for an incoming server connection
  523. m_response.remove_header(key);
  524. } else {
  525. throw exception("Call to remove_header from invalid state",
  526. error::make_error_code(error::invalid_state));
  527. }
  528. } else {
  529. if (m_internal_state == istate::USER_INIT) {
  530. // we are setting initial headers for an outgoing client connection
  531. m_request.remove_header(key);
  532. } else {
  533. throw exception("Call to remove_header from invalid state",
  534. error::make_error_code(error::invalid_state));
  535. }
  536. }
  537. }
  538. /// Defer HTTP Response until later
  539. /**
  540. * Used in the http handler to defer the HTTP response for this connection
  541. * until later. Handshake timers will be canceled and the connection will be
  542. * left open until `send_http_response` or an equivalent is called.
  543. *
  544. * Warning: deferred connections won't time out and as a result can tie up
  545. * resources.
  546. *
  547. * @return A status code, zero on success, non-zero otherwise
  548. */
  549. template <typename config>
  550. lib::error_code connection<config>::defer_http_response() {
  551. // Cancel handshake timer, otherwise the connection will time out and we'll
  552. // close the connection before the app has a chance to send a response.
  553. if (m_handshake_timer) {
  554. m_handshake_timer->cancel();
  555. m_handshake_timer.reset();
  556. }
  557. // Do something to signal deferral
  558. m_http_state = session::http_state::deferred;
  559. return lib::error_code();
  560. }
  561. /// Send deferred HTTP Response (exception free)
  562. /**
  563. * Sends an http response to an HTTP connection that was deferred. This will
  564. * send a complete response including all headers, status line, and body
  565. * text. The connection will be closed afterwards.
  566. *
  567. * @since 0.6.0
  568. *
  569. * @param ec A status code, zero on success, non-zero otherwise
  570. */
  571. template <typename config>
  572. void connection<config>::send_http_response(lib::error_code & ec) {
  573. {
  574. scoped_lock_type lock(m_connection_state_lock);
  575. if (m_http_state != session::http_state::deferred) {
  576. ec = error::make_error_code(error::invalid_state);
  577. return;
  578. }
  579. m_http_state = session::http_state::body_written;
  580. }
  581. this->write_http_response(lib::error_code());
  582. ec = lib::error_code();
  583. }
  584. template <typename config>
  585. void connection<config>::send_http_response() {
  586. lib::error_code ec;
  587. this->send_http_response(ec);
  588. if (ec) {
  589. throw exception(ec);
  590. }
  591. }
  592. /******** logic thread ********/
  593. template <typename config>
  594. void connection<config>::start() {
  595. m_alog->write(log::alevel::devel,"connection start");
  596. if (m_internal_state != istate::USER_INIT) {
  597. m_alog->write(log::alevel::devel,"Start called in invalid state");
  598. this->terminate(error::make_error_code(error::invalid_state));
  599. return;
  600. }
  601. m_internal_state = istate::TRANSPORT_INIT;
  602. // Depending on how the transport implements init this function may return
  603. // immediately and call handle_transport_init later or call
  604. // handle_transport_init from this function.
  605. transport_con_type::init(
  606. lib::bind(
  607. &type::handle_transport_init,
  608. type::get_shared(),
  609. lib::placeholders::_1
  610. )
  611. );
  612. }
  613. template <typename config>
  614. void connection<config>::handle_transport_init(lib::error_code const & ec) {
  615. m_alog->write(log::alevel::devel,"connection handle_transport_init");
  616. lib::error_code ecm = ec;
  617. if (m_internal_state != istate::TRANSPORT_INIT) {
  618. m_alog->write(log::alevel::devel,
  619. "handle_transport_init must be called from transport init state");
  620. ecm = error::make_error_code(error::invalid_state);
  621. }
  622. if (ecm) {
  623. std::stringstream s;
  624. s << "handle_transport_init received error: "<< ecm.message();
  625. m_elog->write(log::elevel::rerror,s.str());
  626. this->terminate(ecm);
  627. return;
  628. }
  629. // At this point the transport is ready to read and write bytes.
  630. if (m_is_server) {
  631. m_internal_state = istate::READ_HTTP_REQUEST;
  632. this->read_handshake(1);
  633. } else {
  634. // We are a client. Set the processor to the version specified in the
  635. // config file and send a handshake request.
  636. m_internal_state = istate::WRITE_HTTP_REQUEST;
  637. m_processor = get_processor(config::client_version);
  638. this->send_http_request();
  639. }
  640. }
  641. template <typename config>
  642. void connection<config>::read_handshake(size_t num_bytes) {
  643. m_alog->write(log::alevel::devel,"connection read_handshake");
  644. if (m_open_handshake_timeout_dur > 0) {
  645. m_handshake_timer = transport_con_type::set_timer(
  646. m_open_handshake_timeout_dur,
  647. lib::bind(
  648. &type::handle_open_handshake_timeout,
  649. type::get_shared(),
  650. lib::placeholders::_1
  651. )
  652. );
  653. }
  654. transport_con_type::async_read_at_least(
  655. num_bytes,
  656. m_buf,
  657. config::connection_read_buffer_size,
  658. lib::bind(
  659. &type::handle_read_handshake,
  660. type::get_shared(),
  661. lib::placeholders::_1,
  662. lib::placeholders::_2
  663. )
  664. );
  665. }
  666. // All exit paths for this function need to call write_http_response() or submit
  667. // a new read request with this function as the handler.
  668. template <typename config>
  669. void connection<config>::handle_read_handshake(lib::error_code const & ec,
  670. size_t bytes_transferred)
  671. {
  672. m_alog->write(log::alevel::devel,"connection handle_read_handshake");
  673. lib::error_code ecm = ec;
  674. if (!ecm) {
  675. scoped_lock_type lock(m_connection_state_lock);
  676. if (m_state == session::state::connecting) {
  677. if (m_internal_state != istate::READ_HTTP_REQUEST) {
  678. ecm = error::make_error_code(error::invalid_state);
  679. }
  680. } else if (m_state == session::state::closed) {
  681. // The connection was canceled while the response was being sent,
  682. // usually by the handshake timer. This is basically expected
  683. // (though hopefully rare) and there is nothing we can do so ignore.
  684. m_alog->write(log::alevel::devel,
  685. "handle_read_handshake invoked after connection was closed");
  686. return;
  687. } else {
  688. ecm = error::make_error_code(error::invalid_state);
  689. }
  690. }
  691. if (ecm) {
  692. if (ecm == transport::error::eof && m_state == session::state::closed) {
  693. // we expect to get eof if the connection is closed already
  694. m_alog->write(log::alevel::devel,
  695. "got (expected) eof/state error from closed con");
  696. return;
  697. }
  698. log_err(log::elevel::rerror,"handle_read_handshake",ecm);
  699. this->terminate(ecm);
  700. return;
  701. }
  702. // Boundaries checking. TODO: How much of this should be done?
  703. if (bytes_transferred > config::connection_read_buffer_size) {
  704. m_elog->write(log::elevel::fatal,"Fatal boundaries checking error.");
  705. this->terminate(make_error_code(error::general));
  706. return;
  707. }
  708. size_t bytes_processed = 0;
  709. try {
  710. bytes_processed = m_request.consume(m_buf,bytes_transferred);
  711. } catch (http::exception &e) {
  712. // All HTTP exceptions will result in this request failing and an error
  713. // response being returned. No more bytes will be read in this con.
  714. m_response.set_status(e.m_error_code,e.m_error_msg);
  715. this->write_http_response_error(error::make_error_code(error::http_parse_error));
  716. return;
  717. }
  718. // More paranoid boundaries checking.
  719. // TODO: Is this overkill?
  720. if (bytes_processed > bytes_transferred) {
  721. m_elog->write(log::elevel::fatal,"Fatal boundaries checking error.");
  722. this->terminate(make_error_code(error::general));
  723. return;
  724. }
  725. if (m_alog->static_test(log::alevel::devel)) {
  726. std::stringstream s;
  727. s << "bytes_transferred: " << bytes_transferred
  728. << " bytes, bytes processed: " << bytes_processed << " bytes";
  729. m_alog->write(log::alevel::devel,s.str());
  730. }
  731. if (m_request.ready()) {
  732. lib::error_code processor_ec = this->initialize_processor();
  733. if (processor_ec) {
  734. this->write_http_response_error(processor_ec);
  735. return;
  736. }
  737. if (m_processor && m_processor->get_version() == 0) {
  738. // Version 00 has an extra requirement to read some bytes after the
  739. // handshake
  740. if (bytes_transferred-bytes_processed >= 8) {
  741. m_request.replace_header(
  742. "Sec-WebSocket-Key3",
  743. std::string(m_buf+bytes_processed,m_buf+bytes_processed+8)
  744. );
  745. bytes_processed += 8;
  746. } else {
  747. // TODO: need more bytes
  748. m_alog->write(log::alevel::devel,"short key3 read");
  749. m_response.set_status(http::status_code::internal_server_error);
  750. this->write_http_response_error(processor::error::make_error_code(processor::error::short_key3));
  751. return;
  752. }
  753. }
  754. if (m_alog->static_test(log::alevel::devel)) {
  755. m_alog->write(log::alevel::devel,m_request.raw());
  756. if (!m_request.get_header("Sec-WebSocket-Key3").empty()) {
  757. m_alog->write(log::alevel::devel,
  758. utility::to_hex(m_request.get_header("Sec-WebSocket-Key3")));
  759. }
  760. }
  761. // The remaining bytes in m_buf are frame data. Copy them to the
  762. // beginning of the buffer and note the length. They will be read after
  763. // the handshake completes and before more bytes are read.
  764. std::copy(m_buf+bytes_processed,m_buf+bytes_transferred,m_buf);
  765. m_buf_cursor = bytes_transferred-bytes_processed;
  766. m_internal_state = istate::PROCESS_HTTP_REQUEST;
  767. // We have the complete request. Process it.
  768. lib::error_code handshake_ec = this->process_handshake_request();
  769. // Write a response if this is a websocket connection or if it is an
  770. // HTTP connection for which the response has not been deferred or
  771. // started yet by a different system (i.e. still in init state).
  772. if (!m_is_http || m_http_state == session::http_state::init) {
  773. this->write_http_response(handshake_ec);
  774. }
  775. } else {
  776. // read at least 1 more byte
  777. transport_con_type::async_read_at_least(
  778. 1,
  779. m_buf,
  780. config::connection_read_buffer_size,
  781. lib::bind(
  782. &type::handle_read_handshake,
  783. type::get_shared(),
  784. lib::placeholders::_1,
  785. lib::placeholders::_2
  786. )
  787. );
  788. }
  789. }
  790. // write_http_response requires the request to be fully read and the connection
  791. // to be in the PROCESS_HTTP_REQUEST state. In some cases we can detect errors
  792. // before the request is fully read (specifically at a point where we aren't
  793. // sure if the hybi00 key3 bytes need to be read). This method sets the correct
  794. // state and calls write_http_response
  795. template <typename config>
  796. void connection<config>::write_http_response_error(lib::error_code const & ec) {
  797. if (m_internal_state != istate::READ_HTTP_REQUEST) {
  798. m_alog->write(log::alevel::devel,
  799. "write_http_response_error called in invalid state");
  800. this->terminate(error::make_error_code(error::invalid_state));
  801. return;
  802. }
  803. m_internal_state = istate::PROCESS_HTTP_REQUEST;
  804. this->write_http_response(ec);
  805. }
  806. // All exit paths for this function need to call write_http_response() or submit
  807. // a new read request with this function as the handler.
  808. template <typename config>
  809. void connection<config>::handle_read_frame(lib::error_code const & ec,
  810. size_t bytes_transferred)
  811. {
  812. //m_alog->write(log::alevel::devel,"connection handle_read_frame");
  813. lib::error_code ecm = ec;
  814. if (!ecm && m_internal_state != istate::PROCESS_CONNECTION) {
  815. ecm = error::make_error_code(error::invalid_state);
  816. }
  817. if (ecm) {
  818. log::level echannel = log::elevel::rerror;
  819. if (ecm == transport::error::eof) {
  820. if (m_state == session::state::closed) {
  821. // we expect to get eof if the connection is closed already
  822. // just ignore it
  823. m_alog->write(log::alevel::devel,"got eof from closed con");
  824. return;
  825. } else if (m_state == session::state::closing && !m_is_server) {
  826. // If we are a client we expect to get eof in the closing state,
  827. // this is a signal to terminate our end of the connection after
  828. // the closing handshake
  829. terminate(lib::error_code());
  830. return;
  831. }
  832. } else if (ecm == error::invalid_state) {
  833. // In general, invalid state errors in the closed state are the
  834. // result of handlers that were in the system already when the state
  835. // changed and should be ignored as they pose no problems and there
  836. // is nothing useful that we can do about them.
  837. if (m_state == session::state::closed) {
  838. m_alog->write(log::alevel::devel,
  839. "handle_read_frame: got invalid istate in closed state");
  840. return;
  841. }
  842. } else if (ecm == transport::error::action_after_shutdown) {
  843. echannel = log::elevel::info;
  844. } else {
  845. // TODO: more generally should we do something different here in the
  846. // case that m_state is cosed? Are errors after the connection is
  847. // already closed really an rerror?
  848. }
  849. log_err(echannel, "handle_read_frame", ecm);
  850. this->terminate(ecm);
  851. return;
  852. }
  853. // Boundaries checking. TODO: How much of this should be done?
  854. /*if (bytes_transferred > config::connection_read_buffer_size) {
  855. m_elog->write(log::elevel::fatal,"Fatal boundaries checking error");
  856. this->terminate(make_error_code(error::general));
  857. return;
  858. }*/
  859. size_t p = 0;
  860. if (m_alog->static_test(log::alevel::devel)) {
  861. std::stringstream s;
  862. s << "p = " << p << " bytes transferred = " << bytes_transferred;
  863. m_alog->write(log::alevel::devel,s.str());
  864. }
  865. while (p < bytes_transferred) {
  866. if (m_alog->static_test(log::alevel::devel)) {
  867. std::stringstream s;
  868. s << "calling consume with " << bytes_transferred-p << " bytes";
  869. m_alog->write(log::alevel::devel,s.str());
  870. }
  871. lib::error_code consume_ec;
  872. if (m_alog->static_test(log::alevel::devel)) {
  873. std::stringstream s;
  874. s << "Processing Bytes: " << utility::to_hex(reinterpret_cast<uint8_t*>(m_buf)+p,bytes_transferred-p);
  875. m_alog->write(log::alevel::devel,s.str());
  876. }
  877. p += m_processor->consume(
  878. reinterpret_cast<uint8_t*>(m_buf)+p,
  879. bytes_transferred-p,
  880. consume_ec
  881. );
  882. if (m_alog->static_test(log::alevel::devel)) {
  883. std::stringstream s;
  884. s << "bytes left after consume: " << bytes_transferred-p;
  885. m_alog->write(log::alevel::devel,s.str());
  886. }
  887. if (consume_ec) {
  888. log_err(log::elevel::rerror, "consume", consume_ec);
  889. if (config::drop_on_protocol_error) {
  890. this->terminate(consume_ec);
  891. return;
  892. } else {
  893. lib::error_code close_ec;
  894. this->close(
  895. processor::error::to_ws(consume_ec),
  896. consume_ec.message(),
  897. close_ec
  898. );
  899. if (close_ec) {
  900. log_err(log::elevel::fatal, "Protocol error close frame ", close_ec);
  901. this->terminate(close_ec);
  902. return;
  903. }
  904. }
  905. return;
  906. }
  907. if (m_processor->ready()) {
  908. if (m_alog->static_test(log::alevel::devel)) {
  909. std::stringstream s;
  910. s << "Complete message received. Dispatching";
  911. m_alog->write(log::alevel::devel,s.str());
  912. }
  913. message_ptr msg = m_processor->get_message();
  914. if (!msg) {
  915. m_alog->write(log::alevel::devel, "null message from m_processor");
  916. } else if (!is_control(msg->get_opcode())) {
  917. // data message, dispatch to user
  918. if (m_state != session::state::open) {
  919. m_elog->write(log::elevel::warn, "got non-close frame while closing");
  920. } else if (m_message_handler) {
  921. m_message_handler(m_connection_hdl, msg);
  922. }
  923. } else {
  924. process_control_frame(msg);
  925. }
  926. }
  927. }
  928. read_frame();
  929. }
  930. /// Issue a new transport read unless reading is paused.
  931. template <typename config>
  932. void connection<config>::read_frame() {
  933. if (!m_read_flag) {
  934. return;
  935. }
  936. transport_con_type::async_read_at_least(
  937. // std::min wont work with undefined static const values.
  938. // TODO: is there a more elegant way to do this?
  939. // Need to determine if requesting 1 byte or the exact number of bytes
  940. // is better here. 1 byte lets us be a bit more responsive at a
  941. // potential expense of additional runs through handle_read_frame
  942. /*(m_processor->get_bytes_needed() > config::connection_read_buffer_size ?
  943. config::connection_read_buffer_size : m_processor->get_bytes_needed())*/
  944. 1,
  945. m_buf,
  946. config::connection_read_buffer_size,
  947. m_handle_read_frame
  948. );
  949. }
  950. template <typename config>
  951. lib::error_code connection<config>::initialize_processor() {
  952. m_alog->write(log::alevel::devel,"initialize_processor");
  953. // if it isn't a websocket handshake nothing to do.
  954. if (!processor::is_websocket_handshake(m_request)) {
  955. return lib::error_code();
  956. }
  957. int version = processor::get_websocket_version(m_request);
  958. if (version < 0) {
  959. m_alog->write(log::alevel::devel, "BAD REQUEST: can't determine version");
  960. m_response.set_status(http::status_code::bad_request);
  961. return error::make_error_code(error::invalid_version);
  962. }
  963. m_processor = get_processor(version);
  964. // if the processor is not null we are done
  965. if (m_processor) {
  966. return lib::error_code();
  967. }
  968. // We don't have a processor for this version. Return bad request
  969. // with Sec-WebSocket-Version header filled with values we do accept
  970. m_alog->write(log::alevel::devel, "BAD REQUEST: no processor for version");
  971. m_response.set_status(http::status_code::bad_request);
  972. std::stringstream ss;
  973. std::string sep;
  974. std::vector<int>::const_iterator it;
  975. for (it = versions_supported.begin(); it != versions_supported.end(); it++)
  976. {
  977. ss << sep << *it;
  978. sep = ",";
  979. }
  980. m_response.replace_header("Sec-WebSocket-Version",ss.str());
  981. return error::make_error_code(error::unsupported_version);
  982. }
  983. template <typename config>
  984. lib::error_code connection<config>::process_handshake_request() {
  985. m_alog->write(log::alevel::devel,"process handshake request");
  986. if (!processor::is_websocket_handshake(m_request)) {
  987. // this is not a websocket handshake. Process as plain HTTP
  988. m_alog->write(log::alevel::devel,"HTTP REQUEST");
  989. // extract URI from request
  990. m_uri = processor::get_uri_from_host(
  991. m_request,
  992. (transport_con_type::is_secure() ? "https" : "http")
  993. );
  994. if (!m_uri->get_valid()) {
  995. m_alog->write(log::alevel::devel, "Bad request: failed to parse uri");
  996. m_response.set_status(http::status_code::bad_request);
  997. return error::make_error_code(error::invalid_uri);
  998. }
  999. if (m_http_handler) {
  1000. m_is_http = true;
  1001. m_http_handler(m_connection_hdl);
  1002. if (m_state == session::state::closed) {
  1003. return error::make_error_code(error::http_connection_ended);
  1004. }
  1005. } else {
  1006. set_status(http::status_code::upgrade_required);
  1007. return error::make_error_code(error::upgrade_required);
  1008. }
  1009. return lib::error_code();
  1010. }
  1011. lib::error_code ec = m_processor->validate_handshake(m_request);
  1012. // Validate: make sure all required elements are present.
  1013. if (ec){
  1014. // Not a valid handshake request
  1015. m_alog->write(log::alevel::devel, "Bad request " + ec.message());
  1016. m_response.set_status(http::status_code::bad_request);
  1017. return ec;
  1018. }
  1019. // Read extension parameters and set up values necessary for the end user
  1020. // to complete extension negotiation.
  1021. std::pair<lib::error_code,std::string> neg_results;
  1022. neg_results = m_processor->negotiate_extensions(m_request);
  1023. if (neg_results.first == processor::error::make_error_code(processor::error::extension_parse_error)) {
  1024. // There was a fatal error in extension parsing that should result in
  1025. // a failed connection attempt.
  1026. m_elog->write(log::elevel::info, "Bad request: " + neg_results.first.message());
  1027. m_response.set_status(http::status_code::bad_request);
  1028. return neg_results.first;
  1029. } else if (neg_results.first) {
  1030. // There was a fatal error in extension processing that is probably our
  1031. // fault. Consider extension negotiation to have failed and continue as
  1032. // if extensions were not supported
  1033. m_elog->write(log::elevel::info,
  1034. "Extension negotiation failed: " + neg_results.first.message());
  1035. } else {
  1036. // extension negotiation succeeded, set response header accordingly
  1037. // we don't send an empty extensions header because it breaks many
  1038. // clients.
  1039. if (neg_results.second.size() > 0) {
  1040. m_response.replace_header("Sec-WebSocket-Extensions",
  1041. neg_results.second);
  1042. }
  1043. }
  1044. // extract URI from request
  1045. m_uri = m_processor->get_uri(m_request);
  1046. if (!m_uri->get_valid()) {
  1047. m_alog->write(log::alevel::devel, "Bad request: failed to parse uri");
  1048. m_response.set_status(http::status_code::bad_request);
  1049. return error::make_error_code(error::invalid_uri);
  1050. }
  1051. // extract subprotocols
  1052. lib::error_code subp_ec = m_processor->extract_subprotocols(m_request,
  1053. m_requested_subprotocols);
  1054. if (subp_ec) {
  1055. // should we do anything?
  1056. }
  1057. // Ask application to validate the connection
  1058. if (!m_validate_handler || m_validate_handler(m_connection_hdl)) {
  1059. m_response.set_status(http::status_code::switching_protocols);
  1060. // Write the appropriate response headers based on request and
  1061. // processor version
  1062. ec = m_processor->process_handshake(m_request,m_subprotocol,m_response);
  1063. if (ec) {
  1064. std::stringstream s;
  1065. s << "Processing error: " << ec << "(" << ec.message() << ")";
  1066. m_alog->write(log::alevel::devel, s.str());
  1067. m_response.set_status(http::status_code::internal_server_error);
  1068. return ec;
  1069. }
  1070. } else {
  1071. // User application has rejected the handshake
  1072. m_alog->write(log::alevel::devel, "USER REJECT");
  1073. // Use Bad Request if the user handler did not provide a more
  1074. // specific http response error code.
  1075. // TODO: is there a better default?
  1076. if (m_response.get_status_code() == http::status_code::uninitialized) {
  1077. m_response.set_status(http::status_code::bad_request);
  1078. }
  1079. return error::make_error_code(error::rejected);
  1080. }
  1081. return lib::error_code();
  1082. }
  1083. template <typename config>
  1084. void connection<config>::write_http_response(lib::error_code const & ec) {
  1085. m_alog->write(log::alevel::devel,"connection write_http_response");
  1086. if (ec == error::make_error_code(error::http_connection_ended)) {
  1087. m_alog->write(log::alevel::http,"An HTTP handler took over the connection.");
  1088. return;
  1089. }
  1090. if (m_response.get_status_code() == http::status_code::uninitialized) {
  1091. m_response.set_status(http::status_code::internal_server_error);
  1092. m_ec = error::make_error_code(error::general);
  1093. } else {
  1094. m_ec = ec;
  1095. }
  1096. m_response.set_version("HTTP/1.1");
  1097. // Set server header based on the user agent settings
  1098. if (m_response.get_header("Server").empty()) {
  1099. if (!m_user_agent.empty()) {
  1100. m_response.replace_header("Server",m_user_agent);
  1101. } else {
  1102. m_response.remove_header("Server");
  1103. }
  1104. }
  1105. // have the processor generate the raw bytes for the wire (if it exists)
  1106. if (m_processor) {
  1107. m_handshake_buffer = m_processor->get_raw(m_response);
  1108. } else {
  1109. // a processor wont exist for raw HTTP responses.
  1110. m_handshake_buffer = m_response.raw();
  1111. }
  1112. if (m_alog->static_test(log::alevel::devel)) {
  1113. m_alog->write(log::alevel::devel,"Raw Handshake response:\n"+m_handshake_buffer);
  1114. if (!m_response.get_header("Sec-WebSocket-Key3").empty()) {
  1115. m_alog->write(log::alevel::devel,
  1116. utility::to_hex(m_response.get_header("Sec-WebSocket-Key3")));
  1117. }
  1118. }
  1119. // write raw bytes
  1120. transport_con_type::async_write(
  1121. m_handshake_buffer.data(),
  1122. m_handshake_buffer.size(),
  1123. lib::bind(
  1124. &type::handle_write_http_response,
  1125. type::get_shared(),
  1126. lib::placeholders::_1
  1127. )
  1128. );
  1129. }
  1130. template <typename config>
  1131. void connection<config>::handle_write_http_response(lib::error_code const & ec) {
  1132. m_alog->write(log::alevel::devel,"handle_write_http_response");
  1133. lib::error_code ecm = ec;
  1134. if (!ecm) {
  1135. scoped_lock_type lock(m_connection_state_lock);
  1136. if (m_state == session::state::connecting) {
  1137. if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
  1138. ecm = error::make_error_code(error::invalid_state);
  1139. }
  1140. } else if (m_state == session::state::closed) {
  1141. // The connection was canceled while the response was being sent,
  1142. // usually by the handshake timer. This is basically expected
  1143. // (though hopefully rare) and there is nothing we can do so ignore.
  1144. m_alog->write(log::alevel::devel,
  1145. "handle_write_http_response invoked after connection was closed");
  1146. return;
  1147. } else {
  1148. ecm = error::make_error_code(error::invalid_state);
  1149. }
  1150. }
  1151. if (ecm) {
  1152. if (ecm == transport::error::eof && m_state == session::state::closed) {
  1153. // we expect to get eof if the connection is closed already
  1154. m_alog->write(log::alevel::devel,
  1155. "got (expected) eof/state error from closed con");
  1156. return;
  1157. }
  1158. log_err(log::elevel::rerror,"handle_write_http_response",ecm);
  1159. this->terminate(ecm);
  1160. return;
  1161. }
  1162. if (m_handshake_timer) {
  1163. m_handshake_timer->cancel();
  1164. m_handshake_timer.reset();
  1165. }
  1166. if (m_response.get_status_code() != http::status_code::switching_protocols)
  1167. {
  1168. /*if (m_processor || m_ec == error::http_parse_error ||
  1169. m_ec == error::invalid_version || m_ec == error::unsupported_version
  1170. || m_ec == error::upgrade_required)
  1171. {*/
  1172. if (!m_is_http) {
  1173. std::stringstream s;
  1174. s << "Handshake ended with HTTP error: "
  1175. << m_response.get_status_code();
  1176. m_elog->write(log::elevel::rerror,s.str());
  1177. } else {
  1178. // if this was not a websocket connection, we have written
  1179. // the expected response and the connection can be closed.
  1180. this->log_http_result();
  1181. if (m_ec) {
  1182. m_alog->write(log::alevel::devel,
  1183. "got to writing HTTP results with m_ec set: "+m_ec.message());
  1184. }
  1185. m_ec = make_error_code(error::http_connection_ended);
  1186. }
  1187. this->terminate(m_ec);
  1188. return;
  1189. }
  1190. this->log_open_result();
  1191. m_internal_state = istate::PROCESS_CONNECTION;
  1192. m_state = session::state::open;
  1193. if (m_open_handler) {
  1194. m_open_handler(m_connection_hdl);
  1195. }
  1196. this->handle_read_frame(lib::error_code(), m_buf_cursor);
  1197. }
  1198. template <typename config>
  1199. void connection<config>::send_http_request() {
  1200. m_alog->write(log::alevel::devel,"connection send_http_request");
  1201. // TODO: origin header?
  1202. // Have the protocol processor fill in the appropriate fields based on the
  1203. // selected client version
  1204. if (m_processor) {
  1205. lib::error_code ec;
  1206. ec = m_processor->client_handshake_request(m_request,m_uri,
  1207. m_requested_subprotocols);
  1208. if (ec) {
  1209. log_err(log::elevel::fatal,"Internal library error: Processor",ec);
  1210. return;
  1211. }
  1212. } else {
  1213. m_elog->write(log::elevel::fatal,"Internal library error: missing processor");
  1214. return;
  1215. }
  1216. // Unless the user has overridden the user agent, send generic WS++ UA.
  1217. if (m_request.get_header("User-Agent").empty()) {
  1218. if (!m_user_agent.empty()) {
  1219. m_request.replace_header("User-Agent",m_user_agent);
  1220. } else {
  1221. m_request.remove_header("User-Agent");
  1222. }
  1223. }
  1224. m_handshake_buffer = m_request.raw();
  1225. if (m_alog->static_test(log::alevel::devel)) {
  1226. m_alog->write(log::alevel::devel,"Raw Handshake request:\n"+m_handshake_buffer);
  1227. }
  1228. if (m_open_handshake_timeout_dur > 0) {
  1229. m_handshake_timer = transport_con_type::set_timer(
  1230. m_open_handshake_timeout_dur,
  1231. lib::bind(
  1232. &type::handle_open_handshake_timeout,
  1233. type::get_shared(),
  1234. lib::placeholders::_1
  1235. )
  1236. );
  1237. }
  1238. transport_con_type::async_write(
  1239. m_handshake_buffer.data(),
  1240. m_handshake_buffer.size(),
  1241. lib::bind(
  1242. &type::handle_send_http_request,
  1243. type::get_shared(),
  1244. lib::placeholders::_1
  1245. )
  1246. );
  1247. }
  1248. template <typename config>
  1249. void connection<config>::handle_send_http_request(lib::error_code const & ec) {
  1250. m_alog->write(log::alevel::devel,"handle_send_http_request");
  1251. lib::error_code ecm = ec;
  1252. if (!ecm) {
  1253. scoped_lock_type lock(m_connection_state_lock);
  1254. if (m_state == session::state::connecting) {
  1255. if (m_internal_state != istate::WRITE_HTTP_REQUEST) {
  1256. ecm = error::make_error_code(error::invalid_state);
  1257. } else {
  1258. m_internal_state = istate::READ_HTTP_RESPONSE;
  1259. }
  1260. } else if (m_state == session::state::closed) {
  1261. // The connection was canceled while the response was being sent,
  1262. // usually by the handshake timer. This is basically expected
  1263. // (though hopefully rare) and there is nothing we can do so ignore.
  1264. m_alog->write(log::alevel::devel,
  1265. "handle_send_http_request invoked after connection was closed");
  1266. return;
  1267. } else {
  1268. ecm = error::make_error_code(error::invalid_state);
  1269. }
  1270. }
  1271. if (ecm) {
  1272. if (ecm == transport::error::eof && m_state == session::state::closed) {
  1273. // we expect to get eof if the connection is closed already
  1274. m_alog->write(log::alevel::devel,
  1275. "got (expected) eof/state error from closed con");
  1276. return;
  1277. }
  1278. log_err(log::elevel::rerror,"handle_send_http_request",ecm);
  1279. this->terminate(ecm);
  1280. return;
  1281. }
  1282. transport_con_type::async_read_at_least(
  1283. 1,
  1284. m_buf,
  1285. config::connection_read_buffer_size,
  1286. lib::bind(
  1287. &type::handle_read_http_response,
  1288. type::get_shared(),
  1289. lib::placeholders::_1,
  1290. lib::placeholders::_2
  1291. )
  1292. );
  1293. }
  1294. template <typename config>
  1295. void connection<config>::handle_read_http_response(lib::error_code const & ec,
  1296. size_t bytes_transferred)
  1297. {
  1298. m_alog->write(log::alevel::devel,"handle_read_http_response");
  1299. lib::error_code ecm = ec;
  1300. if (!ecm) {
  1301. scoped_lock_type lock(m_connection_state_lock);
  1302. if (m_state == session::state::connecting) {
  1303. if (m_internal_state != istate::READ_HTTP_RESPONSE) {
  1304. ecm = error::make_error_code(error::invalid_state);
  1305. }
  1306. } else if (m_state == session::state::closed) {
  1307. // The connection was canceled while the response was being sent,
  1308. // usually by the handshake timer. This is basically expected
  1309. // (though hopefully rare) and there is nothing we can do so ignore.
  1310. m_alog->write(log::alevel::devel,
  1311. "handle_read_http_response invoked after connection was closed");
  1312. return;
  1313. } else {
  1314. ecm = error::make_error_code(error::invalid_state);
  1315. }
  1316. }
  1317. if (ecm) {
  1318. if (ecm == transport::error::eof && m_state == session::state::closed) {
  1319. // we expect to get eof if the connection is closed already
  1320. m_alog->write(log::alevel::devel,
  1321. "got (expected) eof/state error from closed con");
  1322. return;
  1323. }
  1324. log_err(log::elevel::rerror,"handle_read_http_response",ecm);
  1325. this->terminate(ecm);
  1326. return;
  1327. }
  1328. size_t bytes_processed = 0;
  1329. // TODO: refactor this to use error codes rather than exceptions
  1330. try {
  1331. bytes_processed = m_response.consume(m_buf,bytes_transferred);
  1332. } catch (http::exception & e) {
  1333. m_elog->write(log::elevel::rerror,
  1334. std::string("error in handle_read_http_response: ")+e.what());
  1335. this->terminate(make_error_code(error::general));
  1336. return;
  1337. }
  1338. m_alog->write(log::alevel::devel,std::string("Raw response: ")+m_response.raw());
  1339. if (m_response.headers_ready()) {
  1340. if (m_handshake_timer) {
  1341. m_handshake_timer->cancel();
  1342. m_handshake_timer.reset();
  1343. }
  1344. lib::error_code validate_ec = m_processor->validate_server_handshake_response(
  1345. m_request,
  1346. m_response
  1347. );
  1348. if (validate_ec) {
  1349. log_err(log::elevel::rerror,"Server handshake response",validate_ec);
  1350. this->terminate(validate_ec);
  1351. return;
  1352. }
  1353. // Read extension parameters and set up values necessary for the end
  1354. // user to complete extension negotiation.
  1355. std::pair<lib::error_code,std::string> neg_results;
  1356. neg_results = m_processor->negotiate_extensions(m_response);
  1357. if (neg_results.first) {
  1358. // There was a fatal error in extension negotiation. For the moment
  1359. // kill all connections that fail extension negotiation.
  1360. // TODO: deal with cases where the response is well formed but
  1361. // doesn't match the options requested by the client. Its possible
  1362. // that the best behavior in this cases is to log and continue with
  1363. // an unextended connection.
  1364. m_alog->write(log::alevel::devel, "Extension negotiation failed: "
  1365. + neg_results.first.message());
  1366. this->terminate(make_error_code(error::extension_neg_failed));
  1367. // TODO: close connection with reason 1010 (and list extensions)
  1368. }
  1369. // response is valid, connection can now be assumed to be open
  1370. m_internal_state = istate::PROCESS_CONNECTION;
  1371. m_state = session::state::open;
  1372. this->log_open_result();
  1373. if (m_open_handler) {
  1374. m_open_handler(m_connection_hdl);
  1375. }
  1376. // The remaining bytes in m_buf are frame data. Copy them to the
  1377. // beginning of the buffer and note the length. They will be read after
  1378. // the handshake completes and before more bytes are read.
  1379. std::copy(m_buf+bytes_processed,m_buf+bytes_transferred,m_buf);
  1380. m_buf_cursor = bytes_transferred-bytes_processed;
  1381. this->handle_read_frame(lib::error_code(), m_buf_cursor);
  1382. } else {
  1383. transport_con_type::async_read_at_least(
  1384. 1,
  1385. m_buf,
  1386. config::connection_read_buffer_size,
  1387. lib::bind(
  1388. &type::handle_read_http_response,
  1389. type::get_shared(),
  1390. lib::placeholders::_1,
  1391. lib::placeholders::_2
  1392. )
  1393. );
  1394. }
  1395. }
  1396. template <typename config>
  1397. void connection<config>::handle_open_handshake_timeout(
  1398. lib::error_code const & ec)
  1399. {
  1400. if (ec == transport::error::operation_aborted) {
  1401. m_alog->write(log::alevel::devel,"open handshake timer cancelled");
  1402. } else if (ec) {
  1403. m_alog->write(log::alevel::devel,
  1404. "open handle_open_handshake_timeout error: "+ec.message());
  1405. // TODO: ignore or fail here?
  1406. } else {
  1407. m_alog->write(log::alevel::devel,"open handshake timer expired");
  1408. terminate(make_error_code(error::open_handshake_timeout));
  1409. }
  1410. }
  1411. template <typename config>
  1412. void connection<config>::handle_close_handshake_timeout(
  1413. lib::error_code const & ec)
  1414. {
  1415. if (ec == transport::error::operation_aborted) {
  1416. m_alog->write(log::alevel::devel,"asio close handshake timer cancelled");
  1417. } else if (ec) {
  1418. m_alog->write(log::alevel::devel,
  1419. "asio open handle_close_handshake_timeout error: "+ec.message());
  1420. // TODO: ignore or fail here?
  1421. } else {
  1422. m_alog->write(log::alevel::devel, "asio close handshake timer expired");
  1423. terminate(make_error_code(error::close_handshake_timeout));
  1424. }
  1425. }
  1426. template <typename config>
  1427. void connection<config>::terminate(lib::error_code const & ec) {
  1428. if (m_alog->static_test(log::alevel::devel)) {
  1429. m_alog->write(log::alevel::devel,"connection terminate");
  1430. }
  1431. // Cancel close handshake timer
  1432. if (m_handshake_timer) {
  1433. m_handshake_timer->cancel();
  1434. m_handshake_timer.reset();
  1435. }
  1436. terminate_status tstat = unknown;
  1437. if (ec) {
  1438. m_ec = ec;
  1439. m_local_close_code = close::status::abnormal_close;
  1440. m_local_close_reason = ec.message();
  1441. }
  1442. // TODO: does any of this need a mutex?
  1443. if (m_is_http) {
  1444. m_http_state = session::http_state::closed;
  1445. }
  1446. if (m_state == session::state::connecting) {
  1447. m_state = session::state::closed;
  1448. tstat = failed;
  1449. // Log fail result here before socket is shut down and we can't get
  1450. // the remote address, etc anymore
  1451. if (m_ec != error::http_connection_ended) {
  1452. log_fail_result();
  1453. }
  1454. } else if (m_state != session::state::closed) {
  1455. m_state = session::state::closed;
  1456. tstat = closed;
  1457. } else {
  1458. m_alog->write(log::alevel::devel,
  1459. "terminate called on connection that was already terminated");
  1460. return;
  1461. }
  1462. // TODO: choose between shutdown and close based on error code sent
  1463. transport_con_type::async_shutdown(
  1464. lib::bind(
  1465. &type::handle_terminate,
  1466. type::get_shared(),
  1467. tstat,
  1468. lib::placeholders::_1
  1469. )
  1470. );
  1471. }
  1472. template <typename config>
  1473. void connection<config>::handle_terminate(terminate_status tstat,
  1474. lib::error_code const & ec)
  1475. {
  1476. if (m_alog->static_test(log::alevel::devel)) {
  1477. m_alog->write(log::alevel::devel,"connection handle_terminate");
  1478. }
  1479. if (ec) {
  1480. // there was an error actually shutting down the connection
  1481. log_err(log::elevel::devel,"handle_terminate",ec);
  1482. }
  1483. // clean shutdown
  1484. if (tstat == failed) {
  1485. if (m_ec != error::http_connection_ended) {
  1486. if (m_fail_handler) {
  1487. m_fail_handler(m_connection_hdl);
  1488. }
  1489. }
  1490. } else if (tstat == closed) {
  1491. if (m_close_handler) {
  1492. m_close_handler(m_connection_hdl);
  1493. }
  1494. log_close_result();
  1495. } else {
  1496. m_elog->write(log::elevel::rerror,"Unknown terminate_status");
  1497. }
  1498. // call the termination handler if it exists
  1499. // if it exists it might (but shouldn't) refer to a bad memory location.
  1500. // If it does, we don't care and should catch and ignore it.
  1501. if (m_termination_handler) {
  1502. try {
  1503. m_termination_handler(type::get_shared());
  1504. } catch (std::exception const & e) {
  1505. m_elog->write(log::elevel::warn,
  1506. std::string("termination_handler call failed. Reason was: ")+e.what());
  1507. }
  1508. }
  1509. }
  1510. template <typename config>
  1511. void connection<config>::write_frame() {
  1512. //m_alog->write(log::alevel::devel,"connection write_frame");
  1513. {
  1514. scoped_lock_type lock(m_write_lock);
  1515. // Check the write flag. If true, there is an outstanding transport
  1516. // write already. In this case we just return. The write handler will
  1517. // start a new write if the write queue isn't empty. If false, we set
  1518. // the write flag and proceed to initiate a transport write.
  1519. if (m_write_flag) {
  1520. return;
  1521. }
  1522. // pull off all the messages that are ready to write.
  1523. // stop if we get a message marked terminal
  1524. message_ptr next_message = write_pop();
  1525. while (next_message) {
  1526. m_current_msgs.push_back(next_message);
  1527. if (!next_message->get_terminal()) {
  1528. next_message = write_pop();
  1529. } else {
  1530. next_message = message_ptr();
  1531. }
  1532. }
  1533. if (m_current_msgs.empty()) {
  1534. // there was nothing to send
  1535. return;
  1536. } else {
  1537. // At this point we own the next messages to be sent and are
  1538. // responsible for holding the write flag until they are
  1539. // successfully sent or there is some error
  1540. m_write_flag = true;
  1541. }
  1542. }
  1543. typename std::vector<message_ptr>::iterator it;
  1544. for (it = m_current_msgs.begin(); it != m_current_msgs.end(); ++it) {
  1545. std::string const & header = (*it)->get_header();
  1546. std::string const & payload = (*it)->get_payload();
  1547. m_send_buffer.push_back(transport::buffer(header.c_str(),header.size()));
  1548. m_send_buffer.push_back(transport::buffer(payload.c_str(),payload.size()));
  1549. }
  1550. // Print detailed send stats if those log levels are enabled
  1551. if (m_alog->static_test(log::alevel::frame_header)) {
  1552. if (m_alog->dynamic_test(log::alevel::frame_header)) {
  1553. std::stringstream general,header,payload;
  1554. general << "Dispatching write containing " << m_current_msgs.size()
  1555. <<" message(s) containing ";
  1556. header << "Header Bytes: \n";
  1557. payload << "Payload Bytes: \n";
  1558. size_t hbytes = 0;
  1559. size_t pbytes = 0;
  1560. for (size_t i = 0; i < m_current_msgs.size(); i++) {
  1561. hbytes += m_current_msgs[i]->get_header().size();
  1562. pbytes += m_current_msgs[i]->get_payload().size();
  1563. header << "[" << i << "] ("
  1564. << m_current_msgs[i]->get_header().size() << ") "
  1565. << utility::to_hex(m_current_msgs[i]->get_header()) << "\n";
  1566. if (m_alog->static_test(log::alevel::frame_payload)) {
  1567. if (m_alog->dynamic_test(log::alevel::frame_payload)) {
  1568. payload << "[" << i << "] ("
  1569. << m_current_msgs[i]->get_payload().size() << ") ["<<m_current_msgs[i]->get_opcode()<<"] "
  1570. << (m_current_msgs[i]->get_opcode() == frame::opcode::text ?
  1571. m_current_msgs[i]->get_payload() :
  1572. utility::to_hex(m_current_msgs[i]->get_payload())
  1573. )
  1574. << "\n";
  1575. }
  1576. }
  1577. }
  1578. general << hbytes << " header bytes and " << pbytes << " payload bytes";
  1579. m_alog->write(log::alevel::frame_header,general.str());
  1580. m_alog->write(log::alevel::frame_header,header.str());
  1581. m_alog->write(log::alevel::frame_payload,payload.str());
  1582. }
  1583. }
  1584. transport_con_type::async_write(
  1585. m_send_buffer,
  1586. m_write_frame_handler
  1587. );
  1588. }
  1589. template <typename config>
  1590. void connection<config>::handle_write_frame(lib::error_code const & ec)
  1591. {
  1592. if (m_alog->static_test(log::alevel::devel)) {
  1593. m_alog->write(log::alevel::devel,"connection handle_write_frame");
  1594. }
  1595. bool terminal = m_current_msgs.back()->get_terminal();
  1596. m_send_buffer.clear();
  1597. m_current_msgs.clear();
  1598. // TODO: recycle instead of deleting
  1599. if (ec) {
  1600. log_err(log::elevel::fatal,"handle_write_frame",ec);
  1601. this->terminate(ec);
  1602. return;
  1603. }
  1604. if (terminal) {
  1605. this->terminate(lib::error_code());
  1606. return;
  1607. }
  1608. bool needs_writing = false;
  1609. {
  1610. scoped_lock_type lock(m_write_lock);
  1611. // release write flag
  1612. m_write_flag = false;
  1613. needs_writing = !m_send_queue.empty();
  1614. }
  1615. if (needs_writing) {
  1616. transport_con_type::dispatch(lib::bind(
  1617. &type::write_frame,
  1618. type::get_shared()
  1619. ));
  1620. }
  1621. }
  1622. template <typename config>
  1623. std::vector<int> const & connection<config>::get_supported_versions() const
  1624. {
  1625. return versions_supported;
  1626. }
  1627. template <typename config>
  1628. void connection<config>::process_control_frame(typename config::message_type::ptr msg)
  1629. {
  1630. m_alog->write(log::alevel::devel,"process_control_frame");
  1631. frame::opcode::value op = msg->get_opcode();
  1632. lib::error_code ec;
  1633. std::stringstream s;
  1634. s << "Control frame received with opcode " << op;
  1635. m_alog->write(log::alevel::control,s.str());
  1636. if (m_state == session::state::closed) {
  1637. m_elog->write(log::elevel::warn,"got frame in state closed");
  1638. return;
  1639. }
  1640. if (op != frame::opcode::CLOSE && m_state != session::state::open) {
  1641. m_elog->write(log::elevel::warn,"got non-close frame in state closing");
  1642. return;
  1643. }
  1644. if (op == frame::opcode::PING) {
  1645. bool should_reply = true;
  1646. if (m_ping_handler) {
  1647. should_reply = m_ping_handler(m_connection_hdl, msg->get_payload());
  1648. }
  1649. if (should_reply) {
  1650. this->pong(msg->get_payload(),ec);
  1651. if (ec) {
  1652. log_err(log::elevel::devel,"Failed to send response pong",ec);
  1653. }
  1654. }
  1655. } else if (op == frame::opcode::PONG) {
  1656. if (m_pong_handler) {
  1657. m_pong_handler(m_connection_hdl, msg->get_payload());
  1658. }
  1659. if (m_ping_timer) {
  1660. m_ping_timer->cancel();
  1661. }
  1662. } else if (op == frame::opcode::CLOSE) {
  1663. m_alog->write(log::alevel::devel,"got close frame");
  1664. // record close code and reason somewhere
  1665. m_remote_close_code = close::extract_code(msg->get_payload(),ec);
  1666. if (ec) {
  1667. s.str("");
  1668. if (config::drop_on_protocol_error) {
  1669. s << "Received invalid close code " << m_remote_close_code
  1670. << " dropping connection per config.";
  1671. m_elog->write(log::elevel::devel,s.str());
  1672. this->terminate(ec);
  1673. } else {
  1674. s << "Received invalid close code " << m_remote_close_code
  1675. << " sending acknowledgement and closing";
  1676. m_elog->write(log::elevel::devel,s.str());
  1677. ec = send_close_ack(close::status::protocol_error,
  1678. "Invalid close code");
  1679. if (ec) {
  1680. log_err(log::elevel::devel,"send_close_ack",ec);
  1681. }
  1682. }
  1683. return;
  1684. }
  1685. m_remote_close_reason = close::extract_reason(msg->get_payload(),ec);
  1686. if (ec) {
  1687. if (config::drop_on_protocol_error) {
  1688. m_elog->write(log::elevel::devel,
  1689. "Received invalid close reason. Dropping connection per config");
  1690. this->terminate(ec);
  1691. } else {
  1692. m_elog->write(log::elevel::devel,
  1693. "Received invalid close reason. Sending acknowledgement and closing");
  1694. ec = send_close_ack(close::status::protocol_error,
  1695. "Invalid close reason");
  1696. if (ec) {
  1697. log_err(log::elevel::devel,"send_close_ack",ec);
  1698. }
  1699. }
  1700. return;
  1701. }
  1702. if (m_state == session::state::open) {
  1703. s.str("");
  1704. s << "Received close frame with code " << m_remote_close_code
  1705. << " and reason " << m_remote_close_reason;
  1706. m_alog->write(log::alevel::devel,s.str());
  1707. ec = send_close_ack();
  1708. if (ec) {
  1709. log_err(log::elevel::devel,"send_close_ack",ec);
  1710. }
  1711. } else if (m_state == session::state::closing && !m_was_clean) {
  1712. // ack of our close
  1713. m_alog->write(log::alevel::devel, "Got acknowledgement of close");
  1714. m_was_clean = true;
  1715. // If we are a server terminate the connection now. Clients should
  1716. // leave the connection open to give the server an opportunity to
  1717. // initiate the TCP close. The client's timer will handle closing
  1718. // its side of the connection if the server misbehaves.
  1719. //
  1720. // TODO: different behavior if the underlying transport doesn't
  1721. // support timers?
  1722. if (m_is_server) {
  1723. terminate(lib::error_code());
  1724. }
  1725. } else {
  1726. // spurious, ignore
  1727. m_elog->write(log::elevel::devel, "Got close frame in wrong state");
  1728. }
  1729. } else {
  1730. // got an invalid control opcode
  1731. m_elog->write(log::elevel::devel, "Got control frame with invalid opcode");
  1732. // initiate protocol error shutdown
  1733. }
  1734. }
  1735. template <typename config>
  1736. lib::error_code connection<config>::send_close_ack(close::status::value code,
  1737. std::string const & reason)
  1738. {
  1739. return send_close_frame(code,reason,true,m_is_server);
  1740. }
  1741. template <typename config>
  1742. lib::error_code connection<config>::send_close_frame(close::status::value code,
  1743. std::string const & reason, bool ack, bool terminal)
  1744. {
  1745. m_alog->write(log::alevel::devel,"send_close_frame");
  1746. // check for special codes
  1747. // If silent close is set, respect it and blank out close information
  1748. // Otherwise use whatever has been specified in the parameters. If
  1749. // parameters specifies close::status::blank then determine what to do
  1750. // based on whether or not this is an ack. If it is not an ack just
  1751. // send blank info. If it is an ack then echo the close information from
  1752. // the remote endpoint.
  1753. if (config::silent_close) {
  1754. m_alog->write(log::alevel::devel,"closing silently");
  1755. m_local_close_code = close::status::no_status;
  1756. m_local_close_reason.clear();
  1757. } else if (code != close::status::blank) {
  1758. m_alog->write(log::alevel::devel,"closing with specified codes");
  1759. m_local_close_code = code;
  1760. m_local_close_reason = reason;
  1761. } else if (!ack) {
  1762. m_alog->write(log::alevel::devel,"closing with no status code");
  1763. m_local_close_code = close::status::no_status;
  1764. m_local_close_reason.clear();
  1765. } else if (m_remote_close_code == close::status::no_status) {
  1766. m_alog->write(log::alevel::devel,
  1767. "acknowledging a no-status close with normal code");
  1768. m_local_close_code = close::status::normal;
  1769. m_local_close_reason.clear();
  1770. } else {
  1771. m_alog->write(log::alevel::devel,"acknowledging with remote codes");
  1772. m_local_close_code = m_remote_close_code;
  1773. m_local_close_reason = m_remote_close_reason;
  1774. }
  1775. std::stringstream s;
  1776. s << "Closing with code: " << m_local_close_code << ", and reason: "
  1777. << m_local_close_reason;
  1778. m_alog->write(log::alevel::devel,s.str());
  1779. message_ptr msg = m_msg_manager->get_message();
  1780. if (!msg) {
  1781. return error::make_error_code(error::no_outgoing_buffers);
  1782. }
  1783. lib::error_code ec = m_processor->prepare_close(m_local_close_code,
  1784. m_local_close_reason,msg);
  1785. if (ec) {
  1786. return ec;
  1787. }
  1788. // Messages flagged terminal will result in the TCP connection being dropped
  1789. // after the message has been written. This is typically used when servers
  1790. // send an ack and when any endpoint encounters a protocol error
  1791. if (terminal) {
  1792. msg->set_terminal(true);
  1793. }
  1794. m_state = session::state::closing;
  1795. if (ack) {
  1796. m_was_clean = true;
  1797. }
  1798. // Start a timer so we don't wait forever for the acknowledgement close
  1799. // frame
  1800. if (m_close_handshake_timeout_dur > 0) {
  1801. m_handshake_timer = transport_con_type::set_timer(
  1802. m_close_handshake_timeout_dur,
  1803. lib::bind(
  1804. &type::handle_close_handshake_timeout,
  1805. type::get_shared(),
  1806. lib::placeholders::_1
  1807. )
  1808. );
  1809. }
  1810. bool needs_writing = false;
  1811. {
  1812. scoped_lock_type lock(m_write_lock);
  1813. write_push(msg);
  1814. needs_writing = !m_write_flag && !m_send_queue.empty();
  1815. }
  1816. if (needs_writing) {
  1817. transport_con_type::dispatch(lib::bind(
  1818. &type::write_frame,
  1819. type::get_shared()
  1820. ));
  1821. }
  1822. return lib::error_code();
  1823. }
  1824. template <typename config>
  1825. typename connection<config>::processor_ptr
  1826. connection<config>::get_processor(int version) const {
  1827. // TODO: allow disabling certain versions
  1828. processor_ptr p;
  1829. switch (version) {
  1830. case 0:
  1831. p = lib::make_shared<processor::hybi00<config> >(
  1832. transport_con_type::is_secure(),
  1833. m_is_server,
  1834. m_msg_manager
  1835. );
  1836. break;
  1837. case 7:
  1838. p = lib::make_shared<processor::hybi07<config> >(
  1839. transport_con_type::is_secure(),
  1840. m_is_server,
  1841. m_msg_manager,
  1842. lib::ref(m_rng)
  1843. );
  1844. break;
  1845. case 8:
  1846. p = lib::make_shared<processor::hybi08<config> >(
  1847. transport_con_type::is_secure(),
  1848. m_is_server,
  1849. m_msg_manager,
  1850. lib::ref(m_rng)
  1851. );
  1852. break;
  1853. case 13:
  1854. p = lib::make_shared<processor::hybi13<config> >(
  1855. transport_con_type::is_secure(),
  1856. m_is_server,
  1857. m_msg_manager,
  1858. lib::ref(m_rng)
  1859. );
  1860. break;
  1861. default:
  1862. return p;
  1863. }
  1864. // Settings not configured by the constructor
  1865. p->set_max_message_size(m_max_message_size);
  1866. return p;
  1867. }
  1868. template <typename config>
  1869. void connection<config>::write_push(typename config::message_type::ptr msg)
  1870. {
  1871. if (!msg) {
  1872. return;
  1873. }
  1874. m_send_buffer_size += msg->get_payload().size();
  1875. m_send_queue.push(msg);
  1876. if (m_alog->static_test(log::alevel::devel)) {
  1877. std::stringstream s;
  1878. s << "write_push: message count: " << m_send_queue.size()
  1879. << " buffer size: " << m_send_buffer_size;
  1880. m_alog->write(log::alevel::devel,s.str());
  1881. }
  1882. }
  1883. template <typename config>
  1884. typename config::message_type::ptr connection<config>::write_pop()
  1885. {
  1886. message_ptr msg;
  1887. if (m_send_queue.empty()) {
  1888. return msg;
  1889. }
  1890. msg = m_send_queue.front();
  1891. m_send_buffer_size -= msg->get_payload().size();
  1892. m_send_queue.pop();
  1893. if (m_alog->static_test(log::alevel::devel)) {
  1894. std::stringstream s;
  1895. s << "write_pop: message count: " << m_send_queue.size()
  1896. << " buffer size: " << m_send_buffer_size;
  1897. m_alog->write(log::alevel::devel,s.str());
  1898. }
  1899. return msg;
  1900. }
  1901. template <typename config>
  1902. void connection<config>::log_open_result()
  1903. {
  1904. std::stringstream s;
  1905. int version;
  1906. if (!processor::is_websocket_handshake(m_request)) {
  1907. version = -1;
  1908. } else {
  1909. version = processor::get_websocket_version(m_request);
  1910. }
  1911. // Connection Type
  1912. s << (version == -1 ? "HTTP" : "WebSocket") << " Connection ";
  1913. // Remote endpoint address
  1914. s << transport_con_type::get_remote_endpoint() << " ";
  1915. // Version string if WebSocket
  1916. if (version != -1) {
  1917. s << "v" << version << " ";
  1918. }
  1919. // User Agent
  1920. std::string ua = m_request.get_header("User-Agent");
  1921. if (ua.empty()) {
  1922. s << "\"\" ";
  1923. } else {
  1924. // check if there are any quotes in the user agent
  1925. s << "\"" << utility::string_replace_all(ua,"\"","\\\"") << "\" ";
  1926. }
  1927. // URI
  1928. s << (m_uri ? m_uri->get_resource() : "NULL") << " ";
  1929. // Status code
  1930. s << m_response.get_status_code();
  1931. m_alog->write(log::alevel::connect,s.str());
  1932. }
  1933. template <typename config>
  1934. void connection<config>::log_close_result()
  1935. {
  1936. std::stringstream s;
  1937. s << "Disconnect "
  1938. << "close local:[" << m_local_close_code
  1939. << (m_local_close_reason.empty() ? "" : ","+m_local_close_reason)
  1940. << "] remote:[" << m_remote_close_code
  1941. << (m_remote_close_reason.empty() ? "" : ","+m_remote_close_reason) << "]";
  1942. m_alog->write(log::alevel::disconnect,s.str());
  1943. }
  1944. template <typename config>
  1945. void connection<config>::log_fail_result()
  1946. {
  1947. std::stringstream s;
  1948. int version = processor::get_websocket_version(m_request);
  1949. // Connection Type
  1950. s << "WebSocket Connection ";
  1951. // Remote endpoint address & WebSocket version
  1952. s << transport_con_type::get_remote_endpoint();
  1953. if (version < 0) {
  1954. s << " -";
  1955. } else {
  1956. s << " v" << version;
  1957. }
  1958. // User Agent
  1959. std::string ua = m_request.get_header("User-Agent");
  1960. if (ua.empty()) {
  1961. s << " \"\" ";
  1962. } else {
  1963. // check if there are any quotes in the user agent
  1964. s << " \"" << utility::string_replace_all(ua,"\"","\\\"") << "\" ";
  1965. }
  1966. // URI
  1967. s << (m_uri ? m_uri->get_resource() : "-");
  1968. // HTTP Status code
  1969. s << " " << m_response.get_status_code();
  1970. // WebSocket++ error code & reason
  1971. s << " " << m_ec << " " << m_ec.message();
  1972. m_alog->write(log::alevel::fail,s.str());
  1973. }
  1974. template <typename config>
  1975. void connection<config>::log_http_result() {
  1976. std::stringstream s;
  1977. if (processor::is_websocket_handshake(m_request)) {
  1978. m_alog->write(log::alevel::devel,"Call to log_http_result for WebSocket");
  1979. return;
  1980. }
  1981. // Connection Type
  1982. s << (m_request.get_header("host").empty() ? "-" : m_request.get_header("host"))
  1983. << " " << transport_con_type::get_remote_endpoint()
  1984. << " \"" << m_request.get_method()
  1985. << " " << (m_uri ? m_uri->get_resource() : "-")
  1986. << " " << m_request.get_version() << "\" " << m_response.get_status_code()
  1987. << " " << m_response.get_body().size();
  1988. // User Agent
  1989. std::string ua = m_request.get_header("User-Agent");
  1990. if (ua.empty()) {
  1991. s << " \"\" ";
  1992. } else {
  1993. // check if there are any quotes in the user agent
  1994. s << " \"" << utility::string_replace_all(ua,"\"","\\\"") << "\" ";
  1995. }
  1996. m_alog->write(log::alevel::http,s.str());
  1997. }
  1998. } // namespace websocketpp
  1999. #endif // WEBSOCKETPP_CONNECTION_IMPL_HPP