Fix Windows: QStandardPath::findExecutable() to check suffixes.
Append the Windows executables suffixes from the PATHEXT environment variable. The previous code had a bug since the 'break' statement bailed out of the inner loop only. Factor search code out into a separate functions, avoiding repeated invocations of list.constEnd() and variable assignments in the old code. Add a static function that is called on Unix and on Windows for executable names with a suffix. Call another function applying a candidate list of suffixes in case an executable name without a suffix is passed. Lower case the extensions from PATHEXT, streamline code. Split up the test, add a _data() slot for clarity. Task-number: QTBUG-27457 Change-Id: I2bf34de52aeadddd3b937ad1e22191c3c850fd26 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
This commit is contained in:
Friedemann Kleint
The Qt Project
parent
43ea715418
commit
0e8a2788d8
@ -180,16 +180,12 @@ QStringList QStandardPaths::locateAll(StandardLocation type, const QString &file
|
||||
#ifdef Q_OS_WIN
|
||||
static QStringList executableExtensions()
|
||||
{
|
||||
QStringList ret = QString::fromLocal8Bit(qgetenv("PATHEXT")).split(QLatin1Char(';'));
|
||||
if (!ret.contains(QLatin1String(".exe"), Qt::CaseInsensitive)) {
|
||||
// If %PATHEXT% does not contain .exe, it is either empty, malformed, or distorted in ways that we cannot support, anyway.
|
||||
ret.clear();
|
||||
ret << QLatin1String(".exe")
|
||||
<< QLatin1String(".com")
|
||||
<< QLatin1String(".bat")
|
||||
<< QLatin1String(".cmd");
|
||||
}
|
||||
return ret;
|
||||
// If %PATHEXT% does not contain .exe, it is either empty, malformed, or distorted in ways that we cannot support, anyway.
|
||||
const QStringList pathExt = QString::fromLocal8Bit(qgetenv("PATHEXT")).toLower().split(QLatin1Char(';'));
|
||||
return pathExt.contains(QLatin1String(".exe"), Qt::CaseInsensitive) ?
|
||||
pathExt :
|
||||
QStringList() << QLatin1String(".exe") << QLatin1String(".com")
|
||||
<< QLatin1String(".bat") << QLatin1String(".cmd");
|
||||
}
|
||||
#endif
|
||||
|
||||
@ -203,6 +199,42 @@ static QString checkExecutable(const QString &path)
|
||||
return QString();
|
||||
}
|
||||
|
||||
static inline QString searchExecutable(const QStringList &searchPaths,
|
||||
const QString &executableName)
|
||||
{
|
||||
const QDir currentDir = QDir::current();
|
||||
foreach (const QString &searchPath, searchPaths) {
|
||||
const QString candidate = currentDir.absoluteFilePath(searchPath + QLatin1Char('/') + executableName);
|
||||
const QString absPath = checkExecutable(candidate);
|
||||
if (!absPath.isEmpty())
|
||||
return absPath;
|
||||
}
|
||||
return QString();
|
||||
}
|
||||
|
||||
#ifdef Q_OS_WIN
|
||||
|
||||
// Find executable appending candidate suffixes, used for suffix-less executables
|
||||
// on Windows.
|
||||
static inline QString
|
||||
searchExecutableAppendSuffix(const QStringList &searchPaths,
|
||||
const QString &executableName,
|
||||
const QStringList &suffixes)
|
||||
{
|
||||
const QDir currentDir = QDir::current();
|
||||
foreach (const QString &searchPath, searchPaths) {
|
||||
const QString candidateRoot = currentDir.absoluteFilePath(searchPath + QLatin1Char('/') + executableName);
|
||||
foreach (const QString &suffix, suffixes) {
|
||||
const QString absPath = checkExecutable(candidateRoot + suffix);
|
||||
if (!absPath.isEmpty())
|
||||
return absPath;
|
||||
}
|
||||
}
|
||||
return QString();
|
||||
}
|
||||
|
||||
#endif // Q_OS_WIN
|
||||
|
||||
/*!
|
||||
Finds the executable named \a executableName in the paths specified by \a paths,
|
||||
or the system paths if \a paths is empty.
|
||||
@ -235,33 +267,30 @@ QString QStandardPaths::findExecutable(const QString &executableName, const QStr
|
||||
#else
|
||||
const QLatin1Char pathSep(':');
|
||||
#endif
|
||||
searchPaths = QString::fromLocal8Bit(pEnv.constData()).split(pathSep, QString::SkipEmptyParts);
|
||||
}
|
||||
|
||||
QDir currentDir = QDir::current();
|
||||
QString absPath;
|
||||
#ifdef Q_OS_WIN
|
||||
static QStringList executable_extensions = executableExtensions();
|
||||
#endif
|
||||
|
||||
for (QStringList::const_iterator p = searchPaths.constBegin(); p != searchPaths.constEnd(); ++p) {
|
||||
const QString candidate = currentDir.absoluteFilePath(*p + QLatin1Char('/') + executableName);
|
||||
#ifdef Q_OS_WIN
|
||||
const QString extension = QLatin1Char('.') + QFileInfo(executableName).suffix();
|
||||
if (!executable_extensions.contains(extension, Qt::CaseInsensitive)) {
|
||||
foreach (const QString &extension, executable_extensions) {
|
||||
absPath = checkExecutable(candidate + extension.toLower());
|
||||
if (!absPath.isEmpty())
|
||||
break;
|
||||
}
|
||||
}
|
||||
#endif
|
||||
absPath = checkExecutable(candidate);
|
||||
if (!absPath.isEmpty()) {
|
||||
break;
|
||||
// Remove trailing slashes, which occur on Windows.
|
||||
const QStringList rawPaths = QString::fromLocal8Bit(pEnv.constData()).split(pathSep, QString::SkipEmptyParts);
|
||||
searchPaths.reserve(rawPaths.size());
|
||||
foreach (const QString &rawPath, rawPaths) {
|
||||
QString cleanPath = QDir::cleanPath(rawPath);
|
||||
if (cleanPath.size() > 1 && cleanPath.endsWith('/'))
|
||||
cleanPath.truncate(cleanPath.size() - 1);
|
||||
searchPaths.push_back(cleanPath);
|
||||
}
|
||||
}
|
||||
return absPath;
|
||||
|
||||
#ifdef Q_OS_WIN
|
||||
// On Windows, if the name does not have a suffix or a suffix not
|
||||
// in PATHEXT ("xx.foo"), append suffixes from PATHEXT.
|
||||
static const QStringList executable_extensions = executableExtensions();
|
||||
if (executableName.contains(QLatin1Char('.'))) {
|
||||
const QString suffix = QFileInfo(executableName).suffix();
|
||||
if (suffix.isEmpty() || !executable_extensions.contains(QLatin1Char('.') + suffix, Qt::CaseInsensitive))
|
||||
return searchExecutableAppendSuffix(searchPaths, executableName, executable_extensions);
|
||||
} else {
|
||||
return searchExecutableAppendSuffix(searchPaths, executableName, executable_extensions);
|
||||
}
|
||||
#endif
|
||||
return searchExecutable(searchPaths, executableName);
|
||||
}
|
||||
|
||||
/*!
|
||||
|
||||
@ -43,6 +43,8 @@
|
||||
#include <qstandardpaths.h>
|
||||
#include <qdebug.h>
|
||||
#include <qstandardpaths.h>
|
||||
#include <qfileinfo.h>
|
||||
#include <qsysinfo.h>
|
||||
|
||||
#ifdef Q_OS_UNIX
|
||||
#include <unistd.h>
|
||||
@ -63,7 +65,9 @@ private slots:
|
||||
void enableTestMode();
|
||||
void testLocateAll();
|
||||
void testDataLocation();
|
||||
void testFindExecutable_data();
|
||||
void testFindExecutable();
|
||||
void testFindExecutableLinkToDirectory();
|
||||
void testRuntimeDirectory();
|
||||
void testCustomRuntimeDirectory();
|
||||
void testAllWritableLocations_data();
|
||||
@ -264,30 +268,90 @@ void tst_qstandardpaths::testDataLocation()
|
||||
#endif
|
||||
}
|
||||
|
||||
#ifndef Q_OS_WIN
|
||||
// Find "sh" on Unix.
|
||||
static inline QFileInfo findSh()
|
||||
{
|
||||
const char *shPaths[] = {"/bin/sh", "/usr/bin/sh", 0};
|
||||
for (const char **shPath = shPaths; *shPath; ++shPath) {
|
||||
const QFileInfo fi = QFileInfo(QLatin1String(*shPath));
|
||||
if (fi.exists())
|
||||
return fi;
|
||||
}
|
||||
return QFileInfo();
|
||||
}
|
||||
#endif
|
||||
|
||||
void tst_qstandardpaths::testFindExecutable_data()
|
||||
{
|
||||
QTest::addColumn<QString>("directory");
|
||||
QTest::addColumn<QString>("needle");
|
||||
QTest::addColumn<QString>("expected");
|
||||
#ifdef Q_OS_WIN
|
||||
const QFileInfo cmdFi = QFileInfo(QDir::cleanPath(QString::fromLocal8Bit(qgetenv("COMSPEC"))));
|
||||
const QString cmdPath = cmdFi.absoluteFilePath();
|
||||
|
||||
Q_ASSERT(cmdFi.exists());
|
||||
QTest::newRow("win-cmd")
|
||||
<< QString() << QString::fromLatin1("cmd.eXe") << cmdPath;
|
||||
QTest::newRow("win-full-path")
|
||||
<< QString() << cmdPath << cmdPath;
|
||||
QTest::newRow("win-relative-path")
|
||||
<< cmdFi.absolutePath() << QString::fromLatin1("./cmd.exe") << cmdPath;
|
||||
QTest::newRow("win-cmd-nosuffix")
|
||||
<< QString() << QString::fromLatin1("cmd") << cmdPath;
|
||||
|
||||
if (QSysInfo::windowsVersion() >= QSysInfo::WV_WINDOWS8) {
|
||||
// The logo executable on Windows 8 is perfectly suited for testing that the
|
||||
// suffix mechanism is not thrown off by dots in the name.
|
||||
const QString logo = QLatin1String("microsoft.windows.softwarelogo.showdesktop");
|
||||
const QString logoPath = cmdFi.absolutePath() + QLatin1Char('/') + logo + QLatin1String(".exe");
|
||||
QTest::newRow("win8-logo")
|
||||
<< QString() << (logo + QLatin1String(".exe")) << logoPath;
|
||||
QTest::newRow("win8-logo-nosuffix")
|
||||
<< QString() << logo << logoPath;
|
||||
}
|
||||
#else
|
||||
const QFileInfo shFi = findSh();
|
||||
Q_ASSERT(shFi.exists());
|
||||
const QString shPath = shFi.absoluteFilePath();
|
||||
QTest::newRow("unix-sh")
|
||||
<< QString() << QString::fromLatin1("sh") << shPath;
|
||||
QTest::newRow("unix-sh-fullpath")
|
||||
<< QString() << shPath << shPath;
|
||||
QTest::newRow("unix-sh-relativepath")
|
||||
<< QString(shFi.absolutePath()) << QString::fromLatin1("./sh") << shPath;
|
||||
#endif
|
||||
QTest::newRow("idontexist")
|
||||
<< QString() << QString::fromLatin1("idontexist") << QString();
|
||||
QTest::newRow("empty")
|
||||
<< QString() << QString() << QString();
|
||||
}
|
||||
|
||||
void tst_qstandardpaths::testFindExecutable()
|
||||
{
|
||||
// Search for 'sh' on unix and 'cmd.exe' on Windows
|
||||
QFETCH(QString, directory);
|
||||
QFETCH(QString, needle);
|
||||
QFETCH(QString, expected);
|
||||
const bool changeDirectory = !directory.isEmpty();
|
||||
const QString currentDirectory = QDir::currentPath();
|
||||
if (changeDirectory)
|
||||
QVERIFY(QDir::setCurrent(directory));
|
||||
const QString result = QStandardPaths::findExecutable(needle);
|
||||
if (changeDirectory)
|
||||
QVERIFY(QDir::setCurrent(currentDirectory));
|
||||
|
||||
#ifdef Q_OS_WIN
|
||||
const QString exeName = "cmd.exe";
|
||||
const Qt::CaseSensitivity sensitivity = Qt::CaseInsensitive;
|
||||
#else
|
||||
const QString exeName = "sh";
|
||||
const Qt::CaseSensitivity sensitivity = Qt::CaseSensitive;
|
||||
#endif
|
||||
QVERIFY2(!result.compare(expected, sensitivity),
|
||||
qPrintable(QString::fromLatin1("Actual: '%1', Expected: '%2'").arg(result, expected)));
|
||||
}
|
||||
|
||||
const QString result = QStandardPaths::findExecutable(exeName);
|
||||
QVERIFY(!result.isEmpty());
|
||||
#ifdef Q_OS_WIN
|
||||
QVERIFY(result.endsWith("/cmd.exe"));
|
||||
#else
|
||||
QVERIFY(result.endsWith("/bin/sh"));
|
||||
#endif
|
||||
|
||||
// full path as argument
|
||||
QCOMPARE(QStandardPaths::findExecutable(result), result);
|
||||
|
||||
// exe no found
|
||||
QVERIFY(QStandardPaths::findExecutable("idontexist").isEmpty());
|
||||
QVERIFY(QStandardPaths::findExecutable("").isEmpty());
|
||||
|
||||
void tst_qstandardpaths::testFindExecutableLinkToDirectory()
|
||||
{
|
||||
// link to directory
|
||||
const QString target = QDir::tempPath() + QDir::separator() + QLatin1String("link.lnk");
|
||||
QFile::remove(target);
|
||||
@ -295,17 +359,6 @@ void tst_qstandardpaths::testFindExecutable()
|
||||
QVERIFY(appFile.link(target));
|
||||
QVERIFY(QStandardPaths::findExecutable(target).isEmpty());
|
||||
QFile::remove(target);
|
||||
|
||||
// findExecutable with a relative path
|
||||
#ifdef Q_OS_UNIX
|
||||
const QString pwd = QDir::currentPath();
|
||||
QDir::setCurrent("/bin");
|
||||
QStringList possibleResults;
|
||||
possibleResults << QString::fromLatin1("/bin/sh") << QString::fromLatin1("/usr/bin/sh");
|
||||
const QString sh = QStandardPaths::findExecutable("./sh");
|
||||
QVERIFY2(possibleResults.contains(sh), qPrintable(sh));
|
||||
QDir::setCurrent(pwd);
|
||||
#endif
|
||||
}
|
||||
|
||||
void tst_qstandardpaths::testRuntimeDirectory()
|
||||
|
||||
Loading…
Reference in New Issue
Block a user