TelnetServer.cpp File Reference

#include "telnet/TelnetServer.hpp"
#include "Version.h"
#include "utils/ErrorHelpers.hpp"
#include "utils/Hasher.hpp"
#include <spdlog/spdlog.h>
#include <algorithm>
#include <array>
#include <ctime>
#include <format>
#include <iomanip>
#include <sstream>
#include <string>
#include <utility>
#include <sys/time.h>

Include dependency graph for TelnetServer.cpp:

Go to the source code of this file.

Functions
const std::string	ANSI_FG_BLACK ("\x1b[30m")
const std::string	ANSI_FG_RED ("\x1b[31m")
const std::string	ANSI_FG_GREEN ("\x1b[32m")
const std::string	ANSI_FG_YELLOW ("\x1b[33m")
const std::string	ANSI_FG_BLUE ("\x1b[34m")
const std::string	ANSI_FG_MAGENTA ("\x1b[35m")
const std::string	ANSI_FG_CYAN ("\x1b[36m")
const std::string	ANSI_FG_WHITE ("\x1b[37m")
const std::string	ANSI_FG_DEFAULT ("\x1b[39m")
const std::string	ANSI_BG_BLACK ("\x1b[40m")
const std::string	ANSI_BG_RED ("\x1b[41m")
const std::string	ANSI_BG_GREEN ("\x1b[42m")
const std::string	ANSI_BG_YELLOW ("\x1b[43m")
const std::string	ANSI_BG_BLUE ("\x1b[44m")
const std::string	ANSI_BG_MAGENTA ("\x1b[45m")
const std::string	ANSI_BG_CYAN ("\x1b[46m")
const std::string	ANSI_BG_WHITE ("\x1b[47m")
const std::string	ANSI_BG_DEFAULT ("\x1b[49m")
const std::string	ANSI_BOLD_ON ("\x1b[1m")
const std::string	ANSI_BOLD_OFF ("\x1b[22m")
const std::string	ANSI_ITALICS_ON ("\x1b[3m")
const std::string	ANSI_ITALCIS_OFF ("\x1b[23m")
const std::string	ANSI_UNDERLINE_ON ("\x1b[4m")
const std::string	ANSI_UNDERLINE_OFF ("\x1b[24m")
const std::string	ANSI_INVERSE_ON ("\x1b[7m")
const std::string	ANSI_INVERSE_OFF ("\x1b[27m")
const std::string	ANSI_STRIKETHROUGH_ON ("\x1b[9m")
const std::string	ANSI_STRIKETHROUGH_OFF ("\x1b[29m")
const std::string	ANSI_ERASE_LINE ("\x1b[2K")
const std::string	ANSI_ERASE_SCREEN ("\x1b[2J")
const std::string	ANSI_ARROW_UP ("\x1b\x5b\x41")
const std::string	ANSI_ARROW_DOWN ("\x1b\x5b\x42")
const std::string	ANSI_ARROW_RIGHT ("\x1b\x5b\x43")
const std::string	ANSI_ARROW_LEFT ("\x1b\x5b\x44")
const std::string	ANSI_DOUBLE_HORIZONTAL_TAB ("\t\t")
const std::string	ANSI_HORIZONTAL_TAB ("\t")
const std::string	TELNET_ERASE_LINE ("\xff\xf8")
const std::string	TELNET_CLEAR_SCREEN ("\033[2J")
void	TelnetPrintAvailableCommands (const SP_TelnetSession &session)
void	TelnetConnectedCallback (const SP_TelnetSession &session)
bool	TelnetMessageCallback (const SP_TelnetSession &session, const std::string &line)
std::string	TelnetTabCallback (const SP_TelnetSession &session, std::string_view line)

Variables
constexpr int	INVALID_SOCKET = -1
constexpr int	DEFAULT_BUFLEN = 512
constexpr int	TELNET_TIMEOUT = 120
constexpr int	MAX_AVAILABLE_SESSION = 5
constexpr int	TELNET_HISTORY_LIMIT = 50
constexpr int	SLEEP_INTERVAL_MS = 50
constexpr int	KEY_WIDTH = 30
constexpr int	VAL_WIDTH = 15
constexpr int	ASCII_LF = 0x0A
constexpr int	ASCII_NULL = 0x00
constexpr int	ASCII_NBSP = 0xFF
const std::vector< std::pair< std::string, std::string > >	telnetCommands

