Update samples, make C++/Qt threadsafe

Samples updated to changes in pubnub_cancel() and other interface
changes and to use time() instead of clock() as clock() can measure
CPU-only time instead of real time.

Update Qt functional tests and make them reliable.

UUID is now part of the Pubnub context (instead of a pointer to
it). This makes handling its lifetime easier, yet doesn't incur much
memory increase.

C++ wrapper and Qt did not have proper multithreading support as they
didn't protect _their_ data. C protects its own context, but, that
doesn't include stuff in the C++ context (such as `auth` key and
the message to publish via POST).

Author: vveljko

.appveyor.yml

@@ -5,20 +5,33 @@ platform:
 environment:
   matrix:
     - BUILD_TYPE: nmake
+      QT5: C:\Qt\5.11\mingw53_32
+      MINGW: C:\Qt\Tools\mingw530_32
 
+before_build:
+  - set PATH=%MINGW%\bin;%QT5%\bin;%PATH%
 
 build_script:
   - call "%VS120COMNTOOLS%\..\..\VC\vcvarsall.bat"
   - nmake /f windows.mk
   - cd core
   - nmake /f W_makefile.mk
   - cd ..
+  - cd qt
+  - qmake fn_test.pro CONFIG+=release DESTDIR=. &&
+    mingw32-make &&
+    qmake pubnub.pro CONFIG+=release DESTDIR=. &&
+    mingw32-make &&
+    qmake pubnub_gui.pro CONFIG+=release DESTDIR=. &&
+    mingw32-make
+  - cd ..
 
 test_script:
   - core\pubnub_proxy_NTLM_test
   - windows\pubnub_fntest
   - openssl\pubnub_fntest
   - cpp\fntest_runner
   - cpp\openssl\fntest_runner
+  - qt\release\fn_test
 
 deploy: off

.pubnub.yml

@@ -1,7 +1,19 @@
 name: c-core
-version: 2.6.2
+version: 2.6.3
 scm: github.com/pubnub/c-core
 changelog:
+  - version: v2.6.3
+    changes:
+      - type: enhancement
+        text: Update samples to changes in pubnub_cancel() and other interface changes
+      - type: enhancement
+        text: Update samples to use time() instead of clock() as clock() can measure CPU-only time instead of real time
+      - type: enhancement
+        text: Update Qt functional tests and make them reliable
+      - type: enhancement
+        text: UUID is now part of the Pubnub context (instead of a pointer to it). This makes handling its lifetime easier, yet doesn't incur much memory increase
+      - type: bug
+        text: C++ wrapper and Qt did not have proper multithreading support as they didn't protect _their_ data. Now that's fixed.
   - version: v2.6.2
     changes:
       - type: bug

README.md

