Add custom message type support

.github/workflows/composite/unit-integration-test-runner/run-unit-tests.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -e
 
 echo "::group::Run unit tests ('$1' $CC / $CXX)"
 cd "$GITHUB_WORKSPACE/core"

.github/workflows/composite/unit-test-framework/action.yaml

@@ -18,7 +18,7 @@ runs:
   steps:
     - name: Build and Cache Unit Test framework ('${{ inputs.os }}' ${{ inputs.compilers }})
       id: unit-test-framework
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: |
           cgreen
@@ -27,7 +27,7 @@ runs:
           ${{ inputs.os }}-cgreen-${{ inputs.version }}-
     - name: Checkout Unit Test framework
       if: steps.unit-test-framework.outputs.cache-hit != 'true'
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         repository: cgreen-devs/cgreen
         ref: ${{ matrix.cgreen }}

.github/workflows/run-tests.yml

@@ -25,11 +25,11 @@ jobs:
 #            group: organization/macos-gh
     steps:
       - name: Checkout project
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.GH_TOKEN }}
       - name: Checkout actions
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: pubnub/client-engineering-deployment-tools
           ref: v1

core/Makefile

@@ -66,7 +66,7 @@ pubnub_timer_list_unittest: pubnub_timer_list.c pubnub_timer_list_unit_test.c
 	#$(GCOVR) -r . --html --html-details -o coverage.html
 
 
-PROXY_PROJECT_SOURCEFILES = pubnub_proxy_core.c pubnub_proxy.c pbhttp_digest.c pbntlm_core.c pbntlm_packer_std.c pubnub_generate_uuid_v4_random_std.c ../lib/pubnub_parse_ipv4_addr.c ../lib/pubnub_parse_ipv6_addr.c  ../lib/md5/md5.c
+PROXY_PROJECT_SOURCEFILES = pubnub_proxy_core.c pubnub_proxy.c pbhttp_digest.c pbntlm_core.c pbntlm_packer_std.c pubnub_generate_uuid_v4_random_std.c pubnub_dns_servers.c ../lib/pubnub_parse_ipv4_addr.c ../lib/pubnub_parse_ipv6_addr.c  ../lib/md5/md5.c
 
 pubnub_proxy_unittest: $(PROJECT_SOURCEFILES) $(PROXY_PROJECT_SOURCEFILES) pubnub_proxy_unit_test.c
 	gcc -o pubnub_proxy_unit_test.so -shared $(CFLAGS) $(LDFLAGS) -D PUBNUB_CALLBACK_API -D PUBNUB_PROXY_API=1 -Wall $(COVERAGE_FLAGS) -fPIC $(PROJECT_SOURCEFILES) $(PROXY_PROJECT_SOURCEFILES) pubnub_proxy_unit_test.c -lcgreen -lm
@@ -87,6 +87,21 @@ CRYPTO_INCLUDES += -I ../openssl/.
 CRYPTO_LIBS += -lssl -lcrypto
 CRYPTO_SOURCEFILES += pubnub_crypto.c pbcc_crypto.c pbcc_crypto_aes_cbc.c pbcc_crypto_legacy.c ../openssl/pbaes256.c
 
+ifeq ($(shell uname),Darwin)
+	CRYPTO_CFLAGS := $(shell pkg-config --cflags openssl 2>/dev/null)
+	CRYPTO_LIBS := $(shell pkg-config --libs openssl 2>/dev/null)
+
+	ifeq ($(CRYPTO_CFLAGS),)
+		CRYPTO_CFLAGS := -I/usr/local/opt/openssl/include
+	endif
+	ifeq ($(CRYPTO_LIBS),)
+		CRYPTO_LIBS := -L/usr/local/opt/openssl/lib -lssl -lcrypto
+	endif
+
+	CRYPTO_INCLUDES += $(CRYPTO_CFLAGS)
+	CRYPTO_LIBS += $(CRYPTO_LIBS)
+endif
+
 pbcc_crypto_unittest: $(PROJECT_SOURCEFILES) $(CRYPTO_SOURCEFILES) pbcc_crypto_unit_tests.c
 	gcc -o pbcc_crypto_unit_test.so -shared $(CFLAGS) $(LDFLAGS) $(CRYPTO_INCLUDES) $(CRYPTO_LIBS) -D PUBNUB_CRYPTO_API=1 -Wall $(COVERAGE_FLAGS) -fPIC $(PROJECT_SOURCEFILES) $(CRYPTO_SOURCEFILES) test/pubnub_test_mocks.c pbcc_crypto_unit_tests.c -lcgreen -lm
 #	gcc -o pubnub_core_unit_testo  $(CFLAGS) -Wall $(COVERAGE_FLAGS) $(PROJECT_SOURCEFILES) pbcc_crypto_unit_tests.c -lcgreen -lm

