/*
Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012
Her Majesty the Queen in Right of Canada (Communications Research
Center Canada)
Copyright (C) 2014
Matthias P. Braendli, matthias.braendli@mpb.li
*/
/*
This file is part of ODR-DabMux.
ODR-DabMux is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
ODR-DabMux is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with ODR-DabMux. If not, see .
*/
#include
#include
#include
#include
#include
#include
#include
#include "Log.h"
#include "RemoteControl.h"
using boost::asio::ip::tcp;
using namespace std;
RemoteControllerTelnet::~RemoteControllerTelnet()
{
m_running = false;
m_io_service.stop();
m_child_thread.join();
}
void RemoteControllerTelnet::restart()
{
m_restarter_thread = boost::thread(&RemoteControllerTelnet::restart_thread,
this, 0);
}
// This runs in a separate thread, because
// it would take too long to be done in the main loop
// thread.
void RemoteControllerTelnet::restart_thread(long)
{
etiLog.level(warn) << "RC: Restart Telnet server";
m_running = false;
m_io_service.stop();
m_child_thread.join();
m_child_thread = boost::thread(&RemoteControllerTelnet::process, this, 0);
}
void RemoteControllerTelnet::handle_accept(
const boost::system::error_code& boost_error,
boost::shared_ptr< boost::asio::ip::tcp::socket > socket,
boost::asio::ip::tcp::acceptor& acceptor)
{
const std::string welcome = "ODR-DabMux Remote Control CLI\n"
"Write 'help' for help.\n"
"**********\n";
const std::string prompt = "> ";
std::string in_message;
size_t length;
if (boost_error)
{
etiLog.level(error) << "RC: Error accepting connection";
return;
}
try {
etiLog.level(info) << "RC: Accepted";
boost::system::error_code ignored_error;
boost::asio::write(*socket, boost::asio::buffer(welcome),
boost::asio::transfer_all(),
ignored_error);
while (m_running && in_message != "quit") {
boost::asio::write(*socket, boost::asio::buffer(prompt),
boost::asio::transfer_all(),
ignored_error);
in_message = "";
boost::asio::streambuf buffer;
length = boost::asio::read_until(*socket, buffer, "\n", ignored_error);
std::istream str(&buffer);
std::getline(str, in_message);
if (length == 0) {
etiLog.level(info) << "RC: Connection terminated";
break;
}
while (in_message.length() > 0 &&
(in_message[in_message.length()-1] == '\r' ||
in_message[in_message.length()-1] == '\n')) {
in_message.erase(in_message.length()-1, 1);
}
if (in_message.length() == 0) {
continue;
}
etiLog.level(info) << "RC: Got message '" << in_message << "'";
dispatch_command(*socket, in_message);
}
etiLog.level(info) << "RC: Closing socket";
socket->close();
}
catch (std::exception& e)
{
etiLog.level(error) << "Remote control caught exception: " << e.what();
}
}
void RemoteControllerTelnet::process(long)
{
m_running = true;
while (m_running) {
m_io_service.reset();
tcp::acceptor acceptor(m_io_service, tcp::endpoint(
boost::asio::ip::address::from_string("127.0.0.1"), m_port) );
// Add a job to start accepting connections.
boost::shared_ptr socket(
new tcp::socket(acceptor.get_io_service()));
// Add an accept call to the service. This will prevent io_service::run()
// from returning.
etiLog.level(warn) << "RC: Waiting on connection";
acceptor.async_accept(*socket,
boost::bind(&RemoteControllerTelnet::handle_accept,
this,
boost::asio::placeholders::error,
socket,
boost::ref(acceptor)));
// Process event loop.
m_io_service.run();
}
etiLog.level(warn) << "RC: Leaving";
m_fault = true;
}
void RemoteControllerTelnet::dispatch_command(tcp::socket& socket, string command)
{
vector cmd = tokenise_(command);
if (cmd[0] == "help") {
reply(socket,
"The following commands are supported:\n"
" list\n"
" * Lists the modules that are loaded and their parameters\n"
" show MODULE\n"
" * Lists all parameters and their values from module MODULE\n"
" get MODULE PARAMETER\n"
" * Gets the value for the specified PARAMETER from module MODULE\n"
" set MODULE PARAMETER VALUE\n"
" * Sets the value for the PARAMETER ofr module MODULE\n"
" quit\n"
" * Terminate this session\n"
"\n");
}
else if (cmd[0] == "list") {
stringstream ss;
if (cmd.size() == 1) {
for (list::iterator it = m_cohort.begin();
it != m_cohort.end(); ++it) {
ss << (*it)->get_rc_name() << endl;
list< vector >::iterator param;
list< vector > params = (*it)->get_parameter_descriptions();
for (param = params.begin();
param != params.end();
++param) {
ss << "\t" << (*param)[0] << " : " << (*param)[1] << endl;
}
}
}
else {
reply(socket, "Too many arguments for command 'list'");
}
reply(socket, ss.str());
}
else if (cmd[0] == "show") {
if (cmd.size() == 2) {
try {
stringstream ss;
list< vector > r = get_param_list_values_(cmd[1]);
for (list< vector >::iterator it = r.begin();
it != r.end(); ++it) {
ss << (*it)[0] << ": " << (*it)[1] << endl;
}
reply(socket, ss.str());
}
catch (ParameterError &e) {
reply(socket, e.what());
}
}
else
{
reply(socket, "Incorrect parameters for command 'show'");
}
}
else if (cmd[0] == "get") {
if (cmd.size() == 3) {
try {
string r = get_param_(cmd[1], cmd[2]);
reply(socket, r);
}
catch (ParameterError &e) {
reply(socket, e.what());
}
}
else
{
reply(socket, "Incorrect parameters for command 'get'");
}
}
else if (cmd[0] == "set") {
if (cmd.size() >= 4) {
try {
stringstream new_param_value;
for (size_t i = 3; i < cmd.size(); i++) {
new_param_value << cmd[i];
if (i+1 < cmd.size()) {
new_param_value << " ";
}
}
set_param_(cmd[1], cmd[2], new_param_value.str());
reply(socket, "ok");
}
catch (ParameterError &e) {
reply(socket, e.what());
}
catch (exception &e) {
reply(socket, "Error: Invalid parameter value. ");
}
}
else {
reply(socket, "Incorrect parameters for command 'set'");
}
}
else if (cmd[0] == "quit") {
reply(socket, "Goodbye");
}
else {
reply(socket, "Message not understood");
}
}
void RemoteControllerTelnet::reply(tcp::socket& socket, string message)
{
boost::system::error_code ignored_error;
stringstream ss;
ss << message << "\r\n";
boost::asio::write(socket, boost::asio::buffer(ss.str()),
boost::asio::transfer_all(),
ignored_error);
}