cli.h File Reference

#include <stdio.h>
#include <stdlib.h>

Go to the source code of this file.

Data Structures
struct	cli_command
	CLI command structure. More...

Macros
#define	MAX_LINE_LEN   256
#define	CLI_BUFSIZE   64
#define	CLI_DELIM   " "
#define	CLI_COMMANDS_NUM   (int) (sizeof(cli_commands) / sizeof(cli_command))
#define	CLI_HISTORY_FILE   "cli_history.txt"
#define	CLI_PREFIX   "BitLab> "

Functions
void	print_help ()
	Prints CLI command help.
void	print_usage (const char *command_name)
	Prints CLI command usage.
void	print_commands ()
	Prints CLI commands.
const char *	create_history_dir ()
	Create history directory.
int	cli_exit (char **args)
	Exits BitLab CLI command.
int	cli_history (char **args)
	Prints CLI command history.
int	cli_echo (char **args)
	Echoes the input.
int	cli_whoami (char **args)
	Prints the user name.
int	cli_get_ip (char **args)
	Gets remote IP address on an URL or host machine if no URL is provided.
int	cli_info (char **args)
	Prints program information.
int	cli_peer_discovery (char **args)
	Discovers Bitcoin peers.
int	cli_clear (char **args)
	Clears CLI window.
int	cli_help (char **args)
	Prints CLI command help.
int	cli_ping (char **args)
	Pings the specified IP address.
int	cli_connect (char **args)
	Connects to the specified IP address.
int	cli_list (char **args)
	Lists all connected nodes.
int	cli_getaddr (char **args)
	Sends a 'getaddr' message to the specified peer.
int	cli_disconnect (char **args)
	Disconnects from the specified node.
int	cli_getheaders (char **args)
	Sends a 'getheaders' message to specified peer.
int	cli_getblocks (char **args)
	Sends a 'getblocks' message to specified peer.
int	cli_inv (char **args)
	Sends a 'inv' message to specified peer.
int	cli_getdata (char **args)
	Sends a 'getdata' message to specified peer.
int	cli_tx (char **args)
	Sends a 'tx' message to specified peer.
int	cli_get_line (char **lineptr, size_t *n, FILE *stream)
	Gets the line from the file stream.
char *	cli_read_line (void)
	Reads input from user.
int	cli_exec_line (char *line)
	Execute command.
char **	cli_completion (const char *text, int start, int end)
	CLI completion function.
char *	cli_command_generator (const char *text, int state)
	CLI command generator.
void *	handle_cli (void *arg)
	CLI handler thread.

Macro Definition Documentation

CLI_BUFSIZE

#define CLI_BUFSIZE   64

Definition at line 8 of file cli.h.

CLI_COMMANDS_NUM

#define CLI_COMMANDS_NUM   (int) (sizeof(cli_commands) / sizeof(cli_command))

Definition at line 10 of file cli.h.

CLI_DELIM

#define CLI_DELIM   " "

Definition at line 9 of file cli.h.

CLI_HISTORY_FILE

#define CLI_HISTORY_FILE   "cli_history.txt"

Definition at line 11 of file cli.h.

CLI_PREFIX

#define CLI_PREFIX   "BitLab> "

Definition at line 12 of file cli.h.

MAX_LINE_LEN

#define MAX_LINE_LEN   256

Definition at line 7 of file cli.h.

Function Documentation

cli_clear()

int cli_clear

(

char **

args

)

Clears CLI window.

Parameters

args	The arguments passed to the function should be empty.

Returns

The exit code.

Definition at line 1098 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Unknown argument for clear command: %s", args[0]);
        print_usage("clear");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    clear_cli();
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, clear_cli(), cli_mutex, log_message(), LOG_WARN, and print_usage().

cli_command_generator()

char * cli_command_generator	(	const char *	text,
		int	state
	)

CLI command generator.

Parameters

text	The text to generate.
state	The state of the generator.

Returns

The generated command.

Definition at line 1258 of file cli.c.

{
    static int list_index, len;
    const char* name;
    if (!state)
    {
        list_index = 0;
        len = strlen(text);
    }
    while (list_index < CLI_COMMANDS_NUM)
    {
        name = cli_commands[list_index].cli_command_name;
        list_index++;
 
        if (strncmp(name, text, len) == 0)
            return strdup(name);
    }
    return NULL;
}

References cli_command::cli_command_name, cli_commands, CLI_COMMANDS_NUM, state, and strdup().

Referenced by cli_completion().

cli_completion()

char ** cli_completion	(	const char *	text,
		int	start,
		int	end
	)

CLI completion function.

Parameters

text	The text to complete.
start	The start index.
end	The end index.

Returns

The completion.

Definition at line 1225 of file cli.c.

{
    rl_attempted_completion_over = 1;
    start = start; // unused
    end = end; // unused
    char* line = rl_line_buffer;
    int spaces = 0;
 
    // print help for empty input
    if (strlen(line) == 0)
    {
        guarded_print("\n");
        print_help();
        guarded_print(CLI_PREFIX);
        return NULL;
    }
 
    // count spaces
    for (long unsigned i = 0; i < strlen(line); ++i)
        if (line[i] == ' ')
            spaces++;
 
    // check if the input starts with "help" and allow for one space
    if (((strncmp(line, "help", 4) == 0) && spaces <= 1))
        return rl_completion_matches(text, cli_command_generator);
 
    // complete first word
    if (spaces == 0)
        return rl_completion_matches(text, cli_command_generator);
 
    return NULL;
}

