Merge branch 'feature/mqtt_client_with_null_id' into 'master'

Adds the possibilty of client with empty id

See merge request espressif/esp-mqtt!114

.gitlab-ci.yml

@@ -17,6 +17,13 @@ before_script:
   # Use CI Tools
   - curl -sSL ${CIT_LOADER_URL} | sh
   - source citools/import_functions
+  # Add gitlab ssh key
+  - mkdir -p ~/.ssh
+  - chmod 700 ~/.ssh
+  - echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64
+  - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
+  - chmod 600 ~/.ssh/id_rsa
+  - echo -e "Host gitlab.espressif.cn\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
   - PATH=$CI_PROJECT_DIR/esp-idf/tools:$PATH
   - export IDF_PATH=$CI_PROJECT_DIR/esp-idf
   - export MQTT_PATH=$CI_PROJECT_DIR
@@ -28,7 +35,6 @@ build_with_idf_v3:
     - build
   dependencies: []
   script:
-    - cit_add_ssh_key "${GITLAB_KEY}"
     - git clone "${IDF_REPO}"
     # build with IDFv3.2
     - $MQTT_PATH/ci/set_idf.sh release/v3.2
@@ -53,7 +59,6 @@ build_with_idf_v4:
   variables:
     PYTHON_VER: 3.6.13
   script:
-    - cit_add_ssh_key "${GITLAB_KEY}"
     - git clone "${IDF_REPO}"
     - source /opt/pyenv/activate && pyenv global $PYTHON_VER
     - $MQTT_PATH/ci/set_idf.sh master
@@ -105,7 +110,6 @@ build_and_test_qemu:
   variables:
     PYTHON_VER: 3.6.13
   script:
-    - cit_add_ssh_key "${GITLAB_KEY}"
     - git clone "${IDF_REPO}"
     - source /opt/pyenv/activate && pyenv global $PYTHON_VER
     # switch to IDF and setup the tools

include/mqtt_client.h

