syslog_relay: Add new function syslog_relay_start_capture_raw

to allow access to the unprocessed raw data

2 files changed, 60 insertions, 3 deletions

diff --git a/include/libimobiledevice/syslog_relay.h b/include/libimobiledevice/syslog_relay.h
index ea7b649..89d9489 100644
--- a/include/libimobiledevice/syslog_relay.h
+++ b/include/libimobiledevice/syslog_relay.h
@@ -3,7 +3,8 @@
  * @brief Capture the syslog output from a device.
  * \internal
  *
- * Copyright (c) 2013-2014 Martin Szulecki All Rights Reserved.
+ * Copyright (c) 2019-2020 Nikias Bassen, All Rights Reserved.
+ * Copyright (c) 2013-2014 Martin Szulecki, All Rights Reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -109,6 +110,27 @@ syslog_relay_error_t syslog_relay_client_free(syslog_relay_client_t client);
 syslog_relay_error_t syslog_relay_start_capture(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data);
 
 /**
+ * Starts capturing the *raw* syslog of the device using a callback.
+ * This function is like syslog_relay_start_capture with the difference that
+ * it will neither check nor process the received data before passing it to
+ * the callback function.
+ *
+ * Use syslog_relay_stop_capture() to stop receiving the syslog.
+ *
+ * @note Use syslog_relay_start_capture for a safer implementation.
+ *
+ * @param client The syslog_relay client to use
+ * @param callback Callback to receive each character from the syslog.
+ * @param user_data Custom pointer passed to the callback function.
+ *
+ * @return SYSLOG_RELAY_E_SUCCESS on success,
+ *      SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
+ *      invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
+ *      error occurs or a syslog capture has already been started.
+ */
+syslog_relay_error_t syslog_relay_start_capture_raw(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data);
+
+/**
  * Stops capturing the syslog of the device.
  *
  * Use syslog_relay_start_capture() to start receiving the syslog.
diff --git a/src/syslog_relay.c b/src/syslog_relay.c
index 579908c..c137297 100644
--- a/src/syslog_relay.c
+++ b/src/syslog_relay.c
@@ -2,7 +2,8 @@
  * syslog_relay.c
  * com.apple.syslog_relay service implementation.
  *
- * Copyright (c) 2013 Martin Szulecki All Rights Reserved.
+ * Copyright (c) 2019-2020 Nikias Bassen, All Rights Reserved.
+ * Copyright (c) 2013-2015 Martin Szulecki, All Rights Reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -33,6 +34,7 @@ struct syslog_relay_worker_thread {
         syslog_relay_client_t client;
         syslog_relay_receive_cb_t cbfunc;
         void *user_data;
+        int is_raw;
 };
 
 /**
@@ -156,8 +158,12 @@ void *syslog_relay_worker(void *arg)
                         debug_info("Connection to syslog relay interrupted");
                         break;
                 }
-                if(c != 0) {
+                if (srwt->is_raw) {
                         srwt->cbfunc(c, srwt->user_data);
+                } else {
+                        if (c != 0) {
+                                srwt->cbfunc(c, srwt->user_data);
+                        }
                 }
         }
 
@@ -188,6 +194,35 @@ LIBIMOBILEDEVICE_API syslog_relay_error_t syslog_relay_start_capture(syslog_rela
                 srwt->client = client;
                 srwt->cbfunc = callback;
                 srwt->user_data = user_data;
+                srwt->is_raw = 0;
+
+                if (thread_new(&client->worker, syslog_relay_worker, srwt) == 0) {
+                        res = SYSLOG_RELAY_E_SUCCESS;
+                }
+        }
+
+        return res;
+}
+
+LIBIMOBILEDEVICE_API syslog_relay_error_t syslog_relay_start_capture_raw(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data)
+{
+        if (!client || !callback)
+                return SYSLOG_RELAY_E_INVALID_ARG;
+
+        syslog_relay_error_t res = SYSLOG_RELAY_E_UNKNOWN_ERROR;
+
+        if (client->worker) {
+                debug_info("Another syslog capture thread appears to be running already.");
+                return res;
+        }
+
+        /* start worker thread */
+        struct syslog_relay_worker_thread *srwt = (struct syslog_relay_worker_thread*)malloc(sizeof(struct syslog_relay_worker_thread));
+        if (srwt) {
+                srwt->client = client;
+                srwt->cbfunc = callback;
+                srwt->user_data = user_data;
+                srwt->is_raw = 1;
 
                 if (thread_new(&client->worker, syslog_relay_worker, srwt) == 0) {
                         res = SYSLOG_RELAY_E_SUCCESS;