References cli_command_generator(), CLI_PREFIX, guarded_print(), and print_help().

Referenced by handle_cli().

cli_connect()

int cli_connect

(

char **

args

)

Connects to the specified IP address.

Parameters

args	The IP address.

Returns

The exit code.

Definition at line 768 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] == NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "No arguments provided for connect command");
        print_usage("connect");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    if (args[1] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Too many arguments for connect command");
        print_usage("connect");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    char ip_address[BUFFER_SIZE];
    if (is_numeric_address(args[0]))
    {
        strncpy(ip_address, args[0], BUFFER_SIZE - 1);
        ip_address[BUFFER_SIZE - 1] = '\0';
        guarded_print_line("Connecting to %s", ip_address);
        connect_to_peer(ip_address);
    }
    else
        guarded_print_line(
            "Connect command uses numeric address for peer connection. Supplied argument: %s",
            args[0]);
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, BUFFER_SIZE, cli_mutex, connect_to_peer(), guarded_print_line(), is_numeric_address(), log_message(), LOG_WARN, and print_usage().

cli_disconnect()

int cli_disconnect

(

char **

args

)

Disconnects from the specified node.

This function disconnects from the node specified by the given node ID. It closes the socket, terminates the thread, and logs the disconnection.

Parameters

args	The arguments passed to the function should contain the node ID.

Returns

The exit code.

Definition at line 830 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] == NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "No arguments provided for disconnect command");
        print_usage("disconnect");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    if (args[1] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Too many arguments for disconnect command");
        print_usage("disconnect");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    int idx = atoi(args[0]);
    guarded_print_line("Disconnecting from node %d", idx);
    disconnect(idx);
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, disconnect(), guarded_print_line(), log_message(), LOG_WARN, and print_usage().

cli_echo()

int cli_echo

(

char **

args

)

Echoes the input.

Parameters

args	Input that will be echoed.

Returns

The exit code.

Definition at line 367 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] == NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "No arguments provided for echo command");
        print_usage("echo");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    for (int i = 0; args[i] != NULL; ++i)
        guarded_print("%s ", args[i]);
    guarded_print("\n");
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, guarded_print(), log_message(), LOG_WARN, and print_usage().

cli_exec_line()

int cli_exec_line

(

char *

line

)

Execute command.

This function executes a command from line.

Parameters

line	The string containing input from user.

Returns

The exit code.

Definition at line 1163 of file cli.c.

{
    int i = 0;
    int buffer_size = CLI_BUFSIZE;
    char** tokens = malloc(buffer_size * sizeof(char*));
    char* token;
 
    char* command;
    char** args;
 
    if (!tokens)
    {
        log_message(LOG_FATAL, BITLAB_LOG, __FILE__, "cli_exec_line: malloc error");
        exit(EXIT_FAILURE);
    }
 
    token = strtok(line, CLI_DELIM);
    while (token != NULL)
    {
        tokens[i] = token;
        i++;
 
        if (i >= buffer_size)
        {
            buffer_size += CLI_BUFSIZE;
            tokens = realloc(tokens, buffer_size * sizeof(char*));
            if (!tokens)
            {
                log_message(LOG_FATAL, BITLAB_LOG, __FILE__,
                    "cli_exec_line: malloc error");
                exit(EXIT_FAILURE);
            }
        }
 
        token = strtok(NULL, CLI_DELIM);
    }
    tokens[i] = NULL;
 
    command = tokens[0];
    args = tokens + 1;
 
    if (command == NULL)
    {
        free(tokens);
        return 1;
    }
 
    for (i = 0; i < CLI_COMMANDS_NUM; ++i)
    {
        if (!strcmp(command, cli_commands[i].cli_command_name))
        {
            int result = (cli_commands[i].cli_command)(args);
            free(tokens);
            return result;
        }
    }
    guarded_print_line("Command not found! Type \"help\" to see available commands.");
    log_message(LOG_INFO, BITLAB_LOG, __FILE__, "Command not found: %s", command);
    free(tokens);
    return 1;
}

References BITLAB_LOG, CLI_BUFSIZE, cli_command::cli_command, cli_commands, CLI_COMMANDS_NUM, CLI_DELIM, guarded_print_line(), LOG_FATAL, LOG_INFO, log_message(), and strtok().

Referenced by handle_cli(), and run_bitlab().

cli_exit()

int cli_exit

(

char **

args

)

Exits BitLab CLI command.

Parameters

args	The arguments passed to the function should be empty.

Returns

The exit code.