Function Documentation

ANSI_ARROW_DOWN()

const std::string ANSI_ARROW_DOWN

(

"\x1b\x5b\x42"

)

Here is the caller graph for this function:

ANSI_ARROW_LEFT()

const std::string ANSI_ARROW_LEFT

(

"\x1b\x5b\x44"

)

Here is the caller graph for this function:

ANSI_ARROW_RIGHT()

const std::string ANSI_ARROW_RIGHT

(

"\x1b\x5b\x43"

)

Here is the caller graph for this function:

ANSI_ARROW_UP()

const std::string ANSI_ARROW_UP

(

"\x1b\x5b\x41"

)

Here is the caller graph for this function:

ANSI_BG_BLACK()

const std::string ANSI_BG_BLACK

(

)

ANSI_BG_BLUE()

const std::string ANSI_BG_BLUE

(

)

ANSI_BG_CYAN()

const std::string ANSI_BG_CYAN

(

)

ANSI_BG_DEFAULT()

const std::string ANSI_BG_DEFAULT

(

)

ANSI_BG_GREEN()

const std::string ANSI_BG_GREEN

(

)

ANSI_BG_MAGENTA()

const std::string ANSI_BG_MAGENTA

(

)

ANSI_BG_RED()

const std::string ANSI_BG_RED

(

)

ANSI_BG_WHITE()

const std::string ANSI_BG_WHITE

(

)

ANSI_BG_YELLOW()

const std::string ANSI_BG_YELLOW

(

)

ANSI_BOLD_OFF()

const std::string ANSI_BOLD_OFF

(

)

ANSI_BOLD_ON()

const std::string ANSI_BOLD_ON

(

)

ANSI_DOUBLE_HORIZONTAL_TAB()

const std::string ANSI_DOUBLE_HORIZONTAL_TAB

(

"\t\t"

)

ANSI_ERASE_LINE()

const std::string ANSI_ERASE_LINE

(

)

Here is the caller graph for this function:

ANSI_ERASE_SCREEN()

const std::string ANSI_ERASE_SCREEN

(

)

ANSI_FG_BLACK()

const std::string ANSI_FG_BLACK

(

)

ANSI_FG_BLUE()

const std::string ANSI_FG_BLUE

(

)

ANSI_FG_CYAN()

const std::string ANSI_FG_CYAN

(

)

ANSI_FG_DEFAULT()

const std::string ANSI_FG_DEFAULT

(

)

ANSI_FG_GREEN()

const std::string ANSI_FG_GREEN

(

)

ANSI_FG_MAGENTA()

const std::string ANSI_FG_MAGENTA

(

)

ANSI_FG_RED()

const std::string ANSI_FG_RED

(

)

ANSI_FG_WHITE()

const std::string ANSI_FG_WHITE

(

)

ANSI_FG_YELLOW()

const std::string ANSI_FG_YELLOW

(

)

ANSI_HORIZONTAL_TAB()

const std::string ANSI_HORIZONTAL_TAB

(

"\t"

)

ANSI_INVERSE_OFF()

const std::string ANSI_INVERSE_OFF

(

)

ANSI_INVERSE_ON()

const std::string ANSI_INVERSE_ON

(

)

ANSI_ITALCIS_OFF()

const std::string ANSI_ITALCIS_OFF

(

)

ANSI_ITALICS_ON()

const std::string ANSI_ITALICS_ON

(

)

ANSI_STRIKETHROUGH_OFF()

const std::string ANSI_STRIKETHROUGH_OFF

(

)

ANSI_STRIKETHROUGH_ON()

const std::string ANSI_STRIKETHROUGH_ON

(

)

ANSI_UNDERLINE_OFF()

const std::string ANSI_UNDERLINE_OFF

(

)

ANSI_UNDERLINE_ON()

const std::string ANSI_UNDERLINE_ON

(

)

