1
/* Copyright (C) 2000-2003 MySQL AB
3
This program is free software; you can redistribute it and/or modify
4
it under the terms of the GNU General Public License as published by
5
the Free Software Foundation; version 2 of the License.
7
This program is distributed in the hope that it will be useful,
8
but WITHOUT ANY WARRANTY; without even the implied warranty of
9
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10
GNU General Public License for more details.
12
You should have received a copy of the GNU General Public License
13
along with this program; if not, write to the Free Software
14
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
17
/* This file defines all string functions */
19
#ifdef USE_PRAGMA_INTERFACE
20
#pragma interface /* gcc class implementation */
23
class Item_str_func :public Item_func
26
Item_str_func() :Item_func() { decimals=NOT_FIXED_DEC; }
27
Item_str_func(Item *a) :Item_func(a) {decimals=NOT_FIXED_DEC; }
28
Item_str_func(Item *a,Item *b) :Item_func(a,b) { decimals=NOT_FIXED_DEC; }
29
Item_str_func(Item *a,Item *b,Item *c) :Item_func(a,b,c) { decimals=NOT_FIXED_DEC; }
30
Item_str_func(Item *a,Item *b,Item *c,Item *d) :Item_func(a,b,c,d) {decimals=NOT_FIXED_DEC; }
31
Item_str_func(Item *a,Item *b,Item *c,Item *d, Item* e) :Item_func(a,b,c,d,e) {decimals=NOT_FIXED_DEC; }
32
Item_str_func(List<Item> &list) :Item_func(list) {decimals=NOT_FIXED_DEC; }
35
my_decimal *val_decimal(my_decimal *);
36
enum Item_result result_type () const { return STRING_RESULT; }
37
void left_right_max_length();
38
bool fix_fields(THD *thd, Item **ref);
41
class Item_func_md5 :public Item_str_func
45
Item_func_md5(Item *a) :Item_str_func(a)
47
collation.set(&my_charset_bin);
49
String *val_str(String *);
50
void fix_length_and_dec();
51
const char *func_name() const { return "md5"; }
54
class Item_func_aes_encrypt :public Item_str_func
57
Item_func_aes_encrypt(Item *a, Item *b) :Item_str_func(a,b) {}
58
String *val_str(String *);
59
void fix_length_and_dec();
60
const char *func_name() const { return "aes_encrypt"; }
63
class Item_func_aes_decrypt :public Item_str_func
66
Item_func_aes_decrypt(Item *a, Item *b) :Item_str_func(a,b) {}
67
String *val_str(String *);
68
void fix_length_and_dec();
69
const char *func_name() const { return "aes_decrypt"; }
73
class Item_func_concat :public Item_str_func
77
Item_func_concat(List<Item> &list) :Item_str_func(list) {}
78
Item_func_concat(Item *a,Item *b) :Item_str_func(a,b) {}
79
String *val_str(String *);
80
void fix_length_and_dec();
81
const char *func_name() const { return "concat"; }
84
class Item_func_concat_ws :public Item_str_func
88
Item_func_concat_ws(List<Item> &list) :Item_str_func(list) {}
89
String *val_str(String *);
90
void fix_length_and_dec();
91
const char *func_name() const { return "concat_ws"; }
92
table_map not_null_tables() const { return 0; }
95
class Item_func_reverse :public Item_str_func
99
Item_func_reverse(Item *a) :Item_str_func(a) {}
100
String *val_str(String *);
101
void fix_length_and_dec();
102
const char *func_name() const { return "reverse"; }
106
class Item_func_replace :public Item_str_func
108
String tmp_value,tmp_value2;
110
Item_func_replace(Item *org,Item *find,Item *replace)
111
:Item_str_func(org,find,replace) {}
112
String *val_str(String *);
113
void fix_length_and_dec();
114
const char *func_name() const { return "replace"; }
118
class Item_func_insert :public Item_str_func
122
Item_func_insert(Item *org,Item *start,Item *length,Item *new_str)
123
:Item_str_func(org,start,length,new_str) {}
124
String *val_str(String *);
125
void fix_length_and_dec();
126
const char *func_name() const { return "insert"; }
130
class Item_str_conv :public Item_str_func
134
my_charset_conv_case converter;
137
Item_str_conv(Item *item) :Item_str_func(item) {}
138
String *val_str(String *);
142
class Item_func_lcase :public Item_str_conv
145
Item_func_lcase(Item *item) :Item_str_conv(item) {}
146
const char *func_name() const { return "lcase"; }
147
void fix_length_and_dec();
150
class Item_func_ucase :public Item_str_conv
153
Item_func_ucase(Item *item) :Item_str_conv(item) {}
154
const char *func_name() const { return "ucase"; }
155
void fix_length_and_dec();
159
class Item_func_left :public Item_str_func
163
Item_func_left(Item *a,Item *b) :Item_str_func(a,b) {}
164
String *val_str(String *);
165
void fix_length_and_dec();
166
const char *func_name() const { return "left"; }
170
class Item_func_right :public Item_str_func
174
Item_func_right(Item *a,Item *b) :Item_str_func(a,b) {}
175
String *val_str(String *);
176
void fix_length_and_dec();
177
const char *func_name() const { return "right"; }
181
class Item_func_substr :public Item_str_func
185
Item_func_substr(Item *a,Item *b) :Item_str_func(a,b) {}
186
Item_func_substr(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {}
187
String *val_str(String *);
188
void fix_length_and_dec();
189
const char *func_name() const { return "substr"; }
193
class Item_func_substr_index :public Item_str_func
197
Item_func_substr_index(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {}
198
String *val_str(String *);
199
void fix_length_and_dec();
200
const char *func_name() const { return "substring_index"; }
204
class Item_func_trim :public Item_str_func
210
Item_func_trim(Item *a,Item *b) :Item_str_func(a,b) {}
211
Item_func_trim(Item *a) :Item_str_func(a) {}
212
String *val_str(String *);
213
void fix_length_and_dec();
214
const char *func_name() const { return "trim"; }
215
virtual void print(String *str, enum_query_type query_type);
216
virtual const char *mode_name() const { return "both"; }
220
class Item_func_ltrim :public Item_func_trim
223
Item_func_ltrim(Item *a,Item *b) :Item_func_trim(a,b) {}
224
Item_func_ltrim(Item *a) :Item_func_trim(a) {}
225
String *val_str(String *);
226
const char *func_name() const { return "ltrim"; }
227
const char *mode_name() const { return "leading"; }
231
class Item_func_rtrim :public Item_func_trim
234
Item_func_rtrim(Item *a,Item *b) :Item_func_trim(a,b) {}
235
Item_func_rtrim(Item *a) :Item_func_trim(a) {}
236
String *val_str(String *);
237
const char *func_name() const { return "rtrim"; }
238
const char *mode_name() const { return "trailing"; }
243
Item_func_password -- new (4.1.1) PASSWORD() function implementation.
244
Returns strcat('*', octet2hex(sha1(sha1(password)))). '*' stands for new
245
password format, sha1(sha1(password) is so-called hash_stage2 value.
246
Length of returned string is always 41 byte. To find out how entire
247
authentication procedure works, see comments in password.c.
250
class Item_func_password :public Item_str_func
252
char tmp_value[SCRAMBLED_PASSWORD_CHAR_LENGTH+1];
254
Item_func_password(Item *a) :Item_str_func(a) {}
255
String *val_str(String *str);
256
void fix_length_and_dec() { max_length= SCRAMBLED_PASSWORD_CHAR_LENGTH; }
257
const char *func_name() const { return "password"; }
258
static char *alloc(THD *thd, const char *password);
261
class Item_func_des_encrypt :public Item_str_func
265
String *val_str(String *);
266
void fix_length_and_dec()
267
{ maybe_null=1; max_length = args[0]->max_length+8; }
268
const char *func_name() const { return "des_encrypt"; }
271
class Item_func_des_decrypt :public Item_str_func
275
String *val_str(String *);
276
void fix_length_and_dec() { maybe_null=1; max_length = args[0]->max_length; }
277
const char *func_name() const { return "des_decrypt"; }
280
class Item_func_encrypt :public Item_str_func
284
/* Encapsulate common constructor actions */
285
void constructor_helper()
287
collation.set(&my_charset_bin);
290
Item_func_encrypt(Item *a) :Item_str_func(a)
292
constructor_helper();
294
Item_func_encrypt(Item *a, Item *b): Item_str_func(a,b)
296
constructor_helper();
298
String *val_str(String *);
299
void fix_length_and_dec() { maybe_null=1; max_length = 13; }
300
const char *func_name() const { return "encrypt"; }
303
#include "sql_crypt.h"
306
class Item_func_encode :public Item_str_func
309
Item_func_encode(Item *a, Item *seed):
310
Item_str_func(a, seed) {}
311
String *val_str(String *);
312
void fix_length_and_dec();
313
const char *func_name() const { return "encode"; }
317
class Item_func_decode :public Item_func_encode
320
Item_func_decode(Item *a, Item *seed): Item_func_encode(a, seed) {}
321
String *val_str(String *);
322
const char *func_name() const { return "decode"; }
326
class Item_func_sysconst :public Item_str_func
330
{ collation.set(system_charset_info,DERIVATION_SYSCONST); }
331
Item *safe_charset_converter(CHARSET_INFO *tocs);
333
Used to create correct Item name in new converted item in
334
safe_charset_converter, return string representation of this function
337
virtual const char *fully_qualified_func_name() const = 0;
341
class Item_func_database :public Item_func_sysconst
344
Item_func_database() :Item_func_sysconst() {}
345
String *val_str(String *);
346
void fix_length_and_dec()
348
max_length= MAX_FIELD_NAME * system_charset_info->mbmaxlen;
351
const char *func_name() const { return "database"; }
352
const char *fully_qualified_func_name() const { return "database()"; }
356
class Item_func_user :public Item_func_sysconst
359
bool init (const char *user, const char *host);
364
str_value.set("", 0, system_charset_info);
366
String *val_str(String *)
369
return (null_value ? 0 : &str_value);
371
bool fix_fields(THD *thd, Item **ref);
372
void fix_length_and_dec()
374
max_length= (USERNAME_CHAR_LENGTH + HOSTNAME_LENGTH + 1) *
375
system_charset_info->mbmaxlen;
377
const char *func_name() const { return "user"; }
378
const char *fully_qualified_func_name() const { return "user()"; }
379
int save_in_field(Field *field,
380
bool no_conversions __attribute__((__unused__)))
382
return save_str_value_in_field(field, &str_value);
387
class Item_func_current_user :public Item_func_user
389
Name_resolution_context *context;
392
Item_func_current_user(Name_resolution_context *context_arg)
393
: context(context_arg) {}
394
bool fix_fields(THD *thd, Item **ref);
395
const char *func_name() const { return "current_user"; }
396
const char *fully_qualified_func_name() const { return "current_user()"; }
400
class Item_func_soundex :public Item_str_func
404
Item_func_soundex(Item *a) :Item_str_func(a) {}
405
String *val_str(String *);
406
void fix_length_and_dec();
407
const char *func_name() const { return "soundex"; }
411
class Item_func_elt :public Item_str_func
414
Item_func_elt(List<Item> &list) :Item_str_func(list) {}
417
String *val_str(String *str);
418
void fix_length_and_dec();
419
const char *func_name() const { return "elt"; }
423
class Item_func_make_set :public Item_str_func
429
Item_func_make_set(Item *a,List<Item> &list) :Item_str_func(list),item(a) {}
430
String *val_str(String *str);
431
bool fix_fields(THD *thd, Item **ref)
434
return ((!item->fixed && item->fix_fields(thd, &item)) ||
435
item->check_cols(1) ||
436
Item_func::fix_fields(thd, ref));
438
void split_sum_func(THD *thd, Item **ref_pointer_array, List<Item> &fields);
439
void fix_length_and_dec();
440
void update_used_tables();
441
const char *func_name() const { return "make_set"; }
443
bool walk(Item_processor processor, bool walk_subquery, uchar *arg)
445
return item->walk(processor, walk_subquery, arg) ||
446
Item_str_func::walk(processor, walk_subquery, arg);
448
Item *transform(Item_transformer transformer, uchar *arg);
449
virtual void print(String *str, enum_query_type query_type);
453
class Item_func_format :public Item_str_func
457
Item_func_format(Item *org, Item *dec);
458
String *val_str(String *);
459
void fix_length_and_dec();
460
const char *func_name() const { return "format"; }
461
virtual void print(String *str, enum_query_type query_type);
465
class Item_func_char :public Item_str_func
468
Item_func_char(List<Item> &list) :Item_str_func(list)
469
{ collation.set(&my_charset_bin); }
470
Item_func_char(List<Item> &list, CHARSET_INFO *cs) :Item_str_func(list)
471
{ collation.set(cs); }
472
String *val_str(String *);
473
void fix_length_and_dec()
475
max_length= arg_count * 4;
477
const char *func_name() const { return "char"; }
481
class Item_func_repeat :public Item_str_func
485
Item_func_repeat(Item *arg1,Item *arg2) :Item_str_func(arg1,arg2) {}
486
String *val_str(String *);
487
void fix_length_and_dec();
488
const char *func_name() const { return "repeat"; }
492
class Item_func_rpad :public Item_str_func
494
String tmp_value, rpad_str;
496
Item_func_rpad(Item *arg1,Item *arg2,Item *arg3)
497
:Item_str_func(arg1,arg2,arg3) {}
498
String *val_str(String *);
499
void fix_length_and_dec();
500
const char *func_name() const { return "rpad"; }
504
class Item_func_lpad :public Item_str_func
506
String tmp_value, lpad_str;
508
Item_func_lpad(Item *arg1,Item *arg2,Item *arg3)
509
:Item_str_func(arg1,arg2,arg3) {}
510
String *val_str(String *);
511
void fix_length_and_dec();
512
const char *func_name() const { return "lpad"; }
516
class Item_func_conv :public Item_str_func
519
Item_func_conv(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {}
520
const char *func_name() const { return "conv"; }
521
String *val_str(String *);
522
void fix_length_and_dec()
524
collation.set(default_charset());
531
class Item_func_hex :public Item_str_func
535
Item_func_hex(Item *a) :Item_str_func(a) {}
536
const char *func_name() const { return "hex"; }
537
String *val_str(String *);
538
void fix_length_and_dec()
540
collation.set(default_charset());
542
max_length=args[0]->max_length*2*collation.collation->mbmaxlen;
546
class Item_func_unhex :public Item_str_func
550
Item_func_unhex(Item *a) :Item_str_func(a)
552
/* there can be bad hex strings */
555
const char *func_name() const { return "unhex"; }
556
String *val_str(String *);
557
void fix_length_and_dec()
559
collation.set(&my_charset_bin);
561
max_length=(1+args[0]->max_length)/2;
566
class Item_func_binary :public Item_str_func
569
Item_func_binary(Item *a) :Item_str_func(a) {}
570
String *val_str(String *a)
573
String *tmp=args[0]->val_str(a);
574
null_value=args[0]->null_value;
576
tmp->set_charset(&my_charset_bin);
579
void fix_length_and_dec()
581
collation.set(&my_charset_bin);
582
max_length=args[0]->max_length;
584
virtual void print(String *str, enum_query_type query_type);
585
const char *func_name() const { return "cast_as_binary"; }
589
class Item_load_file :public Item_str_func
593
Item_load_file(Item *a) :Item_str_func(a) {}
594
String *val_str(String *);
595
const char *func_name() const { return "load_file"; }
596
void fix_length_and_dec()
598
collation.set(&my_charset_bin, DERIVATION_COERCIBLE);
600
max_length=MAX_BLOB_WIDTH;
605
class Item_func_export_set: public Item_str_func
608
Item_func_export_set(Item *a,Item *b,Item* c) :Item_str_func(a,b,c) {}
609
Item_func_export_set(Item *a,Item *b,Item* c,Item* d) :Item_str_func(a,b,c,d) {}
610
Item_func_export_set(Item *a,Item *b,Item* c,Item* d,Item* e) :Item_str_func(a,b,c,d,e) {}
611
String *val_str(String *str);
612
void fix_length_and_dec();
613
const char *func_name() const { return "export_set"; }
616
class Item_func_quote :public Item_str_func
620
Item_func_quote(Item *a) :Item_str_func(a) {}
621
const char *func_name() const { return "quote"; }
622
String *val_str(String *);
623
void fix_length_and_dec()
625
collation.set(args[0]->collation);
626
max_length= args[0]->max_length * 2 + 2;
630
class Item_func_conv_charset :public Item_str_func
632
bool use_cached_value;
635
CHARSET_INFO *conv_charset; // keep it public
636
Item_func_conv_charset(Item *a, CHARSET_INFO *cs) :Item_str_func(a)
637
{ conv_charset= cs; use_cached_value= 0; safe= 0; }
638
Item_func_conv_charset(Item *a, CHARSET_INFO *cs, bool cache_if_const)
641
assert(args[0]->fixed);
643
if (cache_if_const && args[0]->const_item())
646
String tmp, *str= args[0]->val_str(&tmp);
647
if (!str || str_value.copy(str->ptr(), str->length(),
648
str->charset(), conv_charset, &errors))
651
str_value.mark_as_const();
658
Conversion from and to "binary" is safe.
659
Conversion to Unicode is safe.
660
Other kind of conversions are potentially lossy.
662
safe= (args[0]->collation.collation == &my_charset_bin ||
663
cs == &my_charset_bin ||
664
(cs->state & MY_CS_UNICODE));
667
String *val_str(String *);
668
void fix_length_and_dec();
669
const char *func_name() const { return "convert"; }
670
virtual void print(String *str, enum_query_type query_type);
673
class Item_func_set_collation :public Item_str_func
676
Item_func_set_collation(Item *a, Item *b) :Item_str_func(a,b) {};
677
String *val_str(String *);
678
void fix_length_and_dec();
679
bool eq(const Item *item, bool binary_cmp) const;
680
const char *func_name() const { return "collate"; }
681
enum Functype functype() const { return COLLATE_FUNC; }
682
virtual void print(String *str, enum_query_type query_type);
683
Item_field *filed_for_view_update()
685
/* this function is transparent for view updating */
686
return args[0]->filed_for_view_update();
690
class Item_func_charset :public Item_str_func
693
Item_func_charset(Item *a) :Item_str_func(a) {}
694
String *val_str(String *);
695
const char *func_name() const { return "charset"; }
696
void fix_length_and_dec()
698
collation.set(system_charset_info);
699
max_length= 64 * collation.collation->mbmaxlen; // should be enough
702
table_map not_null_tables() const { return 0; }
705
class Item_func_collation :public Item_str_func
708
Item_func_collation(Item *a) :Item_str_func(a) {}
709
String *val_str(String *);
710
const char *func_name() const { return "collation"; }
711
void fix_length_and_dec()
713
collation.set(system_charset_info);
714
max_length= 64 * collation.collation->mbmaxlen; // should be enough
717
table_map not_null_tables() const { return 0; }
721
class Item_func_weight_string :public Item_str_func
727
Item_func_weight_string(Item *a, uint nweights_arg, uint flags_arg)
728
:Item_str_func(a) { nweights= nweights_arg; flags= flags_arg; }
729
const char *func_name() const { return "weight_string"; }
730
String *val_str(String *);
731
void fix_length_and_dec();
735
class Item_func_crc32 :public Item_int_func
739
Item_func_crc32(Item *a) :Item_int_func(a) { unsigned_flag= 1; }
740
const char *func_name() const { return "crc32"; }
741
void fix_length_and_dec() { max_length=10; }
745
class Item_func_uncompressed_length : public Item_int_func
749
Item_func_uncompressed_length(Item *a):Item_int_func(a){}
750
const char *func_name() const{return "uncompressed_length";}
751
void fix_length_and_dec() { max_length=10; }
756
#define ZLIB_DEPENDED_FUNCTION ;
758
#define ZLIB_DEPENDED_FUNCTION { null_value=1; return 0; }
761
class Item_func_compress: public Item_str_func
765
Item_func_compress(Item *a):Item_str_func(a){}
766
void fix_length_and_dec(){max_length= (args[0]->max_length*120)/100+12;}
767
const char *func_name() const{return "compress";}
768
String *val_str(String *) ZLIB_DEPENDED_FUNCTION
771
class Item_func_uncompress: public Item_str_func
775
Item_func_uncompress(Item *a): Item_str_func(a){}
776
void fix_length_and_dec(){ maybe_null= 1; max_length= MAX_BLOB_WIDTH; }
777
const char *func_name() const{return "uncompress";}
778
String *val_str(String *) ZLIB_DEPENDED_FUNCTION
781
#define UUID_LENGTH (8+1+4+1+4+1+4+1+12)
782
class Item_func_uuid: public Item_str_func
785
Item_func_uuid(): Item_str_func() {}
786
void fix_length_and_dec() {
787
collation.set(system_charset_info);
789
NOTE! uuid() should be changed to use 'ascii'
790
charset when hex(), format(), md5(), etc, and implicit
791
number-to-string conversion will use 'ascii'
793
max_length= UUID_LENGTH * system_charset_info->mbmaxlen;
795
const char *func_name() const{ return "uuid"; }
796
String *val_str(String *);