Bug #34025412 Rename utf8_xxx functions and data structures to utf8mb3_xxx [noclose]

For better code readability/maintainability, rename functions and data
structures used for handling utf8mb3 charsets and collations.

This patch changes: utf8 -> utf8mb3 for plugins and components

Change-Id: I10497b2c231502face1598418bbcfa025357afba

Author: Tor Didriksen

components/audit_api_message_emit/audit_api_message_emit.cc

@@ -207,7 +207,7 @@ static bool set_args_charset_info(UDF_ARGS *args, IError_handler &handler) {
 }
 
 /**
-  Sets the charset info of the return value to utf8.
+  Sets the charset info of the return value to utf8mb4.
 
   @param [in, out]  initid    A pointer to the UDF_INIT structure
   @param [out]      handler   Error handler that keeps the error message

components/example/test_string_service.cc

@@ -70,21 +70,21 @@ mysql_service_status_t test_string_service_init() {
     if (mysql_service_mysql_string_converter->convert_from_buffer(
             &out_string,
             nullptr,  // its a input buffer
-            strlen(test_text), "utf8")) {
+            strlen(test_text), "utf8mb3")) {
       WRITE_LOG("Buffer=NULL in convert from buffer: passed.\n");
     };
     // Length is too high for buffer in convert from buffer
     if (mysql_service_mysql_string_converter->convert_from_buffer(
             &out_string,
             test_text,  // its a input buffer
-            strlen(test_text) + 10, "utf8")) {
+            strlen(test_text) + 10, "utf8mb3")) {
       WRITE_LOG("Length too high for buffer in convert from buffer: passed.\n");
     }
     // Length is zero for buffer in convert from buffer
     if (mysql_service_mysql_string_converter->convert_from_buffer(
             &out_string,
             test_text,  // its a input buffer
-            0, "utf8")) {
+            0, "utf8mb3")) {
       WRITE_LOG("Length is zero for buffer in convert from buffer: failed.\n");
     } else {
       WRITE_LOG("Length is zero for buffer in convert from buffer: passed.\n");
@@ -95,7 +95,7 @@ mysql_service_status_t test_string_service_init() {
        (mysql_service_mysql_string_converter->convert_from_buffer(&out_string,
                                                 test_text, // its a input buffer
                                                 -1,
-                                                "utf8"))
+                                                "utf8mb3"))
           {
             WRITE_LOG ("Length is negative for buffer in convert from buffer:
        failed.\n");
@@ -110,7 +110,7 @@ mysql_service_status_t test_string_service_init() {
     if (mysql_service_mysql_string_converter->convert_from_buffer(
             &out_string,
             empty_test_text,  // its a input buffer
-            strlen(empty_test_text), "utf8")) {
+            strlen(empty_test_text), "utf8mb3")) {
       WRITE_LOG("Empty string as input to convert from buffer failed.\n");
     } else {
       WRITE_LOG("Empty string as input to convert from buffer passed.\n");
@@ -119,7 +119,7 @@ mysql_service_status_t test_string_service_init() {
     if (mysql_service_mysql_string_converter->convert_from_buffer(
             &out_string,
             test_text,  // its a input buffer
-            strlen(test_text), "utf8")) {
+            strlen(test_text), "utf8mb3")) {
       WRITE_LOG("Convert from buffer failed.\n");
     } else {
       uint out_length = 0;
@@ -172,12 +172,12 @@ mysql_service_status_t test_string_service_init() {
           WRITE_LOG("Tolower passed:\n");
           // NULL as input buffer in Convert string to buffer
           if (mysql_service_mysql_string_converter->convert_to_buffer(
-                  nullptr, low_test_text, MAX_BUFFER_LENGTH, "utf8")) {
+                  nullptr, low_test_text, MAX_BUFFER_LENGTH, "utf8mb3")) {
             WRITE_LOG("NULL as input buffer in Convert to buffer passed.\n");
           }
           // Convert low string to buffer
           if (mysql_service_mysql_string_converter->convert_to_buffer(
-                  low_string, low_test_text, MAX_BUFFER_LENGTH, "utf8")) {
+                  low_string, low_test_text, MAX_BUFFER_LENGTH, "utf8mb3")) {
             WRITE_LOG("Convert to buffer failed.\n");
           } else {
             WRITE_LOG(low_test_text);
@@ -201,7 +201,8 @@ mysql_service_status_t test_string_service_init() {
         } else {
           WRITE_LOG("Toupper passed:\n");
           if (mysql_service_mysql_string_converter->convert_to_buffer(
-                  upper_string, upper_test_text, MAX_BUFFER_LENGTH, "utf8")) {
+                  upper_string, upper_test_text, MAX_BUFFER_LENGTH,
+                  "utf8mb3")) {
             WRITE_LOG("Convert to buffer failed.\n");
           } else {
             WRITE_LOG(upper_test_text);

components/example/test_string_service_charset.cc

@@ -161,7 +161,7 @@ bool test_charset(const char *charset, const char *text, int buff_len) {
 */
 mysql_service_status_t test_string_service_init() {
   const char *chs_latin1 = "latin1";
-  const char *chs_utf8 = "utf8";
+  const char *chs_utf8mb3 = "utf8mb3";
   const char *chs_gb18030 = "gb18030";
   //  const char* charset="utf8mb4";
 
@@ -180,9 +180,9 @@ mysql_service_status_t test_string_service_init() {
 
   retcode = test_charset(chs_latin1, test_text_eng, TEST_TEXT_LIT_LENGTH);
   retcode = test_charset(chs_latin1, test_text_ger, TEST_TEXT_LIT_LENGTH);
-  retcode = test_charset(chs_utf8, test_text_eng, TEST_TEXT_LIT_LENGTH);
-  retcode = test_charset(chs_utf8, test_text_ger, TEST_TEXT_LIT_LENGTH);
-  retcode = test_charset(chs_utf8, test_text_chinese, TEST_TEXT_LIT_LENGTH);
+  retcode = test_charset(chs_utf8mb3, test_text_eng, TEST_TEXT_LIT_LENGTH);
+  retcode = test_charset(chs_utf8mb3, test_text_ger, TEST_TEXT_LIT_LENGTH);
+  retcode = test_charset(chs_utf8mb3, test_text_chinese, TEST_TEXT_LIT_LENGTH);
   retcode = test_charset(chs_gb18030, test_text_chinese, TEST_TEXT_LIT_LENGTH);
 
   WRITE_LOG("%s\n", "End of init");

components/example/test_string_service_long.cc

@@ -85,15 +85,15 @@ mysql_service_status_t test_string_service_init() {
     if (mysql_service_mysql_string_converter->convert_from_buffer(
             &out_string,
             test_text,  // its a input buffer
-            strlen(test_text) + 10, "utf8")) {
+            strlen(test_text) + 10, "utf8mb3")) {
       WRITE_LOG("%s\n",
                 "Length too high for buffer in convert from buffer: passed.");
     }
     // Length is zero for buffer in convert from buffer
     if (mysql_service_mysql_string_converter->convert_from_buffer(
             &out_string,
             test_text,  // its a input buffer
-            0, "utf8")) {
+            0, "utf8mb3")) {
       WRITE_LOG("%s\n",
                 "Length is zero for buffer in convert from buffer: failed.");
     } else {
@@ -104,7 +104,7 @@ mysql_service_status_t test_string_service_init() {
     if (mysql_service_mysql_string_converter->convert_from_buffer(
             &out_string,
             test_text,  // its a input buffer
-            strlen(test_text), "utf8")) {
+            strlen(test_text), "utf8mb3")) {
       WRITE_LOG("%s\n", "Convert from buffer failed.");
     } else {
       uint out_length = 0;
@@ -135,7 +135,7 @@ mysql_service_status_t test_string_service_init() {
           WRITE_LOG("%s\n", "Tolower passed:");
           // Convert low string to buffer
           if (mysql_service_mysql_string_converter->convert_to_buffer(
-                  low_string, low_test_text, MAX_BUFFER_LENGTH, "utf8")) {
+                  low_string, low_test_text, MAX_BUFFER_LENGTH, "utf8mb3")) {
             WRITE_LOG("%s\n", "Convert to buffer failed.");
           } else {
             WRITE_LOG("%s\n", low_test_text);
@@ -154,7 +154,8 @@ mysql_service_status_t test_string_service_init() {
         } else {
           WRITE_LOG("%s\n", "Toupper passed:");
           if (mysql_service_mysql_string_converter->convert_to_buffer(
-                  upper_string, upper_test_text, MAX_BUFFER_LENGTH, "utf8")) {
+                  upper_string, upper_test_text, MAX_BUFFER_LENGTH,
+                  "utf8mb3")) {
             WRITE_LOG("%s\n", "Convert to buffer failed.");
           } else {
             WRITE_LOG("%s\n", upper_test_text);

components/test/table_access/test_table_access.cc

@@ -74,7 +74,7 @@ const char *common_insert_customer(char * /* out */, size_t num_tables,
   size_t ticket;
   int rc;
 
-  CHARSET_INFO_h utf8 = charset_srv->get_utf8mb4();
+  CHARSET_INFO_h utf8mb4_h = charset_srv->get_utf8mb4();
   MYSQL_THD thd;
   current_thd_srv->get(&thd);
 
@@ -113,7 +113,8 @@ const char *common_insert_customer(char * /* out */, size_t num_tables,
     goto cleanup;
   }
 
-  string_converter_srv->convert_from_buffer(name_value, "John Doe", 8, utf8);
+  string_converter_srv->convert_from_buffer(name_value, "John Doe", 8,
+                                            utf8mb4_h);
 
   if (fa_varchar_srv->set(access, table, NAME_COL, name_value)) {
     result = "set(name) failed";
@@ -234,7 +235,7 @@ const char *common_fetch_order(char *out, int order_num) {
   size_t ticket_order_line;
   int rc;
 
-  CHARSET_INFO_h utf8 = charset_srv->get_utf8mb4();
+  CHARSET_INFO_h utf8mb4_h = charset_srv->get_utf8mb4();
   MYSQL_THD thd;
   current_thd_srv->get(&thd);
 
@@ -310,9 +311,9 @@ const char *common_fetch_order(char *out, int order_num) {
       goto cleanup_index;
     }
 
-    string_converter_srv->convert_to_buffer(order_comment_value,
-                                            buff_order_comment,
-                                            sizeof(buff_order_comment), utf8);
+    string_converter_srv->convert_to_buffer(
+        order_comment_value, buff_order_comment, sizeof(buff_order_comment),
+        utf8mb4_h);
   }
 
   if (ta_index_srv->end(access, table_order, order_pk)) {
@@ -572,7 +573,7 @@ const char *test_index_fetch_bfas(char *out) {
   return common_index(out, false, 100, 1005, 5, 5, 5);
 }
 
-const char *test_math_insert(char * /* out */, bool utf8mb4) {
+const char *test_math_insert(char * /* out */, bool is_utf8mb4) {
   static const char *schema_name =
       "\xE2" /* for each */
       "\x88"
@@ -639,7 +640,7 @@ const char *test_math_insert(char * /* out */, bool utf8mb4) {
   const char *table_name;
   size_t table_name_length;
 
-  CHARSET_INFO_h utf8 = charset_srv->get_utf8mb4();
+  CHARSET_INFO_h utf8mb4_h = charset_srv->get_utf8mb4();
   MYSQL_THD thd;
   current_thd_srv->get(&thd);
 
@@ -651,7 +652,7 @@ const char *test_math_insert(char * /* out */, bool utf8mb4) {
     goto cleanup;
   }
 
-  if (utf8mb4) {
+  if (is_utf8mb4) {
     table_name = table_name_utf8mb4;
     table_name_length = table_name_utf8mb4_length;
   } else {
@@ -698,7 +699,7 @@ const char *test_math_insert(char * /* out */, bool utf8mb4) {
   ptr += column_name_length;
 
   string_converter_srv->convert_from_buffer(row_value, value_buffer,
-                                            value_length, utf8);
+                                            value_length, utf8mb4_h);
 
   if (fa_varchar_srv->set(access, table, 0, row_value)) {
     result = "set() failed";

components/validate_password/validate_password_imp.cc

@@ -244,7 +244,7 @@ static int validate_dictionary_check(my_h_string password) {
     return (0);
 
   if (mysql_service_mysql_string_converter->convert_to_buffer(
-          lower_string_handle, buffer, MAX_PASSWORD_LENGTH, "utf8")) {
+          lower_string_handle, buffer, MAX_PASSWORD_LENGTH, "utf8mb3")) {
     LogEvent()
         .type(LOG_TYPE_ERROR)
         .prio(ERROR_LEVEL)
@@ -374,7 +374,7 @@ static bool is_valid_password_by_user_name(void *thd, my_h_string password) {
   }
 
   if (mysql_service_mysql_string_converter->convert_to_buffer(
-          password, buffer, MAX_PASSWORD_LENGTH, "utf8")) {
+          password, buffer, MAX_PASSWORD_LENGTH, "utf8mb3")) {
     LogEvent()
         .type(LOG_TYPE_ERROR)
         .prio(WARNING_LEVEL)

mysql-test/r/component_string_service_charset.result

@@ -47,7 +47,7 @@ Get char with index > strlen passed.
 Get byte with index strlen failed.
 Destroy string object.
 -------------------------------------------------------------
-Charset: utf8
+Charset: utf8mb3
 Greetings from  beautiful Austria at March, 9th!
 Destroy string object.
 Convert from buffer passed.
@@ -62,7 +62,7 @@ Get char with index > strlen passed.
 Get byte with index strlen passed.
 Destroy string object.
 -------------------------------------------------------------
-Charset: utf8
+Charset: utf8mb3
 Grüße  aus  dem  schönen  Österreich am 9. März!
 Destroy string object.
 Convert from buffer passed.
@@ -77,7 +77,7 @@ Get char with index > strlen passed.
 Get byte with index strlen failed.
 Destroy string object.
 -------------------------------------------------------------
-Charset: utf8
+Charset: utf8mb3
 遥想公瑾当年，小乔初嫁了，雄姿英发
 Destroy string object.
 Convert from buffer passed.

plugin/password_validation/validate_password.cc

@@ -220,8 +220,8 @@ static int validate_dictionary_check(mysql_string_handle password) {
   mysql_string_handle lower_string_handle = mysql_string_to_lowercase(password);
   if (!(buffer = (char *)malloc(MAX_PASSWORD_LENGTH))) return (0);
 
-  length = mysql_string_convert_to_char_ptr(lower_string_handle, "utf8", buffer,
-                                            MAX_PASSWORD_LENGTH, &error);
+  length = mysql_string_convert_to_char_ptr(
+      lower_string_handle, "utf8mb3", buffer, MAX_PASSWORD_LENGTH, &error);
   /* Free the allocated string */
   mysql_string_free(lower_string_handle);
   int substr_pos = 0;
@@ -342,7 +342,7 @@ static bool is_valid_password_by_user_name(mysql_string_handle password) {
     return false;
   }
 
-  length = mysql_string_convert_to_char_ptr(password, "utf8", buffer,
+  length = mysql_string_convert_to_char_ptr(password, "utf8mb3", buffer,
                                             MAX_PASSWORD_LENGTH, &error);
 
   return is_valid_user(ctx, buffer, length, "user", "login user name") &&

sql/server_component/mysql_string_service.cc

@@ -134,6 +134,7 @@ DEFINE_BOOL_METHOD(mysql_string_imp::toupper,
 DEFINE_BOOL_METHOD(mysql_string_imp::convert_from_buffer,
                    (my_h_string * out_string, const char *in_buffer,
                     uint64 length, const char *charset_name)) {
+  assert(0 != strcmp(charset_name, "utf8"));
   try {
     if (in_buffer == nullptr || length == 0 || length > strlen(in_buffer))
       return true;
@@ -154,6 +155,7 @@ DEFINE_BOOL_METHOD(mysql_string_imp::convert_from_buffer,
 DEFINE_BOOL_METHOD(mysql_string_imp::convert_to_buffer,
                    (my_h_string in_string, char *out_buffer, uint64 length,
                     const char *charset_name)) {
+  assert(0 != strcmp(charset_name, "utf8"));
   try {
     String *str = reinterpret_cast<String *>(in_string);
     uint error;