TELNET_CLEAR_SCREEN()

const std::string TELNET_CLEAR_SCREEN

(

)

Here is the caller graph for this function:

TELNET_ERASE_LINE()

const std::string TELNET_ERASE_LINE

(

"\xff\xf8"

)

TelnetConnectedCallback()

void TelnetConnectedCallback

(

const SP_TelnetSession &

session

)

Telnet session connection start callback

Parameters

[in]

session

Handle to session

Definition at line 783 of file TelnetServer.cpp.

{
    session->sendLine("\r\n"
                      "𝑲𝒆𝒆𝒑 𝒚𝒐𝒖𝒓 𝒆𝒚𝒆𝒔 𝒐𝒏 𝒕𝒉𝒆 𝒔𝒕𝒂𝒓𝒔 "
                      "𝒂𝒏𝒅 𝒚𝒐𝒖𝒓 𝒇𝒆𝒆𝒕 𝒐𝒏 𝒕𝒉𝒆 𝒈𝒓𝒐𝒖𝒏𝒅 "
                      "\r\n");
    TelnetPrintAvailableCommands(session);
}

Here is the call graph for this function:

Here is the caller graph for this function:

TelnetMessageCallback()

bool TelnetMessageCallback	(	const SP_TelnetSession &	session,
		const std::string &	line )

Telnet session message received callback

Parameters

[in]	session	Handle to session
[in]	line	Received message

Definition at line 792 of file TelnetServer.cpp.