Definition at line 281 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] != NULL)
    {
        if (strcmp(args[0], "-f") == 0 || strcmp(args[0], "--force") == 0)
        {
            if (args[1] != NULL)
            {
                log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                    "Unknown argument for exit command: \"%s\"", args[1]);
                print_usage("exit");
                pthread_mutex_unlock(&cli_mutex);
                return 1;
            }
            log_message(LOG_WARN, BITLAB_LOG, __FILE__, "Force exiting BitLab");
            pthread_mutex_unlock(&cli_mutex);
            exit(0);
        }
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Unknown argument for exit command: \"%s\"", args[0]);
        print_usage("exit");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    log_message(LOG_INFO, BITLAB_LOG, __FILE__, "Server shutdown requested");
    set_exit_flag(1);
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, LOG_INFO, log_message(), LOG_WARN, print_usage(), and set_exit_flag().

cli_get_ip()

int cli_get_ip

(

char **

args

)

Gets remote IP address on an URL or host machine if no URL is provided.

Parameters

args

The URL.

Returns

The exit code.

Definition at line 437 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    char ip_address[BUFFER_SIZE];
    if (args[0] == NULL)
    {
        get_remote_ip_address(ip_address);
        guarded_print_line("Public IP address: %s", ip_address);
    }
    else
    {
        if (args[0] != NULL && args[1] == NULL)
        {
            if (is_valid_domain_address(args[0]))
            {
                lookup_address(args[0], ip_address);
                guarded_print_line("IP address of %s: %s", args[0], ip_address);
            }
            else
                guarded_print_line("Invalid domain address: %s", args[0]);
        }
        else
        {
            int i = 0;
            while (args[i] != NULL)
            {
                ip_address[0] = '\0';
                if (is_valid_domain_address(args[i]))
                {
                    lookup_address(args[i], ip_address);
                    guarded_print_line("%d: IP address of %s: %s", i + 1, args[i],
                        ip_address);
                }
                else
                    guarded_print_line("%d: Invalid domain address: %s", i + 1,
                        args[i]);
                i++;
            }
        }
    }
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BUFFER_SIZE, cli_mutex, get_remote_ip_address(), guarded_print_line(), is_valid_domain_address(), and lookup_address().

cli_get_line()

int cli_get_line	(	char **	lineptr,
		size_t *	n,
		FILE *	stream
	)

Gets the line from the file stream.

Parameters

lineptr	The pointer to the line.
n	The size of the line.
stream	The file stream.

Returns

The number of characters read.

Definition at line 1114 of file cli.c.

{
    static char line[MAX_LINE_LEN];
    char* ptr;
    unsigned int len;
 
    if (lineptr == NULL || n == NULL)
    {
        errno = EINVAL;
        return -1;
    }
 
    if (ferror(stream))
        return -1;
 
    if (feof(stream))
        return -1;
 
    (void)fgets(line, MAX_LINE_LEN, stream);
 
    ptr = strchr(line, '\n');
    if (ptr)
        *ptr = '\0';
 
    len = strlen(line);
 
    if ((len + 1) < MAX_LINE_LEN)
    {
        ptr = realloc(*lineptr, MAX_LINE_LEN);
        if (ptr == NULL)
            return (-1);
        *lineptr = ptr;
        *n = MAX_LINE_LEN;
    }
 
    strcpy(*lineptr, line);
    return (len);
}

References MAX_LINE_LEN.

cli_getaddr()

int cli_getaddr

(

char **

args

)

Sends a 'getaddr' message to the specified peer.

Parameters

args	The index of the peer.

Returns

The exit code.

Definition at line 804 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] == NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "No arguments provided for getaddr command");
        print_usage("getaddr");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    if (args[1] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Too many arguments for getaddr command");
        print_usage("getaddr");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    int idx = atoi(args[0]);
    guarded_print_line("Sending getaddr to %d", idx);
    send_getaddr_and_wait(idx);
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, guarded_print_line(), log_message(), LOG_WARN, print_usage(), and send_getaddr_and_wait().

cli_getblocks()

int cli_getblocks

(

char **

args

)

Sends a 'getblocks' message to specified peer.

Parameters

args	The index of the peer.

Returns

The exit code.

Definition at line 882 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] == NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "No arguments provided for getblocks command");
        print_usage("getblocks");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    if (args[1] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Too many arguments for getblocks command");
        print_usage("getblocks");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    int idx = atoi(args[0]);
    guarded_print_line("Sending getblocks to %d", idx);
    send_getblocks_and_wait(idx);
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, guarded_print_line(), log_message(), LOG_WARN, print_usage(), and send_getblocks_and_wait().

cli_getdata()

int cli_getdata

(

char **

args

)

Sends a 'getdata' message to specified peer.

Parameters

args	The index of the peer.

Returns

The exit code.

Definition at line 908 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] == NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "No arguments provided for getdata command");
        print_usage("getdata");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    int idx = atoi(args[0]);
    if (idx < 0 || idx >= MAX_NODES)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Invalid node index for getdata command");
        print_usage("getdata");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    // Count the number of hashes provided
    size_t hash_count = 0;
    for (int i = 1; args[i] != NULL; i++)
    {
        hash_count++;
    }
 
    if (hash_count == 0)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "No hashes provided for getdata command");
        print_usage("getdata");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    if (hash_count > 50000)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Too many hashes provided for getdata command");
        print_usage("getdata");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    // Allocate memory for the hashes
    unsigned char* hashes = malloc(hash_count * 32);
    if (hashes == NULL)
    {
        log_message(LOG_ERROR, BITLAB_LOG, __FILE__,
            "Failed to allocate memory for hashes");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    // Parse the hashes from the arguments
    for (size_t i = 0; i < hash_count; i++)
    {
        if (strlen(args[i + 1]) != 64)
        {
            log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                "Invalid hash length for getdata command");
            print_usage("getdata");
            free(hashes);
            pthread_mutex_unlock(&cli_mutex);
            return 1;
        }
 
        for (size_t j = 0; j < 32; j++)
        {
            sscanf(&args[i + 1][j * 2], "%2hhx", &hashes[i * 32 + j]);
        }
    }
 
    guarded_print_line("Sending getdata to %d with %zu hashes", idx, hash_count);
    send_getdata_and_wait(idx, hashes, hash_count);
 
    free(hashes);
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, guarded_print_line(), LOG_ERROR, log_message(), LOG_WARN, MAX_NODES, print_usage(), and send_getdata_and_wait().