core/pbcc_fetch_history.c

@@ -21,6 +21,7 @@ enum pubnub_res pbcc_fetch_history_prep(struct pbcc_context* pb,
                                   const char*          channel,
                                   unsigned int         max_per_channel,
                                   enum pubnub_tribool  include_meta,
+                                  enum pubnub_tribool  include_custom_message_type,
                                   enum pubnub_tribool  include_message_type,
                                   enum pubnub_tribool  include_user_id,
                                   enum pubnub_tribool  include_message_actions,
@@ -59,7 +60,8 @@ enum pubnub_res pbcc_fetch_history_prep(struct pbcc_context* pb,
     if (max_per_channel) { ADD_URL_PARAM(qparam, max, max_per_ch_cnt_buf); }
 
     if (include_meta != pbccNotSet) { ADD_URL_PARAM(qparam, include_meta, include_meta == pbccTrue ? "true" : "false"); }
-    if (include_message_type != pbccNotSet) { ADD_URL_PARAM(qparam, include_message_type, include_meta == pbccTrue ? "true" : "false"); }
+    if (include_custom_message_type != pbccNotSet) { ADD_URL_PARAM(qparam, include_custom_message_type, include_custom_message_type == pbccTrue ? "true" : "false"); }
+    if (include_message_type != pbccNotSet) { ADD_URL_PARAM(qparam, include_message_type, include_message_type == pbccTrue ? "true" : "false"); }
     if (include_user_id != pbccNotSet) { ADD_URL_PARAM(qparam, include_uuid, include_user_id == pbccTrue ? "true" : "false"); }
 #if PUBNUB_CRYPTO_API
     if (pb->secret_key == NULL) { ADD_URL_AUTH_PARAM(pb, qparam, auth); }

core/pbcc_fetch_history.h

@@ -10,6 +10,7 @@ enum pubnub_res pbcc_fetch_history_prep(struct pbcc_context* pb,
                                   const char*          channel,
                                   unsigned int         max_per_channel,
                                   enum pubnub_tribool  include_meta,
+                                  enum pubnub_tribool  include_custom_message_type,
                                   enum pubnub_tribool  include_message_type,
                                   enum pubnub_tribool  include_user_id,
                                   enum pubnub_tribool  include_message_actions,

core/pbcc_subscribe_v2.c

@@ -27,7 +27,7 @@
 enum pubnub_res pbcc_subscribe_v2_prep(struct pbcc_context* p,
                                        char const*          channel,
                                        char const*          channel_group,
-                                       unsigned*            heartbeat,
+                                       const unsigned*      heartbeat,
                                        char const*          filter_expr)
 {
     char        region_str[20];
@@ -303,6 +303,11 @@ struct pubnub_v2_message pbcc_get_msg_v2(struct pbcc_context* p)
         rslt.message_type = pbsbPublished;
     }
 
+    if (jonmpOK == pbjson_get_object_value(&el, "cmt", &found)) {
+        rslt.custom_message_type.ptr  = (char*)found.start + 1;
+        rslt.custom_message_type.size = found.end - found.start - 2;
+    }
+
     jpresult = pbjson_get_object_value(&el, "p", &found);
     if (jonmpOK == jpresult) {
         struct pbjson_elem titel;

core/pbcc_subscribe_v2.h

@@ -15,7 +15,7 @@ struct pbcc_context;
 enum pubnub_res pbcc_subscribe_v2_prep(struct pbcc_context* p,
                                        char const*          channel,
                                        char const*          channel_group,
-                                       unsigned*            heartbeat,
+                                       const unsigned*      heartbeat,
                                        char const*          filter_expr);
 
 

core/pubnub_ccore_pubsub.c

@@ -525,6 +525,7 @@ enum pubnub_res pbcc_append_url_param_encoded(struct pbcc_context* pb,
 enum pubnub_res pbcc_publish_prep(struct pbcc_context* pb,
                                   const char*          channel,
                                   const char*          message,
+                                  const char*          custom_message_type,
                                   bool                 store_in_history,
                                   bool                 norep,
                                   char const*          meta,
@@ -596,7 +597,7 @@ enum pubnub_res pbcc_publish_prep(struct pbcc_context* pb,
     URL_PARAMS_INIT(qparam, PUBNUB_MAX_URL_PARAMS);
     if (uname) { ADD_URL_PARAM(qparam, pnsdk, uname); }
     ADD_URL_PARAM(qparam, uuid, user_id);
-    if (ttl != SIZE_MAX) { ADD_URL_PARAM_SIZET(qparam, ttl, ttl); }
+    if (ttl != 0 && ttl != SIZE_MAX) { ADD_URL_PARAM_SIZET(qparam, ttl, ttl); }
 #if PUBNUB_CRYPTO_API
     if (pb->secret_key == NULL) { ADD_URL_AUTH_PARAM(pb, qparam, auth); }
     ADD_TS_TO_URL_PARAM();
@@ -606,6 +607,9 @@ enum pubnub_res pbcc_publish_prep(struct pbcc_context* pb,
     if (!store_in_history) { ADD_URL_PARAM(qparam, store, "0"); }
     if (norep) { ADD_URL_PARAM(qparam, norep, "true"); }
     if (meta) { ADD_URL_PARAM(qparam, meta, meta); }
+    if (custom_message_type) {
+        ADD_URL_PARAM(qparam, custom_message_type, custom_message_type);
+    }
 
 #if PUBNUB_CRYPTO_API
     SORT_URL_PARAMETERS(qparam);
@@ -667,7 +671,8 @@ enum pubnub_res pbcc_sign_url(struct pbcc_context* pc, const char* msg, enum pub
 
 enum pubnub_res pbcc_signal_prep(struct pbcc_context* pb,
                                  const char* channel,
-                                 const char* message)
+                                 const char* message,
+                                 const char* custom_message_type)
 {
     enum pubnub_res   rslt = PNR_OK;
     char const* const uname = pubnub_uname();
@@ -689,6 +694,9 @@ enum pubnub_res pbcc_signal_prep(struct pbcc_context* pb,
     URL_PARAMS_INIT(qparam, PUBNUB_MAX_URL_PARAMS);
     if (uname) { ADD_URL_PARAM(qparam, pnsdk, uname); }
     if (user_id) { ADD_URL_PARAM(qparam, uuid, user_id); }
+    if (custom_message_type) {
+        ADD_URL_PARAM(qparam, custom_message_type, custom_message_type);
+    }
 #if PUBNUB_CRYPTO_API
     if (pb->secret_key == NULL) { ADD_URL_AUTH_PARAM(pb, qparam, auth); }
     ADD_TS_TO_URL_PARAM();
@@ -716,7 +724,7 @@ enum pubnub_res pbcc_signal_prep(struct pbcc_context* pb,
 enum pubnub_res pbcc_subscribe_prep(struct pbcc_context* p,
                                     char const*          channel,
                                     char const*          channel_group,
-                                    unsigned*            heartbeat)
+                                    const unsigned*      heartbeat)
 {
     char const* user_id = pbcc_user_id_get(p);
     char const* const uname = pubnub_uname();

core/pubnub_ccore_pubsub.h

@@ -477,6 +477,7 @@ void pbcc_via_post_headers(struct pbcc_context* p, char* header, size_t max_leng
 enum pubnub_res pbcc_publish_prep(struct pbcc_context* pb,
                                   const char*          channel,
                                   const char*          message,
+                                  const char*          custom_message_type,
                                   bool                 store_in_history,
                                   bool                 norep,
                                   char const*          meta,
@@ -488,15 +489,16 @@ enum pubnub_res pbcc_publish_prep(struct pbcc_context* pb,
  */
 enum pubnub_res pbcc_signal_prep(struct pbcc_context* pb,
                                  const char* channel,
-                                 const char* message);
+                                 const char* message,
+                                 const char* custom_message_type);
 
 /** Prepares the Subscribe operation (transaction), mostly by
     formatting the URI of the HTTP request.
  */
 enum pubnub_res pbcc_subscribe_prep(struct pbcc_context* p,
                                     char const*          channel,
                                     char const*          channel_group,
-                                    unsigned*            heartbeat);
+                                    const unsigned*            heartbeat);
 
 
 /** Split @p buf string containing a JSON array (with arbitrary

core/pubnub_coreapi_ex.c

@@ -27,12 +27,13 @@
 struct pubnub_publish_options pubnub_publish_defopts(void)
 {
     struct pubnub_publish_options result;
-    result.store      = true;
-    result.cipher_key = NULL;
-    result.replicate  = true;
-    result.meta       = NULL;
-    result.method     = pubnubSendViaGET;
-    result.ttl        = SIZE_MAX;
+    result.store               = true;
+    result.cipher_key          = NULL;
+    result.replicate           = true;
+    result.meta                = NULL;
+    result.method              = pubnubSendViaGET;
+    result.ttl                 = 0;
+    result.custom_message_type = NULL;
     return result;
 }
 
@@ -85,6 +86,7 @@ enum pubnub_res pubnub_publish_ex(pubnub_t*                     pb,
     rslt = pbcc_publish_prep(&pb->core,
                              channel,
                              message,
+                             opts.custom_message_type,
                              opts.store,
                              !opts.replicate,
                              opts.meta,
@@ -102,6 +104,40 @@ enum pubnub_res pubnub_publish_ex(pubnub_t*                     pb,
     return rslt;
 }
 
+struct pubnub_signal_options pubnub_signal_defopts(void)
+{
+    struct pubnub_signal_options result;
+    result.custom_message_type = NULL;
+    return result;
+}
+
+enum pubnub_res pubnub_signal_ex(
+    pubnub_t* pb,
+    const char* channel,
+    const char* message,
+    struct pubnub_signal_options opts)
+{
+    enum pubnub_res rslt;
+
+    PUBNUB_ASSERT(pb_valid_ctx_ptr(pb));
+
+    pubnub_mutex_lock(pb->monitor);
+    if (!pbnc_can_start_transaction(pb)) {
+        pubnub_mutex_unlock(pb->monitor);
+        return PNR_IN_PROGRESS;
+    }
+
+    rslt = pbcc_signal_prep(&pb->core, channel, message, opts.custom_message_type);
+    if (PNR_STARTED == rslt) {
+        pb->trans            = PBTT_SIGNAL;
+        pb->core.last_result = PNR_STARTED;
+        pbnc_fsm(pb);
+        rslt = pb->core.last_result;
+    }
+    pubnub_mutex_unlock(pb->monitor);
+
+    return rslt;
+}
 
 struct pubnub_subscribe_options pubnub_subscribe_defopts(void)
 {

core/pubnub_coreapi_ex.h

@@ -65,11 +65,17 @@ struct pubnub_publish_options {
         API.
      */
     size_t ttl;
+    /** User-specified message type.
+        Important: String limited by **3**-**50** case-sensitive alphanumeric
+        characters with only `-` and `_` special characters allowed.
+     */
+    char const* custom_message_type;
 };
 
 /** This returns the default options for publish V1 transactions.
     Will set `store = true`, `cipher_key = NULL`, `replicate = true`,
-    `meta = NULL` and `method = pubnubPublishViaGet`
+    `meta = NULL`, `method = pubnubPublishViaGet`, `ttl=0`, and
+    `custom_message_type=NULL`.
  */
 PUBNUB_EXTERN struct pubnub_publish_options pubnub_publish_defopts(void);
 
@@ -85,7 +91,7 @@ PUBNUB_EXTERN struct pubnub_publish_options pubnub_publish_defopts(void);
     @param p The Pubnub context. Can't be NULL.
     @param channel The string with the channel name to publish to. Can't be
    NULL.
-    @param opt Publish V1 options
+    @param opts Publish V1 options
     @return #PNR_STARTED on success, an error otherwise
 */
 PUBNUB_EXTERN enum pubnub_res pubnub_publish_ex(pubnub_t*                     p,
@@ -94,6 +100,41 @@ PUBNUB_EXTERN enum pubnub_res pubnub_publish_ex(pubnub_t*                     p,
                                   struct pubnub_publish_options opts);
 
 
+/** Options for "extended" signal V1. */
+struct pubnub_signal_options {
+    /** User-specified message type.
+        Important: String limited by **3**-**50** case-sensitive alphanumeric
+        characters with only `-` and `_` special characters allowed.
+     */
+    char const* custom_message_type;
+};
+
+/** This returns the default options for signal V1 transactions.
+    Will set `custom_message_type=NULL`. */
+PUBNUB_EXTERN struct pubnub_signal_options pubnub_signal_defopts(void);
+
+/** The extended signal V1. Basically the same as pubnub_signal(),
+    but with added optional parameters in @p opts.
+
+    Basic usage:
+
+        struct pubnub_signal_options opt = pubnub_signal_defopts();
+        opt.custom_message_type = "test-message-type";
+        pbresult = pubnub_signal_ex(pn, "my_channel", "status:active", opt);
+
+    @param pb The pubnub context. Can't be NULL
+    @param channel The string with the channel to signal to.
+    @param message The signal message to send, expected to be in JSON format
+    @param opts Signal V1 options
+    @return #PNR_STARTED on success, an error otherwise
+*/
+PUBNUB_EXTERN enum pubnub_res pubnub_signal_ex(
+    pubnub_t* pb,
+    const char* channel,
+    const char* message,
+    struct pubnub_signal_options opts);
+
+
 /** Options for "extended" subscribe. */
 struct pubnub_subscribe_options {
     /** Channel group (a comma-delimited list of channel group names).

core/pubnub_dns_servers.c

@@ -33,7 +33,6 @@ void pubnub_dns_servers_deinit(void)
     pubnub_mutex_destroy(m_lock);
 }
 
-
 int pubnub_dns_set_primary_server_ipv4(struct pubnub_ipv4_address ipv4_address)
 {
     uint8_t* ipv4 = ipv4_address.ipv4;
@@ -166,6 +165,20 @@ int pubnub_get_dns_secondary_server_ipv4(struct pubnub_ipv4_address* o_ipv4)
 }
 
 #if PUBNUB_USE_IPV6
+void pubnub_set_ipv4_connectivity(pubnub_t *p)
+{
+    pubnub_mutex_lock(p->monitor);
+    p->options.ipv6_connectivity = false;
+    pubnub_mutex_unlock(p->monitor);
+}
+
+void pubnub_set_ipv6_connectivity(pubnub_t *p)
+{
+    pubnub_mutex_lock(p->monitor);
+    p->options.ipv6_connectivity = true;
+    pubnub_mutex_unlock(p->monitor);
+}
+
 int pubnub_dns_set_primary_server_ipv6(struct pubnub_ipv6_address ipv6_address)
 {
     uint8_t* ipv6 = ipv6_address.ipv6;

core/pubnub_dns_servers.h

@@ -2,6 +2,7 @@
 #if !defined INC_PUBNUB_DNS_SERVERS
 #define INC_PUBNUB_DNS_SERVERS
 
+#include "core/pubnub_api_types.h"
 #include <stdint.h>
 
 /** IPv4 Address, in binary format.
@@ -19,6 +20,14 @@ struct pubnub_ipv6_address {
     uint8_t ipv6[16];
 };
 
+/** IPv4 connectivity type for @p.
+    Use IPv4 addresses to establish connection with remote origin. */
+void pubnub_set_ipv4_connectivity(pubnub_t *p);
+
+/** IPv6 connectivity type for @p.
+    Use IPv6 addresses to establish connection with remote origin. */
+void pubnub_set_ipv6_connectivity(pubnub_t *p);
+
 /* primary, secondary(ipv4, ipv6) and default dns server */
 #define PUBNUB_MAX_DNS_SERVERS_MASK 0x10 
 #else