Merge pull request #26 from SimonCahill/feat/update-version-to-1.2.3

Updated version to v1.2.3

Author: SimonCahill

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.10)
 
-project(endlessh-report VERSION 1.2.2 LANGUAGES CXX DESCRIPTION "A simple report generator for endlessh tarpits.")
+project(endlessh-report VERSION 1.2.3 LANGUAGES CXX DESCRIPTION "A simple report generator for endlessh tarpits.")
 set(PROJECT_LONG_NAME "Endlessh Report Generator")
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
@@ -18,7 +18,7 @@ include_directories(
     ${CMAKE_CURRENT_BINARY_DIR}/include
 )
 
-if (DEFINED endlesshreport_DEBUG)
+if (DEFINED endlesshreport_DEBUG OR CMAKE_BUILD_TYPE STREQUAL "Debug")
     add_compile_options(
         -O0
         -ggdb
@@ -30,6 +30,15 @@ else()
     )
 endif()
 
+###
+# Make sure submodules are updated
+###
+message("Ensuring repository has all submodules...")
+execute_process(
+    COMMAND git submodule update --init --recursive
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
 add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/submodules/date)
 add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/submodules/fmt)
 

README.md

@@ -55,7 +55,7 @@ endlessh-report
 ## Arguments
 
 ```
-endlessh-report v1.2.1 - A simple report generator for endlessh tarpits.
+endlessh-report v1.2.3 - A simple report generator for endlessh tarpits.
 
 Usage:
     endlessh-report
@@ -74,7 +74,7 @@ Switches:
     --version,      -v      Display version information and exit
 
 Arguments:
-    --syslog [f],   -S[f]      Override syslog/endlessh log location
+    --syslog [f],   -S[f]   Override syslog/endlessh log location
 ```
 
 ## Output
@@ -245,14 +245,14 @@ Resulting in:
 ## Detailed AbuseIPDB CSV format
 ```csv
 IP,Categories,ReportDate,Comment
-218.92.0.208,"18,14,22,15",2022-10-15T22:43:11Z,"218.92.0.208 fell into Endlessh tarpit; 50/2276 total connections are currently still open. Total time wasted: 64d 15h 33m 56s. Total bytes sent by tarpit: 685.00MiB. Report generated by Endlessh Report Generator v1.2.1"
-179.60.147.99,"18,14,22,15",2022-10-15T22:43:11Z,"179.60.147.99 fell into Endlessh tarpit; 0/534 total connections are currently still open. Total time wasted: 2h 52m 10s. Total bytes sent by tarpit: 1.00MiB. Report generated by Endlessh Report Generator v1.2.1"
-61.177.173.49,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.173.49 fell into Endlessh tarpit; 0/62 total connections are currently still open. Total time wasted: 1d 12h 1m 18s. Total bytes sent by tarpit: 15.00MiB. Report generated by Endlessh Report Generator v1.2.1"
-218.92.0.221,"18,14,22,15",2022-10-15T22:43:11Z,"218.92.0.221 fell into Endlessh tarpit; 0/33 total connections are currently still open. Total time wasted: 8h 39m 45s. Total bytes sent by tarpit: 3.00MiB. Report generated by Endlessh Report Generator v1.2.1"
-61.177.172.98,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.172.98 fell into Endlessh tarpit; 0/48 total connections are currently still open. Total time wasted: 19h 38m 37s. Total bytes sent by tarpit: 8.00MiB. Report generated by Endlessh Report Generator v1.2.1"
-61.177.173.47,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.173.47 fell into Endlessh tarpit; 0/56 total connections are currently still open. Total time wasted: 1d 16h 44m 50s. Total bytes sent by tarpit: 17.00MiB. Report generated by Endlessh Report Generator v1.2.1"
-210.97.53.178,"18,14,22,15",2022-10-15T22:43:11Z,"210.97.53.178 fell into Endlessh tarpit; 0/2 total connections are currently still open. Total time wasted: 6s. Total bytes sent by tarpit: 333B. Report generated by Endlessh Report Generator v1.2.1"
-61.177.173.48,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.173.48 fell into Endlessh tarpit; 0/31 total connections are currently still open. Total time wasted: 55m 10s. Total bytes sent by tarpit: 298.00KiB. Report generated by Endlessh Report Generator v1.2.1"
-61.177.173.53,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.173.53 fell into Endlessh tarpit; 0/72 total connections are currently still open. Total time wasted: 2d 6h 20m 48s. Total bytes sent by tarpit: 24.00MiB. Report generated by Endlessh Report Generator v1.2.1"
-45.141.84.126,"18,14,22,15",2022-10-15T22:43:11Z,"45.141.84.126 fell into Endlessh tarpit; 2/13 total connections are currently still open. Total time wasted: 10d 4h 5m 29s. Total bytes sent by tarpit: 107.00MiB. Report generated by Endlessh Report Generator v1.2.1"
+218.92.0.208,"18,14,22,15",2022-10-15T22:43:11Z,"218.92.0.208 fell into Endlessh tarpit; 50/2276 total connections are currently still open. Total time wasted: 64d 15h 33m 56s. Total bytes sent by tarpit: 685.00MiB. Report generated by Endlessh Report Generator v1.2.3"
+179.60.147.99,"18,14,22,15",2022-10-15T22:43:11Z,"179.60.147.99 fell into Endlessh tarpit; 0/534 total connections are currently still open. Total time wasted: 2h 52m 10s. Total bytes sent by tarpit: 1.00MiB. Report generated by Endlessh Report Generator v1.2.3"
+61.177.173.49,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.173.49 fell into Endlessh tarpit; 0/62 total connections are currently still open. Total time wasted: 1d 12h 1m 18s. Total bytes sent by tarpit: 15.00MiB. Report generated by Endlessh Report Generator v1.2.3"
+218.92.0.221,"18,14,22,15",2022-10-15T22:43:11Z,"218.92.0.221 fell into Endlessh tarpit; 0/33 total connections are currently still open. Total time wasted: 8h 39m 45s. Total bytes sent by tarpit: 3.00MiB. Report generated by Endlessh Report Generator v1.2.3"
+61.177.172.98,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.172.98 fell into Endlessh tarpit; 0/48 total connections are currently still open. Total time wasted: 19h 38m 37s. Total bytes sent by tarpit: 8.00MiB. Report generated by Endlessh Report Generator v1.2.3"
+61.177.173.47,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.173.47 fell into Endlessh tarpit; 0/56 total connections are currently still open. Total time wasted: 1d 16h 44m 50s. Total bytes sent by tarpit: 17.00MiB. Report generated by Endlessh Report Generator v1.2.3"
+210.97.53.178,"18,14,22,15",2022-10-15T22:43:11Z,"210.97.53.178 fell into Endlessh tarpit; 0/2 total connections are currently still open. Total time wasted: 6s. Total bytes sent by tarpit: 333B. Report generated by Endlessh Report Generator v1.2.3"
+61.177.173.48,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.173.48 fell into Endlessh tarpit; 0/31 total connections are currently still open. Total time wasted: 55m 10s. Total bytes sent by tarpit: 298.00KiB. Report generated by Endlessh Report Generator v1.2.3"
+61.177.173.53,"18,14,22,15",2022-10-15T22:43:11Z,"61.177.173.53 fell into Endlessh tarpit; 0/72 total connections are currently still open. Total time wasted: 2d 6h 20m 48s. Total bytes sent by tarpit: 24.00MiB. Report generated by Endlessh Report Generator v1.2.3"
+45.141.84.126,"18,14,22,15",2022-10-15T22:43:11Z,"45.141.84.126 fell into Endlessh tarpit; 2/13 total connections are currently still open. Total time wasted: 10d 4h 5m 29s. Total bytes sent by tarpit: 107.00MiB. Report generated by Endlessh Report Generator v1.2.3"
 ```