cli_getheaders()

int cli_getheaders

(

char **

args

)

Sends a 'getheaders' message to specified peer.

Parameters

args	The index of the peer.

Returns

The exit code.

Definition at line 856 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] == NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "No arguments provided for getheaders command");
        print_usage("getheaders");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    if (args[1] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Too many arguments for getheaders command");
        print_usage("getheaders");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    int idx = atoi(args[0]);
    guarded_print_line("Sending getheaders to %d", idx);
    send_getheaders_and_wait(idx);
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, guarded_print_line(), log_message(), LOG_WARN, print_usage(), and send_getheaders_and_wait().

cli_help()

int cli_help

(

char **

args

)

Prints CLI command help.

Parameters

args	The arguments passed to this function can be empty to get full program help or argument should specify one comand to get help for.

Returns

The exit code.

Definition at line 333 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] != NULL)
    {
        if (args[1] != NULL && args[2] == NULL)
        {
            log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                "Too many arguments for help command");
            print_usage("help");
            pthread_mutex_unlock(&cli_mutex);
            return 1;
        }
        for (long unsigned i = 0; i < sizeof(cli_commands) / sizeof(cli_command); ++i)
        {
            if (strcmp(args[0], cli_commands[i].cli_command_name) == 0)
            {
                if (cli_commands[i].cli_command_detailed_desc)
                    guarded_print_line(cli_commands[i].cli_command_detailed_desc);
                else
                    guarded_print_line(" * %s - Detailed information not included.",
                        args[0]);
                pthread_mutex_unlock(&cli_mutex);
                return 0;
            }
        }
        guarded_print_line(" * %s - Unknown command.", args[0]);
    }
    else
        print_help();
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_commands, cli_mutex, guarded_print_line(), log_message(), LOG_WARN, print_help(), and print_usage().

cli_history()

int cli_history

(

char **

args

)

Prints CLI command history.

Parameters

args	The arguments passed to the function should be empty.

Returns

The exit code.

Definition at line 312 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Unknown argument for history command: \"%s\"", args[0]);
        print_usage("history");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    HIST_ENTRY** history_entries = history_list();
    if (history_entries)
    {
        for (int i = 0; history_entries[i] != NULL; ++i)
            guarded_print_line("%d: %s", i + 1, history_entries[i]->line);
    }
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, guarded_print_line(), log_message(), LOG_WARN, and print_usage().

cli_info()

int cli_info

(

char **

args

)

Prints program information.

Parameters

args	The arguments passed to the function should be empty.

Returns

The exit code.

Definition at line 481 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Unknown argument for info command: %s", args[0]);
        print_usage("info");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    guarded_print_line("BitLab v%s", BITLAB_VERSION);
    guarded_print_line("Built on %s %s", __DATE__, __TIME__);
    print_program_state();
    if (operation.peer_discovery)
    {
        guarded_print_line("Peer discovery: active");
 
        if (operation.peer_discovery_in_progress)
            guarded_print_line("Peer discovery in progress: true");
        else
            guarded_print_line("Peer discovery in progress: false");
        if (operation.peer_discovery_succeeded)
            guarded_print_line("Peer discovery succeeded: true");
        else
            guarded_print_line("Peer discovery succeeded: false");
        if (operation.peer_discovery_daemon)
            guarded_print_line("Peer discovery daemon: true");
        else
            guarded_print_line("Peer discovery daemon: false");
        if (operation.peer_discovery_hardcoded_seeds)
            guarded_print_line("Peer discovery hardcoded seeds: true");
        else
            guarded_print_line("Peer discovery hardcoded seeds: false");
        if (operation.peer_discovery_dns_lookup)
            guarded_print_line("Peer discovery DNS lookup: true");
        else
            guarded_print_line("Peer discovery DNS lookup: false");
    }
    else
        guarded_print_line("Peer discovery: inactive");
 
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, BITLAB_VERSION, cli_mutex, guarded_print_line(), log_message(), LOG_WARN, operation, program_operation::peer_discovery, program_operation::peer_discovery_daemon, program_operation::peer_discovery_dns_lookup, program_operation::peer_discovery_hardcoded_seeds, program_operation::peer_discovery_in_progress, program_operation::peer_discovery_succeeded, print_program_state(), and print_usage().