@@ -42,8 +42,11 @@ In this root directory we have some files, too:
   Makefiles there are (doesn't build Qt - you might not have Qt)
 - `windows.mk`: a "master" Makefile for Windows - will build all the 
   Windows Makefiles there are (doesn't build Qt, you might not have Qt)
-- `VERSION`: Identifies the latest stable / recommended release
 - `.pubnub.yml`: Standard Pubnub library description in YAML
+- `.travis.yml`: Configuration for Travis CI (POSIX: Linux and MacOS)
+- `.appveyor.yml`: Configuration for Appveyor CI (Windows)
+- `.clang-format`: Configuration for Clang-format tool that we use to format
+  C/C++ source code
 
 
 ## Contributing

core/pubnub_ccore.c

@@ -100,6 +100,8 @@ enum pubnub_res pbcc_leave_prep(struct pbcc_context* pb,
                                 const char*          channel,
                                 const char*          channel_group)
 {
+    char const* uuid = pbcc_uuid_get(pb);
+
     if (NULL == channel) {
         if (NULL == channel_group) {
             return PNR_INVALID_CHANNEL;
@@ -120,7 +122,7 @@ enum pubnub_res pbcc_leave_prep(struct pbcc_context* pb,
                  channel,
                  pubnub_uname());
     APPEND_URL_PARAM_M(pb, "channel-group", channel_group, '&');
-    APPEND_URL_PARAM_M(pb, "uuid", pb->uuid, '&');
+    APPEND_URL_PARAM_M(pb, "uuid", uuid, '&');
     APPEND_URL_PARAM_M(pb, "auth", pb->auth, '&');
 
     return PNR_STARTED;
@@ -129,6 +131,8 @@ enum pubnub_res pbcc_leave_prep(struct pbcc_context* pb,
 
 enum pubnub_res pbcc_time_prep(struct pbcc_context* pb)
 {
+    char const* uuid = pbcc_uuid_get(pb);
+
     if (pb->msg_ofs < pb->msg_end) {
         return PNR_RX_BUFF_NOT_EMPTY;
     }
@@ -138,7 +142,7 @@ enum pubnub_res pbcc_time_prep(struct pbcc_context* pb)
 
     pb->http_buf_len = snprintf(
         pb->http_buf, sizeof pb->http_buf, "/time/0?pnsdk=%s", pubnub_uname());
-    APPEND_URL_PARAM_M(pb, "uuid", pb->uuid, '&');
+    APPEND_URL_PARAM_M(pb, "uuid", uuid, '&');
     APPEND_URL_PARAM_M(pb, "auth", pb->auth, '&');
 
     return PNR_STARTED;
@@ -183,6 +187,8 @@ enum pubnub_res pbcc_heartbeat_prep(struct pbcc_context* pb,
                                     const char*          channel,
                                     const char*          channel_group)
 {
+    char const* uuid = pbcc_uuid_get(pb);
+
     if (NULL == channel) {
         if (NULL == channel_group) {
             return PNR_INVALID_CHANNEL;
@@ -205,7 +211,7 @@ enum pubnub_res pbcc_heartbeat_prep(struct pbcc_context* pb,
                  pubnub_uname());
     APPEND_URL_PARAM_M(pb, "channel-group", channel_group, '&');
     APPEND_URL_PARAM_M(pb, "auth", pb->auth, '&');
-    APPEND_URL_PARAM_M(pb, "uuid", pb->uuid, '&');
+    APPEND_URL_PARAM_M(pb, "uuid", uuid, '&');
 
     return PNR_STARTED;
 }
@@ -217,6 +223,8 @@ enum pubnub_res pbcc_here_now_prep(struct pbcc_context* pb,
                                    enum pubnub_tribool  disable_uuids,
                                    enum pubnub_tribool  state)
 {
+    char const* uuid = pbcc_uuid_get(pb);
+
     if (NULL == channel) {
         if (channel_group != NULL) {
             channel = ",";
@@ -238,7 +246,7 @@ enum pubnub_res pbcc_here_now_prep(struct pbcc_context* pb,
                                 pubnub_uname());
     APPEND_URL_PARAM_M(pb, "channel-group", channel_group, '&');
     APPEND_URL_PARAM_M(pb, "auth", pb->auth, '&');
-    APPEND_URL_PARAM_M(pb, "uuid", pb->uuid, '&');
+    APPEND_URL_PARAM_M(pb, "uuid", uuid, '&');
     APPEND_URL_PARAM_TRIBOOL_M(pb, "disable_uuids", disable_uuids, '&');
     APPEND_URL_PARAM_TRIBOOL_M(pb, "state", state, '&');
 

core/pubnub_ccore_pubsub.c

@@ -17,7 +17,8 @@ void pbcc_init(struct pbcc_context* p, const char* publish_key, const char* subs
     p->subscribe_key = subscribe_key;
     p->timetoken[0]  = '0';
     p->timetoken[1]  = '\0';
-    p->uuid = p->auth = NULL;
+    p->uuid[0] = '\0';
+    p->auth = NULL;
     p->msg_ofs = p->msg_end = 0;
 #if PUBNUB_DYNAMIC_REPLY_BUFFER
     p->http_reply = NULL;
@@ -114,7 +115,20 @@ char const* pbcc_get_channel(struct pbcc_context* pb)
 
 void pbcc_set_uuid(struct pbcc_context* pb, const char* uuid)
 {
-    pb->uuid = uuid;
+    if (uuid != NULL) {
+        PUBNUB_ASSERT_OPT(strlen(uuid) < sizeof pb->uuid);
+        strncpy(pb->uuid, uuid, sizeof pb->uuid);
+        pb->uuid[(sizeof pb->uuid) - 1] = '\0';
+    }
+    else {
+        pb->uuid[0] = '\0';
+    }
+}
+
+
+char const* pbcc_uuid_get(struct pbcc_context* pb)
+{
+    return ('\0' == pb->uuid[0]) ? NULL : pb->uuid;
 }
 
 
@@ -424,6 +438,7 @@ enum pubnub_res pbcc_publish_prep(struct pbcc_context*        pb,
                                   enum pubnub_publish_method  method)
 {
     char const* const uname = pubnub_uname();
+    char const*       uuid = pbcc_uuid_get(pb);
     enum pubnub_res   rslt = PNR_OK;
 
     PUBNUB_ASSERT_OPT(message != NULL);
@@ -447,7 +462,7 @@ enum pubnub_res pbcc_publish_prep(struct pbcc_context*        pb,
         pb->message_to_publish = message;
     }
     APPEND_URL_PARAM_M(pb, "pnsdk", uname, '?');
-    APPEND_URL_PARAM_M(pb, "uuid", pb->uuid, '&');
+    APPEND_URL_PARAM_M(pb, "uuid", uuid, '&');
     APPEND_URL_PARAM_M(pb, "auth", pb->auth, '&');
     if ((PNR_OK == rslt) && !store_in_history) {
         rslt = pbcc_append_url_param(pb, "store", sizeof "store" - 1, "0", '&');
@@ -476,6 +491,8 @@ enum pubnub_res pbcc_subscribe_prep(struct pbcc_context* p,
                                     char const*          channel_group,
                                     unsigned*            heartbeat)
 {
+    char const* uuid = pbcc_uuid_get(p);
+
     if (NULL == channel) {
         if (NULL == channel_group) {
             return PNR_INVALID_CHANNEL;
@@ -497,7 +514,7 @@ enum pubnub_res pbcc_subscribe_prep(struct pbcc_context* p,
                                p->timetoken,
                                pubnub_uname());
     APPEND_URL_PARAM_M(p, "channel-group", channel_group, '&');
-    APPEND_URL_PARAM_M(p, "uuid", p->uuid, '&');
+    APPEND_URL_PARAM_M(p, "uuid", uuid, '&');
     APPEND_URL_PARAM_M(p, "auth", p->auth, '&');
     APPEND_URL_OPT_PARAM_UNSIGNED_M(p, "heartbeat", heartbeat, '&');
 

core/pubnub_ccore_pubsub.h

@@ -4,6 +4,7 @@
 
 #include "pubnub_config.h"
 #include "pubnub_api_types.h"
+#include "pubnub_generate_uuid.h"
 
 #include <stdbool.h>
 #include <stdlib.h>
@@ -24,8 +25,8 @@ struct pbcc_context {
     char const* publish_key;
     /** The subscribe key (to use when subscribing) */
     char const* subscribe_key;
-    /** The UUID to be sent to server. If NULL, don't send any */
-    char const* uuid;
+    /** The UUID to be sent to server. If empty string, don't send any */
+    char uuid[UUID_SIZE];
     /** The `auth` parameter to be sent to server. If NULL, don't send
      * any */
     char const* auth;
@@ -113,7 +114,7 @@ struct pbcc_context {
     if ((var) != NULL) {                                                       \
         const char      param_[] = name;                                       \
         enum pubnub_res rslt_    = pbcc_append_url_param(                      \
-            (pbc), param_, sizeof param_ - 1, (var), (separator));          \
+            (pbc), param_, sizeof param_ - 1, (var), (separator));             \
         if (rslt_ != PNR_OK) {                                                 \
             return rslt_;                                                      \
         }                                                                      \
@@ -123,7 +124,7 @@ struct pbcc_context {
     if ((var) != NULL) {                                                       \
         const char      param_[] = name;                                       \
         enum pubnub_res rslt_    = pbcc_append_url_param_encoded(              \
-            (pbc), param_, sizeof param_ - 1, (var), (separator));          \
+            (pbc), param_, sizeof param_ - 1, (var), (separator));             \
         if (rslt_ != PNR_OK) {                                                 \
             return rslt_;                                                      \
         }                                                                      \
@@ -200,6 +201,9 @@ char const* pbcc_get_channel(struct pbcc_context* pb);
 /** Sets the UUID for the context */
 void pbcc_set_uuid(struct pbcc_context* pb, const char* uuid);
 
+/** Returns the UUID for the context */
+char const* pbcc_uuid_get(struct pbcc_context* pb);
+
 /** Sets the `auth` for the context */
 void pbcc_set_auth(struct pbcc_context* pb, const char* auth);
 

core/pubnub_coreapi.c

@@ -189,7 +189,7 @@ enum pubnub_res pubnub_where_now(pubnub_t* pb, const char* uuid)
         return PNR_IN_PROGRESS;
     }
 
-    rslt = pbcc_where_now_prep(&pb->core, uuid ? uuid : pb->core.uuid);
+    rslt = pbcc_where_now_prep(&pb->core, uuid ? uuid : pbcc_uuid_get(&pb->core));
     if (PNR_STARTED == rslt) {
         pb->trans            = PBTT_WHERENOW;
         pb->core.last_result = PNR_STARTED;
@@ -219,7 +219,7 @@ enum pubnub_res pubnub_set_state(pubnub_t*   pb,
     }
 
     rslt = pbcc_set_state_prep(
-        &pb->core, channel, channel_group, uuid ? uuid : pb->core.uuid, state);
+        &pb->core, channel, channel_group, uuid ? uuid : pbcc_uuid_get(&pb->core), state);
     if (PNR_STARTED == rslt) {
         pb->trans            = PBTT_SET_STATE;
         pb->core.last_result = PNR_STARTED;
@@ -248,7 +248,7 @@ enum pubnub_res pubnub_state_get(pubnub_t*   pb,
     }
 
     rslt = pbcc_state_get_prep(
-        &pb->core, channel, channel_group, uuid ? uuid : pb->core.uuid);
+        &pb->core, channel, channel_group, uuid ? uuid : pbcc_uuid_get(&pb->core));
     if (PNR_STARTED == rslt) {
         pb->trans            = PBTT_STATE_GET;
         pb->core.last_result = PNR_STARTED;
@@ -363,3 +363,17 @@ enum pubnub_res pubnub_list_channel_group(pubnub_t* pb, char const* channel_grou
     pubnub_mutex_unlock(pb->monitor);
     return rslt;
 }
+
+
+bool pubnub_can_start_transaction(pubnub_t* pb)
+{
+    bool rslt;
+
+    PUBNUB_ASSERT(pb_valid_ctx_ptr(pb));
+
+    pubnub_mutex_lock(pb->monitor);
+    rslt = pbnc_can_start_transaction(pb);
+    pubnub_mutex_unlock(pb->monitor);
+
+    return rslt;
+}

core/pubnub_coreapi.h

@@ -71,7 +71,7 @@ enum pubnub_res pubnub_leave(pubnub_t *p, const char *channel, const char *chann
     If transaction is successful, the gotten time will be the only
     message you can get with pubnub_get(). It will be a (large) JSON
     integer.
-    
+
     You can't get time if a transaction is in progress on the context.
 
     @param p The Pubnub context. Can't be NULL.  
@@ -94,11 +94,11 @@ enum pubnub_res pubnub_time(pubnub_t *p);
     rather an array of JSON objects, having keys `message` with
     value the actual message, and `timetoken` with the time token
     of that particular message.
-    
+
     You can't get history if a transaction is in progress on the context.
 
-    @param p The Pubnub context. Can't be NULL. 
-    @param channel The string with the channel name to get message 
+    @param p The Pubnub context. Can't be NULL.
+    @param channel The string with the channel name to get message
     history for. This _can't_ be a comma separated list of channels.
     @param count Maximum number of messages to get. If there are less
     than this available on the @c channel, you'll get less, but you
@@ -126,7 +126,7 @@ enum pubnub_res pubnub_history(pubnub_t *p, const char *channel, unsigned count,
     you will subscribe only to the channel group(s). It goes both ways:
     if @p channel_group is NULL, then @p channel cannot be NULL and
     you will subscribe only to the channel(s).
-    
+
     You can't get list of currently present users if a transaction is
     in progress on the context.
 
@@ -171,7 +171,7 @@ enum pubnub_res pubnub_heartbeat(pubnub_t *p, const char* channel, const char* c
     you will subscribe only to the channel group(s). It goes both ways:
     if @p channel_group is NULL, then @p channel cannot be NULL and
     you will subscribe only to the channel(s).
-    
+
     You can't get list of currently present users if a transaction is
     in progress on the context.
 
@@ -193,7 +193,7 @@ enum pubnub_res pubnub_here_now(pubnub_t *p, const char *channel, const char *ch
     If transaction is successful, the response will be the same
     as for "multi-channel" response for pubnub_here_now(), if
     we queried against all currently available channels.
-    
+
     You can't get list of currently present users if a transaction is
     in progress on the context.
 
@@ -277,9 +277,9 @@ enum pubnub_res pubnub_set_state(pubnub_t *p, char const *channel, char const *c
     - "status": the HTTP status of the operation (200 OK, 40x error, etc.)
     - "message": the string/message describing the status ("OK"...)
     - "service": should be "Presence"
-    - "payload": if querying against one channel the gotten state 
+    - "payload": if querying against one channel - the state we got
     (a JSON object), otherwise a JSON object with the key "channels"
-    whose value is a JSON object with keys the name of the channels
+    whose value is a JSON object having keys the name of each channels
     and their respective values JSON objects of the gotten state
 
     If @p channel is NULL, then @p channel_group cannot be NULL and
@@ -401,6 +401,13 @@ enum pubnub_res pubnub_add_channel_to_group(pubnub_t *p, char const *channel, ch
 */
 enum pubnub_res pubnub_list_channel_group(pubnub_t *p, char const *channel_group);
 
+/** Checks if a transaction can be started on @p pb context. In other
+    words, checks if previous transaction is finished.
+
+    @retval true can start new transaction
+    @retval false otherwise (cannot start a new transaction)
+ */
+bool pubnub_can_start_transaction(pubnub_t* pb);
 
 
 #endif /* defined INC_PUBNUB_COREAPI */

core/pubnub_coreapi_ex.h

@@ -62,8 +62,8 @@ struct pubnub_publish_options {
 };
 
 /** This returns the default options for publish V1 transactions.
-    Will set `store = true`, `cipher_key = NULL`, `replicate = true`
-    and `meta = NULL`
+    Will set `store = true`, `cipher_key = NULL`, `replicate = true`,
+    `meta = NULL` and `method = pubnubPublishViaGet`
  */
 struct pubnub_publish_options pubnub_publish_defopts(void);