base/command_line.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "base/command_line.h"
   6
   7 #include <algorithm>
   8 #include <ostream>
   9
  10 #include "base/basictypes.h"
  11 #include "base/files/file_path.h"
  12 #include "base/logging.h"
  13 #include "base/strings/string_split.h"
  14 #include "base/strings/string_util.h"
  15 #include "base/strings/utf_string_conversions.h"
  16 #include "build/build_config.h"
  17
  18 #if defined(OS_WIN)
  19 #include <windows.h>
  20 #include <shellapi.h>
  21 #endif
  22
  23 namespace base {
  24
  25 CommandLine* CommandLine::current_process_commandline_ = NULL;
  26
  27 namespace {
  28
  29 const CommandLine::CharType kSwitchTerminator[] = FILE_PATH_LITERAL("--");
  30 const CommandLine::CharType kSwitchValueSeparator[] = FILE_PATH_LITERAL("=");
  31
  32 // Since we use a lazy match, make sure that longer versions (like "--") are
  33 // listed before shorter versions (like "-") of similar prefixes.
  34 #if defined(OS_WIN)
  35 // By putting slash last, we can control whether it is treaded as a switch
  36 // value by changing the value of switch_prefix_count to be one less than
  37 // the array size.
  38 const CommandLine::CharType* const kSwitchPrefixes[] = {L"--", L"-", L"/"};
  39 #elif defined(OS_POSIX)
  40 // Unixes don't use slash as a switch.
  41 const CommandLine::CharType* const kSwitchPrefixes[] = {"--", "-"};
  42 #endif
  43 size_t switch_prefix_count = arraysize(kSwitchPrefixes);
  44
  45 size_t GetSwitchPrefixLength(const CommandLine::StringType& string) {
  46   for (size_t i = 0; i < switch_prefix_count; ++i) {
  47     CommandLine::StringType prefix(kSwitchPrefixes[i]);
  48     if (string.compare(0, prefix.length(), prefix) == 0)
  49       return prefix.length();
  50   }
  51   return 0;
  52 }
  53
  54 // Fills in |switch_string| and |switch_value| if |string| is a switch.
  55 // This will preserve the input switch prefix in the output |switch_string|.
  56 bool IsSwitch(const CommandLine::StringType& string,
  57               CommandLine::StringType* switch_string,
  58               CommandLine::StringType* switch_value) {
  59   switch_string->clear();
  60   switch_value->clear();
  61   size_t prefix_length = GetSwitchPrefixLength(string);
  62   if (prefix_length == 0 || prefix_length == string.length())
  63     return false;
  64
  65   const size_t equals_position = string.find(kSwitchValueSeparator);
  66   *switch_string = string.substr(0, equals_position);
  67   if (equals_position != CommandLine::StringType::npos)
  68     *switch_value = string.substr(equals_position + 1);
  69   return true;
  70 }
  71
  72 // Append switches and arguments, keeping switches before arguments.
  73 void AppendSwitchesAndArguments(CommandLine* command_line,
  74                                 const CommandLine::StringVector& argv) {
  75   bool parse_switches = true;
  76   for (size_t i = 1; i < argv.size(); ++i) {
  77     CommandLine::StringType arg = argv[i];
  78     TrimWhitespace(arg, TRIM_ALL, &arg);
  79
  80     CommandLine::StringType switch_string;
  81     CommandLine::StringType switch_value;
  82     parse_switches &= (arg != kSwitchTerminator);
  83     if (parse_switches && IsSwitch(arg, &switch_string, &switch_value)) {
  84 #if defined(OS_WIN)
  85       command_line->AppendSwitchNative(UTF16ToASCII(switch_string),
  86                                        switch_value);
  87 #elif defined(OS_POSIX)
  88       command_line->AppendSwitchNative(switch_string, switch_value);
  89 #endif
  90     } else {
  91       command_line->AppendArgNative(arg);
  92     }
  93   }
  94 }
  95
  96 // Lowercase switches for backwards compatiblity *on Windows*.
  97 #if defined(OS_WIN)
  98 std::string LowerASCIIOnWindows(const std::string& string) {
  99   return StringToLowerASCII(string);
 100 }
 101 #elif defined(OS_POSIX)
 102 const std::string& LowerASCIIOnWindows(const std::string& string) {
 103   return string;
 104 }
 105 #endif
 106
 107
 108 #if defined(OS_WIN)
 109 // Quote a string as necessary for CommandLineToArgvW compatiblity *on Windows*.
 110 string16 QuoteForCommandLineToArgvW(const string16& arg,
 111                                     bool quote_placeholders) {
 112   // We follow the quoting rules of CommandLineToArgvW.
 113   // http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
 114   string16 quotable_chars(L" \\\"");
 115   // We may also be required to quote '%', which is commonly used in a command
 116   // line as a placeholder. (It may be substituted for a string with spaces.)
 117   if (quote_placeholders)
 118     quotable_chars.push_back(L'%');
 119   if (arg.find_first_of(quotable_chars) == string16::npos) {
 120     // No quoting necessary.
 121     return arg;
 122   }
 123
 124   string16 out;
 125   out.push_back(L'"');
 126   for (size_t i = 0; i < arg.size(); ++i) {
 127     if (arg[i] == '\\') {
 128       // Find the extent of this run of backslashes.
 129       size_t start = i, end = start + 1;
 130       for (; end < arg.size() && arg[end] == '\\'; ++end) {}
 131       size_t backslash_count = end - start;
 132
 133       // Backslashes are escapes only if the run is followed by a double quote.
 134       // Since we also will end the string with a double quote, we escape for
 135       // either a double quote or the end of the string.
 136       if (end == arg.size() || arg[end] == '"') {
 137         // To quote, we need to output 2x as many backslashes.
 138         backslash_count *= 2;
 139       }
 140       for (size_t j = 0; j < backslash_count; ++j)
 141         out.push_back('\\');
 142
 143       // Advance i to one before the end to balance i++ in loop.
 144       i = end - 1;
 145     } else if (arg[i] == '"') {
 146       out.push_back('\\');
 147       out.push_back('"');
 148     } else {
 149       out.push_back(arg[i]);
 150     }
 151   }
 152   out.push_back('"');
 153
 154   return out;
 155 }
 156 #endif
 157
 158 }  // namespace
 159
 160 CommandLine::CommandLine(NoProgram no_program)
 161     : argv_(1),
 162       begin_args_(1) {
 163 }
 164
 165 CommandLine::CommandLine(const FilePath& program)
 166     : argv_(1),
 167       begin_args_(1) {
 168   SetProgram(program);
 169 }
 170
 171 CommandLine::CommandLine(int argc, const CommandLine::CharType* const* argv)
 172     : argv_(1),
 173       begin_args_(1) {
 174   InitFromArgv(argc, argv);
 175 }
 176
 177 CommandLine::CommandLine(const StringVector& argv)
 178     : argv_(1),
 179       begin_args_(1) {
 180   InitFromArgv(argv);
 181 }
 182
 183 CommandLine::~CommandLine() {
 184 }
 185
 186 #if defined(OS_WIN)
 187 // static
 188 void CommandLine::set_slash_is_not_a_switch() {
 189   // The last switch prefix should be slash, so adjust the size to skip it.
 190   DCHECK_EQ(wcscmp(kSwitchPrefixes[arraysize(kSwitchPrefixes) - 1], L"/"), 0);
 191   switch_prefix_count = arraysize(kSwitchPrefixes) - 1;
 192 }
 193 #endif
 194
 195 // static
 196 bool CommandLine::Init(int argc, const char* const* argv) {
 197   if (current_process_commandline_) {
 198     // If this is intentional, Reset() must be called first. If we are using
 199     // the shared build mode, we have to share a single object across multiple
 200     // shared libraries.
 201     return false;
 202   }
 203
 204   current_process_commandline_ = new CommandLine(NO_PROGRAM);
 205 #if defined(OS_WIN)
 206   current_process_commandline_->ParseFromString(::GetCommandLineW());
 207 #elif defined(OS_POSIX)
 208   current_process_commandline_->InitFromArgv(argc, argv);
 209 #endif
 210
 211   return true;
 212 }
 213
 214 // static
 215 void CommandLine::Reset() {
 216   DCHECK(current_process_commandline_);
 217   delete current_process_commandline_;
 218   current_process_commandline_ = NULL;
 219 }
 220
 221 // static
 222 CommandLine* CommandLine::ForCurrentProcess() {
 223   DCHECK(current_process_commandline_);
 224   return current_process_commandline_;
 225 }
 226
 227 // static
 228 bool CommandLine::InitializedForCurrentProcess() {
 229   return !!current_process_commandline_;
 230 }
 231
 232 #if defined(OS_WIN)
 233 // static
 234 CommandLine CommandLine::FromString(const string16& command_line) {
 235   CommandLine cmd(NO_PROGRAM);
 236   cmd.ParseFromString(command_line);
 237   return cmd;
 238 }
 239 #endif
 240
 241 void CommandLine::InitFromArgv(int argc,
 242                                const CommandLine::CharType* const* argv) {
 243   StringVector new_argv;
 244   for (int i = 0; i < argc; ++i)
 245     new_argv.push_back(argv[i]);
 246   InitFromArgv(new_argv);
 247 }
 248
 249 void CommandLine::InitFromArgv(const StringVector& argv) {
 250   argv_ = StringVector(1);
 251   switches_.clear();
 252   begin_args_ = 1;
 253   SetProgram(argv.empty() ? FilePath() : FilePath(argv[0]));
 254   AppendSwitchesAndArguments(this, argv);
 255 }
 256
 257 FilePath CommandLine::GetProgram() const {
 258   return FilePath(argv_[0]);
 259 }
 260
 261 void CommandLine::SetProgram(const FilePath& program) {
 262   TrimWhitespace(program.value(), TRIM_ALL, &argv_[0]);
 263 }
 264
 265 bool CommandLine::HasSwitch(const std::string& switch_string) const {
 266   DCHECK_EQ(StringToLowerASCII(switch_string), switch_string);
 267   return switches_.find(switch_string) != switches_.end();
 268 }
 269
 270 bool CommandLine::HasSwitch(const char string_constant[]) const {
 271   return HasSwitch(std::string(string_constant));
 272 }
 273
 274 std::string CommandLine::GetSwitchValueASCII(
 275     const std::string& switch_string) const {
 276   StringType value = GetSwitchValueNative(switch_string);
 277   if (!IsStringASCII(value)) {
 278     DLOG(WARNING) << "Value of switch (" << switch_string << ") must be ASCII.";
 279     return std::string();
 280   }
 281 #if defined(OS_WIN)
 282   return UTF16ToASCII(value);
 283 #else
 284   return value;
 285 #endif
 286 }
 287
 288 FilePath CommandLine::GetSwitchValuePath(
 289     const std::string& switch_string) const {
 290   return FilePath(GetSwitchValueNative(switch_string));
 291 }
 292
 293 CommandLine::StringType CommandLine::GetSwitchValueNative(
 294     const std::string& switch_string) const {
 295   SwitchMap::const_iterator result =
 296     switches_.find(LowerASCIIOnWindows(switch_string));
 297   return result == switches_.end() ? StringType() : result->second;
 298 }
 299
 300 void CommandLine::AppendSwitch(const std::string& switch_string) {
 301   AppendSwitchNative(switch_string, StringType());
 302 }
 303
 304 void CommandLine::AppendSwitchPath(const std::string& switch_string,
 305                                    const FilePath& path) {
 306   AppendSwitchNative(switch_string, path.value());
 307 }
 308
 309 void CommandLine::AppendSwitchNative(const std::string& switch_string,
 310                                      const CommandLine::StringType& value) {
 311   std::string switch_key(LowerASCIIOnWindows(switch_string));
 312 #if defined(OS_WIN)
 313   StringType combined_switch_string(ASCIIToUTF16(switch_key));
 314 #elif defined(OS_POSIX)
 315   StringType combined_switch_string(switch_string);
 316 #endif
 317   size_t prefix_length = GetSwitchPrefixLength(combined_switch_string);
 318   switches_[switch_key.substr(prefix_length)] = value;
 319   // Preserve existing switch prefixes in |argv_|; only append one if necessary.
 320   if (prefix_length == 0)
 321     combined_switch_string = kSwitchPrefixes[0] + combined_switch_string;
 322   if (!value.empty())
 323     combined_switch_string += kSwitchValueSeparator + value;
 324   // Append the switch and update the switches/arguments divider |begin_args_|.
 325   argv_.insert(argv_.begin() + begin_args_++, combined_switch_string);
 326 }
 327
 328 void CommandLine::AppendSwitchASCII(const std::string& switch_string,
 329                                     const std::string& value_string) {
 330 #if defined(OS_WIN)
 331   AppendSwitchNative(switch_string, ASCIIToUTF16(value_string));
 332 #elif defined(OS_POSIX)
 333   AppendSwitchNative(switch_string, value_string);
 334 #endif
 335 }
 336
 337 void CommandLine::CopySwitchesFrom(const CommandLine& source,
 338                                    const char* const switches[],
 339                                    size_t count) {
 340   for (size_t i = 0; i < count; ++i) {
 341     if (source.HasSwitch(switches[i]))
 342       AppendSwitchNative(switches[i], source.GetSwitchValueNative(switches[i]));
 343   }
 344 }
 345
 346 CommandLine::StringVector CommandLine::GetArgs() const {
 347   // Gather all arguments after the last switch (may include kSwitchTerminator).
 348   StringVector args(argv_.begin() + begin_args_, argv_.end());
 349   // Erase only the first kSwitchTerminator (maybe "--" is a legitimate page?)
 350   StringVector::iterator switch_terminator =
 351       std::find(args.begin(), args.end(), kSwitchTerminator);
 352   if (switch_terminator != args.end())
 353     args.erase(switch_terminator);
 354   return args;
 355 }
 356
 357 void CommandLine::AppendArg(const std::string& value) {
 358 #if defined(OS_WIN)
 359   DCHECK(IsStringUTF8(value));
 360   AppendArgNative(UTF8ToWide(value));
 361 #elif defined(OS_POSIX)
 362   AppendArgNative(value);
 363 #endif
 364 }
 365
 366 void CommandLine::AppendArgPath(const FilePath& path) {
 367   AppendArgNative(path.value());
 368 }
 369
 370 void CommandLine::AppendArgNative(const CommandLine::StringType& value) {
 371   argv_.push_back(value);
 372 }
 373
 374 void CommandLine::AppendArguments(const CommandLine& other,
 375                                   bool include_program) {
 376   if (include_program)
 377     SetProgram(other.GetProgram());
 378   AppendSwitchesAndArguments(this, other.argv());
 379 }
 380
 381 void CommandLine::PrependWrapper(const CommandLine::StringType& wrapper) {
 382   if (wrapper.empty())
 383     return;
 384   // The wrapper may have embedded arguments (like "gdb --args"). In this case,
 385   // we don't pretend to do anything fancy, we just split on spaces.
 386   StringVector wrapper_argv;
 387   SplitString(wrapper, FILE_PATH_LITERAL(' '), &wrapper_argv);
 388   // Prepend the wrapper and update the switches/arguments |begin_args_|.
 389   argv_.insert(argv_.begin(), wrapper_argv.begin(), wrapper_argv.end());
 390   begin_args_ += wrapper_argv.size();
 391 }
 392
 393 #if defined(OS_WIN)
 394 void CommandLine::ParseFromString(const string16& command_line) {
 395   string16 command_line_string;
 396   TrimWhitespace(command_line, TRIM_ALL, &command_line_string);
 397   if (command_line_string.empty())
 398     return;
 399
 400   int num_args = 0;
 401   wchar_t** args = NULL;
 402   args = ::CommandLineToArgvW(command_line_string.c_str(), &num_args);
 403
 404   DPLOG_IF(FATAL, !args) << "CommandLineToArgvW failed on command line: "
 405                          << UTF16ToUTF8(command_line);
 406   InitFromArgv(num_args, args);
 407   LocalFree(args);
 408 }
 409 #endif
 410
 411 CommandLine::StringType CommandLine::GetCommandLineStringInternal(
 412     bool quote_placeholders) const {
 413   StringType string(argv_[0]);
 414 #if defined(OS_WIN)
 415   string = QuoteForCommandLineToArgvW(string, quote_placeholders);
 416 #endif
 417   StringType params(GetArgumentsStringInternal(quote_placeholders));
 418   if (!params.empty()) {
 419     string.append(StringType(FILE_PATH_LITERAL(" ")));
 420     string.append(params);
 421   }
 422   return string;
 423 }
 424
 425 CommandLine::StringType CommandLine::GetArgumentsStringInternal(
 426     bool quote_placeholders) const {
 427   StringType params;
 428   // Append switches and arguments.
 429   bool parse_switches = true;
 430   for (size_t i = 1; i < argv_.size(); ++i) {
 431     StringType arg = argv_[i];
 432     StringType switch_string;
 433     StringType switch_value;
 434     parse_switches &= arg != kSwitchTerminator;
 435     if (i > 1)
 436       params.append(StringType(FILE_PATH_LITERAL(" ")));
 437     if (parse_switches && IsSwitch(arg, &switch_string, &switch_value)) {
 438       params.append(switch_string);
 439       if (!switch_value.empty()) {
 440 #if defined(OS_WIN)
 441         switch_value =
 442             QuoteForCommandLineToArgvW(switch_value, quote_placeholders);
 443 #endif
 444         params.append(kSwitchValueSeparator + switch_value);
 445       }
 446     } else {
 447 #if defined(OS_WIN)
 448       arg = QuoteForCommandLineToArgvW(arg, quote_placeholders);
 449 #endif
 450       params.append(arg);
 451     }
 452   }
 453   return params;
 454 }
 455
 456 }  // namespace base