cli_inv()

int cli_inv

(

char **

args

)

Sends a 'inv' message to specified peer.

Parameters

args	The index of the peer.

Returns

The exit code.

Definition at line 992 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] == NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Insufficient arguments provided for inv command");
        print_usage("inv");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    if (args[1] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Too many arguments for inv command");
        print_usage("inv");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    int idx = atoi(args[0]);
 
    // Load inventory data from blocks.dat
    size_t inv_len;
    unsigned char* inv_data = load_blocks_from_file("blocks.dat", &inv_len);
    if (!inv_data)
    {
        log_message(LOG_ERROR, BITLAB_LOG, __FILE__,
            "Failed to load inventory data from blocks.dat");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    size_t inv_count = inv_len / 36;
    printf("inv_len: %zu, inv_count: %zu\n", inv_len, inv_count);
 
    // Send the 'inv' message
    send_inv_and_wait(idx, inv_data, inv_count);
 
    free(inv_data);
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, load_blocks_from_file(), LOG_ERROR, log_message(), LOG_WARN, print_usage(), and send_inv_and_wait().

cli_list()

int cli_list

(

char **

args

)

Lists all connected nodes.

Parameters

args	The arguments passed to the function should be empty.

Returns

The exit code.

Definition at line 1082 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] != NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Too many arguments for getaddr command");
        print_usage("getaddr");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
    list_connected_nodes();
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, list_connected_nodes(), log_message(), LOG_WARN, and print_usage().

cli_peer_discovery()

int cli_peer_discovery

(

char **

args

)

Discovers Bitcoin peers.

Parameters

args	The arguments passed to the function should match those specified in 'help peerdiscovery'.

Returns

The exit code.

Definition at line 528 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
 
    // defaults
    bool daemon = PEER_DISCOVERY_DEFAULT_DAEMON;
    bool hardcoded_seeds = PEER_DISCOVERY_DEFAULT_HARDCODED_SEEDS;
    bool dns_lookup = PEER_DISCOVERY_DEFAULT_DNS_LOOKUP;
 
    bool daemon_set = false;
    bool hardcoded_seeds_set = false;
    bool dns_lookup_set = false;
 
    // before checking program state, ensure command is only used with valid arguments to avoid confusion
    if (args[0] != NULL)
    {
        for (int i = 0; args[i] != NULL; ++i)
        {
            if (strcmp(args[i], "-d") == 0 || strcmp(args[i], "--daemon") == 0)
            {
                if (daemon_set)
                {
                    log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                        "Daemon flag already set for peerdiscovery command");
                    print_usage("peerdiscovery");
                    pthread_mutex_unlock(&cli_mutex);
                    return 1;
                }
                daemon = true;
                daemon_set = true;
            }
            else if (strcmp(args[i], "-h") == 0 || strcmp(args[i], "--hardcoded") == 0)
            {
                if (hardcoded_seeds_set || dns_lookup_set)
                {
                    log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                        "Hardcoded seeds or DNS lookup flag already set for peerdiscovery command");
                    print_usage("peerdiscovery");
                    pthread_mutex_unlock(&cli_mutex);
                    return 1;
                }
                hardcoded_seeds = true;
                dns_lookup = false;
 
                hardcoded_seeds_set = true;
            }
            else if (strcmp(args[i], "-l") == 0 || strcmp(args[i], "--dns-lookup") == 0)
            {
                if (dns_lookup_set || hardcoded_seeds_set)
                {
                    log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                        "DNS lookup or hardcoded seeds flag already set for peerdiscovery command");
                    print_usage("peerdiscovery");
                    pthread_mutex_unlock(&cli_mutex);
                    return 1;
                }
 
                if (args[i + 1] == NULL)
                    log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                        "Missing domain argument for DNS lookup flag for peerdiscovery command, default will be used");
                if (args[i + 2] != NULL)
                {
                    log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                        "Too many arguments for DNS lookup flag for peerdiscovery command");
                    print_usage("peerdiscovery");
                    pthread_mutex_unlock(&cli_mutex);
                    return 1;
                }
 
                dns_lookup = true;
                hardcoded_seeds = false;
 
                dns_lookup_set = true;
            }
            else
            {
                if (dns_lookup_set)
                {
                    if (set_peer_discovery_dns_domain(args[i]))
                        log_message(LOG_INFO, BITLAB_LOG, __FILE__,
                            "Set DNS domain for peerdiscovery command: %s",
                            args[i]);
                    else
                    {
                        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                            "Failed to set DNS domain for peerdiscovery command");
                        pthread_mutex_unlock(&cli_mutex);
                        return 1;
                    }
                }
                else
                {
                    log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                        "Unknown argument for peerdiscovery command: %s",
                        args[i]);
                    print_usage("peerdiscovery");
                    pthread_mutex_unlock(&cli_mutex);
                    return 1;
                }
            }
        }
    }
 
    // process current state and provided arguments if state allows
    if (get_peer_discovery_in_progress())
    {
        if (daemon)
        {
            log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                "Peer discovery already in progress");
            guarded_print_line(
                "Peer discovery already in progress. Use \"peerdiscovery\" to check results later or \"info\" to see the status. Any additional arguments will be ignored until the results are cleared.");
            pthread_mutex_unlock(&cli_mutex);
            return 1;
        }
        else // wait for peer discovery to finish
        {
            guarded_print_line(
                "Connected to peer discovery daemon. Arguments ignored if provided. Waiting for results...");
            while (get_peer_discovery_in_progress())
                usleep(100000); // 100 ms
            usleep(1000000); // 1s
        }
    }
    else
    {
        // check if previous peer discovery attempt failed
        bool results_successful = get_peer_discovery_succeeded();
        if (get_peer_discovery() && !results_successful)
            log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                "Peer discovery previous attempt failed. Allowing new attempt...");
 
        if (!results_successful) // results does not exist or failed and are not cleared
        {
            // [ ] Add clearing results
            // set states
            set_peer_discovery(true);
            set_peer_discovery_daemon(daemon);
            set_peer_discovery_hardcoded_seeds(hardcoded_seeds);
            set_peer_discovery_dns_lookup(dns_lookup);
 
            if (daemon)
            {
                log_message(LOG_INFO, BITLAB_LOG, __FILE__,
                    "Peer discovery in background");
                guarded_print_line(
                    "Peer discovery started as daemon. Use \"peerdiscovery\" to check results or \"info\" to see the status.");
                pthread_mutex_unlock(&cli_mutex);
                return 0;
            }
            else // wait for peer discovery to finish
            {
                guarded_print_line("Peer discovery started. Waiting for results...");
                while (get_peer_discovery_in_progress())
                    usleep(100000); // 100 ms
                usleep(1000000); // 1s
            }
        }
    }
 
    print_peer_queue();
 
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, get_peer_discovery(), get_peer_discovery_in_progress(), get_peer_discovery_succeeded(), guarded_print_line(), LOG_INFO, log_message(), LOG_WARN, PEER_DISCOVERY_DEFAULT_DAEMON, PEER_DISCOVERY_DEFAULT_DNS_LOOKUP, PEER_DISCOVERY_DEFAULT_HARDCODED_SEEDS, print_peer_queue(), print_usage(), set_peer_discovery(), set_peer_discovery_daemon(), set_peer_discovery_dns_domain(), set_peer_discovery_dns_lookup(), set_peer_discovery_hardcoded_seeds(), and usleep().