{
    spdlog::trace("Received message {}", line);
 
    // Send received message for user terminal
    session->sendLine(line);
 
    if (line.empty())
    {
        return true;
    }
 
    // Process received message
    switch (constHasher(line.c_str()))
    {
    case constHasher("Test Message"):
        session->sendLine("OK");
        return true;
    case constHasher("help"):
        TelnetPrintAvailableCommands(session);
        return true;
    case constHasher("disable log"):
        session->sendLine("Default log mode enabled");
#ifdef NDEBUG
        spdlog::set_level(spdlog::level::warn);
#else
        spdlog::set_level(spdlog::level::info);
#endif
        return true;
    case constHasher("disable log all"): // Internal use only
        session->sendLine("Disabling all logs");
        spdlog::set_level(spdlog::level::off);
        return true;
    case constHasher("enable log v"):
        session->sendLine("Info log mode enabled");
        spdlog::set_level(spdlog::level::info);
        return true;
    case constHasher("enable log vv"):
        session->sendLine("Debug log mode enabled");
        spdlog::set_level(spdlog::level::debug);
        return true;
    case constHasher("enable log vvv"):
        session->sendLine("Trace log mode enabled");
        spdlog::set_level(spdlog::level::trace);
        return true;
    case constHasher("ping"):
        session->sendLine("pong");
        return true;
    case constHasher("version"):
        session->sendLine(PROJECT_FULL_VERSION_STRING);
        return true;
    case constHasher("clear"):
        session->sendLine(TELNET_CLEAR_SCREEN);
        return true;
    case constHasher("status"):
        for (const auto &[service, statusFlag] : vCheckFlag)
        {
            session->sendLine(std::format("{:.<{}}{:.>{}} ", service + " ", KEY_WIDTH,
                                          (statusFlag->test() ? " OK" : " Not Active"), VAL_WIDTH));
        }
        return true;
    /* ################################################################################### */
    /* ############################# MAKE MODIFICATIONS HERE ############################# */
    /* ################################################################################### */
 
    /* ################################################################################### */
    /* ################################ END MODIFICATIONS ################################ */
    /* ################################################################################### */
    case constHasher("quit"):
        session->sendLine("Closing connection");
        session->sendLine("Goodbye!");
        session->markTimeout();
        return true;
    default:
        session->sendLine("Unknown command received");
        return false;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

TelnetPrintAvailableCommands()

void TelnetPrintAvailableCommands

(

const SP_TelnetSession &

session

)

Print available commands to the session

Parameters

[in]

session

Handle to session

Definition at line 767 of file TelnetServer.cpp.

{
    // Print available commands
    session->sendLine("");
    session->sendLine("Available commands:");
    session->sendLine("");
    for (const auto &[command, info] : telnetCommands)
    {
        std::array<char, BUFSIZ> buffer{'\0'};
        if (std::format_to_n(buffer.data(), BUFSIZ, "{:<25} : {}", command, info).size > 0)
        {
            session->sendLine(buffer.data());
        }
    }
}

Here is the caller graph for this function:

TelnetTabCallback()

std::string TelnetTabCallback	(	const SP_TelnetSession &	session,
		std::string_view	line )

Telnet session TAB received callback

Parameters

[in]	session	Handle to session
[in]	line	Received message

Returns

std::string Command to complete

Definition at line 871 of file TelnetServer.cpp.

{
    std::string retval;
 
    size_t ctr = 0;
    std::ostringstream sStream;
    for (const auto &[command, info] : telnetCommands)
    {
        if (command.starts_with(line))
        {
            ++ctr;
            retval = command;
            sStream << command << std::setw(KEY_WIDTH);
        }
    }
    // Send suggestions if found any. If there is only one command retval will invoke completion
    if (ctr != 1 && (!sStream.str().empty()))
    {
        session->sendLine(sStream.str());
        retval = "";
    }
 
    return retval;
}

Here is the caller graph for this function:

Variable Documentation

ASCII_LF

int ASCII_LF = 0x0A

constexpr

Definition at line 38 of file TelnetServer.cpp.

ASCII_NBSP

int ASCII_NBSP = 0xFF

constexpr

Definition at line 40 of file TelnetServer.cpp.

ASCII_NULL

int ASCII_NULL = 0x00

constexpr

Definition at line 39 of file TelnetServer.cpp.

DEFAULT_BUFLEN

int DEFAULT_BUFLEN = 512

constexpr

Definition at line 23 of file TelnetServer.cpp.

INVALID_SOCKET

int INVALID_SOCKET = -1

constexpr

Definition at line 21 of file TelnetServer.cpp.

KEY_WIDTH

int KEY_WIDTH = 30

constexpr

Definition at line 34 of file TelnetServer.cpp.

MAX_AVAILABLE_SESSION

int MAX_AVAILABLE_SESSION = 5

constexpr

Definition at line 27 of file TelnetServer.cpp.

SLEEP_INTERVAL_MS

int SLEEP_INTERVAL_MS = 50

constexpr

Definition at line 31 of file TelnetServer.cpp.

TELNET_HISTORY_LIMIT

int TELNET_HISTORY_LIMIT = 50

constexpr

Definition at line 29 of file TelnetServer.cpp.

TELNET_TIMEOUT

int TELNET_TIMEOUT = 120

constexpr

Definition at line 25 of file TelnetServer.cpp.

telnetCommands

const std::vector<std::pair<std::string, std::string> > telnetCommands

Initial value:

= {
    {"clear", "Clears the terminal screen"},
    {"disable log", "Resets logger level"},
    {"enable log", R"(Enable specified logger level. Level can be "v" (info), "vv" (debug) and "vvv" (trace))"},
    {"help", "Prints available commands"},
    {"ping", "Pings the server"},
    {"status", "Checks the internal status"},
    {"version", "Displays the current version"},
    
    
    
 
    
    
    
    {"quit", "Ends the connection"}}

Definition at line 43 of file TelnetServer.cpp.

                                                                {
    {"clear", "Clears the terminal screen"},
    {"disable log", "Resets logger level"},
    {"enable log", R"(Enable specified logger level. Level can be "v" (info), "vv" (debug) and "vvv" (trace))"},
    {"help", "Prints available commands"},
    {"ping", "Pings the server"},
    {"status", "Checks the internal status"},
    {"version", "Displays the current version"},
    /* ################################################################################### */
    /* ############################# MAKE MODIFICATIONS HERE ############################# */
    /* ################################################################################### */
 
    /* ################################################################################### */
    /* ################################ END MODIFICATIONS ################################ */
    /* ################################################################################### */
    {"quit", "Ends the connection"}};

VAL_WIDTH

int VAL_WIDTH = 15

constexpr

Definition at line 35 of file TelnetServer.cpp.