oxen-core/src/daemon/command_server.h

// Copyright (c) 2018-2020, The Loki Project
// Copyright (c) 2014-2019, The Monero Project
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of
//    conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the copyright holder 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
// THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.

#pragma once

#include <optional>

#include "common/common_fwd.h"
#include "daemon/command_parser_executor.h"
#include "epee/console_handler.h"

namespace daemonize {

class command_server {
  private:
    command_parser_executor m_parser;
    epee::console_handlers_binder m_command_lookup;
    std::optional<oxenmq::OxenMQ> m_omq;

  public:
    /// command_server constructor; forwards to command_parser_executor
    template <typename... T>
    command_server(T&&... args) : m_parser{std::forward<T>(args)...} {
        init_commands();
    }

    template <typename... T>
    bool process_command_and_log(T&&... args) {
        return m_command_lookup.process_command_and_log(std::forward<T>(args)...);
    }

    bool start_handling(std::function<void()> exit_handler = {});

    void stop_handling();

  private:
    void init_commands(cryptonote::rpc::core_rpc_server* rpc_server = nullptr);
    bool help(const std::vector<std::string>& args);

    std::string get_commands_str();
    std::string get_command_usage(const std::vector<std::string>& args);
};

}  // namespace daemonize