cli_ping()

int cli_ping

(

char **

args

)

Pings the specified IP address.

Parameters

args	The IP address.

Returns

The exit code.

Definition at line 694 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    int count = 4;
    int sleep_time = 1;
    char ip_address[BUFFER_SIZE] = { 0 };
 
    int i = 0;
    while (args[i] != NULL)
    {
        if (strcmp(args[i], "-c") == 0 || strcmp(args[i], "--count") == 0)
        {
            if (args[i + 1] == NULL)
            {
                log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                    "Missing count value for ping command.");
                print_usage("ping");
                pthread_mutex_unlock(&cli_mutex);
                return 1;
            }
 
            count = strtol(args[i + 1], NULL, 10);
            if (count <= 0)
            {
                log_message(LOG_WARN, BITLAB_LOG, __FILE__, "Invalid count value: %s",
                    args[i + 1]);
                print_usage("ping");
                pthread_mutex_unlock(&cli_mutex);
                return 1;
            }
            i += 2;
        }
        else if (ip_address[0] == '\0')
        {
            if (strlen(args[i]) >= BUFFER_SIZE)
            {
                log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                    "Invalid IP address for ping command.");
                print_usage("ping");
                pthread_mutex_unlock(&cli_mutex);
                return 1;
            }
            strncpy(ip_address, args[i], BUFFER_SIZE - 1);
            i++;
        }
        else
        {
            log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                "Too many arguments for ping command: %s", args[i]);
            print_usage("ping");
            pthread_mutex_unlock(&cli_mutex);
            return 1;
        }
    }
 
    if (ip_address[0] == '\0')
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Missing IP address for ping command.");
        print_usage("ping");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    guarded_print_line("Pinging %s with count %d", ip_address, count);
    char command[BUFFER_SIZE];
    snprintf(command, sizeof(command), "ping -c %d -i %d %s", count, sleep_time,
        ip_address);
    system(command);
 
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, BUFFER_SIZE, cli_mutex, guarded_print_line(), log_message(), LOG_WARN, and print_usage().

cli_read_line()

char * cli_read_line

(

void

)

Reads input from user.

WARNING: char* returned from this function must be freed.

Returns

The string containing input from user.

Definition at line 1153 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    char* line = readline(CLI_PREFIX);
    if (line && *line)
        add_history(line);
    pthread_mutex_unlock(&cli_mutex);
    return line;
}

References cli_mutex, and CLI_PREFIX.

Referenced by handle_cli().

cli_tx()

int cli_tx

(

char **

args

)

Sends a 'tx' message to specified peer.

Parameters

args	The index of the peer.

