Merge pull request #3 from milosz275/install

BitLab installation/uninstallation

Author: milosz275

.vscode/settings.json

@@ -6,7 +6,8 @@
         "codespaces",
         "Doxyfile",
         "Doxygen",
-        "lineptr"
+        "lineptr",
+        "Uninstallation"
     ],
     "task.allowAutomaticTasks": "on",
     "editor.formatOnSave": true,

README.md

@@ -1,4 +1,4 @@
-# BitLab
+# BitLab: A Bitcoin P2P Network and Blockchain Explorer
 
 [![Make](https://github.com/milosz275/bitlab/actions/workflows/makefile.yml/badge.svg)](https://github.com/milosz275/bitlab/actions/workflows/makefile.yml)
 [![CodeQL](https://github.com/milosz275/bitlab/actions/workflows/codeql.yml/badge.svg)](https://github.com/milosz275/bitlab/actions/workflows/codeql.yml)
@@ -14,9 +14,52 @@ BitLab acts as a powerful educational resource and debugging tool for understand
 - [GitHub Repo](https://github.com/milosz275/bitlab)
 - [Doxygen Docs](https://milosz275.github.io/bitlab)
 
+> [!NOTE]
+> This project is a work in progress.
+
 ## Table of Contents
 
-## Getting Started
+- [Features](#features)
+- [Installation](#installation)
+- [Uninstallation](#uninstallation)
+- [Usage](#usage)
+- [Config directory](#config-directory)
+- [Acknowledgements](#acknowledgements)
+- [License](#license)
+
+## Features
+
+## Installation
+
+> [!NOTE]
+> Default installation directory is `/usr/local/bin`
+
+To install [BitLab](https://github.com/milosz275/bitlab), simply run the following command in your terminal:
+
+```bash
+curl -s https://raw.githubusercontent.com/milosz275/bitlab/main/install.sh | sudo bash
+```
+
+## Uninstallation
+
+To uninstall [BitLab](https://github.com/milosz275/bitlab), simply run the following command in your terminal:
+
+```bash
+curl -s https://raw.githubusercontent.com/milosz275/bitlab/main/uninstall.sh | sudo bash -s -- -y
+```
+
+## Usage
+
+## Config directory
+
+The default configuration directory is `~/.bitlab`. The configuration directory contains the following files:
+
+- `logs/bitlab.log`: BitLab main log file
+- `history/cli_history.txt`: BitLab CLI command history file
+<!-- - `bitlab.conf`: BitLab configuration file
+- `peers.dat`: Peer list file
+- `blocks.dat`: Block list file
+- `txs.dat`: Transaction list file -->
 
 ## Acknowledgements
 

assets/logo.png

@@ -8,7 +8,7 @@
 #define CLI_BUFSIZE 64
 #define CLI_DELIM " "
 #define CLI_COMMANDS_NUM (int) (sizeof(cli_commands) / sizeof(cli_command))
-#define CLI_HISTORY_FILE ".bitlab_history.txt"
+#define CLI_HISTORY_FILE "cli_history.txt"
 
 /**
  * CLI command structure.
@@ -90,4 +90,11 @@ int cli_exec_line(char* line);
  */
 void* handle_cli(void* arg);
 
+/**
+ * Create history directory.
+ *
+ * @return The history directory.
+ */
+const char* create_history_dir();
+
 #endif // __CLI_H

bitlab/include/cli.h

@@ -2,12 +2,12 @@
 #define __LOG_H
 
 #include <stdio.h>
+#include <stdlib.h>
 #include <stdarg.h>
 #include <pthread.h>
 
 #define MAX_LOG_FILES 10
 #define MAX_FILENAME_LENGTH 256
-#define LOGS_DIR "logs"
 #define BITLAB_LOG "bitlab.log"
 #define LOG_BITLAB_STARTED "BitLab started ----------------------------------------------------------------------------------------"
 #define LOG_BITLAB_FINISHED "BitLab finished successfully"
@@ -59,6 +59,13 @@ typedef struct loggers
     int is_initializing;
 } loggers;
 
+/**
+ * Create logs directory used to create the logs directory if it does not exist.
+ *
+ * @return The logs directory.
+ */
+const char* create_logs_dir();
+
 /**
  * Initialize logging used to initialize the logging system, open and preserve the log file.
  *

bitlab/include/log.h

@@ -29,4 +29,9 @@ void get_formatted_timestamp(char* buffer, size_t buffer_size);
  */
 void clear_cli();
 
+/**
+ * Initialize the configuration directory.
+ */
+int init_config_dir();
+
 #endif // __UTILS_H

bitlab/include/utils.h

@@ -16,6 +16,7 @@ bitlab_result run_bitlab(int argc, char* argv[])
     if (argc != 1 && argv != NULL) {}
 
     // init
+    init_config_dir();
     init_logging(BITLAB_LOG);
     log_message(LOG_INFO, BITLAB_LOG, __FILE__, LOG_BITLAB_STARTED);
     init_program_state(&state);

bitlab/src/bitlab.c

@@ -3,11 +3,14 @@
 #include <readline/readline.h>
 #include <readline/history.h>
 #include <errno.h>
+#include <sys/stat.h>
 
 #include "state.h"
 #include "log.h"
 #include "utils.h"
 
+static const char* cli_history_dir = NULL;
+
 // BitLab command array
 static cli_command cli_commands[] =
 {
@@ -175,15 +178,23 @@ int cli_exec_line(char* line)
 void* handle_cli(void* arg)
 {
     char* line = NULL;
-    read_history(CLI_HISTORY_FILE);
+    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[256];
+    snprintf(full_path, sizeof(full_path), "%s/%s", cli_history_dir, CLI_HISTORY_FILE);
+    read_history(full_path);
     usleep(50000); // 50 ms
     while (!get_exit_flag(&state))
     {
         line = cli_read_line();
         if (line && *line)
         {
             cli_exec_line(line);
-            write_history(CLI_HISTORY_FILE);
+            write_history(full_path);
         }
         if (line)
         {
@@ -192,6 +203,25 @@ void* handle_cli(void* arg)
         }
     }
     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);
 }
+
+const char* create_history_dir()
+{
+    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;
+}

bitlab/src/cli.c

@@ -17,15 +17,31 @@ static struct loggers logs = { PTHREAD_MUTEX_INITIALIZER, {NULL}, 0 };
 int fileno(FILE* __stream);
 void usleep(unsigned int usec);
 
+static const char* logs_dir = NULL;
+
+const char* create_logs_dir()
+{
+    const char* home = getenv("HOME");
+    if (home == NULL)
+        return NULL;
+    const char* suffix = "/.bitlab/logs";
+    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;
+}
+
 void init_logging(const char* filename)
 {
     logs.is_initializing = 1;
-    const char* log_dir = LOGS_DIR;
+    logs_dir = create_logs_dir();
     struct stat st = { 0 };
 
-    if (stat(log_dir, &st) == -1)
+    if (stat(logs_dir, &st) == -1)
     {
-        if (mkdir(log_dir, 0700) != 0)
+        if (mkdir(logs_dir, 0700) != 0)
         {
             perror("Failed to create logs directory");
             logs.is_initializing = 0;
@@ -34,7 +50,7 @@ void init_logging(const char* filename)
     }
 
     char full_path[256];
-    snprintf(full_path, sizeof(full_path), "%s/%s", log_dir, filename);
+    snprintf(full_path, sizeof(full_path), "%s/%s", logs_dir, filename);
 
     pthread_mutex_lock(&logs.log_mutex);
     for (int i = 0; i < MAX_LOG_FILES; ++i)
@@ -68,10 +84,8 @@ void init_logging(const char* filename)
 
 void log_message(log_level level, const char* filename, const char* source_file, const char* format, ...)
 {
-    const char* log_dir = LOGS_DIR;
-
     char full_path[256];
-    snprintf(full_path, sizeof(full_path), "%s/%s", log_dir, filename);
+    snprintf(full_path, sizeof(full_path), "%s/%s", logs_dir, filename);
 
     pthread_mutex_lock(&logs.log_mutex);
 
@@ -160,4 +174,9 @@ void finish_logging()
         }
     }
     pthread_mutex_unlock(&logs.log_mutex);
+    if (logs_dir != NULL)
+    {
+        free((void*)logs_dir);
+        logs_dir = NULL;
+    }
 }

bitlab/src/log.c

@@ -1,6 +1,10 @@
 #include "utils.h"
 
+#include <stdlib.h>
 #include <time.h>
+#include <string.h>
+#include <sys/file.h>
+#include <sys/stat.h>
 
 struct tm* localtime_r(const time_t* timer, struct tm* buf);
 
@@ -24,3 +28,20 @@ void clear_cli()
 {
     printf("\033[H\033[J");
 }
+
+int init_config_dir()
+{
+    const char* home = getenv("HOME");
+    if (home == NULL)
+        return 1;
+    const char* suffix = "/.bitlab";
+    char* init_dir = malloc(strlen(home) + strlen(suffix) + 1);
+    if (init_dir == NULL)
+        return 1;
+    strcpy(init_dir, home);
+    strcat(init_dir, suffix);
+
+    mkdir(init_dir, 0700);
+    free(init_dir);
+    return 0;
+}