/*
* Copyright (C) 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 .
*
* 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.
*/
#include "mongo/shell/shell_options.h"
#include
#include
#include "mongo/base/status.h"
#include "mongo/bson/util/builder.h"
#include "mongo/client/sasl_client_authenticate.h"
#include "mongo/db/server_options.h"
#include "mongo/shell/shell_utils.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/net/sock.h"
#include "mongo/util/net/ssl_options.h"
#include "mongo/util/options_parser/startup_options.h"
#include "mongo/util/version.h"
namespace mongo {
ShellGlobalParams shellGlobalParams;
Status addMongoShellOptions(moe::OptionSection* options) {
options->addOptionChaining("shell", "shell", moe::Switch,
"run the shell after executing files");
options->addOptionChaining("nodb", "nodb", moe::Switch,
"don't connect to mongod on startup - no 'db address' arg expected");
options->addOptionChaining("norc", "norc", moe::Switch,
"will not run the \".mongorc.js\" file on start up");
options->addOptionChaining("quiet", "quiet", moe::Switch, "be less chatty");
options->addOptionChaining("port", "port", moe::String, "port to connect to");
options->addOptionChaining("host", "host", moe::String, "server to connect to");
options->addOptionChaining("eval", "eval", moe::String, "evaluate javascript");
moe::OptionSection authenticationOptions("Authentication Options");
authenticationOptions.addOptionChaining("username", "username,u", moe::String,
"username for authentication");
authenticationOptions.addOptionChaining("password", "password,p", moe::String,
"password for authentication")
.setImplicit(moe::Value(std::string("")));
authenticationOptions.addOptionChaining("authenticationDatabase", "authenticationDatabase",
moe::String, "user source (defaults to dbname)")
.setDefault(moe::Value(std::string("")));
authenticationOptions.addOptionChaining("authenticationMechanism",
"authenticationMechanism", moe::String, "authentication mechanism");
authenticationOptions.addOptionChaining("gssapiServiceName", "gssapiServiceName",
moe::String,
"Service name to use when authenticating using GSSAPI/Kerberos")
.setDefault(moe::Value(std::string(saslDefaultServiceName)));
authenticationOptions.addOptionChaining("gssapiHostName", "gssapiHostName", moe::String,
"Remote host name to use for purpose of GSSAPI/Kerberos authentication");
options->addSection(authenticationOptions);
options->addOptionChaining("help", "help,h", moe::Switch, "show this usage information");
options->addOptionChaining("version", "version", moe::Switch, "show version information");
options->addOptionChaining("verbose", "verbose", moe::Switch, "increase verbosity");
options->addOptionChaining("ipv6", "ipv6", moe::Switch,
"enable IPv6 support (disabled by default)");
Status ret = Status::OK();
#ifdef MONGO_SSL
ret = addSSLClientOptions(options);
if (!ret.isOK()) {
return ret;
}
#endif
options->addOptionChaining("dbaddress", "dbaddress", moe::String, "dbaddress")
.hidden()
.positional(1, 1);
options->addOptionChaining("files", "files", moe::StringVector, "files")
.hidden()
.positional(2, -1);
// for testing, kill op will also be disabled automatically if the tests starts a mongo
// program
options->addOptionChaining("nokillop", "nokillop", moe::Switch, "nokillop")
.hidden();
// for testing, will kill op without prompting
options->addOptionChaining("autokillop", "autokillop", moe::Switch, "autokillop")
.hidden();
options->addOptionChaining("useLegacyWriteOps",
"useLegacyWriteOps",
moe::Switch,
"use legacy write ops instead of write commands").hidden();
options->addOptionChaining("writeMode",
"writeMode",
moe::String,
"mode to determine how writes are done:"
" commands, compatibility, legacy").hidden();
return Status::OK();
}
std::string getMongoShellHelp(const StringData& name, const moe::OptionSection& options) {
StringBuilder sb;
sb << "MongoDB shell version: " << mongo::versionString << "\n";
sb << "usage: " << name << " [options] [db address] [file names (ending in .js)]\n"
<< "db address can be:\n"
<< " foo foo database on local machine\n"
<< " 192.169.0.5/foo foo database on 192.168.0.5 machine\n"
<< " 192.169.0.5:9999/foo foo database on 192.168.0.5 machine on port 9999\n"
<< options.helpString() << "\n"
<< "file names: a list of files to run. files have to end in .js and will exit after "
<< "unless --shell is specified";
return sb.str();
}
bool handlePreValidationMongoShellOptions(const moe::Environment& params,
const std::vector& args) {
if (params.count("help")) {
std::cout << getMongoShellHelp(args[0], moe::startupOptions) << std::endl;
return false;
}
if (params.count("version")) {
cout << "MongoDB shell version: " << mongo::versionString << endl;
return false;
}
return true;
}
Status storeMongoShellOptions(const moe::Environment& params,
const std::vector& args) {
if (params.count("quiet")) {
mongo::serverGlobalParams.quiet = true;
}
#ifdef MONGO_SSL
Status ret = storeSSLClientOptions(params);
if (!ret.isOK()) {
return ret;
}
#endif
if (params.count("ipv6")) {
mongo::enableIPv6();
}
if (params.count("verbose")) {
logger::globalLogDomain()->setMinimumLoggedSeverity(logger::LogSeverity::Debug(1));
}
if (params.count("port")) {
shellGlobalParams.port = params["port"].as();
}
if (params.count("host")) {
shellGlobalParams.dbhost = params["host"].as();
}
if (params.count("eval")) {
shellGlobalParams.script = params["eval"].as();
}
if (params.count("username")) {
shellGlobalParams.username = params["username"].as();
}
if (params.count("password")) {
shellGlobalParams.usingPassword = true;
shellGlobalParams.password = params["password"].as();
}
if (params.count("authenticationDatabase")) {
shellGlobalParams.authenticationDatabase =
params["authenticationDatabase"].as();
}
if (params.count("authenticationMechanism")) {
shellGlobalParams.authenticationMechanism =
params["authenticationMechanism"].as();
}
if (params.count("gssapiServiceName")) {
shellGlobalParams.gssapiServiceName = params["gssapiServiceName"].as();
}
if (params.count("gssapiHostName")) {
shellGlobalParams.gssapiHostName = params["gssapiHostName"].as();
}
if (params.count("shell")) {
shellGlobalParams.runShell = true;
}
if (params.count("nodb")) {
shellGlobalParams.nodb = true;
}
if (params.count("norc")) {
shellGlobalParams.norc = true;
}
if (params.count("files")) {
shellGlobalParams.files = params["files"].as< vector >();
}
if (params.count("nokillop")) {
mongo::shell_utils::_nokillop = true;
}
if (params.count("autokillop")) {
shellGlobalParams.autoKillOp = true;
}
if (params.count("useLegacyWriteOps")) {
shellGlobalParams.writeMode = "legacy";
}
if (params.count("writeMode")) {
std::string mode = params["writeMode"].as();
if (mode != "commands" && mode != "legacy" && mode != "compatibility") {
throw MsgAssertionException(17396,
mongoutils::str::stream() <<
"Unknown writeMode option: " << mode);
}
shellGlobalParams.writeMode = mode;
}
/* This is a bit confusing, here are the rules:
*
* if nodb is set then all positional parameters are files
* otherwise the first positional parameter might be a dbaddress, but
* only if one of these conditions is met:
* - it contains no '.' after the last appearance of '\' or '/'
* - it doesn't end in '.js' and it doesn't specify a path to an existing file */
if (params.count("dbaddress")) {
string dbaddress = params["dbaddress"].as();
if (shellGlobalParams.nodb) {
shellGlobalParams.files.insert( shellGlobalParams.files.begin(), dbaddress );
}
else {
string basename = dbaddress.substr( dbaddress.find_last_of( "/\\" ) + 1 );
if (basename.find_first_of( '.' ) == string::npos ||
(basename.find(".js", basename.size() - 3) == string::npos &&
!::mongo::shell_utils::fileExists(dbaddress))) {
shellGlobalParams.url = dbaddress;
}
else {
shellGlobalParams.files.insert( shellGlobalParams.files.begin(), dbaddress );
}
}
}
if ( shellGlobalParams.url == "*" ) {
StringBuilder sb;
sb << "ERROR: " << "\"*\" is an invalid db address";
sb << getMongoShellHelp(args[0], moe::startupOptions);
return Status(ErrorCodes::BadValue, sb.str());
}
return Status::OK();
}
Status validateMongoShellOptions(const moe::Environment& params) {
#ifdef MONGO_SSL
Status ret = validateSSLMongoShellOptions(params);
if (!ret.isOK()) {
return ret;
}
#endif
return Status::OK();
}
}