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
|
/* Copyright 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects
* for all of the code used other than as permitted herein. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you do not
* wish to do so, delete this exception statement from your version. If you
* delete this exception statement from all source files in the program,
* then also delete it in the license file.
*/
#pragma once
#include <map>
#include <string>
#include <vector>
#include "mongo/base/status.h"
#include "mongo/stdx/functional.h"
#include "mongo/util/duration.h"
namespace mongo {
namespace optionenvironment {
constexpr Seconds kDefaultConfigExpandTimeout{30};
class Environment;
class OptionSection;
class Value;
/** Handles parsing of the command line as well as YAML and INI config files. Takes an
* OptionSection instance that describes the allowed options, parses argv (env not yet
* supported), and populates an Environment with the results.
*
* Usage:
*
* namespace moe = mongo::optionenvironment;
*
* moe::OptionsParser parser;
* moe::Environment environment;
* moe::OptionSection options;
*
* // Register our allowed options with our OptionSection
* options.addOptionChaining("help", "help", moe::Switch, "Display Help");
* options.addOptionChaining("port", "port", moe::Int, "Port");
*
* // Run the parser
* Status ret = parser.run(options, argv, env, &environment);
* if (!ret.isOK()) {
* cerr << options.helpString() << std::endl;
* exit(EXIT_FAILURE);
* }
*
* bool displayHelp;
* ret = environment.get(moe::Key("help"), &displayHelp);
* if (!ret.isOK()) {
* // Help is a switch, so it should always be set
* cout << "Should not get here" << std::endl;
* exit(EXIT_FAILURE);
* }
* if (displayHelp) {
* cout << options.helpString() << std::endl;
* exit(EXIT_SUCCESS);
* }
*
* // Get the value of port from the environment
* int port = 27017;
* ret = environment.get(moe::Key("port"), &port);
* if (ret.isOK()) {
* // We have overridden port here, otherwise it stays as the default.
* }
*/
class OptionsParser {
public:
/** Indicates if unknown config options are allowed or not.
*
* true - unknown config options will generate an error during parsing.
* false - unknow config options will be ignored during parsing.
*/
static stdx::function<bool()> useStrict;
OptionsParser() {}
virtual ~OptionsParser() {}
/** Handles parsing of the command line as well as YAML and INI config files. The
* OptionSection be a description of the allowed options. This function populates the
* given Environment with the results of parsing the command line and or config files but
* does not call validate on the Environment.
*
* The only special option is the "config" option. This function will check if the
* "config" option was set on the command line and if so attempt to read the given config
* file. For binaries that do not support config files, the "config" option should not be
* registered in the OptionSection.
*/
Status run(const OptionSection&,
const std::vector<std::string>& argv,
const std::map<std::string, std::string>& env,
Environment*);
/** Handles parsing of a YAML or INI formatted string. The
* OptionSection be a description of the allowed options. This function populates the
* given Environment with the results but does not call validate on the Environment.
*/
Status runConfigFile(const OptionSection&,
const std::string& config,
const std::map<std::string, std::string>& env,
Environment*);
/**
* Flags controlling whether or not __rest and/or __exec directives in a
* config file should be expanded via HttpClient/shellExec.
*/
struct ConfigExpand {
bool rest = false;
bool exec = false;
Seconds timeout = kDefaultConfigExpandTimeout;
};
private:
/** Handles parsing of the command line and adds the results to the given Environment */
Status parseCommandLine(const OptionSection&,
const std::vector<std::string>& argv,
Environment*);
/** Handles parsing of an INI config std::string and adds the results to the given Environment
* */
Status parseINIConfigFile(const OptionSection&, const std::string& config, Environment*);
/** Handles parsing of either YAML or INI config and adds the results to the given Environment
*/
Status parseConfigFile(const OptionSection&,
const std::string& argv,
Environment*,
const ConfigExpand& configExpand);
/** Gets defaults from the OptionSection and adds them to the given Environment */
Status addDefaultValues(const OptionSection&, Environment*);
/** Reads the given config file into the output string. This function is virtual for
* testing purposes only. */
virtual Status readConfigFile(const std::string& filename, std::string*);
};
} // namespace optionenvironment
} // namespace mongo
|
