echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cmCacheManager: Truncate values containing newlines

Browse Source 
Fixes #16098.
This commit is contained in:
Kyle Edwards 2018-01-09 15:56:40 -05:00
parent e40541339a
commit a9c483071e
5 changed files with 88 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
Source/cmCacheManager.cxx
View File

@ -10,6 +10,7 @@
#include <string.h>
#include "cmGeneratedFileStream.h"
#include "cmMessenger.h"
#include "cmState.h"
#include "cmSystemTools.h"
#include "cmVersion.h"
@ -205,7 +206,8 @@ bool cmCacheManager::ReadPropertyEntry(std::string const& entryKey,
return false;
}
void cmCacheManager::WritePropertyEntries(std::ostream& os, CacheIterator i)
void cmCacheManager::WritePropertyEntries(std::ostream& os, CacheIterator i,
cmMessenger* messenger)
{
for (const char** p = this->PersistentProperties; *p; ++p) {
if (const char* value = i.GetProperty(*p)) {
@ -221,11 +223,13 @@ void cmCacheManager::WritePropertyEntries(std::ostream& os, CacheIterator i)
os << ":INTERNAL=";
this->OutputValue(os, value);
os << "\n";
cmCacheManager::OutputNewlineTruncationWarning(os, key, value,
messenger);
}
}
}
bool cmCacheManager::SaveCache(const std::string& path)
bool cmCacheManager::SaveCache(const std::string& path, cmMessenger* messenger)
{
std::string cacheFile = path;
cacheFile += "/CMakeCache.txt";
@ -316,7 +320,10 @@ bool cmCacheManager::SaveCache(const std::string& path)
this->OutputKey(fout, i.first);
fout << ":" << cmState::CacheEntryTypeToString(t) << "=";
this->OutputValue(fout, ce.Value);
fout << "\n\n";
fout << "\n";
cmCacheManager::OutputNewlineTruncationWarning(fout, i.first, ce.Value,
messenger);
fout << "\n";
}
}
@ -333,7 +340,7 @@ bool cmCacheManager::SaveCache(const std::string& path)
}
cmStateEnums::CacheEntryType t = i.GetType();
this->WritePropertyEntries(fout, i);
this->WritePropertyEntries(fout, i, messenger);
if (t == cmStateEnums::INTERNAL) {
// Format is key:type=value
if (const char* help = i.GetProperty("HELPSTRING")) {
@ -343,6 +350,8 @@ bool cmCacheManager::SaveCache(const std::string& path)
fout << ":" << cmState::CacheEntryTypeToString(t) << "=";
this->OutputValue(fout, i.GetValue());
fout << "\n";
cmCacheManager::OutputNewlineTruncationWarning(fout, i.GetName(),
i.GetValue(), messenger);
}
}
fout << "\n";
@ -389,6 +398,19 @@ void cmCacheManager::OutputKey(std::ostream& fout, std::string const& key)
}
void cmCacheManager::OutputValue(std::ostream& fout, std::string const& value)
{
// look for and truncate newlines
std::string::size_type newline = value.find('\n');
if (newline != std::string::npos) {
std::string truncated = value.substr(0, newline);
OutputValueNoNewlines(fout, truncated);
} else {
OutputValueNoNewlines(fout, value);
}
}
void cmCacheManager::OutputValueNoNewlines(std::ostream& fout,
std::string const& value)
{
// if value has trailing space or tab, enclose it in single quotes
if (!value.empty() &&
@ -423,6 +445,50 @@ void cmCacheManager::OutputHelpString(std::ostream& fout,
}
}
void cmCacheManager::OutputWarningComment(std::ostream& fout,
std::string const& message,
bool wrapSpaces)
{
std::string::size_type end = message.size();
std::string oneLine;
std::string::size_type pos = 0;
for (std::string::size_type i = 0; i <= end; i++) {
if ((i == end) || (message[i] == '\n') ||
((i - pos >= 60) && (message[i] == ' ') && wrapSpaces)) {
fout << "# ";
if (message[pos] == '\n') {
pos++;
fout << "\\n";
}
oneLine = message.substr(pos, i - pos);
fout << oneLine << "\n";
pos = i;
}
}
}
void cmCacheManager::OutputNewlineTruncationWarning(std::ostream& fout,
std::string const& key,
std::string const& value,
cmMessenger* messenger)
{
if (value.find('\n') != std::string::npos) {
if (messenger) {
std::string message = "Value of ";
message += key;
message += " contained a newline; truncating";
messenger->IssueMessage(cmake::WARNING, message);
}
std::string comment = "WARNING: Value of ";
comment += key;
comment += " contained a newline and was truncated. Original value:";
OutputWarningComment(fout, comment, true);
OutputWarningComment(fout, value, false);
}
}
void cmCacheManager::RemoveCacheEntry(const std::string& key)
{
CacheEntryMap::iterator i = this->Cache.find(key);

17
Source/cmCacheManager.h
View File

@ -15,7 +15,7 @@
#include "cmPropertyMap.h"
#include "cmStateTypes.h"
class cmake;
class cmMessenger;
/** \class cmCacheManager
* \brief Control class for cmake's cache
@ -108,7 +108,7 @@ public:
std::set<std::string>& includes);
///! Save cache for given makefile. Saves to output path/CMakeCache.txt
bool SaveCache(const std::string& path);
bool SaveCache(const std::string& path, cmMessenger* messenger);
///! Delete the cache given
bool DeleteCache(const std::string& path);
@ -218,16 +218,25 @@ protected:
unsigned int CacheMinorVersion;
private:
cmake* CMakeInstance;
typedef std::map<std::string, CacheEntry> CacheEntryMap;
static void OutputHelpString(std::ostream& fout,
const std::string& helpString);
static void OutputWarningComment(std::ostream& fout,
std::string const& message,
bool wrapSpaces);
static void OutputNewlineTruncationWarning(std::ostream& fout,
std::string const& key,
std::string const& value,
cmMessenger* messenger);
static void OutputKey(std::ostream& fout, std::string const& key);
static void OutputValue(std::ostream& fout, std::string const& value);
static void OutputValueNoNewlines(std::ostream& fout,
std::string const& value);
static const char* PersistentProperties[];
bool ReadPropertyEntry(std::string const& key, CacheEntry& e);
void WritePropertyEntries(std::ostream& os, CacheIterator i);
void WritePropertyEntries(std::ostream& os, CacheIterator i,
cmMessenger* messenger);
CacheEntryMap Cache;
// Only cmake and cmState should be able to add cache values

4
Source/cmState.cxx
View File

@ -107,9 +107,9 @@ bool cmState::LoadCache(const std::string& path, bool internal,
return this->CacheManager->LoadCache(path, internal, excludes, includes);
}
bool cmState::SaveCache(const std::string& path)
bool cmState::SaveCache(const std::string& path, cmMessenger* messenger)
{
return this->CacheManager->SaveCache(path);
return this->CacheManager->SaveCache(path, messenger);
}
bool cmState::DeleteCache(const std::string& path)

3
Source/cmState.h
View File

@ -23,6 +23,7 @@ class cmCacheManager;
class cmCommand;
class cmPropertyDefinition;
class cmStateSnapshot;
class cmMessenger;
class cmState
{
@ -59,7 +60,7 @@ public:
std::set<std::string>& excludes,
std::set<std::string>& includes);
bool SaveCache(const std::string& path);
bool SaveCache(const std::string& path, cmMessenger* messenger);
bool DeleteCache(const std::string& path);

2
Source/cmake.cxx
View File

@ -1770,7 +1770,7 @@ bool cmake::LoadCache(const std::string& path, bool internal,
bool cmake::SaveCache(const std::string& path)
{
bool result = this->State->SaveCache(path);
bool result = this->State->SaveCache(path, this->GetMessenger());
static const char* entries[] = { "CMAKE_CACHE_MAJOR_VERSION",
"CMAKE_CACHE_MINOR_VERSION",
"CMAKE_CACHE_PATCH_VERSION",