@@ -176,7 +176,11 @@ typedef struct {
     const char *host;                       /*!< MQTT server domain (ipv4 as string) */
     const char *uri;                        /*!< Complete MQTT broker URI */
     uint32_t port;                          /*!< MQTT server port */
-    const char *client_id;                  /*!< default client id is ``ESP32_%CHIPID%`` where %CHIPID% are last 3 bytes of MAC address in hex format */
+    bool set_null_client_id;                /*!< Selects a NULL client id */
+    const char *client_id;                  /*!< Set client id.
+                                                 Ignored if set_null_client_id == true
+                                                 If NULL set the default client id.
+                                                 Default client id is ``ESP32_%CHIPID%`` where %CHIPID% are last 3 bytes of MAC address in hex format */
     const char *username;                   /*!< MQTT username */
     const char *password;                   /*!< MQTT password */
     const char *lwt_topic;                  /*!< LWT (Last Will and Testament) message topic (NULL by default) */

lib/mqtt_msg.c

@@ -361,7 +361,7 @@ mqtt_message_t *mqtt_msg_connect(mqtt_connection_t *connection, mqtt_connect_inf
     if (connection->message.length + header_len > connection->buffer_length) {
         return fail_message(connection);
     }
-    char* variable_header = (void *)(connection->buffer + connection->message.length);
+    char *variable_header = (char *)(connection->buffer + connection->message.length);
     connection->message.length += header_len;
 
     int header_idx = 0;
@@ -394,7 +394,9 @@ mqtt_message_t *mqtt_msg_connect(mqtt_connection_t *connection, mqtt_connect_inf
             return fail_message(connection);
         }
     } else {
-        return fail_message(connection);
+        if (append_string(connection, "", 0) < 0) {
+            return fail_message(connection);
+        }
     }
 
     if (info->will_topic != NULL && info->will_topic[0] != '\0') {
@@ -456,7 +458,7 @@ mqtt_message_t *mqtt_msg_publish(mqtt_connection_t *connection, const char *topi
     }
 
     if (data == NULL && data_length > 0) {
-       return fail_message(connection);
+        return fail_message(connection);
     }
 
     if (qos > 0) {
@@ -474,8 +476,7 @@ mqtt_message_t *mqtt_msg_publish(mqtt_connection_t *connection, const char *topi
         connection->message.length = connection->buffer_length;
         connection->message.fragmented_msg_total_length = data_length + connection->message.fragmented_msg_data_offset;
     } else {
-        if (data != NULL)
-        {
+        if (data != NULL) {
             memcpy(connection->buffer + connection->message.length, data, data_length);
             connection->message.length += data_length;
         }

mqtt_client.c

@@ -43,7 +43,6 @@ ESP_EVENT_DEFINE_BASE(MQTT_EVENTS);
 #endif
 
 typedef struct mqtt_state {
-    mqtt_connect_info_t *connect_info;
     uint8_t *in_buffer;
     uint8_t *out_buffer;
     int in_buffer_length;
@@ -372,7 +371,7 @@ esp_err_t esp_mqtt_set_config(esp_mqtt_client_handle_t client, const esp_mqtt_cl
 
     client->config->message_retransmit_timeout = config->message_retransmit_timeout;
     if (config->message_retransmit_timeout <= 0) {
-       client->config->message_retransmit_timeout = 1000;
+        client->config->message_retransmit_timeout = 1000;
     }
 
     client->config->task_prio = config->task_prio;
@@ -395,13 +394,15 @@ esp_err_t esp_mqtt_set_config(esp_mqtt_client_handle_t client, const esp_mqtt_cl
     ESP_MEM_CHECK(TAG, set_if_config(config->username, &client->connect_info.username), goto _mqtt_set_config_failed);
     ESP_MEM_CHECK(TAG, set_if_config(config->password, &client->connect_info.password), goto _mqtt_set_config_failed);
 
-    if (config->client_id) {
-        ESP_MEM_CHECK(TAG, set_if_config(config->client_id, &client->connect_info.client_id), goto _mqtt_set_config_failed);
-    } else if (client->connect_info.client_id == NULL) {
-        client->connect_info.client_id = platform_create_id_string();
+    if (!config->set_null_client_id) {
+        if (config->client_id) {
+            ESP_MEM_CHECK(TAG, set_if_config(config->client_id, &client->connect_info.client_id), goto _mqtt_set_config_failed);
+        } else if (client->connect_info.client_id == NULL) {
+            client->connect_info.client_id = platform_create_id_string();
+        }
+        ESP_MEM_CHECK(TAG, client->connect_info.client_id, goto _mqtt_set_config_failed);
+        ESP_LOGD(TAG, "MQTT client_id=%s", client->connect_info.client_id);
     }
-    ESP_MEM_CHECK(TAG, client->connect_info.client_id, goto _mqtt_set_config_failed);
-    ESP_LOGD(TAG, "MQTT client_id=%s", client->connect_info.client_id);
 
     ESP_MEM_CHECK(TAG, set_if_config(config->uri, &client->config->uri), goto _mqtt_set_config_failed);
     ESP_MEM_CHECK(TAG, set_if_config(config->lwt_topic, &client->connect_info.will_topic), goto _mqtt_set_config_failed);
@@ -427,6 +428,9 @@ esp_err_t esp_mqtt_set_config(esp_mqtt_client_handle_t client, const esp_mqtt_cl
 
     if (config->disable_clean_session == client->connect_info.clean_session) {
         client->connect_info.clean_session = !config->disable_clean_session;
+        if (!client->connect_info.clean_session && config->set_null_client_id) {
+            ESP_LOGE(TAG, "Clean Session flag must be true if client has a null id");
+        }
     }
     if (config->keepalive) {
         client->connect_info.keepalive = config->keepalive;
@@ -623,7 +627,7 @@ static esp_err_t esp_mqtt_connect(esp_mqtt_client_handle_t client, int timeout_m
     int read_len, connect_rsp_code;
     client->wait_for_ping_resp = false;
     client->mqtt_state.outbound_message = mqtt_msg_connect(&client->mqtt_state.mqtt_connection,
-                                          client->mqtt_state.connect_info);
+                                          &client->connect_info);
     if (client->mqtt_state.outbound_message->length == 0) {
         ESP_LOGE(TAG, "Connect message cannot be created");
         return ESP_FAIL;
@@ -791,7 +795,6 @@ esp_mqtt_client_handle_t esp_mqtt_client_init(const esp_mqtt_client_config_t *co
     ESP_MEM_CHECK(TAG, client->mqtt_state.out_buffer, goto _mqtt_init_failed);
 
     client->mqtt_state.out_buffer_length = out_buffer_size;
-    client->mqtt_state.connect_info = &client->connect_info;
     client->outbox = outbox_init();
     ESP_MEM_CHECK(TAG, client->outbox, goto _mqtt_init_failed);
     client->status_bits = xEventGroupCreate();