-
Notifications
You must be signed in to change notification settings - Fork 149
/
Copy pathmy_default.cc
1793 lines (1534 loc) · 59 KB
/
my_default.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright (c) 2000, 2024, Oracle and/or its affiliates.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation. The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
Without limiting anything contained in the foregoing, this file,
which is part of C Driver for MySQL (Connector/C), is also subject to the
Universal FOSS Exception, version 1.0, a copy of which can be found at
http://oss.oracle.com/licenses/universal-foss-exception.
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, version 2.0, 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
/**
@file mysys/my_default.cc
Add all options from files named "group".cnf from the default_directories
before the command line arguments.
On Windows defaults will also search in the Windows directory for a file
called 'group'.ini
As long as the program uses the last argument for conflicting
options one only have to add a call to "load_defaults" to enable
use of default values.
pre- and end 'blank space' are removed from options and values. The
following escape sequences are recognized in values: @code \b \t \n \r \\
@endcode
The following arguments are handled automatically; If used, they must be
first argument on the command line!
--no-defaults ; no options are read, except for the ones provided in the
login file.
--defaults-file=full-path-to-default-file ; Only this file will be read.
--defaults-extra-file=full-path-to-default-file ; Read this file before ~/
--defaults-group-suffix ; Also read groups with concat(group, suffix)
--print-defaults ; Print the modified command line and exit
--login-path=login-path-name ; Read options under login-path-name from
the login file.
*/
#include "my_config.h"
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include "m_ctype.h"
#include "m_string.h"
#include "my_aes.h"
#include "my_alloc.h"
#include "my_byteorder.h"
#include "my_compiler.h"
#include "my_dbug.h"
#include "my_default.h"
#include "my_dir.h"
#include "my_getopt.h"
#include "my_inttypes.h"
#include "my_io.h"
#include "my_loglevel.h"
#include "my_macros.h"
#include "my_psi_config.h"
#include "mysql/psi/mysql_file.h"
#include "mysql_version.h" // MYSQL_PERSIST_CONFIG_NAME
#include "mysys/my_default_priv.h"
#include "mysys/mysys_priv.h"
#include "mysys_err.h"
#include "typelib.h"
#ifdef _WIN32
#include <winbase.h>
#endif
#include <algorithm>
#include <map>
#include <string>
#include "prealloced_array.h"
using std::string;
struct my_variable_sources {
string m_config_file_name;
enum_variable_source m_source;
};
/**
Defines mapping between variable names (set as part of config files
or command line) and its config file/source value.
ex: If config file /etc/my.cnf has variables max_connections= 30 and
$datadir/mysqld-auto.cnf has variables max_heap_table_size=887808
then this variable will have following key/value pair.
max_connections -> (/etc/my.cnf , enum_variable_source::GLOBAL)
max_heap_table_size -> ($datadir/mysqld-auto.cnf ,
enum_variable_source::PERSISTED)
*/
static std::map<string, my_variable_sources> variables_hash;
/**
Defines mapping between config files names and its corresponding enum values.
ex: File /etc/my.cnf is mapped to enum_variable_source::GLOBAL
~/.my.cnf is mapped to enum_variable_source::USER
command line options are mapped to enum_variable_source::COMMAND_LINE
*/
static std::map<string, enum_variable_source> default_paths;
/**
Holds a reference to the directory where the persisted configuration
file is located.
This usually is the data directory.
This is different from ::mysql_real_data_home mostly because it's passed down
to mysys. And is also filled in a bit differently from ::mysql_real_data_home
by Persisted_variables_cache::init()
*/
char datadir_buffer[FN_REFLEN] = {0};
#ifdef HAVE_PSI_INTERFACE
extern PSI_file_key key_file_cnf;
#endif
PSI_memory_key key_memory_defaults;
/**
arguments separator
load_defaults() loads arguments from config file and put them
before the arguments from command line, this separator is used to
separate the arguments loaded from config file and arguments user
provided on command line.
Options with value loaded from config file are always in the form
'--option=value', while for command line options, the value can be
given as the next argument. Thus we used a separator so that
handle_options() can distinguish them.
Note: any other places that does not need to distinguish them
should skip the separator.
The content of arguments separator does not matter, one should only
check the pointer, use "----args-separator----" here to ease debug
if someone misused it.
The args separator will only be added when
my_getopt_use_args_seprator is set to TRUE before calling
load_defaults();
See BUG#25192
*/
static const char *args_separator = "----args-separator----";
inline static void set_args_separator(const char **arg) {
assert(my_getopt_use_args_separator);
*arg = args_separator;
}
/*
persisted arguments separator
This argument separator string is used to separate arguments loaded
from persisted config file and command line arguments. This string
is placed after command line options if there are any read only
persisted variables in persisted config file.
*/
static const char *persist_args_separator = "----persist-args-separator----";
void set_persist_args_separator(char **arg) {
*arg = const_cast<char *>(persist_args_separator);
}
bool my_getopt_is_ro_persist_args_separator(const char *arg) {
return (arg == persist_args_separator);
}
/*
This flag indicates that the argument separator string
(args_separator) should be added to the list of arguments,
in order to separate arguments received from config file
and command line.
*/
bool my_getopt_use_args_separator = false;
bool my_getopt_is_args_separator(const char *arg) {
return (arg == args_separator);
}
const char *my_defaults_file = nullptr;
const char *my_defaults_group_suffix = nullptr;
const char *my_defaults_extra_file = nullptr;
static const char *my_login_path = nullptr;
static char my_defaults_file_buffer[FN_REFLEN];
static char my_defaults_extra_file_buffer[FN_REFLEN];
static bool defaults_already_read = false;
/* Set to TRUE, if --no-defaults is found. */
bool no_defaults = false;
#ifdef WITH_WSREP
/*
Cache full path of my.cnf along with group suffix.
This needs to be passed to sst process.
*/
char wsrep_defaults_file[FN_REFLEN + 10] = {
0,
};
static const char wsrep_defaults_group_suffix_empty = '\0';
const char *wsrep_defaults_group_suffix = &wsrep_defaults_group_suffix_empty;
#endif /* WITH_WREP */
/* Which directories are searched for options (and in which order) */
#define MAX_DEFAULT_DIRS 6
#define DEFAULT_DIRS_SIZE (MAX_DEFAULT_DIRS + 1) /* Terminate with NULL */
static const char **default_directories = nullptr;
#ifdef _WIN32
static const char *f_extensions[] = {".ini", ".cnf", 0};
#else
static const char *f_extensions[] = {".cnf", nullptr};
#endif
extern "C" {
static int handle_default_option(void *in_ctx, const char *group_name,
const char *option, const char *cnf_file);
}
/*
This structure defines the context that we pass to callback
function 'handle_default_option' used in search_default_file
to process each option. This context is used if search_default_file
was called from load_defaults.
*/
typedef Prealloced_array<char *, 100> My_args;
struct handle_option_ctx {
MEM_ROOT *alloc;
My_args *m_args;
TYPELIB *group;
};
static int search_default_file(Process_option_func func, void *func_ctx,
const char *dir, const char *config_file,
bool is_login_file);
static int search_default_file_with_ext(Process_option_func func,
void *func_ctx, const char *dir,
const char *ext,
const char *config_file,
int recursion_level, bool is_login_file,
bool report_os_error_on_open);
using mysql_file_getline_ret = std::unique_ptr<char, decltype(std::free) *>;
static mysql_file_getline_ret mysql_file_getline(char *str, int size,
MYSQL_FILE *file,
bool is_login_file)
MY_ATTRIBUTE((nonnull));
/**
Create the list of default directories.
@verbatim
The directories searched, in order, are:
- Windows: GetSystemWindowsDirectory()
- Windows: GetWindowsDirectory()
- Windows: C:/
- Windows: Directory above where the executable is located
- Unix: /etc/
- Unix: /etc/mysql/
- Unix: --sysconfdir=<path> (compile-time option)
- ALL: getenv("MYSQL_HOME")
- ALL: --defaults-extra-file=<path> (run-time option)
- Unix: ~/
@endverbatim
On all systems, if a directory is already in the list, it will be moved
to the end of the list. This avoids reading defaults files multiple times,
while ensuring the correct precedence.
@param alloc MEM_ROOT where the list of directories is stored
@retval NULL Failure (out of memory, probably)
@retval other Pointer to NULL-terminated array of default directories
*/
static const char **init_default_directories(MEM_ROOT *alloc);
static char *remove_end_comment(char *ptr);
/*
Expand a file name so that the current working directory is added if
the name is relative.
RETURNS
0 All OK
2 Out of memory or path too long
3 Not able to get working directory
*/
static int fn_expand(const char *filename, char *result_buf) {
char dir[FN_REFLEN];
const int flags = MY_UNPACK_FILENAME | MY_SAFE_PATH | MY_RELATIVE_PATH;
DBUG_TRACE;
DBUG_PRINT("enter", ("filename: %s, result_buf: %p", filename, result_buf));
if (my_getwd(dir, sizeof(dir), MYF(0))) return 3;
DBUG_PRINT("debug", ("dir: %s", dir));
if (fn_format(result_buf, filename, dir, "", flags) == nullptr) return 2;
DBUG_PRINT("return", ("result: %s", result_buf));
return 0;
}
/*
Process config files in default directories.
SYNOPSIS
my_search_option_files()
conf_file Basename for configuration file to search for.
If this is a path, then only this file is read.
argc Pointer to argc of original program
argv Pointer to argv of original program
args_used Pointer to variable for storing the number of
arguments used.
func Pointer to the function to process options
func_ctx It's context. Usually it is the structure to
store additional options.
default_directories List of default directories.
found_no_defaults TRUE, if --no-defaults is specified.
DESCRIPTION
Process the default options from argc & argv
Read through each found config file looks and calls 'func' to process
each option. This function also reads options from login file.
NOTES
--defaults-group-suffix is only processed if we are called from
load_defaults().
RETURN
0 ok
1 given cinf_file doesn't exist
2 out of memory
3 Can't get current working directory
The global variable 'my_defaults_group_suffix' is updated with value for
--defaults_group_suffix
*/
int my_search_option_files(const char *conf_file, int *argc, char ***argv,
uint *args_used, Process_option_func func,
void *func_ctx, const char **default_directories,
bool is_login_file, bool found_no_defaults) {
const char **dirs;
char *forced_default_file, *forced_extra_defaults;
DBUG_TRACE;
/* Skip for login file. */
if (!is_login_file) {
/* Check if we want to force the use a specific default file */
*args_used += get_defaults_options(
*argc - *args_used, *argv + *args_used, &forced_default_file,
&forced_extra_defaults, const_cast<char **>(&my_defaults_group_suffix),
const_cast<char **>(&my_login_path), found_no_defaults);
if (!my_defaults_group_suffix)
my_defaults_group_suffix = getenv("MYSQL_GROUP_SUFFIX");
if (forced_extra_defaults && !defaults_already_read) {
int error =
fn_expand(forced_extra_defaults, my_defaults_extra_file_buffer);
if (error) return error;
my_defaults_extra_file = my_defaults_extra_file_buffer;
}
if (forced_default_file && !defaults_already_read) {
int error = fn_expand(forced_default_file, my_defaults_file_buffer);
if (error) return error;
my_defaults_file = my_defaults_file_buffer;
}
defaults_already_read = true;
init_variable_default_paths();
/*
We can only handle 'defaults-group-suffix' if we are called from
load_defaults() as otherwise we can't know the type of 'func_ctx'
*/
if (my_defaults_group_suffix && func == handle_default_option) {
/* Handle --defaults-group-suffix= */
uint i;
const char **extra_groups;
const size_t instance_len = strlen(my_defaults_group_suffix);
struct handle_option_ctx *ctx = (struct handle_option_ctx *)func_ctx;
char *ptr;
TYPELIB *group = ctx->group;
if (!(extra_groups = (const char **)ctx->alloc->Alloc(
(2 * group->count + 1) * sizeof(char *))))
return 2;
for (i = 0; i < group->count; i++) {
size_t len;
extra_groups[i] = group->type_names[i]; /** copy group */
len = strlen(extra_groups[i]);
if (!(ptr = (char *)ctx->alloc->Alloc((uint)(len + instance_len + 1))))
return 2;
extra_groups[i + group->count] = ptr;
/** Construct new group */
memcpy(ptr, extra_groups[i], len);
memcpy(ptr + len, my_defaults_group_suffix, instance_len + 1);
}
group->count *= 2;
group->type_names = extra_groups;
group->type_names[group->count] = nullptr;
}
} else if (my_login_path && func == handle_default_option) {
/* Handle --login_path= */
uint i;
size_t len;
const char **extra_groups;
size_t instance_len = 0;
struct handle_option_ctx *ctx = (struct handle_option_ctx *)func_ctx;
char *ptr;
TYPELIB *group = ctx->group;
if (!(extra_groups = (const char **)ctx->alloc->Alloc((group->count + 3) *
sizeof(char *))))
return 2;
for (i = 0; i < group->count; i++) {
extra_groups[i] = group->type_names[i]; /** copy group */
}
extra_groups[i] = my_login_path;
if (my_defaults_group_suffix && func == handle_default_option) {
instance_len = strlen(my_defaults_group_suffix);
len = strlen(extra_groups[i]);
if (!(ptr = (char *)ctx->alloc->Alloc((uint)(len + instance_len + 1))))
return 2;
extra_groups[i + 1] = ptr;
/** Construct new group */
memcpy(ptr, extra_groups[i], len);
memcpy(ptr + len, my_defaults_group_suffix, instance_len + 1);
group->count += 1;
}
group->count += 1;
group->type_names = extra_groups;
group->type_names[group->count] = nullptr;
}
// If conf_file is an absolute path, we only read it
if (dirname_length(conf_file)) {
int error;
if ((error = search_default_file(func, func_ctx, NullS, conf_file,
is_login_file)) < 0)
goto err;
}
// If my defaults file is set (from a previous run), we read it
else if (my_defaults_file) {
int error;
if ((error = search_default_file_with_ext(func, func_ctx, "", "",
my_defaults_file, 0,
is_login_file, false)) < 0)
goto err;
if (error > 0) {
my_message_local(ERROR_LEVEL, EE_FAILED_TO_OPEN_DEFAULTS_FILE,
my_defaults_file);
goto err;
}
} else if (!found_no_defaults) {
for (dirs = default_directories; *dirs; dirs++) {
if (**dirs) {
if (search_default_file(func, func_ctx, *dirs, conf_file,
is_login_file) < 0)
goto err;
} else if (my_defaults_extra_file) {
int error;
if ((error = search_default_file_with_ext(func, func_ctx, "", "",
my_defaults_extra_file, 0,
is_login_file, false)) < 0)
goto err; /* Fatal error */
if (error > 0) {
my_message_local(ERROR_LEVEL, EE_FAILED_TO_OPEN_DEFAULTS_FILE,
my_defaults_extra_file);
goto err;
}
}
}
}
return 0;
err:
my_message_local(ERROR_LEVEL, EE_FAILED_TO_HANDLE_DEFAULTS_FILE);
return 1;
}
/*
The option handler for load_defaults.
SYNOPSIS
handle_deault_option()
in_ctx Handler context. In this case it is a
handle_option_ctx structure.
group_name The name of the group the option belongs to.
option The very option to be processed. It is already
prepared to be used in argv (has -- prefix). If it
is NULL, we are handling a new group (section).
cnf_file Config file name with absolute file path.
DESCRIPTION
This handler checks whether a group is one of the listed and adds an option
to the array if yes. Some other handler can record, for instance, all
groups and their options, not knowing in advance the names and amount of
groups.
RETURN
0 - ok
1 - error occurred
*/
static int handle_default_option(void *in_ctx, const char *group_name,
const char *option, const char *cnf_file) {
char *tmp;
struct handle_option_ctx *ctx = (struct handle_option_ctx *)in_ctx;
if (!option) return 0;
if (find_type(group_name, ctx->group, FIND_TYPE_NO_PREFIX)) {
if (!(tmp = (char *)ctx->alloc->Alloc(strlen(option) + 1))) return 1;
if (ctx->m_args->push_back(tmp)) return 1;
my_stpcpy(tmp, option);
update_variable_source(option, cnf_file);
}
return 0;
}
/*
Gets options from the command line, however if --no-defaults
option is used, --defaults-file & --defaults-extra-file options
would be ignored.
SYNOPSIS
get_defaults_options()
argc Pointer to argc of original program
argv Pointer to argv of original program
defaults --defaults-file option
extra_defaults --defaults-extra-file option
group_suffix --defaults-group-suffix option
login_path --login-path option
RETURN
# Number of arguments used from *argv
defaults and extra_defaults will be set to option of the appropriate
items of argv array, or to NULL if there are no such options
*/
int get_defaults_options(int argc, char **argv, char **defaults,
char **extra_defaults, char **group_suffix,
char **login_path, bool found_no_defaults) {
int org_argc = argc, prev_argc = 0, default_option_count = 0;
*defaults = *extra_defaults = *group_suffix = *login_path = nullptr;
while (argc >= 2 && argc != prev_argc) {
/* Skip program name or previously handled argument */
argv++;
prev_argc = argc; /* To check if we found */
/* --no-defaults is always the first option. */
if (is_prefix(*argv, "--no-defaults") && !default_option_count) {
argc--;
default_option_count++;
continue;
}
if (!*defaults && is_prefix(*argv, "--defaults-file=") &&
!found_no_defaults) {
*defaults = *argv + sizeof("--defaults-file=") - 1;
argc--;
default_option_count++;
continue;
}
if (!*extra_defaults && is_prefix(*argv, "--defaults-extra-file=") &&
!found_no_defaults) {
*extra_defaults = *argv + sizeof("--defaults-extra-file=") - 1;
argc--;
default_option_count++;
continue;
}
if (!*group_suffix && is_prefix(*argv, "--defaults-group-suffix=")) {
*group_suffix = *argv + sizeof("--defaults-group-suffix=") - 1;
#ifdef WITH_WSREP
/* make sure we do this only once - for top-level file */
if ('\0' == wsrep_defaults_group_suffix[0])
wsrep_defaults_group_suffix = *group_suffix;
#endif /* WITH_WSREP */
argc--;
default_option_count++;
continue;
}
if (!*login_path && is_prefix(*argv, "--login-path=")) {
*login_path = *argv + sizeof("--login-path=") - 1;
argc--;
default_option_count++;
continue;
}
}
return org_argc - argc;
}
/*
Wrapper around my_load_defaults() for interface compatibility.
SYNOPSIS
load_defaults()
conf_file Basename for configuration file to search for.
If this is a path, then only this file is read.
groups Which [group] entries to read.
Points to an null terminated array of pointers
argc Pointer to argc of original program
argv Pointer to argv of original program
alloc MEM_ROOT to allocate new argv on
NOTES
This function is NOT thread-safe as it uses a global pointer internally.
See also notes for my_load_defaults().
RETURN
0 ok
1 The given conf_file didn't exists
*/
int load_defaults(const char *conf_file, const char **groups, int *argc,
char ***argv, MEM_ROOT *alloc) {
return my_load_defaults(conf_file, groups, argc, argv, alloc,
&default_directories);
}
/** A global to turn off or on reading the mylogin file. On by default */
bool my_defaults_read_login_file = true;
/*
Read options from configurations files
SYNOPSIS
my_load_defaults()
conf_file Basename for configuration file to search for.
If this is a path, then only this file is read.
groups Which [group] entries to read.
Points to an null terminated array of pointers
argc Pointer to argc of original program
argv Pointer to argv of original program
alloc MEM_ROOT to allocate new argv on
default_directories Pointer to a location where a pointer to the
list of default directories will be stored
IMPLEMENTATION
Read options from configuration files and put them BEFORE the arguments
that are already in argc and argv. This way the calling program can
easily command line options override options in configuration files
NOTES
In case of fatal error, the function will print a warning and do
exit(1)
argv will be replaced with a set of filtered arguments, allocated on
the MEM_ROOT given in as "alloc". You must free this MEM_ROOT yourself.
RETURN
- If successful, 0 is returned. If 'default_directories' is not NULL,
a pointer to the array of default directory paths is stored to a location
it points to. That stored value must be passed to my_search_option_files()
later.
- 1 is returned if the given conf_file didn't exist. In this case, the
value pointed to by default_directories is undefined.
*/
int my_load_defaults(const char *conf_file, const char **groups, int *argc,
char ***argv, MEM_ROOT *alloc,
const char ***default_directories) {
My_args my_args(key_memory_defaults);
TYPELIB group;
bool found_print_defaults = false;
uint args_used = 0;
int error = 0;
const char **ptr;
const char **res;
struct handle_option_ctx ctx;
const char **dirs;
char my_login_file[FN_REFLEN];
bool found_no_defaults = false;
uint args_sep = my_getopt_use_args_separator ? 1 : 0;
DBUG_TRACE;
if ((dirs = init_default_directories(alloc)) == nullptr) goto err;
/*
Check if the user doesn't want any default option processing
--no-defaults is always the first option
*/
if (*argc >= 2 && !strcmp(argv[0][1], "--no-defaults"))
no_defaults = found_no_defaults = true;
group.count = 0;
group.name = "defaults";
group.type_names = groups;
for (; *groups; groups++) group.count++;
ctx.alloc = alloc;
ctx.m_args = &my_args;
ctx.group = &group;
if ((error = my_search_option_files(conf_file, argc, argv, &args_used,
handle_default_option, (void *)&ctx, dirs,
false, found_no_defaults))) {
return error;
}
if (my_defaults_read_login_file) {
/* Read options from login group. */
if (my_default_get_login_file(my_login_file, sizeof(my_login_file)) &&
(error = my_search_option_files(my_login_file, argc, argv, &args_used,
handle_default_option, (void *)&ctx,
dirs, true, found_no_defaults))) {
alloc->Clear();
return error;
}
}
/*
Here error contains <> 0 only if we have a fully specified conf_file
or a forced default file
*/
if (!(ptr = (const char **)alloc->Alloc(
(my_args.size() + *argc + 1 + args_sep) * sizeof(char *))))
goto err;
res = ptr;
/* copy name + found arguments + command line arguments to new array */
res[0] = argv[0][0]; /* Name MUST be set */
if (!my_args.empty())
memcpy((res + 1), &my_args[0], my_args.size() * sizeof(char *));
/* Skip --defaults-xxx options */
(*argc) -= args_used;
(*argv) += args_used;
/*
Check if we want to see the new argument list
This options must always be the last of the default options
*/
if (*argc >= 2 && !strcmp(argv[0][1], "--print-defaults")) {
found_print_defaults = true;
--*argc;
++*argv; /* skip argument */
}
if (my_getopt_use_args_separator) {
/* set arguments separator for arguments from config file and
command line */
set_args_separator(&res[my_args.size() + 1]);
}
if (*argc)
memcpy((uchar *)(res + 1 + my_args.size() + args_sep),
(char *)((*argv) + 1), (*argc - 1) * sizeof(char *));
res[my_args.size() + *argc + args_sep] = nullptr; /* last null */
(*argc) += my_args.size() + args_sep;
*argv = const_cast<char **>(res);
if (default_directories) *default_directories = dirs;
if (found_no_defaults) return 0;
if (found_print_defaults) {
int i;
printf("%s would have been started with the following arguments:\n",
**argv);
for (i = 1; i < *argc; i++)
if (!my_getopt_is_args_separator(
(*argv)[i])) /* skip arguments separator */
{
if (strncmp((*argv)[i], "--password", 10) == 0)
printf("%s ", "--password=*****");
else
printf("%s ", (*argv)[i]);
}
puts("");
exit(0);
}
return 0;
err:
my_message_local(ERROR_LEVEL, EE_FAILED_TO_HANDLE_DEFAULTS_FILE);
exit(1);
return 0; /* Keep compiler happy */
}
static int search_default_file(Process_option_func opt_handler,
void *handler_ctx, const char *dir,
const char *config_file, bool is_login_file) {
const char **ext;
const char *empty_list[] = {"", nullptr};
bool have_ext = fn_ext(config_file)[0] != 0;
const char **exts_to_use = have_ext ? empty_list : f_extensions;
for (ext = exts_to_use; *ext; ext++) {
int error;
if ((error = search_default_file_with_ext(opt_handler, handler_ctx, dir,
*ext, config_file, 0,
is_login_file, false)) < 0)
return error;
}
return 0;
}
/*
Skip over keyword and get argument after keyword
SYNOPSIS
get_argument()
keyword Include directive keyword
kwlen Length of keyword
ptr Pointer to the keyword in the line under process
line line number
RETURN
0 error
# Returns pointer to the argument after the keyword.
*/
static char *get_argument(const char *keyword, size_t kwlen, char *ptr,
char *name, uint line) {
char *end;
/* Skip over "include / includedir keyword" and following whitespace */
for (ptr += kwlen - 1; my_isspace(&my_charset_latin1, ptr[0]); ptr++) {
}
/*
Trim trailing whitespace from directory name
The -1 below is for the newline added by fgets()
Note that my_isspace() is true for \r and \n
*/
for (end = ptr + strlen(ptr) - 1; my_isspace(&my_charset_latin1, *(end - 1));
end--) {
}
end[0] = 0; /* Cut off end space */
/* Print error msg if there is nothing after !include* directive */
if (end <= ptr) {
my_message_local(ERROR_LEVEL, EE_WRONG_DIRECTIVE_IN_CONFIG_FILE, keyword,
name, line);
return nullptr;
}
return ptr;
}
/*
Open a configuration file (if exists) and read given options from it
SYNOPSIS
search_default_file_with_ext()
opt_handler Option handler function. It is used to process
every separate option.
handler_ctx Pointer to the structure to store actual
parameters of the function.
dir directory to read
ext Extension for configuration file
config_file Name of configuration file
group groups to read
recursion_level the level of recursion, got while processing
"!include" or "!includedir"
is_login_file TRUE, when login file is being processed.
report_os_error_on_open true when OS error is to be reported
RETURN
0 Success
-1 Fatal error, abort
1 File not found (Warning)
*/
static int search_default_file_with_ext(Process_option_func opt_handler,
void *handler_ctx, const char *dir,
const char *ext,
const char *config_file,
int recursion_level, bool is_login_file,
bool report_os_error_on_open) {
char name[FN_REFLEN + 10], buff[4096], curr_gr[4096], *ptr, *end;
const char **tmp_ext;
char *value, tmp[FN_REFLEN];
static const char includedir_keyword[] = "includedir";
static const char include_keyword[] = "include";
const int max_recursion_level = 10;
MYSQL_FILE *fp;
uint line = 0;
bool found_group = false;
uint i, rc;
MY_DIR *search_dir;
FILEINFO *search_file;
myf flags = MYF(report_os_error_on_open ? MY_WME : 0);
if ((dir ? strlen(dir) : 0) + strlen(config_file) >= FN_REFLEN - 3)
return 0; /* Ignore wrong paths */
if (dir) {
end = convert_dirname(name, dir, NullS);
if (dir[0] == FN_HOMELIB) /* Add . to filenames in home */
*end++ = '.';
strxmov(end, config_file, ext, NullS);
} else {
my_stpcpy(name, config_file);
}
fn_format(name, name, "", "", MY_UNPACK_FILENAME);
if ((rc = check_file_permissions(name, is_login_file, flags)) < 2)
return (int)rc;
if (is_login_file) {
if (!(fp = mysql_file_fopen(key_file_cnf, name, O_RDONLY | MY_FOPEN_BINARY,
flags)))
return 1; /* Ignore wrong files. */
} else {
if (!(fp = mysql_file_fopen(key_file_cnf, name, O_RDONLY, flags)))
return 1; /* Ignore wrong files */
}
#ifdef WITH_WSREP
/* make sure we do this only once - for top-level file */
if ('\0' == wsrep_defaults_file[0]) {
/* We are safe here to not truncate the filename, because of the check
done at the beginning of this function.
At this point 'name' is at most the sum of:
converted_dir_len + config_file: (FN_REFLEN-3)+1
dot: 1
ext: 4
terminating null: 1
=> FN_REFLEN + 4
fn_format() which expands ~ to home directory path prevents overflowing
FN_REFLEN as well.
*/
strncpy(wsrep_defaults_file, name, sizeof(wsrep_defaults_file) - 1);
wsrep_defaults_file[sizeof(wsrep_defaults_file) - 1] = 0;
}
#endif /* WITH_WSREP */
while (true) {
auto fileline = mysql_file_getline(buff, sizeof(buff), fp, is_login_file);
char *linebuff = fileline.get();
if (linebuff == nullptr) break;
line++;
/* Ignore comment and empty lines */
for (ptr = linebuff; my_isspace(&my_charset_latin1, *ptr); ptr++) {
}
if (*ptr == '#' || *ptr == ';' || !*ptr) continue;
/* Configuration File Directives */
if (*ptr == '!') {
if (recursion_level >= max_recursion_level) {
for (end = ptr + strlen(ptr) - 1;
my_isspace(&my_charset_latin1, *(end - 1)); end--) {
}
end[0] = 0;
my_message_local(WARNING_LEVEL,
EE_SKIPPING_DIRECTIVE_DUE_TO_MAX_INCLUDE_RECURSION,
ptr, name, line);
continue;
}
/* skip over `!' and following whitespace */
for (++ptr; my_isspace(&my_charset_latin1, ptr[0]); ptr++) {
}
if ((!strncmp(ptr, includedir_keyword, sizeof(includedir_keyword) - 1)) &&
my_isspace(&my_charset_latin1, ptr[sizeof(includedir_keyword) - 1])) {
if (!(ptr = get_argument(includedir_keyword, sizeof(includedir_keyword),
ptr, name, line)))
goto err;
if (!(search_dir = my_dir(ptr, MYF(MY_WME)))) {
my_message_local(ERROR_LEVEL, EE_FAILED_PROCESSING_DIRECTIVE,
includedir_keyword, name, line);