Returns

The exit code.

Definition at line 1036 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    if (args[0] == NULL || args[1] == NULL)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "No arguments provided for tx command");
        print_usage("tx");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    int idx = atoi(args[0]);
    if (idx < 0 || idx >= MAX_NODES)
    {
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Invalid node index for tx command");
        print_usage("tx");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    // Parse the transaction data from the arguments
    size_t tx_size = strlen(args[1]) / 2;
    unsigned char* tx_data = malloc(tx_size);
    if (tx_data == NULL)
    {
        log_message(LOG_ERROR, BITLAB_LOG, __FILE__,
            "Failed to allocate memory for transaction data");
        pthread_mutex_unlock(&cli_mutex);
        return 1;
    }
 
    for (size_t i = 0; i < tx_size; i++)
    {
        sscanf(&args[1][i * 2], "%2hhx", &tx_data[i]);
    }
 
    guarded_print_line("Sending transaction to %d with size %zu", idx, tx_size);
    send_tx(idx, tx_data, tx_size);
 
    free(tx_data);
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, cli_mutex, guarded_print_line(), LOG_ERROR, log_message(), LOG_WARN, MAX_NODES, print_usage(), and send_tx().

cli_whoami()

int cli_whoami

(

char **

args

)

Prints the user name.

Parameters

args	The arguments passed to the function should be empty.

Returns

The exit code.

Definition at line 385 of file cli.c.

{
    pthread_mutex_lock(&cli_mutex);
    bool full_information = false;
    if (args[0] != NULL)
    {
        if (strcmp(args[0], "-f") == 0 || strcmp(args[0], "--full") == 0)
        {
            if (args[1] != NULL)
            {
                log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                    "Unknown argument for whoami command: \"%s\"", args[1]);
                print_usage("whoami");
                pthread_mutex_unlock(&cli_mutex);
                return 1;
            }
            full_information = true;
        }
        else
        {
            log_message(LOG_WARN, BITLAB_LOG, __FILE__,
                "Unknown argument for whoami command: \"%s\"", args[0]);
            print_usage("whoami");
            pthread_mutex_unlock(&cli_mutex);
            return 1;
        }
    }
 
    if (!full_information)
        guarded_print_line("%s", getenv("USER"));
    else
    {
        char ip_address[BUFFER_SIZE];
        get_local_ip_address(ip_address);
 
        if (getenv("USER") == NULL)
            guarded_print_line("Unknown user");
        else if (strcmp(getenv("USER"), "root") == 0)
            guarded_print_line("You are \033[1;31m%s\033[0m", getenv("USER"));
        else
            guarded_print_line("You are \033[1;34m%s\033[0m", getenv("USER"));
 
        guarded_print_line("Local IP address: %s", ip_address);
 
        get_remote_ip_address(ip_address);
        guarded_print_line("Public IP address: %s", ip_address);
    }
 
    pthread_mutex_unlock(&cli_mutex);
    return 0;
}

References BITLAB_LOG, BUFFER_SIZE, cli_mutex, get_local_ip_address(), get_remote_ip_address(), guarded_print_line(), log_message(), LOG_WARN, and print_usage().

create_history_dir()

const char * create_history_dir

(

)

Create history directory.

Returns

The history directory.

Definition at line 1328 of file cli.c.

{
    const char* home = getenv("HOME");
    if (home == NULL)
        return NULL;
    const char* suffix = "/.bitlab/history";
    char* logs_dir = malloc(strlen(home) + strlen(suffix) + 1);
    if (logs_dir == NULL)
        return NULL;
    strcpy(logs_dir, home);
    strcat(logs_dir, suffix);
    return logs_dir;
}

References logs_dir.

Referenced by handle_cli().

handle_cli()

void * handle_cli

(

void *

arg

)

CLI handler thread.

Parameters

arg	Not used. Write dummy code for no warning.

Definition at line 1278 of file cli.c.

{
    char* line = NULL;
    cli_history_dir = create_history_dir();
    struct stat st = { 0 };
 
    if (stat(cli_history_dir, &st) == -1 && mkdir(cli_history_dir, 0700) != 0)
        log_message(LOG_WARN, BITLAB_LOG, __FILE__,
            "Failed to create history directory");
 
    char full_path[BUFFER_SIZE];
    snprintf(full_path, sizeof(full_path), "%s/%s", cli_history_dir, CLI_HISTORY_FILE);
    read_history(full_path);
    usleep(50000); // 50 ms
 
    rl_basic_word_break_characters = " \t\n\"\\'`@$><=;|&{(";
    rl_completer_word_break_characters = " \t\n\"\\'`@$><=;|&{(";
    rl_completer_quote_characters = "\"\\'`";
    rl_completion_append_character = '\0';
    rl_attempted_completion_over = 1;
    rl_attempted_completion_function = cli_completion;
    rl_getc_function = getc;
    rl_catch_signals = 0;
 
    while (!get_exit_flag())
    {
        line = cli_read_line();
        if (line && *line)
        {
            cli_exec_line(line);
            write_history(full_path);
        }
        if (line)
        {
            free(line);
            line = NULL;
        }
    }
    if (arg)
    {
    } // dummy code to avoid unused parameter warning
    if (cli_history_dir != NULL)
    {
        free((void*)cli_history_dir);
        cli_history_dir = NULL;
    }
    log_message(LOG_INFO, BITLAB_LOG, __FILE__, "Exiting CLI thread");
    pthread_exit(NULL);
}

