remove protobuf protocol

Author: saschatommasone

plugins/helix/CMakeLists.txt

@@ -3,38 +3,20 @@ option(PL_HELIX "Build the Helix plugin" ON)
 if(PL_HELIX OR BUILD_ALL_PLUGINS)
 
     # Dependencies
-    find_package(absl REQUIRED)
-    find_package(hiredis REQUIRED)
-    find_package(Libevent REQUIRED)
-    find_package(Protobuf CONFIG REQUIRED)   
+    add_subdirectory(deps)
     find_package(Qt5 REQUIRED COMPONENTS Core Widgets)
 
     # Include-What-You-Use (optional)
     if(IWYU)
         set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE "include-what-you-use")
+        message(STATUS "include-what-you-use turned ON")
     else()
         message(STATUS "include-what-you-use turned OFF")
     endif()
 
-    # --- Protocol buffer library ---
-    set(PROTO_SRC_DIR "${CMAKE_CURRENT_LIST_DIR}")
-    set(PROTO_OUT_DIR "${PROTO_SRC_DIR}/protobuf/protocol")
-    file(MAKE_DIRECTORY "${PROTO_OUT_DIR}")
-
-    # Define protocol library
-    add_library(protocol SHARED "${PROTO_SRC_DIR}/helix.proto")
-    target_include_directories(protocol PUBLIC "${PROTO_OUT_DIR}")
-    target_link_libraries(protocol PUBLIC protobuf::libprotobuf)
-
-    protobuf_generate(
-        TARGET protocol
-        IMPORT_DIRS "${Protobuf_INCLUDE_DIRS}"
-        PROTOC_OUT_DIR "${PROTO_OUT_DIR}"
-    )
-
     # --- Source Collection ---
-    file(GLOB_RECURSE HELIX_INC "${CMAKE_CURRENT_SOURCE_DIR}/include/*.h" "${PROTO_OUT_DIR}/*.h")
-    file(GLOB_RECURSE HELIX_SRC "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cc" "${PROTO_OUT_DIR}/*.cc")
+    file(GLOB_RECURSE HELIX_INC "${CMAKE_CURRENT_SOURCE_DIR}/include/*.h")
+    file(GLOB_RECURSE HELIX_SRC "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cc")
     file(GLOB_RECURSE HELIX_PYTHON_SRC "${CMAKE_CURRENT_SOURCE_DIR}/python/*.cc")
 
     # --- Plugin Target ---
@@ -48,7 +30,6 @@ if(PL_HELIX OR BUILD_ALL_PLUGINS)
     # --- Includes ---
     target_include_directories(helix PRIVATE
         "${PROJECT_SOURCE_DIR}/plugins/gui/include"
-        "${CMAKE_CURRENT_SOURCE_DIR}/protobuf"
     )
 
     # --- Link Libraries ---
@@ -59,10 +40,6 @@ if(PL_HELIX OR BUILD_ALL_PLUGINS)
         event
         event_pthreads
         hiredis
-        protocol
-        absl::log_internal_check_op
-        absl::log
-        absl::strings
         gui
     )
 

plugins/helix/deps/CMakeLists.txt

@@ -0,0 +1,3 @@
+include(cmake/get_latest_github_tag.cmake)
+add_subdirectory(hiredis)
+add_subdirectory(libevent)

plugins/helix/deps/cmake/get_latest_github_tag.cmake

@@ -0,0 +1,16 @@
+function(get_github_latest_release_tag owner repo out_var)
+  set(_url "https://api.github.com/repos/${owner}/${repo}/releases/latest")
+  set(_tmp "${CMAKE_BINARY_DIR}/latest_${repo}.json")
+  file(DOWNLOAD ${_url} ${_tmp} STATUS stat)
+  list(GET stat 0 code)
+  if(NOT code EQUAL 0)
+    message(FATAL_ERROR "${repo} download failed: ${stat}")
+  endif()
+  file(READ ${_tmp} _json)
+  string(REGEX MATCH "\"tag_name\": ?\"([a-zA-Z0-9._-]+)\"" _match ${_json})
+  string(REGEX REPLACE ".*\"tag_name\": ?\"([a-zA-Z0-9._-]+)\".*" "\\1" _tag
+                       ${_match})
+  set(${out_var}
+      ${_tag}
+      PARENT_SCOPE)
+endfunction()

plugins/helix/deps/hiredis/CMakeLists.txt

@@ -0,0 +1,41 @@
+include(ExternalProject)
+
+set(HIREDIS_INSTALL "${CMAKE_BINARY_DIR}")
+set(HIREDIS_BASE "${CMAKE_BINARY_DIR}/hiredis")
+set(HIREDIS_DOWNLOAD "${HIREDIS_BASE}/download")
+set(HIREDIS_BUILD "${HIREDIS_BASE}/build")
+set(HIREDIS_INCLUDES "${HIREDIS_BASE}/include")
+set(HIREDIS_LIB "${HIREDIS_BASE}/lib/libhiredis${CMAKE_SHARED_LIBRARY_SUFFIX}")
+set(HAVE_HIREDIS TRUE)
+
+get_github_latest_release_tag(redis hiredis HIREDIS_TAG)
+
+message(
+  "-- Using hiredis-${HIREDIS_TAG}"
+)
+
+if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
+  cmake_policy(SET CMP0135 NEW)
+endif()
+
+ExternalProject_Add(
+  hiredis_src
+  PREFIX hiredis
+  GIT_REPOSITORY https://github.com/redis/hiredis
+  GIT_TAG ${HIREDIS_TAG}
+  CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}/hiredis
+             -DBUILD_SHARED_LIBS=ON)
+
+file(MAKE_DIRECTORY ${HIREDIS_INCLUDES})
+
+add_library(hiredis SHARED IMPORTED GLOBAL)
+
+set_target_properties(
+  hiredis
+  PROPERTIES IMPORTED_LOCATION_DEBUG ${HIREDIS_LIB}
+             IMPORTED_LOCATION_RELEASE ${HIREDIS_LIB}
+             INTERFACE_INCLUDE_DIRECTORIES ${HIREDIS_INCLUDES})
+
+add_dependencies(hiredis hiredis_src)
+
+mark_as_advanced(HAVE_HIREDIS HIREDIS_LIB HIREDIS_INCLUDES)

