CMake/Source/cmGetFilenameComponentCommand.cxx
Brad King 31f73eb12d get_filename_component: Revise PROGRAM/PROGRAM_ARGS split semantics
The KWSys `SystemTools::SplitProgramFromArgs` implementation goes into
an infinite loop when the value is just " " (a space).  Since the
"program path with unquoted spaces plus command-line arguments"
operation it is trying to provide is poorly defined (string parsing
should not depend on filesystem content), just stop using it.

Instead consider the main two use cases the old approach tried to handle:

* The value is the name or absolute path of a program with no quoting
  or escaping, but also no command-line arguments.  In this case we
  can use the value as given with no parsing, and assume no arguments.

* The value is a command-line string containing the program name/path
  plus arguments.  In this case we now assume that the command line
  is properly quoted or escaped.

Fixes: #17262
2017-09-13 10:47:04 -04:00

134 lines
4.5 KiB
C++

/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#include "cmGetFilenameComponentCommand.h"
#include "cmMakefile.h"
#include "cmStateTypes.h"
#include "cmSystemTools.h"
class cmExecutionStatus;
// cmGetFilenameComponentCommand
bool cmGetFilenameComponentCommand::InitialPass(
std::vector<std::string> const& args, cmExecutionStatus&)
{
if (args.size() < 3) {
this->SetError("called with incorrect number of arguments");
return false;
}
// Check and see if the value has been stored in the cache
// already, if so use that value
if (args.size() >= 4 && args[args.size() - 1] == "CACHE") {
const char* cacheValue = this->Makefile->GetDefinition(args[0]);
if (cacheValue && !cmSystemTools::IsNOTFOUND(cacheValue)) {
return true;
}
}
std::string result;
std::string filename = args[1];
if (filename.find("[HKEY") != std::string::npos) {
// Check the registry as the target application would view it.
cmSystemTools::KeyWOW64 view = cmSystemTools::KeyWOW64_32;
cmSystemTools::KeyWOW64 other_view = cmSystemTools::KeyWOW64_64;
if (this->Makefile->PlatformIs64Bit()) {
view = cmSystemTools::KeyWOW64_64;
other_view = cmSystemTools::KeyWOW64_32;
}
cmSystemTools::ExpandRegistryValues(filename, view);
if (filename.find("/registry") != std::string::npos) {
std::string other = args[1];
cmSystemTools::ExpandRegistryValues(other, other_view);
if (other.find("/registry") == std::string::npos) {
filename = other;
}
}
}
std::string storeArgs;
std::string programArgs;
if (args[2] == "DIRECTORY" || args[2] == "PATH") {
result = cmSystemTools::GetFilenamePath(filename);
} else if (args[2] == "NAME") {
result = cmSystemTools::GetFilenameName(filename);
} else if (args[2] == "PROGRAM") {
for (unsigned int i = 2; i < args.size(); ++i) {
if (args[i] == "PROGRAM_ARGS") {
i++;
if (i < args.size()) {
storeArgs = args[i];
}
}
}
// First assume the path to the program was specified with no
// arguments and with no quoting or escaping for spaces.
// Only bother doing this if there is non-whitespace.
if (!cmSystemTools::TrimWhitespace(filename).empty()) {
result = cmSystemTools::FindProgram(filename);
}
// If that failed then assume a command-line string was given
// and split the program part from the rest of the arguments.
if (result.empty()) {
std::string program;
if (cmSystemTools::SplitProgramFromArgs(filename, program,
programArgs)) {
if (cmSystemTools::FileExists(program)) {
result = program;
} else {
result = cmSystemTools::FindProgram(program);
}
}
if (result.empty()) {
programArgs.clear();
}
}
} else if (args[2] == "EXT") {
result = cmSystemTools::GetFilenameExtension(filename);
} else if (args[2] == "NAME_WE") {
result = cmSystemTools::GetFilenameWithoutExtension(filename);
} else if (args[2] == "ABSOLUTE" || args[2] == "REALPATH") {
// If the path given is relative, evaluate it relative to the
// current source directory unless the user passes a different
// base directory.
std::string baseDir = this->Makefile->GetCurrentSourceDirectory();
for (unsigned int i = 3; i < args.size(); ++i) {
if (args[i] == "BASE_DIR") {
++i;
if (i < args.size()) {
baseDir = args[i];
}
}
}
// Collapse the path to its simplest form.
result = cmSystemTools::CollapseFullPath(filename, baseDir);
if (args[2] == "REALPATH") {
// Resolve symlinks if possible
result = cmSystemTools::GetRealPath(result);
}
} else {
std::string err = "unknown component " + args[2];
this->SetError(err);
return false;
}
if (args.size() >= 4 && args[args.size() - 1] == "CACHE") {
if (!programArgs.empty() && !storeArgs.empty()) {
this->Makefile->AddCacheDefinition(
storeArgs, programArgs.c_str(), "",
args[2] == "PATH" ? cmStateEnums::FILEPATH : cmStateEnums::STRING);
}
this->Makefile->AddCacheDefinition(
args[0], result.c_str(), "",
args[2] == "PATH" ? cmStateEnums::FILEPATH : cmStateEnums::STRING);
} else {
if (!programArgs.empty() && !storeArgs.empty()) {
this->Makefile->AddDefinition(storeArgs, programArgs.c_str());
}
this->Makefile->AddDefinition(args[0], result.c_str());
}
return true;
}