References BITLAB_LOG, BUFFER_SIZE, cli_completion(), cli_exec_line(), cli_history_dir, CLI_HISTORY_FILE, cli_read_line(), create_history_dir(), get_exit_flag(), LOG_INFO, log_message(), LOG_WARN, and usleep().

Referenced by run_bitlab().

print_commands()

void print_commands

(

)

Prints CLI commands.

Definition at line 275 of file cli.c.

{
    for (int i = 0; i < CLI_COMMANDS_NUM; ++i)
        guarded_print_line("%s", cli_commands[i].cli_command_name);
}

References cli_commands, CLI_COMMANDS_NUM, and guarded_print_line().

print_help()

void print_help

(

)

Prints CLI command help.

Definition at line 171 of file cli.c.

{
    int longest_command_length = 0;
    int longest_parameters_length = 0;
    for (int i = 0; i < CLI_COMMANDS_NUM; ++i)
    {
        int cmd_length = 0;
        int param_length = 0;
 
        char* space_pos = strchr(cli_commands[i].cli_command_usage, ' ');
        if (space_pos)
        {
            cmd_length = space_pos - cli_commands[i].cli_command_usage;
            // only command length
            param_length = strlen(space_pos + 1); // parameters length
        }
        else
        {
            cmd_length = strlen(cli_commands[i].cli_command_usage);
        }
 
        if (cmd_length > longest_command_length)
            longest_command_length = cmd_length;
        if (param_length > longest_parameters_length)
            longest_parameters_length = param_length;
    }
 
    int longest_description_length = 0;
    for (int i = 0; i < CLI_COMMANDS_NUM; ++i)
    {
        int length = strlen(cli_commands[i].cli_command_brief_desc);
        if (length > longest_description_length)
            longest_description_length = length;
    }
 
    char* dashes_command = (char*)malloc(longest_command_length + 1);
    memset(dashes_command, '-', longest_command_length);
    dashes_command[longest_command_length] = '\0';
 
    char* dashes_params = (char*)malloc(longest_parameters_length + 1);
    memset(dashes_params, '-', longest_parameters_length);
    dashes_params[longest_parameters_length] = '\0';
 
    char* dashes_description = (char*)malloc(longest_description_length + 1);
    memset(dashes_description, '-', longest_description_length);
    dashes_description[longest_description_length] = '\0';
 
    guarded_print_line("\033[1m%-*s | %-*s | %s\033[0m",
        longest_command_length, "Command",
        longest_parameters_length, "Parameters",
        "Description");
    guarded_print_line("%s-+-%s-+-%s",
        dashes_command, dashes_params, dashes_description);
 
    for (int i = 0; i < CLI_COMMANDS_NUM; ++i)
    {
        const char* usage = cli_commands[i].cli_command_usage;
        const char* description = cli_commands[i].cli_command_brief_desc;
 
        // split the command and its parameters
        char command[longest_command_length + 1];
        char parameters[longest_parameters_length + 1];
        char* params = strchr(usage, ' ');
 
        if (params)
        {
            int cmd_length = params - usage;
            strncpy(command, usage, cmd_length);
            command[cmd_length] = '\0';
            strncpy(parameters, params + 1, longest_parameters_length);
            parameters[longest_parameters_length] = '\0';
        }
        else
        {
            strncpy(command, usage, longest_command_length);
            command[longest_command_length] = '\0';
            parameters[0] = '\0';
        }
 
        // print the row
        guarded_print_line("%-*s | %-*s | %s",
            longest_command_length, command,
            longest_parameters_length, parameters,
            description);
    }
 
    free(dashes_command);
    free(dashes_params);
    free(dashes_description);
}

References cli_command::cli_command_brief_desc, cli_command::cli_command_usage, cli_commands, CLI_COMMANDS_NUM, and guarded_print_line().

Referenced by cli_completion(), and cli_help().

print_usage()

void print_usage

(

const char *

command_name

)

Prints CLI command usage.

Parameters

command_name

The name of the command.

Definition at line 262 of file cli.c.

{
    for (int i = 0; i < CLI_COMMANDS_NUM; ++i)
    {
        if (strcmp(command_name, cli_commands[i].cli_command_name) == 0)
        {
            guarded_print_line("Usage: %s", cli_commands[i].cli_command_usage);
            return;
        }
    }
    guarded_print_line("Unknown command: %s", command_name);
}

References cli_commands, CLI_COMMANDS_NUM, and guarded_print_line().

Referenced by cli_clear(), cli_connect(), cli_disconnect(), cli_echo(), cli_exit(), cli_getaddr(), cli_getblocks(), cli_getdata(), cli_getheaders(), cli_help(), cli_history(), cli_info(), cli_inv(), cli_list(), cli_peer_discovery(), cli_ping(), cli_tx(), and cli_whoami().