refactor: remove atclient_atsign, atclient_atstr, refactor a bunch of function signatures

.github/workflows/build_source_tests.yaml

@@ -29,5 +29,5 @@ jobs:
       - name: Run sample_cmake_project executable
         working-directory: examples/desktop/sample_cmake_project
         run: |
-          ./build/exec
+          ./build/main
 

.github/workflows/codeql.yml

@@ -78,7 +78,7 @@ jobs:
     - name: Run sample_cmake_project executable
       working-directory: examples/desktop/sample_cmake_project
       run: |
-        ./build/exec
+        ./build/main
 
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@b611370bb5703a7efb587f9d136a52ea24c5c38c # v3.25.11

examples/desktop/at_talk/src/main.c

@@ -1,11 +1,10 @@
 #include <atchops/aes.h>
-#include <atchops/aesctr.h>
+#include <atchops/aes_ctr.h>
 #include <atchops/base64.h>
 #include <atchops/iv.h>
 #include <atclient/atclient.h>
 #include <atclient/atclient_utils.h>
 #include <atclient/atkeysfile.h>
-#include <atclient/atsign.h>
 #include <atclient/constants.h>
 #include <atclient/encryption_key_helpers.h>
 #include <atclient/monitor.h>
@@ -152,14 +151,29 @@ int main(int argc, char *argv[]) {
     atclient_atkey atkey;
     atclient_atkey_init(&atkey);
 
-    if ((ret = atclient_atkey_create_sharedkey(&atkey, ATKEY_NAME, strlen(ATKEY_NAME), from_atsign, strlen(from_atsign),
-                                               to_atsign, strlen(to_atsign), ATKEY_NAMESPACE,
-                                               strlen(ATKEY_NAMESPACE))) != 0) {
-      atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_atkey_create_sharedkey: %d\n", ret);
+    if ((ret = atclient_atkey_create_shared_key(&atkey, ATKEY_NAME, from_atsign, to_atsign, ATKEY_NAMESPACE)) != 0) {
+      atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_atkey_create_shared_key: %d\n", ret);
     }
 
-    atclient_notify_params_create(&params, ATCLIENT_NOTIFY_OPERATION_UPDATE, &atkey, line, true);
-    params.notification_expiry = 5000;
+    if((ret = atclient_notify_params_set_operation(&params, ATCLIENT_NOTIFY_OPERATION_UPDATE)) != 0) {
+      atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_notify_params_set_operation: %d\n", ret);
+    }
+
+    if((ret = atclient_notify_params_set_atkey(&params, &atkey)) != 0) {
+      atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_notify_params_set_atkey: %d\n", ret);
+    }
+
+    if((ret = atclient_notify_params_set_value(&params, line)) != 0) {
+      atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_notify_params_set_value: %d\n", ret);
+    }
+
+    if((ret = atclient_notify_params_set_should_encrypt(&params, true)) != 0) {
+      atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_notify_params_set_should_encrypt: %d\n", ret);
+    }
+
+    if((ret = atclient_notify_params_set_notification_expiry(&params, 5000)) != 0) {
+      atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_notify_params_set_notification_expiry: %d\n", ret);
+    }
 
     pthread_mutex_lock(&client_mutex);
     if ((ret = atclient_notify(&atclient1, &params, NULL)) != 0) {
@@ -236,7 +250,7 @@ static void *monitor_handler(void *xargs) {
     goto exit;
   }
   atclient_monitor_set_read_timeout(monitor, READ_TIMEOUT); // blocking read takes 1 second to timeout
-  if ((ret = atclient_monitor_start(monitor, MONITOR_REGEX, strlen(MONITOR_REGEX))) != 0) {
+  if ((ret = atclient_monitor_start(monitor, MONITOR_REGEX)) != 0) {
     atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to start monitor: %d\n", ret);
     goto exit;
   }
@@ -245,8 +259,8 @@ static void *monitor_handler(void *xargs) {
   int tries = 1;
 
   while (true) {
-    atclient_monitor_message message;
-    atclient_monitor_message_init(&message);
+    atclient_monitor_response message;
+    atclient_monitor_response_init(&message);
 
     pthread_mutex_lock(&monitor_mutex);
     pthread_mutex_lock(&client_mutex);
@@ -260,9 +274,9 @@ static void *monitor_handler(void *xargs) {
         // We received a stats notification. Ignore it.
         break;
       }
-      if (atclient_atnotification_decryptedvalue_is_initialized(&(message.notification))) {
+      if (atclient_atnotification_is_decrypted_value_initialized(&(message.notification))) {
         const atclient_atnotification *notification = &(message.notification);
-        printf("\n%s%s%s: %s\n", HGRN, notification->from, reset, notification->decryptedvalue);
+        printf("\n%s%s%s: %s\n", HGRN, notification->from, reset, notification->decrypted_value);
         printf("%s%s%s: ", HBLU, from_atsign, reset);
         fflush(stdout);
       }
@@ -320,7 +334,7 @@ static void *monitor_handler(void *xargs) {
     }
     }
 
-    atclient_monitor_message_free(&message);
+    atclient_monitor_response_free(&message);
     usleep(100);
   }
   goto exit;
@@ -358,7 +372,7 @@ static int reconnect_clients(atclient *monitor, atclient *ctx, const char *atser
    * 3. Start monitor
    */
   atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "Restarting monitor...\n");
-  if ((ret = atclient_monitor_start(monitor, MONITOR_REGEX, strlen(MONITOR_REGEX))) != 0) {
+  if ((ret = atclient_monitor_start(monitor, MONITOR_REGEX)) != 0) {
     atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to start monitor: %d\n", ret);
     return ret;
   }

examples/desktop/connection_hooks/.gitignore

@@ -0,0 +1,2 @@
+/*build*/
+/*bin*/

examples/desktop/connection_hooks/CMakeLists.txt

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 3.24)
+
+project(temp)
+
+find_package(atsdk REQUIRED)
+
+add_executable(main ${CMAKE_CURRENT_LIST_DIR}/main.c)
+target_link_libraries(main atsdk::atclient)
+
+install(TARGETS main DESTINATION ${CMAKE_CURRENT_LIST_DIR}/bin)

examples/desktop/connection_hooks/main.c

@@ -0,0 +1,186 @@
+#include <atclient/connection.h>
+#include <atclient/connection_hooks.h>
+#include <atlogger/atlogger.h>
+#include <string.h>
+#include <stdlib.h>
+
+#define TAG "main"
+
+#define HOST "3b419d7a-2fee-5080-9289-f0e1853abb47.swarm0002.atsign.zone"
+#define PORT 5770
+
+void *pre_read_hook(atclient_connection_hook_params *params) {
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "pre_read_hook was called\n");
+  // log params
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "src (%p): \"%s\"\n", params->recv, (char *)params->src);
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "src_len: %d\n", params->src_len);
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv (%p): %s\n", params->recv, (char *)params->recv);
+  if (params->recv_len != NULL) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_len: %d\n", *params->recv_len);
+  } else {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_len: NULL\n");
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_size: %d\n", params->recv_size);
+  return NULL;
+}
+
+void *post_read_hook(atclient_connection_hook_params *params) {
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "post_read_hook was called\n");
+  // log params
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "src (%p): \"%s\"\n", params->recv, (char *)params->src);
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "src_len: %d\n", params->src_len);
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv (%p): %s\n", params->recv, (char *)params->recv);
+  if (params->recv_len != NULL) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_len: %d\n", *params->recv_len);
+  } else {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_len: NULL\n");
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_size: %d\n", params->recv_size);
+
+  return NULL;
+}
+
+void *pre_write_hook(atclient_connection_hook_params *params) {
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "pre_write_hook was called\n");
+  // log params
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "src (%p): \"%s\"\n", params->recv, (char *)params->src);
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "src_len: %d\n", params->src_len);
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv (%p): %s\n", params->recv, (char *)params->recv);
+  if (params->recv_len != NULL) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_len: %d\n", *params->recv_len);
+  } else {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_len: NULL\n");
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_size: %d\n", params->recv_size);
+  return NULL;
+}
+
+void *post_write_hook(atclient_connection_hook_params *params) {
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "post_write_hook was called\n");
+  // log params
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "src (%p): \"%s\"\n", params->recv, (char *)params->src);
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "src_len: %d\n", params->src_len);
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv (%p): %s\n", params->recv, (char *)params->recv);
+  if (params->recv_len != NULL) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_len: %d\n", *params->recv_len);
+  } else {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_len: NULL\n");
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_DEBUG, "recv_size: %d\n", params->recv_size);
+  return NULL;
+}
+
+int main(int argc, char *argv[]) {
+  int ret = 1;
+
+  atlogger_set_logging_level(ATLOGGER_LOGGING_LEVEL_DEBUG);
+
+  atclient_connection conn;
+  atclient_connection_init(&conn, ATCLIENT_CONNECTION_TYPE_ATSERVER);
+
+  const unsigned char *src = (const unsigned char *) "from:12alpaca\r\n";
+  const size_t src_len = strlen((char *) src);
+  unsigned char *recv = NULL;
+  size_t recv_len = 0;
+
+  if ((ret = atclient_connection_hooks_enable(&conn)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to enable hooks\n");
+    goto exit;
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "Enabled hooks\n");
+
+  if ((ret = atclient_connection_hooks_set(&conn, ATCLIENT_CONNECTION_HOOK_TYPE_PRE_READ, pre_read_hook)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to set pre_read hook\n");
+    goto exit;
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "Set pre_read_hook successfully\n");
+
+  if ((ret = atclient_connection_hooks_set(&conn, ATCLIENT_CONNECTION_HOOK_TYPE_POST_READ, post_read_hook)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to set post_read hook\n");
+    goto exit;
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "Set post_read_hook successfully\n");
+
+  if ((ret = atclient_connection_hooks_set(&conn, ATCLIENT_CONNECTION_HOOK_TYPE_PRE_WRITE, pre_write_hook)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to set pre_write hook\n");
+    goto exit;
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "Set pre_write_hook successfully\n");
+
+  if ((ret = atclient_connection_hooks_set(&conn, ATCLIENT_CONNECTION_HOOK_TYPE_POST_WRITE, post_write_hook)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to set post_write hook\n");
+    goto exit;
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "Set post_write_hook successfully\n");
+
+  if ((ret = atclient_connection_connect(&conn, HOST, PORT)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to connect to %s:%d\n", HOST, PORT);
+    goto exit;
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "Connected to %s:%d\n", HOST, PORT);
+
+  if ((ret = atclient_connection_write(&conn, (const unsigned char *)src, src_len)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to write to %s:%d\n", HOST, PORT);
+    goto exit;
+  }
+
+  if ((ret = atclient_connection_write(&conn, (const unsigned char *)src, src_len)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to write to %s:%d\n", HOST, PORT);
+    goto exit;
+  }
+
+  if ((ret = atclient_connection_read(&conn, &recv, &recv_len, 20)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to read from %s:%d\n", HOST, PORT);
+    goto exit;
+  }
+  free(recv);
+  recv = NULL;
+
+  if ((ret = atclient_connection_read(&conn, &recv, &recv_len, 20)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to read from %s:%d\n", HOST, PORT);
+    goto exit;
+  }
+  free(recv);
+  recv = NULL;
+
+  if ((ret = atclient_connection_read(&conn, &recv, &recv_len, 20)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to read from %s:%d\n", HOST, PORT);
+    goto exit;
+  }
+  free(recv);
+  recv = NULL;
+
+  if ((ret = atclient_connection_read(&conn, &recv, &recv_len, 0)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to read from %s:%d\n", HOST, PORT);
+    goto exit;
+  }
+  free(recv);
+  recv = NULL;
+
+  size_t recv_size = 4096;
+  recv = malloc(sizeof(unsigned char) * recv_size);
+  if(recv == NULL) {
+    ret = 1;
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to malloc\n");
+    goto exit;
+  }
+
+  if((ret = atclient_connection_send(&conn, src, src_len, recv, recv_size, &recv_len)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "atclient_connection_send: %d\n", ret);
+    goto exit;
+  }
+
+  if ((ret = atclient_connection_disconnect(&conn)) != 0) {
+    atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_ERROR, "Failed to disconnect from %s:%d\n", HOST, PORT);
+    goto exit;
+  }
+  atlogger_log(TAG, ATLOGGER_LOGGING_LEVEL_INFO, "Disconnected from %s:%d\n", HOST, PORT);
+
+  ret = 0;
+  goto exit;
+exit: {
+  free(recv);
+  atclient_connection_free(&conn);
+  return ret;
+}
+}

examples/desktop/connection_hooks/run.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+set -eu
+
+# Clean
+rm -f build/CMakeCache.txt
+rm -f bin/main
+
+# Install dependencies
+FULL_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")"
+SCRIPT_DIRECTORY="$(dirname "$FULL_PATH_TO_SCRIPT")"
+
+# Install atsdk
+"$SCRIPT_DIRECTORY/../../../tools/install.sh"
+
+# Build
+cd "$SCRIPT_DIRECTORY"
+
+## CMake configure
+cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
+
+## CMake build
+cmake --build build --target install
+
+# Run
+./bin/main $@