include/extensions.hpp

@@ -5,7 +5,7 @@
  * @version 0.1
  * @date 2022-10-15
  * 
- * @copyright Copyright (c) 2022 Simon Cahill
+ * @copyright Copyright (c) 2023 Simon Cahill
  */
 
 #ifndef ENDLESSH_REPORT_INCLUDE_EXTENSIONS_HPP

include/options.hpp

@@ -5,7 +5,7 @@
  * @version 0.1
  * @date 2022-10-15
  * 
- * @copyright Copyright (c) 2022 Simon Cahill
+ * @copyright Copyright (c) 2023 Simon Cahill
  */
 
 #ifndef ENDLESSH_REPORT_INCLUDE_OPTIONS_HPP
@@ -25,8 +25,18 @@
 using std::string;
 using std::string_view;
 
+/**
+ * @brief Gets the string containing the application's short arg string.
+ * 
+ * @return constexpr string_view The arg string as required for @see getopt_long
+ */
 constexpr string_view   getAppArgs() { return R"(icsandhvS:)"; }
 
+/**
+ * @brief Gets the application's command-line options for @see getopt_long.
+ * 
+ * @return const option* A const pointer to the array containing the options.
+ */
 const option*           getAppOptions() {
     const static option OPTIONS[] = {
         { "no-ip-stats",    no_argument,        nullptr,    'i' },
@@ -43,6 +53,13 @@ const option*           getAppOptions() {
     return OPTIONS;
 }
 
+/**
+ * @brief Gets the application's help text.
+ * 
+ * @param binName The name of the binary.
+ * 
+ * @return string The actual help text.
+ */
 inline string           getAppHelpText(const string_view& binName = getProjectName()) {
     const static string HELP_TEXT_FMT = R"(
 {0:s} v{1:s} - {2:s}
@@ -64,12 +81,17 @@ inline string           getAppHelpText(const string_view& binName = getProjectNa
     --version,      -v      Display version information and exit
 
 Arguments:
-    --syslog [f],   -S[f]      Override syslog/endlessh log location
+    --syslog [f],   -S[f]   Override syslog/endlessh log location
 )";
 
     return fmt::format(HELP_TEXT_FMT, binName, getApplicationVersion(), getProjectDescription());
 }
 
+/**
+ * @brief Gets the application's version information.
+ * 
+ * @return string The string containing the version information.
+ */
 inline string           getAppVersionText() { return fmt::format(R"({0:s} v{1:s} - {2:s})", getProjectName(), getApplicationVersion(), getProjectDescription()); }
 
 #endif // ENDLESSH_REPORT_INCLUDE_OPTIONS_HPP

include/version.hpp.in

@@ -5,7 +5,7 @@
  * @version 0.1
  * @date 2022-10-15
  * 
- * @copyright Copyright (c) 2022 Simon Cahill and Contributors
+ * @copyright Copyright (c) 2023 Simon Cahill and Contributors
  */
 
 #ifndef ENDLESSH_REPORT_INCLUDE_VERSION_HPP

src/main.cpp

@@ -5,7 +5,7 @@
  * @version 0.1
  * @date 2022-01-07
  * 
- * @copyright Copyright (c) 2022 Simon Cahill
+ * @copyright Copyright (c) 2023 Simon Cahill
  */
 
 ////////////////////////////////