WorkBase.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2016 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_APP_MISC_DETAIL_WORKBASE_H_INCLUDED
#define RIPPLE_APP_MISC_DETAIL_WORKBASE_H_INCLUDED
 
#include <xrpld/app/misc/detail/Work.h>
 
#include <xrpl/basics/random.h>
#include <xrpl/protocol/BuildInfo.h>
 
#include <boost/asio.hpp>
#include <boost/beast/core/multi_buffer.hpp>
#include <boost/beast/http/empty_body.hpp>
#include <boost/beast/http/read.hpp>
#include <boost/beast/http/write.hpp>
 
namespace ripple {
 
namespace detail {
 
template <class Impl>
class WorkBase : public Work
{
protected:
    using error_code = boost::system::error_code;
    using endpoint_type = boost::asio::ip::tcp::endpoint;
 
public:
    using callback_type = std::function<
        void(error_code const&, endpoint_type const&, response_type&&)>;
 
protected:
    using socket_type = boost::asio::ip::tcp::socket;
    using resolver_type = boost::asio::ip::tcp::resolver;
    using results_type = boost::asio::ip::tcp::resolver::results_type;
    using request_type =
        boost::beast::http::request<boost::beast::http::empty_body>;
 
    std::string host_;
    std::string path_;
    std::string port_;
    callback_type cb_;
    boost::asio::io_service& ios_;
    boost::asio::io_service::strand strand_;
    resolver_type resolver_;
    socket_type socket_;
    request_type req_;
    response_type res_;
    boost::beast::multi_buffer readBuf_;
    endpoint_type lastEndpoint_;
    bool lastStatus_;
 
public:
    WorkBase(
        std::string const& host,
        std::string const& path,
        std::string const& port,
        boost::asio::io_service& ios,
        endpoint_type const& lastEndpoint,
        bool lastStatus,
        callback_type cb);
    ~WorkBase();
 
    Impl&
    impl()
    {
        return *static_cast<Impl*>(this);
    }
 
    void
    run() override;
 
    void
    cancel() override;
 
    void
    fail(error_code const& ec);
 
    void
    onResolve(error_code const& ec, results_type results);
 
    void
    onStart();
 
    void
    onRequest(error_code const& ec);
 
    void
    onResponse(error_code const& ec);
 
private:
    void
    close();
};
 
//------------------------------------------------------------------------------
 
template <class Impl>
WorkBase<Impl>::WorkBase(
    std::string const& host,
    std::string const& path,
    std::string const& port,
    boost::asio::io_service& ios,
    endpoint_type const& lastEndpoint,
    bool lastStatus,
    callback_type cb)
    : host_(host)
    , path_(path)
    , port_(port)
    , cb_(std::move(cb))
    , ios_(ios)
    , strand_(ios)
    , resolver_(ios)
    , socket_(ios)
    , lastEndpoint_{lastEndpoint}
    , lastStatus_(lastStatus)
{
}
 
template <class Impl>
WorkBase<Impl>::~WorkBase()
{
    if (cb_)
        cb_(make_error_code(boost::system::errc::not_a_socket),
            lastEndpoint_,
            std::move(res_));
    close();
}
 
template <class Impl>
void
WorkBase<Impl>::run()
{
    if (!strand_.running_in_this_thread())
        return ios_.post(
            strand_.wrap(std::bind(&WorkBase::run, impl().shared_from_this())));
 
    resolver_.async_resolve(
        host_,
        port_,
        strand_.wrap(std::bind(
            &WorkBase::onResolve,
            impl().shared_from_this(),
            std::placeholders::_1,
            std::placeholders::_2)));
}
 
template <class Impl>
void
WorkBase<Impl>::cancel()
{
    if (!strand_.running_in_this_thread())
    {
        return ios_.post(strand_.wrap(
            std::bind(&WorkBase::cancel, impl().shared_from_this())));
    }
 
    error_code ec;
    resolver_.cancel();
    socket_.cancel(ec);
}
 
template <class Impl>
void
WorkBase<Impl>::fail(error_code const& ec)
{
    if (cb_)
    {
        cb_(ec, lastEndpoint_, std::move(res_));
        cb_ = nullptr;
    }
}
 
template <class Impl>
void
WorkBase<Impl>::onResolve(error_code const& ec, results_type results)
{
    if (ec)
        return fail(ec);
 
    // Use last endpoint if it is successfully connected
    // and is in the list, otherwise pick a random endpoint
    // from the list (excluding last endpoint). If there is
    // only one endpoint and it is the last endpoint then
    // use the last endpoint.
    lastEndpoint_ = [&]() -> endpoint_type {
        int foundIndex = 0;
        auto const foundIt = std::find_if(
            results.begin(), results.end(), [&](endpoint_type const& e) {
                if (e == lastEndpoint_)
                    return true;
                foundIndex++;
                return false;
            });
        if (foundIt != results.end() && lastStatus_)
            return lastEndpoint_;
        else if (results.size() == 1)
            return *results.begin();
        else if (foundIt == results.end())
            return *std::next(results.begin(), rand_int(results.size() - 1));
 
        // lastEndpoint_ is part of the collection
        // Pick a random number from the n-1 valid choices, if we use
        // this as an index, note the last element will never be chosen
        // and the `lastEndpoint_` index may be chosen. So when the
        // `lastEndpoint_` index is chosen, that is treated as if the
        // last element was chosen.
        auto randIndex =
            (results.size() > 2) ? rand_int(results.size() - 2) : 0;
        if (randIndex == foundIndex)
            randIndex = results.size() - 1;
        return *std::next(results.begin(), randIndex);
    }();
 
    socket_.async_connect(
        lastEndpoint_,
        strand_.wrap(std::bind(
            &Impl::onConnect,
            impl().shared_from_this(),
            std::placeholders::_1)));
}
 
template <class Impl>
void
WorkBase<Impl>::onStart()
{
    req_.method(boost::beast::http::verb::get);
    req_.target(path_.empty() ? "/" : path_);
    req_.version(11);
    req_.set("Host", host_ + ":" + port_);
    req_.set("User-Agent", BuildInfo::getFullVersionString());
    req_.prepare_payload();
    boost::beast::http::async_write(
        impl().stream(),
        req_,
        strand_.wrap(std::bind(
            &WorkBase::onRequest,
            impl().shared_from_this(),
            std::placeholders::_1)));
}
 
template <class Impl>
void
WorkBase<Impl>::onRequest(error_code const& ec)
{
    if (ec)
        return fail(ec);
 
    boost::beast::http::async_read(
        impl().stream(),
        readBuf_,
        res_,
        strand_.wrap(std::bind(
            &WorkBase::onResponse,
            impl().shared_from_this(),
            std::placeholders::_1)));
}
 
template <class Impl>
void
WorkBase<Impl>::onResponse(error_code const& ec)
{
    if (ec)
        return fail(ec);
 
    close();
    XRPL_ASSERT(cb_, "ripple::detail::WorkBase::onResponse : callback is set");
    cb_(ec, lastEndpoint_, std::move(res_));
    cb_ = nullptr;
}
 
template <class Impl>
void
WorkBase<Impl>::close()
{
    if (socket_.is_open())
    {
        error_code ec;
        socket_.shutdown(boost::asio::socket_base::shutdown_send, ec);
        if (ec)
            return;
        socket_.close(ec);
    }
}
 
}  // namespace detail
 
}  // namespace ripple
 
#endif