Skip to content

Fix #14749 (cmdFilename: handle more bash special characters) #8552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
danmar wants to merge 2 commits into
base: main
Choose a base branch
from
+26 −8
Draft

Fix #14749 (cmdFilename: handle more bash special characters) #8552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22bb464
Fix #14749 (cmdFilename: handle more bash special characters)
danmar May 12, 2026
0c1927f
comment
danmar May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions lib/cppcheck.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,10 +304,10 @@ namespace {
};
}

static std::string cmdFileName(std::string f)
std::string CppCheck::cmdFileName(std::string f)
{
f = Path::toNativeSeparators(std::move(f));
if (f.find(' ') != std::string::npos)
if (f.find_first_of(" \t;$<>|&`\n") != std::string::npos)
return "\"" + f + "\"";
return f;
}
Expand Down Expand Up @@ -442,11 +442,11 @@ static std::vector<picojson::value> executeAddon(const AddonInfo &addonInfo,
std::string pythonExe;

if (!addonInfo.executable.empty())
pythonExe = addonInfo.executable;
pythonExe = CppCheck::cmdFileName(addonInfo.executable);
else if (!addonInfo.python.empty())
pythonExe = cmdFileName(addonInfo.python);
pythonExe = CppCheck::cmdFileName(addonInfo.python);
else if (!defaultPythonExe.empty())
pythonExe = cmdFileName(defaultPythonExe);
pythonExe = CppCheck::cmdFileName(defaultPythonExe);
else {
// store in static variable so we only look this up once - TODO: do not cache globally
static const std::string detectedPythonExe = detectPython(executeCommand);
Expand All @@ -457,13 +457,13 @@ static std::vector<picojson::value> executeAddon(const AddonInfo &addonInfo,

std::string args;
if (addonInfo.executable.empty())
args = cmdFileName(addonInfo.runScript) + " " + cmdFileName(addonInfo.scriptFile);
args = CppCheck::cmdFileName(addonInfo.runScript) + " " + CppCheck::cmdFileName(addonInfo.scriptFile);
args += std::string(args.empty() ? "" : " ") + "--cli" + addonInfo.args;
if (!premiumArgs.empty() && !addonInfo.executable.empty())
args += " " + premiumArgs;

const bool is_file_list = (file.find(FILELIST) != std::string::npos);
const std::string fileArg = (is_file_list ? " --file-list " : " ") + cmdFileName(file);
const std::string fileArg = (is_file_list ? " --file-list " : " ") + CppCheck::cmdFileName(file);
args += fileArg;

std::string result;
Expand Down Expand Up @@ -658,7 +658,7 @@ static std::string getClangFlags(const Settings& setting, Standards::Language la
flags += getDefinesFlags(setting.userDefines);

for (const std::string &i: setting.userIncludes)
flags += "--include " + cmdFileName(i) + " ";
flags += "--include " + CppCheck::cmdFileName(i) + " ";

return flags;
}
Expand Down
5 changes: 5 additions & 0 deletions lib/cppcheck.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,11 @@ class CPPCHECKLIB CppCheck {
/** analyse whole program use .analyzeinfo files or ctuinfo string */
unsigned int analyseWholeProgram(const std::string &buildDir, const std::list<FileWithDetails> &files, const std::list<FileSettings>& fileSettings, const std::string& ctuInfo);

/**
* Return quoted filename string if input filename contains spaces or various other shell meta characters.
*/
static std::string cmdFileName(std::string f);

private:
void purgedConfigurationMessage(const std::string &file, const std::string& configuration);

Expand Down
13 changes: 13 additions & 0 deletions test/testcppcheck.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ class TestCppcheck : public TestFixture {
TEST_CASE(checkPlistOutput);
TEST_CASE(premiumResultsCache);
TEST_CASE(purgedConfiguration);
TEST_CASE(cmdFileName);
}

void getErrorMessages() const {
Expand Down Expand Up @@ -622,6 +623,18 @@ class TestCppcheck : public TestFixture {
it->toString(false, templateFormat, ""));
}

void cmdFileName() const {
ASSERT_EQUALS("x", CppCheck::cmdFileName("x"));
ASSERT_EQUALS("\" \"", CppCheck::cmdFileName(" "));
ASSERT_EQUALS("\"\t\"", CppCheck::cmdFileName("\t"));
ASSERT_EQUALS("\";\"", CppCheck::cmdFileName(";"));
ASSERT_EQUALS("\">\"", CppCheck::cmdFileName(">"));
ASSERT_EQUALS("\"<\"", CppCheck::cmdFileName("<"));
ASSERT_EQUALS("\"|\"", CppCheck::cmdFileName("|"));
ASSERT_EQUALS("\"`\"", CppCheck::cmdFileName("`"));
ASSERT_EQUALS("\"$\"", CppCheck::cmdFileName("$"));
}

// TODO: test suppressions
// TODO: test all with FS
};
Expand Down
Loading