plugins/helix/deps/libevent/CMakeLists.txt

@@ -0,0 +1,41 @@
+include(ExternalProject)
+
+set(LIBEVENT_INSTALL "${CMAKE_BINARY_DIR}")
+set(LIBEVENT_BASE "${CMAKE_BINARY_DIR}/libevent")
+set(LIBEVENT_DOWNLOAD "${LIBEVENT_BASE}/download")
+set(LIBEVENT_BUILD "${LIBEVENT_BASE}/build")
+set(LIBEVENT_INCLUDES "${LIBEVENT_BASE}/include")
+set(LIBEVENT_LIB "${LIBEVENT_BASE}/lib/libevent${CMAKE_SHARED_LIBRARY_SUFFIX}")
+set(HAVE_LIBEVENT TRUE)
+
+get_github_latest_release_tag(libevent libevent LIBEVENT_TAG)
+
+message(
+  "-- Using libevent-${LIBEVENT_TAG}"
+)
+
+if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
+  cmake_policy(SET CMP0135 NEW)
+endif()
+
+ExternalProject_Add(
+  libevent_src
+  PREFIX libevent
+  GIT_REPOSITORY https://github.com/libevent/libevent
+  GIT_TAG ${LIBEVENT_TAG}
+  CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=${LIBEVENT_BASE}
+             -DBUILD_SHARED_LIBS=ON)
+
+file(MAKE_DIRECTORY ${LIBEVENT_INCLUDES})
+
+add_library(event SHARED IMPORTED GLOBAL)
+
+set_target_properties(event PROPERTIES
+  IMPORTED_LOCATION_DEBUG ${LIBEVENT_LIB}
+  IMPORTED_LOCATION_RELEASE ${LIBEVENT_LIB}
+  INTERFACE_INCLUDE_DIRECTORIES ${LIBEVENT_INCLUDES}
+)
+
+add_dependencies(event libevent_src)
+
+mark_as_advanced(HAVE_LIBEVENT LIBEVENT_LIB LIBEVENT_INCLUDES)

plugins/helix/helix.proto

@@ -1,20 +1,21 @@
 // MIT License
-// 
+//
 // Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
 // Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
 // Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
-// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
-// 
+// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS").
+// All Rights reserved.
+//
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
 // in the Software without restriction, including without limitation the rights
 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 // copies of the Software, and to permit persons to whom the Software is
 // furnished to do so, subject to the following conditions:
-// 
+//
 // The above copyright notice and this permission notice shall be included in all
 // copies or substantial portions of the Software.
-// 
+//
 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

plugins/helix/include/helix/plugin_helix.h

@@ -1,2 +1 @@
-redis
-protobuf
+redis

plugins/helix/scripts/requirements.txt

@@ -1,12 +1,6 @@
 import sys
 import redis
 
-try:
-    import helix_pb2 as hx
-except ImportError:
-    sys.stderr.write("Error: Missing generated Python code. Please compile 'helix.proto' using 'protoc' before running this script.\n")
-    sys.exit(1)
-
 
 CHANNELS: list[str] = ["hal", "application1", "application2"]
 
@@ -24,9 +18,7 @@ def main() -> None:
         if msg.get("type") != "message":
             continue
 
-        message: hx.Message = hx.Message()
-        message.ParseFromString(msg.get("data"))
-        print(f"{message}")
+        print("")
 
 
 if __name__ == "__main__":

plugins/helix/scripts/subscriber.py

@@ -7,9 +7,7 @@
 #include "hal_core/utilities/log.h"
 #include "helix/helix.h"
 #include "helix/plugin_helix.h"
-#include "protocol/helix.pb.h"
 
-#include <google/protobuf/repeated_ptr_field.h>
 #include <istream>
 #include <string>
 #include <vector>
@@ -163,30 +161,17 @@ namespace hal
             return;
         }
 
-        Message msg;
-        static u64 sqn = 1;
-        msg.set_sequence_number( sqn++ );
-        msg.set_application( "hal" );
         if( tag == "gate_action_zoom" )
         {
-            msg.mutable_gate_action_zoom()->mutable_identifiers()->Assign( identifiers.begin(), identifiers.end() );
         }
         else if( tag == "gate_action_select" )
         {
-            msg.mutable_gate_action_select()->mutable_identifiers()->Assign( identifiers.begin(), identifiers.end() );
         }
         else if( tag == "gate_action_isolate" )
         {
-            msg.mutable_gate_action_isolate()->mutable_identifiers()->Assign( identifiers.begin(), identifiers.end() );
         }
 
         std::string payload;
-        if( !msg.SerializeToString( &payload ) )
-        {
-            log_error( "helix", "could not serialize message" );
-            return;
-        }
-
         this->m_parent->get_helix()->publish( helix::Helix::channel, payload );
     }
 }  // namespace hal