/* Copyright (C) 2000-2003 MySQL AB This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* This file defines all string functions */ #ifdef USE_PRAGMA_INTERFACE #pragma interface /* gcc class implementation */ #endif class Item_str_func :public Item_func { public: Item_str_func() :Item_func() { decimals=NOT_FIXED_DEC; } Item_str_func(Item *a) :Item_func(a) {decimals=NOT_FIXED_DEC; } Item_str_func(Item *a,Item *b) :Item_func(a,b) { decimals=NOT_FIXED_DEC; } Item_str_func(Item *a,Item *b,Item *c) :Item_func(a,b,c) { decimals=NOT_FIXED_DEC; } Item_str_func(Item *a,Item *b,Item *c,Item *d) :Item_func(a,b,c,d) {decimals=NOT_FIXED_DEC; } Item_str_func(Item *a,Item *b,Item *c,Item *d, Item* e) :Item_func(a,b,c,d,e) {decimals=NOT_FIXED_DEC; } Item_str_func(List<Item> &list) :Item_func(list) {decimals=NOT_FIXED_DEC; } longlong val_int(); double val_real(); my_decimal *val_decimal(my_decimal *); enum Item_result result_type () const { return STRING_RESULT; } void left_right_max_length(); String *check_well_formed_result(String *str); bool fix_fields(THD *thd, Item **ref); }; class Item_func_md5 :public Item_str_func { String tmp_value; public: Item_func_md5(Item *a) :Item_str_func(a) { collation.set(&my_charset_bin); } String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "md5"; } }; class Item_func_sha :public Item_str_func { public: Item_func_sha(Item *a) :Item_str_func(a) { collation.set(&my_charset_bin); } String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "sha"; } }; class Item_func_aes_encrypt :public Item_str_func { public: Item_func_aes_encrypt(Item *a, Item *b) :Item_str_func(a,b) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "aes_encrypt"; } }; class Item_func_aes_decrypt :public Item_str_func { public: Item_func_aes_decrypt(Item *a, Item *b) :Item_str_func(a,b) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "aes_decrypt"; } }; class Item_func_concat :public Item_str_func { String tmp_value; public: Item_func_concat(List<Item> &list) :Item_str_func(list) {} Item_func_concat(Item *a,Item *b) :Item_str_func(a,b) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "concat"; } }; class Item_func_concat_ws :public Item_str_func { String tmp_value; public: Item_func_concat_ws(List<Item> &list) :Item_str_func(list) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "concat_ws"; } table_map not_null_tables() const { return 0; } }; class Item_func_reverse :public Item_str_func { String tmp_value; public: Item_func_reverse(Item *a) :Item_str_func(a) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "reverse"; } }; class Item_func_replace :public Item_str_func { String tmp_value,tmp_value2; public: Item_func_replace(Item *org,Item *find,Item *replace) :Item_str_func(org,find,replace) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "replace"; } }; class Item_func_insert :public Item_str_func { String tmp_value; public: Item_func_insert(Item *org,Item *start,Item *length,Item *new_str) :Item_str_func(org,start,length,new_str) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "insert"; } }; class Item_str_conv :public Item_str_func { protected: uint multiply; uint (*converter)(CHARSET_INFO *cs, char *src, uint srclen, char *dst, uint dstlen); String tmp_value; public: Item_str_conv(Item *item) :Item_str_func(item) {} String *val_str(String *); }; class Item_func_lcase :public Item_str_conv { public: Item_func_lcase(Item *item) :Item_str_conv(item) {} const char *func_name() const { return "lcase"; } void fix_length_and_dec() { collation.set(args[0]->collation); multiply= collation.collation->casedn_multiply; converter= collation.collation->cset->casedn; max_length= args[0]->max_length * multiply; } }; class Item_func_ucase :public Item_str_conv { public: Item_func_ucase(Item *item) :Item_str_conv(item) {} const char *func_name() const { return "ucase"; } void fix_length_and_dec() { collation.set(args[0]->collation); multiply= collation.collation->caseup_multiply; converter= collation.collation->cset->caseup; max_length= args[0]->max_length * multiply; } }; class Item_func_left :public Item_str_func { String tmp_value; public: Item_func_left(Item *a,Item *b) :Item_str_func(a,b) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "left"; } }; class Item_func_right :public Item_str_func { String tmp_value; public: Item_func_right(Item *a,Item *b) :Item_str_func(a,b) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "right"; } }; class Item_func_substr :public Item_str_func { String tmp_value; public: Item_func_substr(Item *a,Item *b) :Item_str_func(a,b) {} Item_func_substr(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "substr"; } }; class Item_func_substr_index :public Item_str_func { String tmp_value; public: Item_func_substr_index(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "substring_index"; } }; class Item_func_trim :public Item_str_func { protected: String tmp_value; String remove; public: Item_func_trim(Item *a,Item *b) :Item_str_func(a,b) {} Item_func_trim(Item *a) :Item_str_func(a) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "trim"; } void print(String *str); virtual const char *mode_name() const { return "both"; } }; class Item_func_ltrim :public Item_func_trim { public: Item_func_ltrim(Item *a,Item *b) :Item_func_trim(a,b) {} Item_func_ltrim(Item *a) :Item_func_trim(a) {} String *val_str(String *); const char *func_name() const { return "ltrim"; } const char *mode_name() const { return "leading"; } }; class Item_func_rtrim :public Item_func_trim { public: Item_func_rtrim(Item *a,Item *b) :Item_func_trim(a,b) {} Item_func_rtrim(Item *a) :Item_func_trim(a) {} String *val_str(String *); const char *func_name() const { return "rtrim"; } const char *mode_name() const { return "trailing"; } }; /* Item_func_password -- new (4.1.1) PASSWORD() function implementation. Returns strcat('*', octet2hex(sha1(sha1(password)))). '*' stands for new password format, sha1(sha1(password) is so-called hash_stage2 value. Length of returned string is always 41 byte. To find out how entire authentication procedure works, see comments in password.c. */ class Item_func_password :public Item_str_func { char tmp_value[SCRAMBLED_PASSWORD_CHAR_LENGTH+1]; public: Item_func_password(Item *a) :Item_str_func(a) {} String *val_str(String *str); void fix_length_and_dec() { max_length= SCRAMBLED_PASSWORD_CHAR_LENGTH; } const char *func_name() const { return "password"; } static char *alloc(THD *thd, const char *password); }; /* Item_func_old_password -- PASSWORD() implementation used in MySQL 3.21 - 4.0 compatibility mode. This item is created in sql_yacc.yy when 'old_passwords' session variable is set, and to handle OLD_PASSWORD() function. */ class Item_func_old_password :public Item_str_func { char tmp_value[SCRAMBLED_PASSWORD_CHAR_LENGTH_323+1]; public: Item_func_old_password(Item *a) :Item_str_func(a) {} String *val_str(String *str); void fix_length_and_dec() { max_length= SCRAMBLED_PASSWORD_CHAR_LENGTH_323; } const char *func_name() const { return "old_password"; } static char *alloc(THD *thd, const char *password); }; class Item_func_des_encrypt :public Item_str_func { String tmp_value; public: Item_func_des_encrypt(Item *a) :Item_str_func(a) {} Item_func_des_encrypt(Item *a, Item *b): Item_str_func(a,b) {} String *val_str(String *); void fix_length_and_dec() { maybe_null=1; max_length = args[0]->max_length+8; } const char *func_name() const { return "des_encrypt"; } }; class Item_func_des_decrypt :public Item_str_func { String tmp_value; public: Item_func_des_decrypt(Item *a) :Item_str_func(a) {} Item_func_des_decrypt(Item *a, Item *b): Item_str_func(a,b) {} String *val_str(String *); void fix_length_and_dec() { maybe_null=1; max_length = args[0]->max_length; } const char *func_name() const { return "des_decrypt"; } }; class Item_func_encrypt :public Item_str_func { String tmp_value; /* Encapsulate common constructor actions */ void constructor_helper() { collation.set(&my_charset_bin); } public: Item_func_encrypt(Item *a) :Item_str_func(a) { constructor_helper(); } Item_func_encrypt(Item *a, Item *b): Item_str_func(a,b) { constructor_helper(); } String *val_str(String *); void fix_length_and_dec() { maybe_null=1; max_length = 13; } const char *func_name() const { return "encrypt"; } }; #include "sql_crypt.h" class Item_func_encode :public Item_str_func { protected: SQL_CRYPT sql_crypt; String seed; public: Item_func_encode(Item *a, char *seed_arg): Item_str_func(a), sql_crypt(seed_arg) { seed.copy(seed_arg, strlen(seed_arg), default_charset_info); } String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "encode"; } void print(String *str); }; class Item_func_decode :public Item_func_encode { public: Item_func_decode(Item *a, char *seed_arg): Item_func_encode(a, seed_arg) {} String *val_str(String *); const char *func_name() const { return "decode"; } }; class Item_func_sysconst :public Item_str_func { public: Item_func_sysconst() { collation.set(system_charset_info,DERIVATION_SYSCONST); } Item *safe_charset_converter(CHARSET_INFO *tocs); /* Used to create correct Item name in new converted item in safe_charset_converter, return string representation of this function call */ virtual const char *fully_qualified_func_name() const = 0; }; class Item_func_database :public Item_func_sysconst { public: Item_func_database() :Item_func_sysconst() {} String *val_str(String *); void fix_length_and_dec() { max_length= MAX_FIELD_NAME * system_charset_info->mbmaxlen; maybe_null=1; } const char *func_name() const { return "database"; } const char *fully_qualified_func_name() const { return "database()"; } }; class Item_func_user :public Item_func_sysconst { protected: bool init (const char *user, const char *host); public: Item_func_user() { str_value.set("", 0, system_charset_info); } String *val_str(String *) { DBUG_ASSERT(fixed == 1); return (null_value ? 0 : &str_value); } bool fix_fields(THD *thd, Item **ref); void fix_length_and_dec() { max_length= ((USERNAME_LENGTH + HOSTNAME_LENGTH + 1) * system_charset_info->mbmaxlen); } const char *func_name() const { return "user"; } const char *fully_qualified_func_name() const { return "user()"; } }; class Item_func_current_user :public Item_func_user { Name_resolution_context *context; public: Item_func_current_user(Name_resolution_context *context_arg) : context(context_arg) {} bool fix_fields(THD *thd, Item **ref); const char *func_name() const { return "current_user"; } const char *fully_qualified_func_name() const { return "current_user()"; } }; class Item_func_soundex :public Item_str_func { String tmp_value; public: Item_func_soundex(Item *a) :Item_str_func(a) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "soundex"; } }; class Item_func_elt :public Item_str_func { public: Item_func_elt(List<Item> &list) :Item_str_func(list) {} double val_real(); longlong val_int(); String *val_str(String *str); void fix_length_and_dec(); const char *func_name() const { return "elt"; } }; class Item_func_make_set :public Item_str_func { Item *item; String tmp_str; public: Item_func_make_set(Item *a,List<Item> &list) :Item_str_func(list),item(a) {} String *val_str(String *str); bool fix_fields(THD *thd, Item **ref) { DBUG_ASSERT(fixed == 0); return ((!item->fixed && item->fix_fields(thd, &item)) || item->check_cols(1) || Item_func::fix_fields(thd, ref)); } void split_sum_func(THD *thd, Item **ref_pointer_array, List<Item> &fields); void fix_length_and_dec(); void update_used_tables(); const char *func_name() const { return "make_set"; } bool walk(Item_processor processor, byte *arg) { return item->walk(processor, arg) || Item_str_func::walk(processor, arg); } Item *transform(Item_transformer transformer, byte *arg); void print(String *str); }; class Item_func_format :public Item_str_func { String tmp_str; public: Item_func_format(Item *org,int dec); String *val_str(String *); void fix_length_and_dec() { collation.set(default_charset()); uint char_length= args[0]->max_length/args[0]->collation.collation->mbmaxlen; max_length= ((char_length + (char_length-args[0]->decimals)/3) * collation.collation->mbmaxlen); } const char *func_name() const { return "format"; } void print(String *); }; class Item_func_char :public Item_str_func { public: Item_func_char(List<Item> &list) :Item_str_func(list) { collation.set(&my_charset_bin); } Item_func_char(List<Item> &list, CHARSET_INFO *cs) :Item_str_func(list) { collation.set(cs); } String *val_str(String *); void fix_length_and_dec() { max_length= arg_count * collation.collation->mbmaxlen; } const char *func_name() const { return "char"; } }; class Item_func_repeat :public Item_str_func { String tmp_value; public: Item_func_repeat(Item *arg1,Item *arg2) :Item_str_func(arg1,arg2) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "repeat"; } }; class Item_func_rpad :public Item_str_func { String tmp_value, rpad_str; public: Item_func_rpad(Item *arg1,Item *arg2,Item *arg3) :Item_str_func(arg1,arg2,arg3) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "rpad"; } }; class Item_func_lpad :public Item_str_func { String tmp_value, lpad_str; public: Item_func_lpad(Item *arg1,Item *arg2,Item *arg3) :Item_str_func(arg1,arg2,arg3) {} String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "lpad"; } }; class Item_func_conv :public Item_str_func { public: Item_func_conv(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {} const char *func_name() const { return "conv"; } String *val_str(String *); void fix_length_and_dec() { collation.set(default_charset()); max_length= 64; } }; class Item_func_hex :public Item_str_func { String tmp_value; public: Item_func_hex(Item *a) :Item_str_func(a) {} const char *func_name() const { return "hex"; } String *val_str(String *); void fix_length_and_dec() { collation.set(default_charset()); decimals=0; max_length=args[0]->max_length*2*collation.collation->mbmaxlen; } }; class Item_func_unhex :public Item_str_func { String tmp_value; public: Item_func_unhex(Item *a) :Item_str_func(a) { /* there can be bad hex strings */ maybe_null= 1; } const char *func_name() const { return "unhex"; } String *val_str(String *); void fix_length_and_dec() { collation.set(&my_charset_bin); decimals=0; max_length=(1+args[0]->max_length)/2; } }; class Item_func_binary :public Item_str_func { public: Item_func_binary(Item *a) :Item_str_func(a) {} String *val_str(String *a) { DBUG_ASSERT(fixed == 1); String *tmp=args[0]->val_str(a); null_value=args[0]->null_value; if (tmp) tmp->set_charset(&my_charset_bin); return tmp; } void fix_length_and_dec() { collation.set(&my_charset_bin); max_length=args[0]->max_length; } void print(String *str); const char *func_name() const { return "cast_as_binary"; } }; class Item_load_file :public Item_str_func { String tmp_value; public: Item_load_file(Item *a) :Item_str_func(a) {} String *val_str(String *); const char *func_name() const { return "load_file"; } void fix_length_and_dec() { collation.set(&my_charset_bin, DERIVATION_COERCIBLE); maybe_null=1; max_length=MAX_BLOB_WIDTH; } }; class Item_func_export_set: public Item_str_func { public: Item_func_export_set(Item *a,Item *b,Item* c) :Item_str_func(a,b,c) {} Item_func_export_set(Item *a,Item *b,Item* c,Item* d) :Item_str_func(a,b,c,d) {} Item_func_export_set(Item *a,Item *b,Item* c,Item* d,Item* e) :Item_str_func(a,b,c,d,e) {} String *val_str(String *str); void fix_length_and_dec(); const char *func_name() const { return "export_set"; } }; class Item_func_inet_ntoa : public Item_str_func { public: Item_func_inet_ntoa(Item *a) :Item_str_func(a) { } String* val_str(String* str); const char *func_name() const { return "inet_ntoa"; } void fix_length_and_dec() { decimals = 0; max_length=3*8+7; } }; class Item_func_quote :public Item_str_func { String tmp_value; public: Item_func_quote(Item *a) :Item_str_func(a) {} const char *func_name() const { return "quote"; } String *val_str(String *); void fix_length_and_dec() { collation.set(args[0]->collation); max_length= args[0]->max_length * 2 + 2; } }; class Item_func_conv_charset :public Item_str_func { bool use_cached_value; public: bool safe; CHARSET_INFO *conv_charset; // keep it public Item_func_conv_charset(Item *a, CHARSET_INFO *cs) :Item_str_func(a) { conv_charset= cs; use_cached_value= 0; safe= 0; } Item_func_conv_charset(Item *a, CHARSET_INFO *cs, bool cache_if_const) :Item_str_func(a) { DBUG_ASSERT(args[0]->fixed); conv_charset= cs; if (cache_if_const && args[0]->const_item()) { uint errors= 0; String tmp, *str= args[0]->val_str(&tmp); if (!str || str_value.copy(str->ptr(), str->length(), str->charset(), conv_charset, &errors)) null_value= 1; use_cached_value= 1; str_value.mark_as_const(); safe= (errors == 0); } else { use_cached_value= 0; /* Conversion from and to "binary" is safe. Conversion to Unicode is safe. Other kind of conversions are potentially lossy. */ safe= (args[0]->collation.collation == &my_charset_bin || cs == &my_charset_bin || (cs->state & MY_CS_UNICODE)); } } String *val_str(String *); void fix_length_and_dec(); const char *func_name() const { return "convert"; } void print(String *str); }; class Item_func_set_collation :public Item_str_func { public: Item_func_set_collation(Item *a, Item *b) :Item_str_func(a,b) {}; String *val_str(String *); void fix_length_and_dec(); bool eq(const Item *item, bool binary_cmp) const; const char *func_name() const { return "collate"; } enum Functype functype() const { return COLLATE_FUNC; } void print(String *str); Item_field *filed_for_view_update() { /* this function is transparent for view updating */ return args[0]->filed_for_view_update(); } }; class Item_func_charset :public Item_str_func { public: Item_func_charset(Item *a) :Item_str_func(a) {} String *val_str(String *); const char *func_name() const { return "charset"; } void fix_length_and_dec() { collation.set(system_charset_info); max_length= 64 * collation.collation->mbmaxlen; // should be enough maybe_null= 0; }; table_map not_null_tables() const { return 0; } }; class Item_func_collation :public Item_str_func { public: Item_func_collation(Item *a) :Item_str_func(a) {} String *val_str(String *); const char *func_name() const { return "collation"; } void fix_length_and_dec() { collation.set(system_charset_info); max_length= 64 * collation.collation->mbmaxlen; // should be enough maybe_null= 0; }; table_map not_null_tables() const { return 0; } }; class Item_func_crc32 :public Item_int_func { String value; public: Item_func_crc32(Item *a) :Item_int_func(a) { unsigned_flag= 1; } const char *func_name() const { return "crc32"; } void fix_length_and_dec() { max_length=10; } longlong val_int(); }; class Item_func_uncompressed_length : public Item_int_func { String value; public: Item_func_uncompressed_length(Item *a):Item_int_func(a){} const char *func_name() const{return "uncompressed_length";} void fix_length_and_dec() { max_length=10; } longlong val_int(); }; #ifdef HAVE_COMPRESS #define ZLIB_DEPENDED_FUNCTION ; #else #define ZLIB_DEPENDED_FUNCTION { null_value=1; return 0; } #endif class Item_func_compress: public Item_str_func { String buffer; public: Item_func_compress(Item *a):Item_str_func(a){} void fix_length_and_dec(){max_length= (args[0]->max_length*120)/100+12;} const char *func_name() const{return "compress";} String *val_str(String *) ZLIB_DEPENDED_FUNCTION }; class Item_func_uncompress: public Item_str_func { String buffer; public: Item_func_uncompress(Item *a): Item_str_func(a){} void fix_length_and_dec(){ maybe_null= 1; max_length= MAX_BLOB_WIDTH; } const char *func_name() const{return "uncompress";} String *val_str(String *) ZLIB_DEPENDED_FUNCTION }; #define UUID_LENGTH (8+1+4+1+4+1+4+1+12) class Item_func_uuid: public Item_str_func { public: Item_func_uuid(): Item_str_func() {} void fix_length_and_dec() { collation.set(system_charset_info); /* NOTE! uuid() should be changed to use 'ascii' charset when hex(), format(), md5(), etc, and implicit number-to-string conversion will use 'ascii' */ max_length= UUID_LENGTH * system_charset_info->mbmaxlen; } const char *func_name() const{ return "uuid"; } String *val_str(String *); };