// Copyright (c) 2010 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include "base/command_line.h" #if defined(OS_WIN) #include #include #elif defined(OS_POSIX) #include #include #include #endif #if defined(OS_LINUX) #include #endif #include #include "base/file_path.h" #include "base/logging.h" #include "base/singleton.h" #include "base/string_util.h" #include "base/sys_string_conversions.h" #include "base/utf_string_conversions.h" #if defined(OS_LINUX) // Linux/glibc doesn't natively have setproctitle(). #include "base/setproctitle_linux.h" #endif CommandLine* CommandLine::current_process_commandline_ = NULL; // Since we use a lazy match, make sure that longer versions (like L"--") // are listed before shorter versions (like L"-") of similar prefixes. #if defined(OS_WIN) const wchar_t* const kSwitchPrefixes[] = {L"--", L"-", L"/"}; const wchar_t kSwitchTerminator[] = L"--"; const wchar_t kSwitchValueSeparator[] = L"="; #elif defined(OS_POSIX) // Unixes don't use slash as a switch. const char* const kSwitchPrefixes[] = {"--", "-"}; const char kSwitchTerminator[] = "--"; const char kSwitchValueSeparator[] = "="; #endif #if defined(OS_WIN) // Lowercase a string. This is used to lowercase switch names. // Is this what we really want? It seems crazy to me. I've left it in // for backwards compatibility on Windows. static void Lowercase(std::string* parameter) { transform(parameter->begin(), parameter->end(), parameter->begin(), tolower); } #endif CommandLine::~CommandLine() { } #if defined(OS_WIN) CommandLine::CommandLine(ArgumentsOnly args_only) { } void CommandLine::ParseFromString(const std::wstring& command_line) { TrimWhitespace(command_line, TRIM_ALL, &command_line_string_); if (command_line_string_.empty()) return; int num_args = 0; wchar_t** args = NULL; args = CommandLineToArgvW(command_line_string_.c_str(), &num_args); // Populate program_ with the trimmed version of the first arg. TrimWhitespace(args[0], TRIM_ALL, &program_); bool parse_switches = true; for (int i = 1; i < num_args; ++i) { std::wstring arg; TrimWhitespace(args[i], TRIM_ALL, &arg); if (!parse_switches) { args_.push_back(arg); continue; } if (arg == kSwitchTerminator) { parse_switches = false; continue; } std::string switch_string; std::wstring switch_value; if (IsSwitch(arg, &switch_string, &switch_value)) { switches_[switch_string] = switch_value; } else { args_.push_back(arg); } } if (args) LocalFree(args); } // static CommandLine CommandLine::FromString(const std::wstring& command_line) { CommandLine cmd; cmd.ParseFromString(command_line); return cmd; } CommandLine::CommandLine(const FilePath& program) { if (!program.empty()) { program_ = program.value(); // TODO(evanm): proper quoting here. command_line_string_ = L'"' + program.value() + L'"'; } } #elif defined(OS_POSIX) CommandLine::CommandLine(ArgumentsOnly args_only) { // Push an empty argument, because we always assume argv_[0] is a program. argv_.push_back(""); } CommandLine::CommandLine(int argc, const char* const* argv) { InitFromArgv(argc, argv); } CommandLine::CommandLine(const std::vector& argv) { InitFromArgv(argv); } void CommandLine::InitFromArgv(int argc, const char* const* argv) { for (int i = 0; i < argc; ++i) argv_.push_back(argv[i]); InitFromArgv(argv_); } void CommandLine::InitFromArgv(const std::vector& argv) { argv_ = argv; bool parse_switches = true; for (size_t i = 1; i < argv_.size(); ++i) { const std::string& arg = argv_[i]; if (!parse_switches) { args_.push_back(arg); continue; } if (arg == kSwitchTerminator) { parse_switches = false; continue; } std::string switch_string; std::string switch_value; if (IsSwitch(arg, &switch_string, &switch_value)) { switches_[switch_string] = switch_value; } else { args_.push_back(arg); } } } CommandLine::CommandLine(const FilePath& program) { argv_.push_back(program.value()); } #endif // static bool CommandLine::IsSwitch(const StringType& parameter_string, std::string* switch_string, StringType* switch_value) { switch_string->clear(); switch_value->clear(); for (size_t i = 0; i < arraysize(kSwitchPrefixes); ++i) { StringType prefix(kSwitchPrefixes[i]); if (parameter_string.find(prefix) != 0) continue; const size_t switch_start = prefix.length(); const size_t equals_position = parameter_string.find( kSwitchValueSeparator, switch_start); StringType switch_native; if (equals_position == StringType::npos) { switch_native = parameter_string.substr(switch_start); } else { switch_native = parameter_string.substr( switch_start, equals_position - switch_start); *switch_value = parameter_string.substr(equals_position + 1); } #if defined(OS_WIN) *switch_string = WideToASCII(switch_native); Lowercase(switch_string); #else *switch_string = switch_native; #endif return true; } return false; } // static void CommandLine::Init(int argc, const char* const* argv) { delete current_process_commandline_; current_process_commandline_ = new CommandLine; #if defined(OS_WIN) current_process_commandline_->ParseFromString(::GetCommandLineW()); #elif defined(OS_POSIX) current_process_commandline_->InitFromArgv(argc, argv); #endif #if defined(OS_LINUX) if (argv) setproctitle_init(const_cast(argv)); #endif } #if defined(OS_POSIX) && !defined(OS_MACOSX) // static void CommandLine::SetProcTitle() { // Build a single string which consists of all the arguments separated // by spaces. We can't actually keep them separate due to the way the // setproctitle() function works. std::string title; bool have_argv0 = false; #if defined(OS_LINUX) // In Linux we sometimes exec ourselves from /proc/self/exe, but this makes us // show up as "exe" in process listings. Read the symlink /proc/self/exe and // use the path it points at for our process title. Note that this is only for // display purposes and has no TOCTTOU security implications. char buffer[PATH_MAX]; // Note: readlink() does not append a null byte to terminate the string. ssize_t length = readlink("/proc/self/exe", buffer, sizeof(buffer)); DCHECK(length <= static_cast(sizeof(buffer))); if (length > 0) { have_argv0 = true; title.assign(buffer, length); // If the binary has since been deleted, Linux appends " (deleted)" to the // symlink target. Remove it, since this is not really part of our name. const std::string kDeletedSuffix = " (deleted)"; if (EndsWith(title, kDeletedSuffix, true)) title.resize(title.size() - kDeletedSuffix.size()); #if defined(PR_SET_NAME) // If PR_SET_NAME is available at compile time, we try using it. We ignore // any errors if the kernel does not support it at runtime though. When // available, this lets us set the short process name that shows when the // full command line is not being displayed in most process listings. prctl(PR_SET_NAME, FilePath(title).BaseName().value().c_str()); #endif } #endif for (size_t i = 1; i < current_process_commandline_->argv_.size(); ++i) { if (!title.empty()) title += " "; title += current_process_commandline_->argv_[i]; } // Disable prepending argv[0] with '-' if we prepended it ourselves above. setproctitle(have_argv0 ? "-%s" : "%s", title.c_str()); } #endif void CommandLine::Reset() { DCHECK(current_process_commandline_ != NULL); delete current_process_commandline_; current_process_commandline_ = NULL; } // static CommandLine* CommandLine::ForCurrentProcess() { DCHECK(current_process_commandline_); return current_process_commandline_; } bool CommandLine::HasSwitch(const std::string& switch_string) const { std::string lowercased_switch(switch_string); #if defined(OS_WIN) Lowercase(&lowercased_switch); #endif return switches_.find(lowercased_switch) != switches_.end(); } #if defined(OS_WIN) // Deprecated; still temporarily available on Windows. bool CommandLine::HasSwitch(const std::wstring& switch_string) const { return HasSwitch(WideToASCII(switch_string)); } #endif std::string CommandLine::GetSwitchValueASCII( const std::string& switch_string) const { return WideToASCII(GetSwitchValue(switch_string)); } FilePath CommandLine::GetSwitchValuePath( const std::string& switch_string) const { return FilePath(GetSwitchValueNative(switch_string)); } CommandLine::StringType CommandLine::GetSwitchValueNative( const std::string& switch_string) const { std::string lowercased_switch(switch_string); #if defined(OS_WIN) Lowercase(&lowercased_switch); #endif std::map::const_iterator result = switches_.find(lowercased_switch); if (result == switches_.end()) { return CommandLine::StringType(); } else { return result->second; } } std::wstring CommandLine::GetSwitchValue( const std::string& switch_string) const { // TODO(evanm): deprecate. CommandLine::StringType value = GetSwitchValueNative(switch_string); #if defined(OS_WIN) return value; #else return base::SysNativeMBToWide(value); #endif } std::wstring CommandLine::GetSwitchValue( const std::wstring& switch_string) const { // TODO(evanm): deprecate. return GetSwitchValue(WideToASCII(switch_string)); } FilePath CommandLine::GetProgram() const { return FilePath::FromWStringHack(program()); } #if defined(OS_WIN) std::wstring CommandLine::program() const { return program_; } #else std::wstring CommandLine::program() const { DCHECK_GT(argv_.size(), 0U); return base::SysNativeMBToWide(argv_[0]); } #endif #if defined(OS_POSIX) std::string CommandLine::command_line_string() const { return JoinString(argv_, ' '); } #endif #if defined(OS_WIN) void CommandLine::AppendSwitch(const std::string& switch_string) { command_line_string_.append(L" "); command_line_string_.append(kSwitchPrefixes[0] + ASCIIToWide(switch_string)); switches_[switch_string] = L""; } void CommandLine::AppendSwitchASCII(const std::string& switch_string, const std::string& value_string) { AppendSwitchNative(switch_string, ASCIIToWide(value_string)); } // Quote a string if necessary, such that CommandLineToArgvW() will // always process it as a single argument. static std::wstring WindowsStyleQuote(const std::wstring& arg) { // We follow the quoting rules of CommandLineToArgvW. // http://msdn.microsoft.com/en-us/library/17w5ykft.aspx if (arg.find_first_of(L" \\\"") == std::wstring::npos) { // No quoting necessary. return arg; } std::wstring out; out.push_back(L'"'); for (size_t i = 0; i < arg.size(); ++i) { if (arg[i] == '\\') { // Find the extent of this run of backslashes. size_t start = i, end = start + 1; for (; end < arg.size() && arg[end] == '\\'; ++end) /* empty */; size_t backslash_count = end - start; // Backslashes are escapes only if the run is followed by a double quote. // Since we also will end the string with a double quote, we escape for // either a double quote or the end of the string. if (end == arg.size() || arg[end] == '"') { // To quote, we need to output 2x as many backslashes. backslash_count *= 2; } for (size_t j = 0; j < backslash_count; ++j) out.push_back('\\'); // Advance i to one before the end to balance i++ in loop. i = end - 1; } else if (arg[i] == '"') { out.push_back('\\'); out.push_back('"'); } else { out.push_back(arg[i]); } } out.push_back('"'); return out; } void CommandLine::AppendSwitchNative(const std::string& switch_string, const std::wstring& value) { std::wstring combined_switch_string = kSwitchPrefixes[0] + ASCIIToWide(switch_string); if (!value.empty()) combined_switch_string += kSwitchValueSeparator + WindowsStyleQuote(value); command_line_string_.append(L" "); command_line_string_.append(combined_switch_string); switches_[switch_string] = value; } void CommandLine::AppendArg(const std::string& value) { DCHECK(IsStringUTF8(value)); AppendArgNative(UTF8ToWide(value)); } void CommandLine::AppendArgNative(const std::wstring& value) { command_line_string_.append(L" "); command_line_string_.append(WindowsStyleQuote(value)); args_.push_back(value); } void CommandLine::AppendArguments(const CommandLine& other, bool include_program) { // Verify include_program is used correctly. // Logic could be shorter but this is clearer. DCHECK_EQ(include_program, !other.GetProgram().empty()); command_line_string_ += L" " + other.command_line_string_; std::map::const_iterator i; for (i = other.switches_.begin(); i != other.switches_.end(); ++i) switches_[i->first] = i->second; } void CommandLine::PrependWrapper(const std::wstring& wrapper) { if (wrapper.empty()) return; // The wrapper may have embedded arguments (like "gdb --args"). In this case, // we don't pretend to do anything fancy, we just split on spaces. std::vector wrapper_and_args; SplitString(wrapper, ' ', &wrapper_and_args); program_ = wrapper_and_args[0]; command_line_string_ = wrapper + L" " + command_line_string_; } #elif defined(OS_POSIX) void CommandLine::AppendSwitch(const std::string& switch_string) { argv_.push_back(kSwitchPrefixes[0] + switch_string); switches_[switch_string] = ""; } void CommandLine::AppendSwitchNative(const std::string& switch_string, const std::string& value) { std::string combined_switch_string = kSwitchPrefixes[0] + switch_string; if (!value.empty()) combined_switch_string += kSwitchValueSeparator + value; argv_.push_back(combined_switch_string); switches_[switch_string] = value; } void CommandLine::AppendSwitchASCII(const std::string& switch_string, const std::string& value_string) { AppendSwitchNative(switch_string, value_string); } void CommandLine::AppendArg(const std::string& value) { AppendArgNative(value); } void CommandLine::AppendArgNative(const std::string& value) { DCHECK(IsStringUTF8(value)); argv_.push_back(value); } void CommandLine::AppendArguments(const CommandLine& other, bool include_program) { // Verify include_program is used correctly. // Logic could be shorter but this is clearer. DCHECK_EQ(include_program, !other.GetProgram().empty()); size_t first_arg = include_program ? 0 : 1; for (size_t i = first_arg; i < other.argv_.size(); ++i) argv_.push_back(other.argv_[i]); std::map::const_iterator i; for (i = other.switches_.begin(); i != other.switches_.end(); ++i) switches_[i->first] = i->second; } void CommandLine::PrependWrapper(const std::string& wrapper) { // The wrapper may have embedded arguments (like "gdb --args"). In this case, // we don't pretend to do anything fancy, we just split on spaces. std::vector wrapper_and_args; SplitString(wrapper, ' ', &wrapper_and_args); argv_.insert(argv_.begin(), wrapper_and_args.begin(), wrapper_and_args.end()); } #endif void CommandLine::AppendArgPath(const FilePath& path) { AppendArgNative(path.value()); } void CommandLine::AppendSwitchPath(const std::string& switch_string, const FilePath& path) { AppendSwitchNative(switch_string, path.value()); } void CommandLine::CopySwitchesFrom(const CommandLine& source, const char* const switches[], size_t count) { for (size_t i = 0; i < count; ++i) { if (source.HasSwitch(switches[i])) { StringType value = source.GetSwitchValueNative(switches[i]); AppendSwitchNative(switches[i], value); } } } // private CommandLine::CommandLine() { } // static CommandLine* CommandLine::ForCurrentProcessMutable() { DCHECK(current_process_commandline_); return current_process_commandline_; }