| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332 |
- /*
- * Copyright (c) 2014, Peter Thorson. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- * * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * * Neither the name of the WebSocket++ Project nor the
- * names of its contributors may be used to endorse or promote products
- * derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
- #ifndef WEBSOCKETPP_CONNECTION_IMPL_HPP
- #define WEBSOCKETPP_CONNECTION_IMPL_HPP
- #include <websocketpp/processors/hybi00.hpp>
- #include <websocketpp/processors/hybi07.hpp>
- #include <websocketpp/processors/hybi08.hpp>
- #include <websocketpp/processors/hybi13.hpp>
- #include <websocketpp/processors/processor.hpp>
- #include <websocketpp/common/platforms.hpp>
- #include <websocketpp/common/system_error.hpp>
- #include <algorithm>
- #include <exception>
- #include <sstream>
- #include <string>
- #include <utility>
- #include <vector>
- namespace websocketpp {
- namespace istate = session::internal_state;
- template <typename config>
- void connection<config>::set_termination_handler(
- termination_handler new_handler)
- {
- m_alog.write(log::alevel::devel,
- "connection set_termination_handler");
- //scoped_lock_type lock(m_connection_state_lock);
- m_termination_handler = new_handler;
- }
- template <typename config>
- std::string const & connection<config>::get_origin() const {
- //scoped_lock_type lock(m_connection_state_lock);
- return m_processor->get_origin(m_request);
- }
- template <typename config>
- size_t connection<config>::get_buffered_amount() const {
- //scoped_lock_type lock(m_connection_state_lock);
- return m_send_buffer_size;
- }
- template <typename config>
- session::state::value connection<config>::get_state() const {
- //scoped_lock_type lock(m_connection_state_lock);
- return m_state;
- }
- template <typename config>
- lib::error_code connection<config>::send(std::string const & payload,
- frame::opcode::value op)
- {
- message_ptr msg = m_msg_manager->get_message(op,payload.size());
- msg->append_payload(payload);
- return send(msg);
- }
- template <typename config>
- lib::error_code connection<config>::send(void const * payload, size_t len,
- frame::opcode::value op)
- {
- message_ptr msg = m_msg_manager->get_message(op,len);
- msg->append_payload(payload,len);
- return send(msg);
- }
- template <typename config>
- lib::error_code connection<config>::send(typename config::message_type::ptr msg)
- {
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,"connection send");
- }
- {
- scoped_lock_type lock(m_connection_state_lock);
- if (m_state != session::state::open) {
- return error::make_error_code(error::invalid_state);
- }
- }
- message_ptr outgoing_msg;
- bool needs_writing = false;
- if (msg->get_prepared()) {
- outgoing_msg = msg;
- scoped_lock_type lock(m_write_lock);
- write_push(outgoing_msg);
- needs_writing = !m_write_flag && !m_send_queue.empty();
- } else {
- outgoing_msg = m_msg_manager->get_message();
- if (!outgoing_msg) {
- return error::make_error_code(error::no_outgoing_buffers);
- }
- scoped_lock_type lock(m_write_lock);
- lib::error_code ec = m_processor->prepare_data_frame(msg,outgoing_msg);
- if (ec) {
- return ec;
- }
- write_push(outgoing_msg);
- needs_writing = !m_write_flag && !m_send_queue.empty();
- }
- if (needs_writing) {
- transport_con_type::dispatch(lib::bind(
- &type::write_frame,
- type::get_shared()
- ));
- }
- return lib::error_code();
- }
- template <typename config>
- void connection<config>::ping(std::string const& payload, lib::error_code& ec) {
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,"connection ping");
- }
- {
- scoped_lock_type lock(m_connection_state_lock);
- if (m_state != session::state::open) {
- std::stringstream ss;
- ss << "connection::ping called from invalid state " << m_state;
- m_alog.write(log::alevel::devel,ss.str());
- ec = error::make_error_code(error::invalid_state);
- return;
- }
- }
- message_ptr msg = m_msg_manager->get_message();
- if (!msg) {
- ec = error::make_error_code(error::no_outgoing_buffers);
- return;
- }
- ec = m_processor->prepare_ping(payload,msg);
- if (ec) {return;}
- // set ping timer if we are listening for one
- if (m_pong_timeout_handler) {
- // Cancel any existing timers
- if (m_ping_timer) {
- m_ping_timer->cancel();
- }
- if (m_pong_timeout_dur > 0) {
- m_ping_timer = transport_con_type::set_timer(
- m_pong_timeout_dur,
- lib::bind(
- &type::handle_pong_timeout,
- type::get_shared(),
- payload,
- lib::placeholders::_1
- )
- );
- }
- if (!m_ping_timer) {
- // Our transport doesn't support timers
- m_elog.write(log::elevel::warn,"Warning: a pong_timeout_handler is \
- set but the transport in use does not support timeouts.");
- }
- }
- bool needs_writing = false;
- {
- scoped_lock_type lock(m_write_lock);
- write_push(msg);
- needs_writing = !m_write_flag && !m_send_queue.empty();
- }
- if (needs_writing) {
- transport_con_type::dispatch(lib::bind(
- &type::write_frame,
- type::get_shared()
- ));
- }
- ec = lib::error_code();
- }
- template<typename config>
- void connection<config>::ping(std::string const & payload) {
- lib::error_code ec;
- ping(payload,ec);
- if (ec) {
- throw exception(ec);
- }
- }
- template<typename config>
- void connection<config>::handle_pong_timeout(std::string payload,
- lib::error_code const & ec)
- {
- if (ec) {
- if (ec == transport::error::operation_aborted) {
- // ignore, this is expected
- return;
- }
- m_elog.write(log::elevel::devel,"pong_timeout error: "+ec.message());
- return;
- }
- if (m_pong_timeout_handler) {
- m_pong_timeout_handler(m_connection_hdl,payload);
- }
- }
- template <typename config>
- void connection<config>::pong(std::string const& payload, lib::error_code& ec) {
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,"connection pong");
- }
- {
- scoped_lock_type lock(m_connection_state_lock);
- if (m_state != session::state::open) {
- std::stringstream ss;
- ss << "connection::pong called from invalid state " << m_state;
- m_alog.write(log::alevel::devel,ss.str());
- ec = error::make_error_code(error::invalid_state);
- return;
- }
- }
- message_ptr msg = m_msg_manager->get_message();
- if (!msg) {
- ec = error::make_error_code(error::no_outgoing_buffers);
- return;
- }
- ec = m_processor->prepare_pong(payload,msg);
- if (ec) {return;}
- bool needs_writing = false;
- {
- scoped_lock_type lock(m_write_lock);
- write_push(msg);
- needs_writing = !m_write_flag && !m_send_queue.empty();
- }
- if (needs_writing) {
- transport_con_type::dispatch(lib::bind(
- &type::write_frame,
- type::get_shared()
- ));
- }
- ec = lib::error_code();
- }
- template<typename config>
- void connection<config>::pong(std::string const & payload) {
- lib::error_code ec;
- pong(payload,ec);
- if (ec) {
- throw exception(ec);
- }
- }
- template <typename config>
- void connection<config>::close(close::status::value const code,
- std::string const & reason, lib::error_code & ec)
- {
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,"connection close");
- }
- // Truncate reason to maximum size allowable in a close frame.
- std::string tr(reason,0,std::min<size_t>(reason.size(),
- frame::limits::close_reason_size));
- scoped_lock_type lock(m_connection_state_lock);
- if (m_state != session::state::open) {
- ec = error::make_error_code(error::invalid_state);
- return;
- }
- ec = this->send_close_frame(code,tr,false,close::status::terminal(code));
- }
- template<typename config>
- void connection<config>::close(close::status::value const code,
- std::string const & reason)
- {
- lib::error_code ec;
- close(code,reason,ec);
- if (ec) {
- throw exception(ec);
- }
- }
- /// Trigger the on_interrupt handler
- /**
- * This is thread safe if the transport is thread safe
- */
- template <typename config>
- lib::error_code connection<config>::interrupt() {
- m_alog.write(log::alevel::devel,"connection connection::interrupt");
- return transport_con_type::interrupt(
- lib::bind(
- &type::handle_interrupt,
- type::get_shared()
- )
- );
- }
- template <typename config>
- void connection<config>::handle_interrupt() {
- if (m_interrupt_handler) {
- m_interrupt_handler(m_connection_hdl);
- }
- }
- template <typename config>
- lib::error_code connection<config>::pause_reading() {
- m_alog.write(log::alevel::devel,"connection connection::pause_reading");
- return transport_con_type::dispatch(
- lib::bind(
- &type::handle_pause_reading,
- type::get_shared()
- )
- );
- }
- /// Pause reading handler. Not safe to call directly
- template <typename config>
- void connection<config>::handle_pause_reading() {
- m_alog.write(log::alevel::devel,"connection connection::handle_pause_reading");
- m_read_flag = false;
- }
- template <typename config>
- lib::error_code connection<config>::resume_reading() {
- m_alog.write(log::alevel::devel,"connection connection::resume_reading");
- return transport_con_type::dispatch(
- lib::bind(
- &type::handle_resume_reading,
- type::get_shared()
- )
- );
- }
- /// Resume reading helper method. Not safe to call directly
- template <typename config>
- void connection<config>::handle_resume_reading() {
- m_read_flag = true;
- read_frame();
- }
- template <typename config>
- bool connection<config>::get_secure() const {
- //scoped_lock_type lock(m_connection_state_lock);
- return m_uri->get_secure();
- }
- template <typename config>
- std::string const & connection<config>::get_host() const {
- //scoped_lock_type lock(m_connection_state_lock);
- return m_uri->get_host();
- }
- template <typename config>
- std::string const & connection<config>::get_resource() const {
- //scoped_lock_type lock(m_connection_state_lock);
- return m_uri->get_resource();
- }
- template <typename config>
- uint16_t connection<config>::get_port() const {
- //scoped_lock_type lock(m_connection_state_lock);
- return m_uri->get_port();
- }
- template <typename config>
- uri_ptr connection<config>::get_uri() const {
- //scoped_lock_type lock(m_connection_state_lock);
- return m_uri;
- }
- template <typename config>
- void connection<config>::set_uri(uri_ptr uri) {
- //scoped_lock_type lock(m_connection_state_lock);
- m_uri = uri;
- }
- template <typename config>
- std::string const & connection<config>::get_subprotocol() const {
- return m_subprotocol;
- }
- template <typename config>
- std::vector<std::string> const &
- connection<config>::get_requested_subprotocols() const {
- return m_requested_subprotocols;
- }
- template <typename config>
- void connection<config>::add_subprotocol(std::string const & value,
- lib::error_code & ec)
- {
- if (m_is_server) {
- ec = error::make_error_code(error::client_only);
- return;
- }
- // If the value is empty or has a non-RFC2616 token character it is invalid.
- if (value.empty() || std::find_if(value.begin(),value.end(),
- http::is_not_token_char) != value.end())
- {
- ec = error::make_error_code(error::invalid_subprotocol);
- return;
- }
- m_requested_subprotocols.push_back(value);
- }
- template <typename config>
- void connection<config>::add_subprotocol(std::string const & value) {
- lib::error_code ec;
- this->add_subprotocol(value,ec);
- if (ec) {
- throw exception(ec);
- }
- }
- template <typename config>
- void connection<config>::select_subprotocol(std::string const & value,
- lib::error_code & ec)
- {
- if (!m_is_server) {
- ec = error::make_error_code(error::server_only);
- return;
- }
- if (value.empty()) {
- ec = lib::error_code();
- return;
- }
- std::vector<std::string>::iterator it;
- it = std::find(m_requested_subprotocols.begin(),
- m_requested_subprotocols.end(),
- value);
- if (it == m_requested_subprotocols.end()) {
- ec = error::make_error_code(error::unrequested_subprotocol);
- return;
- }
- m_subprotocol = value;
- }
- template <typename config>
- void connection<config>::select_subprotocol(std::string const & value) {
- lib::error_code ec;
- this->select_subprotocol(value,ec);
- if (ec) {
- throw exception(ec);
- }
- }
- template <typename config>
- std::string const &
- connection<config>::get_request_header(std::string const & key) const {
- return m_request.get_header(key);
- }
- template <typename config>
- std::string const &
- connection<config>::get_request_body() const {
- return m_request.get_body();
- }
- template <typename config>
- std::string const &
- connection<config>::get_response_header(std::string const & key) const {
- return m_response.get_header(key);
- }
- template <typename config>
- void connection<config>::set_status(http::status_code::value code)
- {
- if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
- throw exception("Call to set_status from invalid state",
- error::make_error_code(error::invalid_state));
- }
- m_response.set_status(code);
- }
- template <typename config>
- void connection<config>::set_status(http::status_code::value code,
- std::string const & msg)
- {
- if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
- throw exception("Call to set_status from invalid state",
- error::make_error_code(error::invalid_state));
- }
- m_response.set_status(code,msg);
- }
- template <typename config>
- void connection<config>::set_body(std::string const & value) {
- if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
- throw exception("Call to set_status from invalid state",
- error::make_error_code(error::invalid_state));
- }
- m_response.set_body(value);
- }
- template <typename config>
- void connection<config>::append_header(std::string const & key,
- std::string const & val)
- {
- if (m_is_server) {
- if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
- // we are setting response headers for an incoming server connection
- m_response.append_header(key,val);
- } else {
- throw exception("Call to append_header from invalid state",
- error::make_error_code(error::invalid_state));
- }
- } else {
- if (m_internal_state == istate::USER_INIT) {
- // we are setting initial headers for an outgoing client connection
- m_request.append_header(key,val);
- } else {
- throw exception("Call to append_header from invalid state",
- error::make_error_code(error::invalid_state));
- }
- }
- }
- template <typename config>
- void connection<config>::replace_header(std::string const & key,
- std::string const & val)
- {
- if (m_is_server) {
- if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
- // we are setting response headers for an incoming server connection
- m_response.replace_header(key,val);
- } else {
- throw exception("Call to replace_header from invalid state",
- error::make_error_code(error::invalid_state));
- }
- } else {
- if (m_internal_state == istate::USER_INIT) {
- // we are setting initial headers for an outgoing client connection
- m_request.replace_header(key,val);
- } else {
- throw exception("Call to replace_header from invalid state",
- error::make_error_code(error::invalid_state));
- }
- }
- }
- template <typename config>
- void connection<config>::remove_header(std::string const & key)
- {
- if (m_is_server) {
- if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
- // we are setting response headers for an incoming server connection
- m_response.remove_header(key);
- } else {
- throw exception("Call to remove_header from invalid state",
- error::make_error_code(error::invalid_state));
- }
- } else {
- if (m_internal_state == istate::USER_INIT) {
- // we are setting initial headers for an outgoing client connection
- m_request.remove_header(key);
- } else {
- throw exception("Call to remove_header from invalid state",
- error::make_error_code(error::invalid_state));
- }
- }
- }
- /// Defer HTTP Response until later
- /**
- * Used in the http handler to defer the HTTP response for this connection
- * until later. Handshake timers will be canceled and the connection will be
- * left open until `send_http_response` or an equivalent is called.
- *
- * Warning: deferred connections won't time out and as a result can tie up
- * resources.
- *
- * @return A status code, zero on success, non-zero otherwise
- */
- template <typename config>
- lib::error_code connection<config>::defer_http_response() {
- // Cancel handshake timer, otherwise the connection will time out and we'll
- // close the connection before the app has a chance to send a response.
- if (m_handshake_timer) {
- m_handshake_timer->cancel();
- m_handshake_timer.reset();
- }
-
- // Do something to signal deferral
- m_http_state = session::http_state::deferred;
-
- return lib::error_code();
- }
- /// Send deferred HTTP Response (exception free)
- /**
- * Sends an http response to an HTTP connection that was deferred. This will
- * send a complete response including all headers, status line, and body
- * text. The connection will be closed afterwards.
- *
- * @since 0.6.0
- *
- * @param ec A status code, zero on success, non-zero otherwise
- */
- template <typename config>
- void connection<config>::send_http_response(lib::error_code & ec) {
- {
- scoped_lock_type lock(m_connection_state_lock);
- if (m_http_state != session::http_state::deferred) {
- ec = error::make_error_code(error::invalid_state);
- return;
- }
-
- m_http_state = session::http_state::body_written;
- }
-
- this->write_http_response(lib::error_code());
- ec = lib::error_code();
- }
- template <typename config>
- void connection<config>::send_http_response() {
- lib::error_code ec;
- this->send_http_response(ec);
- if (ec) {
- throw exception(ec);
- }
- }
- /******** logic thread ********/
- template <typename config>
- void connection<config>::start() {
- m_alog.write(log::alevel::devel,"connection start");
- if (m_internal_state != istate::USER_INIT) {
- m_alog.write(log::alevel::devel,"Start called in invalid state");
- this->terminate(error::make_error_code(error::invalid_state));
- return;
- }
- m_internal_state = istate::TRANSPORT_INIT;
- // Depending on how the transport implements init this function may return
- // immediately and call handle_transport_init later or call
- // handle_transport_init from this function.
- transport_con_type::init(
- lib::bind(
- &type::handle_transport_init,
- type::get_shared(),
- lib::placeholders::_1
- )
- );
- }
- template <typename config>
- void connection<config>::handle_transport_init(lib::error_code const & ec) {
- m_alog.write(log::alevel::devel,"connection handle_transport_init");
- lib::error_code ecm = ec;
- if (m_internal_state != istate::TRANSPORT_INIT) {
- m_alog.write(log::alevel::devel,
- "handle_transport_init must be called from transport init state");
- ecm = error::make_error_code(error::invalid_state);
- }
- if (ecm) {
- std::stringstream s;
- s << "handle_transport_init received error: "<< ecm.message();
- m_elog.write(log::elevel::rerror,s.str());
- this->terminate(ecm);
- return;
- }
- // At this point the transport is ready to read and write bytes.
- if (m_is_server) {
- m_internal_state = istate::READ_HTTP_REQUEST;
- this->read_handshake(1);
- } else {
- // We are a client. Set the processor to the version specified in the
- // config file and send a handshake request.
- m_internal_state = istate::WRITE_HTTP_REQUEST;
- m_processor = get_processor(config::client_version);
- this->send_http_request();
- }
- }
- template <typename config>
- void connection<config>::read_handshake(size_t num_bytes) {
- m_alog.write(log::alevel::devel,"connection read");
- if (m_open_handshake_timeout_dur > 0) {
- m_handshake_timer = transport_con_type::set_timer(
- m_open_handshake_timeout_dur,
- lib::bind(
- &type::handle_open_handshake_timeout,
- type::get_shared(),
- lib::placeholders::_1
- )
- );
- }
- transport_con_type::async_read_at_least(
- num_bytes,
- m_buf,
- config::connection_read_buffer_size,
- lib::bind(
- &type::handle_read_handshake,
- type::get_shared(),
- lib::placeholders::_1,
- lib::placeholders::_2
- )
- );
- }
- // All exit paths for this function need to call write_http_response() or submit
- // a new read request with this function as the handler.
- template <typename config>
- void connection<config>::handle_read_handshake(lib::error_code const & ec,
- size_t bytes_transferred)
- {
- m_alog.write(log::alevel::devel,"connection handle_read_handshake");
- lib::error_code ecm = ec;
- if (!ecm) {
- scoped_lock_type lock(m_connection_state_lock);
-
- if (m_state == session::state::connecting) {
- if (m_internal_state != istate::READ_HTTP_REQUEST) {
- ecm = error::make_error_code(error::invalid_state);
- }
- } else if (m_state == session::state::closed) {
- // The connection was canceled while the response was being sent,
- // usually by the handshake timer. This is basically expected
- // (though hopefully rare) and there is nothing we can do so ignore.
- m_alog.write(log::alevel::devel,
- "handle_read_handshake invoked after connection was closed");
- return;
- } else {
- ecm = error::make_error_code(error::invalid_state);
- }
- }
- if (ecm) {
- if (ecm == transport::error::eof && m_state == session::state::closed) {
- // we expect to get eof if the connection is closed already
- m_alog.write(log::alevel::devel,
- "got (expected) eof/state error from closed con");
- return;
- }
-
- log_err(log::elevel::rerror,"handle_read_handshake",ecm);
- this->terminate(ecm);
- return;
- }
- // Boundaries checking. TODO: How much of this should be done?
- if (bytes_transferred > config::connection_read_buffer_size) {
- m_elog.write(log::elevel::fatal,"Fatal boundaries checking error.");
- this->terminate(make_error_code(error::general));
- return;
- }
- size_t bytes_processed = 0;
- try {
- bytes_processed = m_request.consume(m_buf,bytes_transferred);
- } catch (http::exception &e) {
- // All HTTP exceptions will result in this request failing and an error
- // response being returned. No more bytes will be read in this con.
- m_response.set_status(e.m_error_code,e.m_error_msg);
- this->write_http_response_error(error::make_error_code(error::http_parse_error));
- return;
- }
- // More paranoid boundaries checking.
- // TODO: Is this overkill?
- if (bytes_processed > bytes_transferred) {
- m_elog.write(log::elevel::fatal,"Fatal boundaries checking error.");
- this->terminate(make_error_code(error::general));
- return;
- }
- if (m_alog.static_test(log::alevel::devel)) {
- std::stringstream s;
- s << "bytes_transferred: " << bytes_transferred
- << " bytes, bytes processed: " << bytes_processed << " bytes";
- m_alog.write(log::alevel::devel,s.str());
- }
- if (m_request.ready()) {
- lib::error_code processor_ec = this->initialize_processor();
- if (processor_ec) {
- this->write_http_response_error(processor_ec);
- return;
- }
- if (m_processor && m_processor->get_version() == 0) {
- // Version 00 has an extra requirement to read some bytes after the
- // handshake
- if (bytes_transferred-bytes_processed >= 8) {
- m_request.replace_header(
- "Sec-WebSocket-Key3",
- std::string(m_buf+bytes_processed,m_buf+bytes_processed+8)
- );
- bytes_processed += 8;
- } else {
- // TODO: need more bytes
- m_alog.write(log::alevel::devel,"short key3 read");
- m_response.set_status(http::status_code::internal_server_error);
- this->write_http_response_error(processor::error::make_error_code(processor::error::short_key3));
- return;
- }
- }
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,m_request.raw());
- if (m_request.get_header("Sec-WebSocket-Key3") != "") {
- m_alog.write(log::alevel::devel,
- utility::to_hex(m_request.get_header("Sec-WebSocket-Key3")));
- }
- }
- // The remaining bytes in m_buf are frame data. Copy them to the
- // beginning of the buffer and note the length. They will be read after
- // the handshake completes and before more bytes are read.
- std::copy(m_buf+bytes_processed,m_buf+bytes_transferred,m_buf);
- m_buf_cursor = bytes_transferred-bytes_processed;
- m_internal_state = istate::PROCESS_HTTP_REQUEST;
-
- // We have the complete request. Process it.
- lib::error_code handshake_ec = this->process_handshake_request();
- if (!m_is_http || m_http_state != session::http_state::deferred) {
- this->write_http_response(handshake_ec);
- }
- } else {
- // read at least 1 more byte
- transport_con_type::async_read_at_least(
- 1,
- m_buf,
- config::connection_read_buffer_size,
- lib::bind(
- &type::handle_read_handshake,
- type::get_shared(),
- lib::placeholders::_1,
- lib::placeholders::_2
- )
- );
- }
- }
- // write_http_response requires the request to be fully read and the connection
- // to be in the PROCESS_HTTP_REQUEST state. In some cases we can detect errors
- // before the request is fully read (specifically at a point where we aren't
- // sure if the hybi00 key3 bytes need to be read). This method sets the correct
- // state and calls write_http_response
- template <typename config>
- void connection<config>::write_http_response_error(lib::error_code const & ec) {
- if (m_internal_state != istate::READ_HTTP_REQUEST) {
- m_alog.write(log::alevel::devel,
- "write_http_response_error called in invalid state");
- this->terminate(error::make_error_code(error::invalid_state));
- return;
- }
-
- m_internal_state = istate::PROCESS_HTTP_REQUEST;
-
- this->write_http_response(ec);
- }
- // All exit paths for this function need to call write_http_response() or submit
- // a new read request with this function as the handler.
- template <typename config>
- void connection<config>::handle_read_frame(lib::error_code const & ec,
- size_t bytes_transferred)
- {
- //m_alog.write(log::alevel::devel,"connection handle_read_frame");
- lib::error_code ecm = ec;
- if (!ecm && m_internal_state != istate::PROCESS_CONNECTION) {
- ecm = error::make_error_code(error::invalid_state);
- }
- if (ecm) {
- log::level echannel = log::elevel::rerror;
-
- if (ecm == transport::error::eof) {
- if (m_state == session::state::closed) {
- // we expect to get eof if the connection is closed already
- // just ignore it
- m_alog.write(log::alevel::devel,"got eof from closed con");
- return;
- } else if (m_state == session::state::closing && !m_is_server) {
- // If we are a client we expect to get eof in the closing state,
- // this is a signal to terminate our end of the connection after
- // the closing handshake
- terminate(lib::error_code());
- return;
- }
- } else if (ecm == error::invalid_state) {
- // In general, invalid state errors in the closed state are the
- // result of handlers that were in the system already when the state
- // changed and should be ignored as they pose no problems and there
- // is nothing useful that we can do about them.
- if (m_state == session::state::closed) {
- m_alog.write(log::alevel::devel,
- "handle_read_frame: got invalid istate in closed state");
- return;
- }
- } else if (ecm == transport::error::tls_short_read) {
- if (m_state == session::state::closed) {
- // We expect to get a TLS short read if we try to read after the
- // connection is closed. If this happens ignore and exit the
- // read frame path.
- terminate(lib::error_code());
- return;
- }
- echannel = log::elevel::rerror;
- } else if (ecm == transport::error::action_after_shutdown) {
- echannel = log::elevel::info;
- }
-
- log_err(echannel, "handle_read_frame", ecm);
- this->terminate(ecm);
- return;
- }
- // Boundaries checking. TODO: How much of this should be done?
- /*if (bytes_transferred > config::connection_read_buffer_size) {
- m_elog.write(log::elevel::fatal,"Fatal boundaries checking error");
- this->terminate(make_error_code(error::general));
- return;
- }*/
- size_t p = 0;
- if (m_alog.static_test(log::alevel::devel)) {
- std::stringstream s;
- s << "p = " << p << " bytes transferred = " << bytes_transferred;
- m_alog.write(log::alevel::devel,s.str());
- }
- while (p < bytes_transferred) {
- if (m_alog.static_test(log::alevel::devel)) {
- std::stringstream s;
- s << "calling consume with " << bytes_transferred-p << " bytes";
- m_alog.write(log::alevel::devel,s.str());
- }
- lib::error_code consume_ec;
- p += m_processor->consume(
- reinterpret_cast<uint8_t*>(m_buf)+p,
- bytes_transferred-p,
- consume_ec
- );
- if (m_alog.static_test(log::alevel::devel)) {
- std::stringstream s;
- s << "bytes left after consume: " << bytes_transferred-p;
- m_alog.write(log::alevel::devel,s.str());
- }
- if (consume_ec) {
- log_err(log::elevel::rerror, "consume", consume_ec);
- if (config::drop_on_protocol_error) {
- this->terminate(consume_ec);
- return;
- } else {
- lib::error_code close_ec;
- this->close(
- processor::error::to_ws(consume_ec),
- consume_ec.message(),
- close_ec
- );
- if (close_ec) {
- log_err(log::elevel::fatal, "Protocol error close frame ", close_ec);
- this->terminate(close_ec);
- return;
- }
- }
- return;
- }
- if (m_processor->ready()) {
- if (m_alog.static_test(log::alevel::devel)) {
- std::stringstream s;
- s << "Complete message received. Dispatching";
- m_alog.write(log::alevel::devel,s.str());
- }
- message_ptr msg = m_processor->get_message();
- if (!msg) {
- m_alog.write(log::alevel::devel, "null message from m_processor");
- } else if (!is_control(msg->get_opcode())) {
- // data message, dispatch to user
- if (m_state != session::state::open) {
- m_elog.write(log::elevel::warn, "got non-close frame while closing");
- } else if (m_message_handler) {
- m_message_handler(m_connection_hdl, msg);
- }
- } else {
- process_control_frame(msg);
- }
- }
- }
- read_frame();
- }
- /// Issue a new transport read unless reading is paused.
- template <typename config>
- void connection<config>::read_frame() {
- if (!m_read_flag) {
- return;
- }
-
- transport_con_type::async_read_at_least(
- // std::min wont work with undefined static const values.
- // TODO: is there a more elegant way to do this?
- // Need to determine if requesting 1 byte or the exact number of bytes
- // is better here. 1 byte lets us be a bit more responsive at a
- // potential expense of additional runs through handle_read_frame
- /*(m_processor->get_bytes_needed() > config::connection_read_buffer_size ?
- config::connection_read_buffer_size : m_processor->get_bytes_needed())*/
- 1,
- m_buf,
- config::connection_read_buffer_size,
- m_handle_read_frame
- );
- }
- template <typename config>
- lib::error_code connection<config>::initialize_processor() {
- m_alog.write(log::alevel::devel,"initialize_processor");
- // if it isn't a websocket handshake nothing to do.
- if (!processor::is_websocket_handshake(m_request)) {
- return lib::error_code();
- }
- int version = processor::get_websocket_version(m_request);
- if (version < 0) {
- m_alog.write(log::alevel::devel, "BAD REQUEST: can't determine version");
- m_response.set_status(http::status_code::bad_request);
- return error::make_error_code(error::invalid_version);
- }
- m_processor = get_processor(version);
- // if the processor is not null we are done
- if (m_processor) {
- return lib::error_code();
- }
- // We don't have a processor for this version. Return bad request
- // with Sec-WebSocket-Version header filled with values we do accept
- m_alog.write(log::alevel::devel, "BAD REQUEST: no processor for version");
- m_response.set_status(http::status_code::bad_request);
- std::stringstream ss;
- std::string sep = "";
- std::vector<int>::const_iterator it;
- for (it = versions_supported.begin(); it != versions_supported.end(); it++)
- {
- ss << sep << *it;
- sep = ",";
- }
- m_response.replace_header("Sec-WebSocket-Version",ss.str());
- return error::make_error_code(error::unsupported_version);
- }
- template <typename config>
- lib::error_code connection<config>::process_handshake_request() {
- m_alog.write(log::alevel::devel,"process handshake request");
- if (!processor::is_websocket_handshake(m_request)) {
- // this is not a websocket handshake. Process as plain HTTP
- m_alog.write(log::alevel::devel,"HTTP REQUEST");
- // extract URI from request
- m_uri = processor::get_uri_from_host(
- m_request,
- (transport_con_type::is_secure() ? "https" : "http")
- );
- if (!m_uri->get_valid()) {
- m_alog.write(log::alevel::devel, "Bad request: failed to parse uri");
- m_response.set_status(http::status_code::bad_request);
- return error::make_error_code(error::invalid_uri);
- }
- if (m_http_handler) {
- m_is_http = true;
- m_http_handler(m_connection_hdl);
-
- if (m_state == session::state::closed) {
- return error::make_error_code(error::http_connection_ended);
- }
- } else {
- set_status(http::status_code::upgrade_required);
- return error::make_error_code(error::upgrade_required);
- }
- return lib::error_code();
- }
- lib::error_code ec = m_processor->validate_handshake(m_request);
- // Validate: make sure all required elements are present.
- if (ec){
- // Not a valid handshake request
- m_alog.write(log::alevel::devel, "Bad request " + ec.message());
- m_response.set_status(http::status_code::bad_request);
- return ec;
- }
- // Read extension parameters and set up values necessary for the end user
- // to complete extension negotiation.
- std::pair<lib::error_code,std::string> neg_results;
- neg_results = m_processor->negotiate_extensions(m_request);
- if (neg_results.first) {
- // There was a fatal error in extension parsing that should result in
- // a failed connection attempt.
- m_alog.write(log::alevel::devel, "Bad request: " + neg_results.first.message());
- m_response.set_status(http::status_code::bad_request);
- return neg_results.first;
- } else {
- // extension negotiation succeeded, set response header accordingly
- // we don't send an empty extensions header because it breaks many
- // clients.
- if (neg_results.second.size() > 0) {
- m_response.replace_header("Sec-WebSocket-Extensions",
- neg_results.second);
- }
- }
- // extract URI from request
- m_uri = m_processor->get_uri(m_request);
- if (!m_uri->get_valid()) {
- m_alog.write(log::alevel::devel, "Bad request: failed to parse uri");
- m_response.set_status(http::status_code::bad_request);
- return error::make_error_code(error::invalid_uri);
- }
- // extract subprotocols
- lib::error_code subp_ec = m_processor->extract_subprotocols(m_request,
- m_requested_subprotocols);
- if (subp_ec) {
- // should we do anything?
- }
- // Ask application to validate the connection
- if (!m_validate_handler || m_validate_handler(m_connection_hdl)) {
- m_response.set_status(http::status_code::switching_protocols);
- // Write the appropriate response headers based on request and
- // processor version
- ec = m_processor->process_handshake(m_request,m_subprotocol,m_response);
- if (ec) {
- std::stringstream s;
- s << "Processing error: " << ec << "(" << ec.message() << ")";
- m_alog.write(log::alevel::devel, s.str());
- m_response.set_status(http::status_code::internal_server_error);
- return ec;
- }
- } else {
- // User application has rejected the handshake
- m_alog.write(log::alevel::devel, "USER REJECT");
- // Use Bad Request if the user handler did not provide a more
- // specific http response error code.
- // TODO: is there a better default?
- if (m_response.get_status_code() == http::status_code::uninitialized) {
- m_response.set_status(http::status_code::bad_request);
- }
-
- return error::make_error_code(error::rejected);
- }
- return lib::error_code();
- }
- template <typename config>
- void connection<config>::write_http_response(lib::error_code const & ec) {
- m_alog.write(log::alevel::devel,"connection write_http_response");
- if (ec == error::make_error_code(error::http_connection_ended)) {
- m_alog.write(log::alevel::http,"An HTTP handler took over the connection.");
- return;
- }
- if (m_response.get_status_code() == http::status_code::uninitialized) {
- m_response.set_status(http::status_code::internal_server_error);
- m_ec = error::make_error_code(error::general);
- } else {
- m_ec = ec;
- }
- m_response.set_version("HTTP/1.1");
- // Set server header based on the user agent settings
- if (m_response.get_header("Server") == "") {
- if (!m_user_agent.empty()) {
- m_response.replace_header("Server",m_user_agent);
- } else {
- m_response.remove_header("Server");
- }
- }
- // have the processor generate the raw bytes for the wire (if it exists)
- if (m_processor) {
- m_handshake_buffer = m_processor->get_raw(m_response);
- } else {
- // a processor wont exist for raw HTTP responses.
- m_handshake_buffer = m_response.raw();
- }
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,"Raw Handshake response:\n"+m_handshake_buffer);
- if (m_response.get_header("Sec-WebSocket-Key3") != "") {
- m_alog.write(log::alevel::devel,
- utility::to_hex(m_response.get_header("Sec-WebSocket-Key3")));
- }
- }
- // write raw bytes
- transport_con_type::async_write(
- m_handshake_buffer.data(),
- m_handshake_buffer.size(),
- lib::bind(
- &type::handle_write_http_response,
- type::get_shared(),
- lib::placeholders::_1
- )
- );
- }
- template <typename config>
- void connection<config>::handle_write_http_response(lib::error_code const & ec) {
- m_alog.write(log::alevel::devel,"handle_write_http_response");
- lib::error_code ecm = ec;
- if (!ecm) {
- scoped_lock_type lock(m_connection_state_lock);
-
- if (m_state == session::state::connecting) {
- if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
- ecm = error::make_error_code(error::invalid_state);
- }
- } else if (m_state == session::state::closed) {
- // The connection was canceled while the response was being sent,
- // usually by the handshake timer. This is basically expected
- // (though hopefully rare) and there is nothing we can do so ignore.
- m_alog.write(log::alevel::devel,
- "handle_write_http_response invoked after connection was closed");
- return;
- } else {
- ecm = error::make_error_code(error::invalid_state);
- }
- }
- if (ecm) {
- if (ecm == transport::error::eof && m_state == session::state::closed) {
- // we expect to get eof if the connection is closed already
- m_alog.write(log::alevel::devel,
- "got (expected) eof/state error from closed con");
- return;
- }
-
- log_err(log::elevel::rerror,"handle_write_http_response",ecm);
- this->terminate(ecm);
- return;
- }
- if (m_handshake_timer) {
- m_handshake_timer->cancel();
- m_handshake_timer.reset();
- }
- if (m_response.get_status_code() != http::status_code::switching_protocols)
- {
- /*if (m_processor || m_ec == error::http_parse_error ||
- m_ec == error::invalid_version || m_ec == error::unsupported_version
- || m_ec == error::upgrade_required)
- {*/
- if (!m_is_http) {
- std::stringstream s;
- s << "Handshake ended with HTTP error: "
- << m_response.get_status_code();
- m_elog.write(log::elevel::rerror,s.str());
- } else {
- // if this was not a websocket connection, we have written
- // the expected response and the connection can be closed.
-
- this->log_http_result();
-
- if (m_ec) {
- m_alog.write(log::alevel::devel,
- "got to writing HTTP results with m_ec set: "+m_ec.message());
- }
- m_ec = make_error_code(error::http_connection_ended);
- }
-
- this->terminate(m_ec);
- return;
- }
- this->log_open_result();
- m_internal_state = istate::PROCESS_CONNECTION;
- m_state = session::state::open;
- if (m_open_handler) {
- m_open_handler(m_connection_hdl);
- }
- this->handle_read_frame(lib::error_code(), m_buf_cursor);
- }
- template <typename config>
- void connection<config>::send_http_request() {
- m_alog.write(log::alevel::devel,"connection send_http_request");
- // TODO: origin header?
- // Have the protocol processor fill in the appropriate fields based on the
- // selected client version
- if (m_processor) {
- lib::error_code ec;
- ec = m_processor->client_handshake_request(m_request,m_uri,
- m_requested_subprotocols);
- if (ec) {
- log_err(log::elevel::fatal,"Internal library error: Processor",ec);
- return;
- }
- } else {
- m_elog.write(log::elevel::fatal,"Internal library error: missing processor");
- return;
- }
- // Unless the user has overridden the user agent, send generic WS++ UA.
- if (m_request.get_header("User-Agent") == "") {
- if (!m_user_agent.empty()) {
- m_request.replace_header("User-Agent",m_user_agent);
- } else {
- m_request.remove_header("User-Agent");
- }
- }
- m_handshake_buffer = m_request.raw();
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,"Raw Handshake request:\n"+m_handshake_buffer);
- }
- if (m_open_handshake_timeout_dur > 0) {
- m_handshake_timer = transport_con_type::set_timer(
- m_open_handshake_timeout_dur,
- lib::bind(
- &type::handle_open_handshake_timeout,
- type::get_shared(),
- lib::placeholders::_1
- )
- );
- }
- transport_con_type::async_write(
- m_handshake_buffer.data(),
- m_handshake_buffer.size(),
- lib::bind(
- &type::handle_send_http_request,
- type::get_shared(),
- lib::placeholders::_1
- )
- );
- }
- template <typename config>
- void connection<config>::handle_send_http_request(lib::error_code const & ec) {
- m_alog.write(log::alevel::devel,"handle_send_http_request");
- lib::error_code ecm = ec;
- if (!ecm) {
- scoped_lock_type lock(m_connection_state_lock);
-
- if (m_state == session::state::connecting) {
- if (m_internal_state != istate::WRITE_HTTP_REQUEST) {
- ecm = error::make_error_code(error::invalid_state);
- } else {
- m_internal_state = istate::READ_HTTP_RESPONSE;
- }
- } else if (m_state == session::state::closed) {
- // The connection was canceled while the response was being sent,
- // usually by the handshake timer. This is basically expected
- // (though hopefully rare) and there is nothing we can do so ignore.
- m_alog.write(log::alevel::devel,
- "handle_send_http_request invoked after connection was closed");
- return;
- } else {
- ecm = error::make_error_code(error::invalid_state);
- }
- }
- if (ecm) {
- if (ecm == transport::error::eof && m_state == session::state::closed) {
- // we expect to get eof if the connection is closed already
- m_alog.write(log::alevel::devel,
- "got (expected) eof/state error from closed con");
- return;
- }
-
- log_err(log::elevel::rerror,"handle_send_http_request",ecm);
- this->terminate(ecm);
- return;
- }
- transport_con_type::async_read_at_least(
- 1,
- m_buf,
- config::connection_read_buffer_size,
- lib::bind(
- &type::handle_read_http_response,
- type::get_shared(),
- lib::placeholders::_1,
- lib::placeholders::_2
- )
- );
- }
- template <typename config>
- void connection<config>::handle_read_http_response(lib::error_code const & ec,
- size_t bytes_transferred)
- {
- m_alog.write(log::alevel::devel,"handle_read_http_response");
- lib::error_code ecm = ec;
- if (!ecm) {
- scoped_lock_type lock(m_connection_state_lock);
-
- if (m_state == session::state::connecting) {
- if (m_internal_state != istate::READ_HTTP_RESPONSE) {
- ecm = error::make_error_code(error::invalid_state);
- }
- } else if (m_state == session::state::closed) {
- // The connection was canceled while the response was being sent,
- // usually by the handshake timer. This is basically expected
- // (though hopefully rare) and there is nothing we can do so ignore.
- m_alog.write(log::alevel::devel,
- "handle_read_http_response invoked after connection was closed");
- return;
- } else {
- ecm = error::make_error_code(error::invalid_state);
- }
- }
- if (ecm) {
- if (ecm == transport::error::eof && m_state == session::state::closed) {
- // we expect to get eof if the connection is closed already
- m_alog.write(log::alevel::devel,
- "got (expected) eof/state error from closed con");
- return;
- }
-
- log_err(log::elevel::rerror,"handle_read_http_response",ecm);
- this->terminate(ecm);
- return;
- }
-
- size_t bytes_processed = 0;
- // TODO: refactor this to use error codes rather than exceptions
- try {
- bytes_processed = m_response.consume(m_buf,bytes_transferred);
- } catch (http::exception & e) {
- m_elog.write(log::elevel::rerror,
- std::string("error in handle_read_http_response: ")+e.what());
- this->terminate(make_error_code(error::general));
- return;
- }
- m_alog.write(log::alevel::devel,std::string("Raw response: ")+m_response.raw());
- if (m_response.headers_ready()) {
- if (m_handshake_timer) {
- m_handshake_timer->cancel();
- m_handshake_timer.reset();
- }
- lib::error_code validate_ec = m_processor->validate_server_handshake_response(
- m_request,
- m_response
- );
- if (validate_ec) {
- log_err(log::elevel::rerror,"Server handshake response",validate_ec);
- this->terminate(validate_ec);
- return;
- }
- // response is valid, connection can now be assumed to be open
- m_internal_state = istate::PROCESS_CONNECTION;
- m_state = session::state::open;
- this->log_open_result();
- if (m_open_handler) {
- m_open_handler(m_connection_hdl);
- }
- // The remaining bytes in m_buf are frame data. Copy them to the
- // beginning of the buffer and note the length. They will be read after
- // the handshake completes and before more bytes are read.
- std::copy(m_buf+bytes_processed,m_buf+bytes_transferred,m_buf);
- m_buf_cursor = bytes_transferred-bytes_processed;
- this->handle_read_frame(lib::error_code(), m_buf_cursor);
- } else {
- transport_con_type::async_read_at_least(
- 1,
- m_buf,
- config::connection_read_buffer_size,
- lib::bind(
- &type::handle_read_http_response,
- type::get_shared(),
- lib::placeholders::_1,
- lib::placeholders::_2
- )
- );
- }
- }
- template <typename config>
- void connection<config>::handle_open_handshake_timeout(
- lib::error_code const & ec)
- {
- if (ec == transport::error::operation_aborted) {
- m_alog.write(log::alevel::devel,"open handshake timer cancelled");
- } else if (ec) {
- m_alog.write(log::alevel::devel,
- "open handle_open_handshake_timeout error: "+ec.message());
- // TODO: ignore or fail here?
- } else {
- m_alog.write(log::alevel::devel,"open handshake timer expired");
- terminate(make_error_code(error::open_handshake_timeout));
- }
- }
- template <typename config>
- void connection<config>::handle_close_handshake_timeout(
- lib::error_code const & ec)
- {
- if (ec == transport::error::operation_aborted) {
- m_alog.write(log::alevel::devel,"asio close handshake timer cancelled");
- } else if (ec) {
- m_alog.write(log::alevel::devel,
- "asio open handle_close_handshake_timeout error: "+ec.message());
- // TODO: ignore or fail here?
- } else {
- m_alog.write(log::alevel::devel, "asio close handshake timer expired");
- terminate(make_error_code(error::close_handshake_timeout));
- }
- }
- template <typename config>
- void connection<config>::terminate(lib::error_code const & ec) {
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,"connection terminate");
- }
- // Cancel close handshake timer
- if (m_handshake_timer) {
- m_handshake_timer->cancel();
- m_handshake_timer.reset();
- }
- terminate_status tstat = unknown;
- if (ec) {
- m_ec = ec;
- m_local_close_code = close::status::abnormal_close;
- m_local_close_reason = ec.message();
- }
- // TODO: does any of this need a mutex?
- if (m_is_http) {
- m_http_state = session::http_state::closed;
- }
- if (m_state == session::state::connecting) {
- m_state = session::state::closed;
- tstat = failed;
-
- // Log fail result here before socket is shut down and we can't get
- // the remote address, etc anymore
- if (m_ec != error::http_connection_ended) {
- log_fail_result();
- }
- } else if (m_state != session::state::closed) {
- m_state = session::state::closed;
- tstat = closed;
- } else {
- m_alog.write(log::alevel::devel,
- "terminate called on connection that was already terminated");
- return;
- }
- // TODO: choose between shutdown and close based on error code sent
- transport_con_type::async_shutdown(
- lib::bind(
- &type::handle_terminate,
- type::get_shared(),
- tstat,
- lib::placeholders::_1
- )
- );
- }
- template <typename config>
- void connection<config>::handle_terminate(terminate_status tstat,
- lib::error_code const & ec)
- {
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,"connection handle_terminate");
- }
- if (ec) {
- // there was an error actually shutting down the connection
- log_err(log::elevel::devel,"handle_terminate",ec);
- }
- // clean shutdown
- if (tstat == failed) {
- if (m_ec != error::http_connection_ended) {
- if (m_fail_handler) {
- m_fail_handler(m_connection_hdl);
- }
- }
- } else if (tstat == closed) {
- if (m_close_handler) {
- m_close_handler(m_connection_hdl);
- }
- log_close_result();
- } else {
- m_elog.write(log::elevel::rerror,"Unknown terminate_status");
- }
- // call the termination handler if it exists
- // if it exists it might (but shouldn't) refer to a bad memory location.
- // If it does, we don't care and should catch and ignore it.
- if (m_termination_handler) {
- try {
- m_termination_handler(type::get_shared());
- } catch (std::exception const & e) {
- m_elog.write(log::elevel::warn,
- std::string("termination_handler call failed. Reason was: ")+e.what());
- }
- }
- }
- template <typename config>
- void connection<config>::write_frame() {
- //m_alog.write(log::alevel::devel,"connection write_frame");
- {
- scoped_lock_type lock(m_write_lock);
- // Check the write flag. If true, there is an outstanding transport
- // write already. In this case we just return. The write handler will
- // start a new write if the write queue isn't empty. If false, we set
- // the write flag and proceed to initiate a transport write.
- if (m_write_flag) {
- return;
- }
- // pull off all the messages that are ready to write.
- // stop if we get a message marked terminal
- message_ptr next_message = write_pop();
- while (next_message) {
- m_current_msgs.push_back(next_message);
- if (!next_message->get_terminal()) {
- next_message = write_pop();
- } else {
- next_message = message_ptr();
- }
- }
-
- if (m_current_msgs.empty()) {
- // there was nothing to send
- return;
- } else {
- // At this point we own the next messages to be sent and are
- // responsible for holding the write flag until they are
- // successfully sent or there is some error
- m_write_flag = true;
- }
- }
- typename std::vector<message_ptr>::iterator it;
- for (it = m_current_msgs.begin(); it != m_current_msgs.end(); ++it) {
- std::string const & header = (*it)->get_header();
- std::string const & payload = (*it)->get_payload();
- m_send_buffer.push_back(transport::buffer(header.c_str(),header.size()));
- m_send_buffer.push_back(transport::buffer(payload.c_str(),payload.size()));
- }
- // Print detailed send stats if those log levels are enabled
- if (m_alog.static_test(log::alevel::frame_header)) {
- if (m_alog.dynamic_test(log::alevel::frame_header)) {
- std::stringstream general,header,payload;
-
- general << "Dispatching write containing " << m_current_msgs.size()
- <<" message(s) containing ";
- header << "Header Bytes: \n";
- payload << "Payload Bytes: \n";
-
- size_t hbytes = 0;
- size_t pbytes = 0;
-
- for (size_t i = 0; i < m_current_msgs.size(); i++) {
- hbytes += m_current_msgs[i]->get_header().size();
- pbytes += m_current_msgs[i]->get_payload().size();
-
- header << "[" << i << "] ("
- << m_current_msgs[i]->get_header().size() << ") "
- << utility::to_hex(m_current_msgs[i]->get_header()) << "\n";
- if (m_alog.static_test(log::alevel::frame_payload)) {
- if (m_alog.dynamic_test(log::alevel::frame_payload)) {
- payload << "[" << i << "] ("
- << m_current_msgs[i]->get_payload().size() << ") ["<<m_current_msgs[i]->get_opcode()<<"] "
- << (m_current_msgs[i]->get_opcode() == frame::opcode::text ?
- m_current_msgs[i]->get_payload() :
- utility::to_hex(m_current_msgs[i]->get_payload())
- )
- << "\n";
- }
- }
- }
-
- general << hbytes << " header bytes and " << pbytes << " payload bytes";
-
- m_alog.write(log::alevel::frame_header,general.str());
- m_alog.write(log::alevel::frame_header,header.str());
- m_alog.write(log::alevel::frame_payload,payload.str());
- }
- }
- transport_con_type::async_write(
- m_send_buffer,
- m_write_frame_handler
- );
- }
- template <typename config>
- void connection<config>::handle_write_frame(lib::error_code const & ec)
- {
- if (m_alog.static_test(log::alevel::devel)) {
- m_alog.write(log::alevel::devel,"connection handle_write_frame");
- }
- bool terminal = m_current_msgs.back()->get_terminal();
- m_send_buffer.clear();
- m_current_msgs.clear();
- // TODO: recycle instead of deleting
- if (ec) {
- log_err(log::elevel::fatal,"handle_write_frame",ec);
- this->terminate(ec);
- return;
- }
- if (terminal) {
- this->terminate(lib::error_code());
- return;
- }
- bool needs_writing = false;
- {
- scoped_lock_type lock(m_write_lock);
- // release write flag
- m_write_flag = false;
- needs_writing = !m_send_queue.empty();
- }
- if (needs_writing) {
- transport_con_type::dispatch(lib::bind(
- &type::write_frame,
- type::get_shared()
- ));
- }
- }
- template <typename config>
- std::vector<int> const & connection<config>::get_supported_versions() const
- {
- return versions_supported;
- }
- template <typename config>
- void connection<config>::process_control_frame(typename config::message_type::ptr msg)
- {
- m_alog.write(log::alevel::devel,"process_control_frame");
- frame::opcode::value op = msg->get_opcode();
- lib::error_code ec;
- std::stringstream s;
- s << "Control frame received with opcode " << op;
- m_alog.write(log::alevel::control,s.str());
- if (m_state == session::state::closed) {
- m_elog.write(log::elevel::warn,"got frame in state closed");
- return;
- }
- if (op != frame::opcode::CLOSE && m_state != session::state::open) {
- m_elog.write(log::elevel::warn,"got non-close frame in state closing");
- return;
- }
- if (op == frame::opcode::PING) {
- bool should_reply = true;
- if (m_ping_handler) {
- should_reply = m_ping_handler(m_connection_hdl, msg->get_payload());
- }
- if (should_reply) {
- this->pong(msg->get_payload(),ec);
- if (ec) {
- log_err(log::elevel::devel,"Failed to send response pong",ec);
- }
- }
- } else if (op == frame::opcode::PONG) {
- if (m_pong_handler) {
- m_pong_handler(m_connection_hdl, msg->get_payload());
- }
- if (m_ping_timer) {
- m_ping_timer->cancel();
- }
- } else if (op == frame::opcode::CLOSE) {
- m_alog.write(log::alevel::devel,"got close frame");
- // record close code and reason somewhere
- m_remote_close_code = close::extract_code(msg->get_payload(),ec);
- if (ec) {
- s.str("");
- if (config::drop_on_protocol_error) {
- s << "Received invalid close code " << m_remote_close_code
- << " dropping connection per config.";
- m_elog.write(log::elevel::devel,s.str());
- this->terminate(ec);
- } else {
- s << "Received invalid close code " << m_remote_close_code
- << " sending acknowledgement and closing";
- m_elog.write(log::elevel::devel,s.str());
- ec = send_close_ack(close::status::protocol_error,
- "Invalid close code");
- if (ec) {
- log_err(log::elevel::devel,"send_close_ack",ec);
- }
- }
- return;
- }
- m_remote_close_reason = close::extract_reason(msg->get_payload(),ec);
- if (ec) {
- if (config::drop_on_protocol_error) {
- m_elog.write(log::elevel::devel,
- "Received invalid close reason. Dropping connection per config");
- this->terminate(ec);
- } else {
- m_elog.write(log::elevel::devel,
- "Received invalid close reason. Sending acknowledgement and closing");
- ec = send_close_ack(close::status::protocol_error,
- "Invalid close reason");
- if (ec) {
- log_err(log::elevel::devel,"send_close_ack",ec);
- }
- }
- return;
- }
- if (m_state == session::state::open) {
- s.str("");
- s << "Received close frame with code " << m_remote_close_code
- << " and reason " << m_remote_close_reason;
- m_alog.write(log::alevel::devel,s.str());
- ec = send_close_ack();
- if (ec) {
- log_err(log::elevel::devel,"send_close_ack",ec);
- }
- } else if (m_state == session::state::closing && !m_was_clean) {
- // ack of our close
- m_alog.write(log::alevel::devel, "Got acknowledgement of close");
- m_was_clean = true;
- // If we are a server terminate the connection now. Clients should
- // leave the connection open to give the server an opportunity to
- // initiate the TCP close. The client's timer will handle closing
- // its side of the connection if the server misbehaves.
- //
- // TODO: different behavior if the underlying transport doesn't
- // support timers?
- if (m_is_server) {
- terminate(lib::error_code());
- }
- } else {
- // spurious, ignore
- m_elog.write(log::elevel::devel, "Got close frame in wrong state");
- }
- } else {
- // got an invalid control opcode
- m_elog.write(log::elevel::devel, "Got control frame with invalid opcode");
- // initiate protocol error shutdown
- }
- }
- template <typename config>
- lib::error_code connection<config>::send_close_ack(close::status::value code,
- std::string const & reason)
- {
- return send_close_frame(code,reason,true,m_is_server);
- }
- template <typename config>
- lib::error_code connection<config>::send_close_frame(close::status::value code,
- std::string const & reason, bool ack, bool terminal)
- {
- m_alog.write(log::alevel::devel,"send_close_frame");
- // check for special codes
- // If silent close is set, respect it and blank out close information
- // Otherwise use whatever has been specified in the parameters. If
- // parameters specifies close::status::blank then determine what to do
- // based on whether or not this is an ack. If it is not an ack just
- // send blank info. If it is an ack then echo the close information from
- // the remote endpoint.
- if (config::silent_close) {
- m_alog.write(log::alevel::devel,"closing silently");
- m_local_close_code = close::status::no_status;
- m_local_close_reason = "";
- } else if (code != close::status::blank) {
- m_alog.write(log::alevel::devel,"closing with specified codes");
- m_local_close_code = code;
- m_local_close_reason = reason;
- } else if (!ack) {
- m_alog.write(log::alevel::devel,"closing with no status code");
- m_local_close_code = close::status::no_status;
- m_local_close_reason = "";
- } else if (m_remote_close_code == close::status::no_status) {
- m_alog.write(log::alevel::devel,
- "acknowledging a no-status close with normal code");
- m_local_close_code = close::status::normal;
- m_local_close_reason = "";
- } else {
- m_alog.write(log::alevel::devel,"acknowledging with remote codes");
- m_local_close_code = m_remote_close_code;
- m_local_close_reason = m_remote_close_reason;
- }
- std::stringstream s;
- s << "Closing with code: " << m_local_close_code << ", and reason: "
- << m_local_close_reason;
- m_alog.write(log::alevel::devel,s.str());
- message_ptr msg = m_msg_manager->get_message();
- if (!msg) {
- return error::make_error_code(error::no_outgoing_buffers);
- }
- lib::error_code ec = m_processor->prepare_close(m_local_close_code,
- m_local_close_reason,msg);
- if (ec) {
- return ec;
- }
- // Messages flagged terminal will result in the TCP connection being dropped
- // after the message has been written. This is typically used when servers
- // send an ack and when any endpoint encounters a protocol error
- if (terminal) {
- msg->set_terminal(true);
- }
- m_state = session::state::closing;
- if (ack) {
- m_was_clean = true;
- }
- // Start a timer so we don't wait forever for the acknowledgement close
- // frame
- if (m_close_handshake_timeout_dur > 0) {
- m_handshake_timer = transport_con_type::set_timer(
- m_close_handshake_timeout_dur,
- lib::bind(
- &type::handle_close_handshake_timeout,
- type::get_shared(),
- lib::placeholders::_1
- )
- );
- }
- bool needs_writing = false;
- {
- scoped_lock_type lock(m_write_lock);
- write_push(msg);
- needs_writing = !m_write_flag && !m_send_queue.empty();
- }
- if (needs_writing) {
- transport_con_type::dispatch(lib::bind(
- &type::write_frame,
- type::get_shared()
- ));
- }
- return lib::error_code();
- }
- template <typename config>
- typename connection<config>::processor_ptr
- connection<config>::get_processor(int version) const {
- // TODO: allow disabling certain versions
-
- processor_ptr p;
-
- switch (version) {
- case 0:
- p = lib::make_shared<processor::hybi00<config> >(
- transport_con_type::is_secure(),
- m_is_server,
- m_msg_manager
- );
- break;
- case 7:
- p = lib::make_shared<processor::hybi07<config> >(
- transport_con_type::is_secure(),
- m_is_server,
- m_msg_manager,
- lib::ref(m_rng)
- );
- break;
- case 8:
- p = lib::make_shared<processor::hybi08<config> >(
- transport_con_type::is_secure(),
- m_is_server,
- m_msg_manager,
- lib::ref(m_rng)
- );
- break;
- case 13:
- p = lib::make_shared<processor::hybi13<config> >(
- transport_con_type::is_secure(),
- m_is_server,
- m_msg_manager,
- lib::ref(m_rng)
- );
- break;
- default:
- return p;
- }
-
- // Settings not configured by the constructor
- p->set_max_message_size(m_max_message_size);
-
- return p;
- }
- template <typename config>
- void connection<config>::write_push(typename config::message_type::ptr msg)
- {
- if (!msg) {
- return;
- }
- m_send_buffer_size += msg->get_payload().size();
- m_send_queue.push(msg);
- if (m_alog.static_test(log::alevel::devel)) {
- std::stringstream s;
- s << "write_push: message count: " << m_send_queue.size()
- << " buffer size: " << m_send_buffer_size;
- m_alog.write(log::alevel::devel,s.str());
- }
- }
- template <typename config>
- typename config::message_type::ptr connection<config>::write_pop()
- {
- message_ptr msg;
- if (m_send_queue.empty()) {
- return msg;
- }
- msg = m_send_queue.front();
- m_send_buffer_size -= msg->get_payload().size();
- m_send_queue.pop();
- if (m_alog.static_test(log::alevel::devel)) {
- std::stringstream s;
- s << "write_pop: message count: " << m_send_queue.size()
- << " buffer size: " << m_send_buffer_size;
- m_alog.write(log::alevel::devel,s.str());
- }
- return msg;
- }
- template <typename config>
- void connection<config>::log_open_result()
- {
- std::stringstream s;
- int version;
- if (!processor::is_websocket_handshake(m_request)) {
- version = -1;
- } else {
- version = processor::get_websocket_version(m_request);
- }
- // Connection Type
- s << (version == -1 ? "HTTP" : "WebSocket") << " Connection ";
- // Remote endpoint address
- s << transport_con_type::get_remote_endpoint() << " ";
- // Version string if WebSocket
- if (version != -1) {
- s << "v" << version << " ";
- }
- // User Agent
- std::string ua = m_request.get_header("User-Agent");
- if (ua == "") {
- s << "\"\" ";
- } else {
- // check if there are any quotes in the user agent
- s << "\"" << utility::string_replace_all(ua,"\"","\\\"") << "\" ";
- }
- // URI
- s << (m_uri ? m_uri->get_resource() : "NULL") << " ";
- // Status code
- s << m_response.get_status_code();
- m_alog.write(log::alevel::connect,s.str());
- }
- template <typename config>
- void connection<config>::log_close_result()
- {
- std::stringstream s;
- s << "Disconnect "
- << "close local:[" << m_local_close_code
- << (m_local_close_reason == "" ? "" : ","+m_local_close_reason)
- << "] remote:[" << m_remote_close_code
- << (m_remote_close_reason == "" ? "" : ","+m_remote_close_reason) << "]";
- m_alog.write(log::alevel::disconnect,s.str());
- }
- template <typename config>
- void connection<config>::log_fail_result()
- {
- std::stringstream s;
-
- int version = processor::get_websocket_version(m_request);
- // Connection Type
- s << "WebSocket Connection ";
- // Remote endpoint address & WebSocket version
- s << transport_con_type::get_remote_endpoint();
- if (version < 0) {
- s << " -";
- } else {
- s << " v" << version;
- }
- // User Agent
- std::string ua = m_request.get_header("User-Agent");
- if (ua == "") {
- s << " \"\" ";
- } else {
- // check if there are any quotes in the user agent
- s << " \"" << utility::string_replace_all(ua,"\"","\\\"") << "\" ";
- }
- // URI
- s << (m_uri ? m_uri->get_resource() : "-");
- // HTTP Status code
- s << " " << m_response.get_status_code();
-
- // WebSocket++ error code & reason
- s << " " << m_ec << " " << m_ec.message();
- m_alog.write(log::alevel::fail,s.str());
- }
- template <typename config>
- void connection<config>::log_http_result() {
- std::stringstream s;
- if (processor::is_websocket_handshake(m_request)) {
- m_alog.write(log::alevel::devel,"Call to log_http_result for WebSocket");
- return;
- }
- // Connection Type
- s << (m_request.get_header("host") == "" ? "-" : m_request.get_header("host"))
- << " " << transport_con_type::get_remote_endpoint()
- << " \"" << m_request.get_method()
- << " " << (m_uri ? m_uri->get_resource() : "-")
- << " " << m_request.get_version() << "\" " << m_response.get_status_code()
- << " " << m_response.get_body().size();
-
- // User Agent
- std::string ua = m_request.get_header("User-Agent");
- if (ua == "") {
- s << " \"\" ";
- } else {
- // check if there are any quotes in the user agent
- s << " \"" << utility::string_replace_all(ua,"\"","\\\"") << "\" ";
- }
- m_alog.write(log::alevel::http,s.str());
- }
- } // namespace websocketpp
- #endif // WEBSOCKETPP_CONNECTION_IMPL_HPP
|