blob: 1caae35ca04f4555f82d8bd8bf5861f7845cb374 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the ActiveQt framework of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** BSD License Usage
** Alternatively, you may use this file under the terms of the BSD license
** as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of The Qt Company Ltd nor the names of its
** contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qaxselect.h"
#include "ui_qaxselect.h"
#include <QtCore/qfileinfo.h>
#include <QtCore/qsortfilterproxymodel.h>
#include <QtCore/qitemselectionmodel.h>
#include <QtCore/qsysinfo.h>
#include <QtCore/qtextstream.h>
#include <QtWidgets/qdesktopwidget.h>
#include <QtWidgets/qpushbutton.h>
#include <qt_windows.h>
#include <algorithm>
#include <functional>
QT_BEGIN_NAMESPACE
/*!
\since 5.13
\enum QAxSelect::SandboxingLevel
The SandboxingLevel enumeration defines the desired level of ActiveX sandboxing.
\value SandboxingNone No specific sandboxing desired
\value SandboxingProcess Run ActiveX control in a separate process
\value SandboxingLowIntegrity Run ActiveX control in a separate low-integrity process
Sandboxing requires that the ActiveX is either built as an EXE, or as a DLL with AppID "DllSurrogate" enabled.
*/
enum ControlType { InProcessControl, OutOfProcessControl };
struct Control
{
int compare(const Control &rhs) const;
QString toolTip() const;
ControlType type = InProcessControl;
QString clsid;
QString name;
QString dll;
QString version;
QString rootKey;
unsigned wordSize = 0;
};
inline int Control::compare(const Control &rhs) const
{
// Sort reverse by word size to ensure that disabled 32bit controls
// are listed last in 64bit executables.
if (wordSize > rhs.wordSize)
return -1;
if (wordSize < rhs.wordSize)
return 1;
if (const int k = rootKey.compare(rhs.rootKey))
return k;
if (const int n = name.compare(rhs.name))
return n;
if (const int c = clsid.compare(rhs.clsid))
return c;
if (const int d = dll.compare(rhs.dll))
return d;
if (const int v = version.compare(rhs.version))
return v;
return 0;
}
static inline QString nonbreakingSpace(QString in)
{
in.replace(QStringLiteral(" "), QStringLiteral("&nbsp;"));
return in;
}
// The entry for an out of process binary typically looks like:
// "..\foo.exe" -activex
// Extract the actual binary
static QString outOfProcessBinary(const QString &entry)
{
if (entry.startsWith(QLatin1Char('"'))) {
const int closing = entry.indexOf(QLatin1Char('"'), 1);
if (closing > 1)
return entry.mid(1, closing - 1);
}
const int spacePos = entry.indexOf(QLatin1Char(' '));
return spacePos > 0 ? entry.left(spacePos) : entry;
}
// Replace environment variables enclosed in '%' in a string (registry entry)
static QString replaceEnvironmentVariables(QString in)
{
while (true) {
const int openInPercentPos = in.indexOf(QLatin1Char('%'));
if (openInPercentPos < 0)
break;
const int closingPercentPos = in.indexOf(QLatin1Char('%'), openInPercentPos + 1);
if (closingPercentPos < 0)
break;
const QStringRef varName = in.midRef(openInPercentPos + 1, closingPercentPos - openInPercentPos - 1);
const QString contents = QString::fromLocal8Bit(qgetenv(varName.toLocal8Bit()));
in.replace(openInPercentPos, closingPercentPos - openInPercentPos + 1, contents);
}
return in;
}
QString Control::toolTip() const
{
QString result;
QTextStream str(&result);
str << "<html><head/><body><table>"
<< "<tr><th>" << QAxSelect::tr("Name:") << "</th><td>" << nonbreakingSpace(name) << "</td></tr>"
<< "<tr><th>" << QAxSelect::tr("Type:") << "</th><td>"
<< (type == InProcessControl ? QAxSelect::tr("In process") : QAxSelect::tr("Out of process"))
<< "</td></tr>"
<< "<tr><th>" << QAxSelect::tr("CLSID:") << "</th><td>" << clsid << "</td></tr>"
<< "<tr><th>" << QAxSelect::tr("Key:") << "</th><td>" << rootKey << "</td></tr>"
<< "<tr><th>" << QAxSelect::tr("Word&nbsp;size:") << "</th><td>" << wordSize << "</td></tr>";
if (!dll.isEmpty()) {
str << "<tr><th>"
<< (type == InProcessControl ? QAxSelect::tr("DLL:") : QAxSelect::tr("Binary:"))
<< "</th><td";
if (!QFileInfo(dll).exists())
str << " style=\"color:red\"";
str << '>' << nonbreakingSpace(dll) << "</td></tr>";
}
if (!version.isEmpty())
str << "<tr><th>" << QAxSelect::tr("Version:") << "</th><td>" << version << "</td></tr>";
str << "</table></body></html>";
return result;
}
inline bool operator<(const Control &c1, const Control &c2) { return c1.compare(c2) < 0; }
inline bool operator==(const Control &c1, const Control &c2) { return !c1.compare(c2); }
static LONG RegistryQueryValue(HKEY hKey, LPCWSTR lpSubKey, LPBYTE lpData, LPDWORD lpcbData)
{
LONG ret = ERROR_FILE_NOT_FOUND;
HKEY hSubKey = nullptr;
RegOpenKeyEx(hKey, lpSubKey, 0, KEY_READ, &hSubKey);
if (hSubKey) {
ret = RegQueryValueEx(hSubKey, nullptr, nullptr, nullptr, lpData, lpcbData);
RegCloseKey(hSubKey);
}
return ret;
}
static bool querySubKeyValue(HKEY hKey, const QString &subKeyName, LPBYTE lpData, LPDWORD lpcbData)
{
HKEY hSubKey = nullptr;
const LONG openResult = RegOpenKeyEx(hKey, reinterpret_cast<const wchar_t *>(subKeyName.utf16()),
0, KEY_READ, &hSubKey);
if (openResult != ERROR_SUCCESS)
return false;
const bool result = RegQueryValueEx(hSubKey, nullptr, nullptr, nullptr, lpData, lpcbData) == ERROR_SUCCESS;
RegCloseKey(hSubKey);
return result;
}
static QList<Control> readControls(const wchar_t *rootKey, unsigned wordSize)
{
QList<Control> controls;
HKEY classesKey;
RegOpenKeyEx(HKEY_CLASSES_ROOT, rootKey, 0, KEY_READ, &classesKey);
if (!classesKey) {
qErrnoWarning("RegOpenKeyEx failed.");
return controls;
}
const QString rootKeyS = QStringLiteral("HKEY_CLASSES_ROOT\\") + QString::fromWCharArray(rootKey);
DWORD index = 0;
LONG result = 0;
wchar_t buffer[256];
DWORD szBuffer = 0;
FILETIME ft;
do {
szBuffer = sizeof(buffer) / sizeof(wchar_t);
result = RegEnumKeyEx(classesKey, index, buffer, &szBuffer, nullptr, nullptr, nullptr, &ft);
szBuffer = sizeof(buffer) / sizeof(wchar_t);
if (result == ERROR_SUCCESS) {
HKEY subKey;
const QString clsid = QString::fromWCharArray(buffer);
const QString key = clsid + QStringLiteral("\\Control");
result = RegOpenKeyEx(classesKey, reinterpret_cast<const wchar_t *>(key.utf16()), 0, KEY_READ, &subKey);
if (result == ERROR_SUCCESS) {
RegCloseKey(subKey);
szBuffer = sizeof(buffer) / sizeof(wchar_t);
RegistryQueryValue(classesKey, buffer, reinterpret_cast<LPBYTE>(buffer), &szBuffer);
Control control;
control.clsid = clsid;
control.wordSize = wordSize;
control.name = QString::fromWCharArray(buffer);
control.rootKey = rootKeyS;
szBuffer = sizeof(buffer) / sizeof(wchar_t);
if (querySubKeyValue(classesKey, clsid + QStringLiteral("\\InprocServer32"),
reinterpret_cast<LPBYTE>(buffer), &szBuffer)) {
control.type = InProcessControl;
control.dll = replaceEnvironmentVariables(QString::fromWCharArray(buffer));
} else if (querySubKeyValue(classesKey, clsid + QStringLiteral("\\LocalServer32"),
reinterpret_cast<LPBYTE>(buffer), &szBuffer)) {
control.type = OutOfProcessControl;
control.dll = outOfProcessBinary(replaceEnvironmentVariables(QString::fromWCharArray(buffer)));
}
szBuffer = sizeof(buffer) / sizeof(wchar_t);
if (querySubKeyValue(classesKey, clsid + QStringLiteral("\\VERSION"),
reinterpret_cast<LPBYTE>(buffer), &szBuffer))
control.version = QString::fromWCharArray(buffer);
controls.push_back(control);
}
result = ERROR_SUCCESS;
}
++index;
} while (result == ERROR_SUCCESS);
RegCloseKey(classesKey);
return controls;
}
class ControlList : public QAbstractListModel
{
public:
ControlList(QObject *parent=nullptr)
: QAbstractListModel(parent)
{
m_controls = readControls(L"CLSID", unsigned(QSysInfo::WordSize));
if (QSysInfo::WordSize == 64) // Append the 32bit controls
m_controls += readControls(L"Wow6432Node\\CLSID", 32u);
std::sort(m_controls.begin(), m_controls.end());
}
int rowCount(const QModelIndex & = QModelIndex()) const override { return m_controls.count(); }
QVariant data(const QModelIndex &index, int role) const override ;
Qt::ItemFlags flags(const QModelIndex &index) const override ;
private:
QList<Control> m_controls;
};
QVariant ControlList::data(const QModelIndex &index, int role) const
{
if (!index.isValid())
return QVariant();
switch (role) {
case Qt::DisplayRole:
return m_controls.at(index.row()).name;
case Qt::ToolTipRole:
return m_controls.at(index.row()).toolTip();
case Qt::UserRole:
return m_controls.at(index.row()).clsid;
default:
break;
}
return QVariant();
}
Qt::ItemFlags ControlList::flags(const QModelIndex &index) const
{
Qt::ItemFlags result = QAbstractListModel::flags(index);
if (index.isValid()) {
const Control &control = m_controls.at(index.row());
if (control.type == InProcessControl && control.wordSize != QSysInfo::WordSize)
result &= ~Qt::ItemIsEnabled;
}
return result;
}
class QAxSelectPrivate {
public:
inline QString clsidAt(const QModelIndex &index) const
{
if (index.isValid()) {
const QModelIndex sourceIndex = filterModel->mapToSource(index);
if (sourceIndex.isValid())
return sourceIndex.data(Qt::UserRole).toString();
}
return QString();
}
inline QPushButton *okButton() const { return selectUi.buttonBox->button(QDialogButtonBox::Ok); }
inline void setOkButtonEnabled(bool enabled) { okButton()->setEnabled(enabled); }
Ui::QAxSelect selectUi;
QSortFilterProxyModel *filterModel;
};
/*!
\class QAxSelect
\brief The QAxSelect class provides a selection dialog for registered COM components.
\inmodule QAxContainer
QAxSelect dialog can be used to provide users with a way to browse the registered COM
components of the system and select one. It also provides a combo box for selecting
desired sandboxing level. The CLSID of the selected component can then be used in the
application to e.g. initialize a QAxWidget:
\snippet src_activeqt_container_qaxselect.cpp 0
\sa QAxWidget, {ActiveQt Framework}
*/
/*!
Constructs a QAxSelect object. Dialog parent widget and window flags can be
optionally specified with \a parent and \a flags parameters, respectively.
*/
QAxSelect::QAxSelect(QWidget *parent, Qt::WindowFlags flags)
: QDialog(parent, flags)
, d(new QAxSelectPrivate)
{
setWindowFlags(windowFlags() &~ Qt::WindowContextHelpButtonHint);
d->selectUi.setupUi(this);
d->setOkButtonEnabled(false);
const QRect availableGeometry = QApplication::desktop()->availableGeometry(this);
resize(availableGeometry.width() / 4, availableGeometry.height() * 2 / 3);
#ifndef QT_NO_CURSOR
QApplication::setOverrideCursor(Qt::WaitCursor);
#endif
d->filterModel = new QSortFilterProxyModel(this);
d->filterModel->setFilterCaseSensitivity(Qt::CaseInsensitive);
d->filterModel->setSourceModel(new ControlList(this));
d->selectUi.ActiveXList->setModel(d->filterModel);
QStringList sandboxingOptions = { QLatin1String("None"), QLatin1String("Process isolation"), QLatin1String("Low integrity process") };
d->selectUi.SandboxingCombo->addItems(sandboxingOptions);
connect(d->selectUi.ActiveXList->selectionModel(), &QItemSelectionModel::currentChanged,
this, &QAxSelect::onActiveXListCurrentChanged);
connect(d->selectUi.ActiveXList, &QAbstractItemView::activated,
this, &QAxSelect::onActiveXListActivated);
#ifndef QT_NO_CURSOR
QApplication::restoreOverrideCursor();
#endif
d->selectUi.ActiveXList->setFocus();
connect(d->selectUi.buttonBox, &QDialogButtonBox::accepted, this, &QDialog::accept);
connect(d->selectUi.buttonBox, &QDialogButtonBox::rejected, this, &QDialog::reject);
connect(d->selectUi.filterLineEdit, &QLineEdit::textChanged,
this, &QAxSelect::onFilterLineEditChanged);
}
/*!
Destroys the QAxSelect object.
*/
QAxSelect::~QAxSelect() = default;
/*!
\fn QString QAxSelect::clsid() const
Returns the CLSID of the selected COM component.
*/
QString QAxSelect::clsid() const
{
return d->selectUi.ActiveX->text().trimmed();
}
/*!
\since 5.13
Returns the desired level of sandboxing for the ActiveX control.
*/
QAxSelect::SandboxingLevel QAxSelect::sandboxingLevel() const
{
switch (d->selectUi.SandboxingCombo->currentIndex()) {
case 1:
return SandboxingProcess;
case 2:
return SandboxingLowIntegrity;
default:
break;
}
return SandboxingNone;
}
void QAxSelect::onActiveXListCurrentChanged(const QModelIndex &index)
{
const QString newClsid = d->clsidAt(index);
d->selectUi.ActiveX->setText(newClsid);
d->setOkButtonEnabled(!newClsid.isEmpty());
}
void QAxSelect::onActiveXListActivated()
{
if (!clsid().isEmpty())
d->okButton()->animateClick();
}
void QAxSelect::onFilterLineEditChanged(const QString &text)
{
d->filterModel->setFilterFixedString(text);
}
QT_END_NAMESPACE