1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
/*
probesettings.cpp
This file is part of GammaRay, the Qt application inspection and manipulation tool.
SPDX-FileCopyrightText: 2013 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
Author: Volker Krause <volker.krause@kdab.com>
SPDX-License-Identifier: GPL-2.0-or-later
Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
#include <config-gammaray.h>
#include "probesettings.h"
#include "common/message.h"
#include "common/paths.h"
#include <QCoreApplication>
#include <QDebug>
#include <QDir>
#include <QLocalSocket>
#include <QMutex>
#include <QUrl>
#include <QThread>
#include <QWaitCondition>
#ifdef Q_OS_ANDROID
#include <QtAndroid>
#endif
#include <iostream>
using namespace GammaRay;
namespace GammaRay {
class ProbeSettingsReceiver;
struct ProbeSettingsData
{
QHash<QByteArray, QByteArray> settings;
ProbeSettingsReceiver *receiver;
};
Q_GLOBAL_STATIC(ProbeSettingsData, s_probeSettings)
class ProbeSettingsReceiver : public QObject
{
Q_OBJECT
public:
explicit ProbeSettingsReceiver(QObject *parent = nullptr);
~ProbeSettingsReceiver() override;
Q_INVOKABLE void sendServerAddress(const QUrl &address);
Q_INVOKABLE void sendServerLaunchError(const QString &reason);
void waitForSettingsReceived();
private slots:
void readyRead();
void settingsReceivedFallback();
private:
Q_INVOKABLE void run();
static void setRootPathFromProbePath(const QString &probePath);
QLocalSocket *m_socket = nullptr;
QWaitCondition m_waitCondition;
QMutex m_mutex;
};
ProbeSettingsReceiver::ProbeSettingsReceiver(QObject *parent)
: QObject(parent)
{
}
ProbeSettingsReceiver::~ProbeSettingsReceiver()
{
delete m_socket;
}
void ProbeSettingsReceiver::run()
{
m_mutex.lock(); // we only need this for ordering run after waitForSettingsReceived
m_mutex.unlock();
m_socket = new QLocalSocket;
connect(m_socket, &QLocalSocket::disconnected, this, &ProbeSettingsReceiver::settingsReceivedFallback);
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
connect(m_socket, &QLocalSocket::errorOccurred, this, &ProbeSettingsReceiver::settingsReceivedFallback);
#else
connect(m_socket, static_cast<void (QLocalSocket::*)(QLocalSocket::LocalSocketError)>(&QLocalSocket::error),
this, &ProbeSettingsReceiver::settingsReceivedFallback);
#endif
connect(m_socket, &QIODevice::readyRead, this, &ProbeSettingsReceiver::readyRead);
m_socket->connectToServer(QStringLiteral("gammaray-")
+ QString::number(ProbeSettings::launcherIdentifier()));
if (!m_socket->waitForConnected(10000)) {
#ifndef Q_OS_ANDROID
qWarning() << "Failed to connect to launcher, can't receive probe settings!"
<< m_socket->errorString();
#endif
settingsReceivedFallback();
}
}
void ProbeSettingsReceiver::waitForSettingsReceived()
{
m_mutex.lock();
QMetaObject::invokeMethod(this, "run", Qt::QueuedConnection);
m_waitCondition.wait(&m_mutex);
m_mutex.unlock();
}
void ProbeSettingsReceiver::readyRead()
{
while (Message::canReadMessage(m_socket)) {
auto msg = Message::readMessage(m_socket);
switch (msg.type()) {
case Protocol::ServerVersion: {
qint32 version;
msg >> version;
if (version != Protocol::version()) {
qWarning()
<< "Unable to receive probe settings, mismatching protocol versions (expected:"
<< Protocol::version() << "got:" << version << ")";
qWarning() << "Continuing anyway, but this is likely going to fail.";
settingsReceivedFallback();
return;
}
break;
}
case Protocol::ProbeSettings: {
msg >> s_probeSettings()->settings;
// qDebug() << Q_FUNC_INFO << s_probeSettings()->settings;
const QString probePath = ProbeSettings::value(QStringLiteral("ProbePath")).toString();
setRootPathFromProbePath(probePath);
m_waitCondition.wakeAll();
return;
}
default:
continue;
}
}
}
void ProbeSettingsReceiver::sendServerAddress(const QUrl &address)
{
if (!m_socket || m_socket->state() != QLocalSocket::ConnectedState)
return;
Message msg(Protocol::LauncherAddress, Protocol::ServerAddress);
msg << address;
msg.write(m_socket);
m_socket->waitForBytesWritten();
m_socket->close();
deleteLater();
s_probeSettings()->receiver = nullptr;
thread()->quit();
}
void ProbeSettingsReceiver::sendServerLaunchError(const QString &reason)
{
if (!m_socket || m_socket->state() != QLocalSocket::ConnectedState)
return;
Message msg(Protocol::LauncherAddress, Protocol::ServerLaunchError);
msg << reason;
msg.write(m_socket);
m_socket->waitForBytesWritten();
m_socket->close();
deleteLater();
s_probeSettings()->receiver = nullptr;
thread()->quit();
}
void ProbeSettingsReceiver::settingsReceivedFallback()
{
// see if we got fallback data via environment variables
const QString probePath = ProbeSettings::value(QStringLiteral("ProbePath")).toString();
setRootPathFromProbePath(probePath);
m_waitCondition.wakeAll();
}
void ProbeSettingsReceiver::setRootPathFromProbePath(const QString &probePath)
{
if (probePath.isEmpty())
return;
QFileInfo fi(probePath);
if (fi.isFile())
Paths::setRootPath(fi.absolutePath() + QDir::separator() + GAMMARAY_INVERSE_PROBE_DIR);
else
Paths::setRootPath(probePath + QDir::separator() + GAMMARAY_INVERSE_PROBE_DIR);
}
}
#ifdef QT_ANDROIDEXTRAS_LIB
static QVariant getPackageMetaData(const QString &key, const QVariant &defaultValue)
{
auto pm = QtAndroid::androidContext().callObjectMethod("getPackageManager", "()Landroid/content/pm/PackageManager;");
auto packageName = QtAndroid::androidContext().callObjectMethod("getPackageName", "()Ljava/lang/String;");
auto GET_META_DATA = QAndroidJniObject::getStaticField<jint>("android/content/pm/PackageManager", "GET_META_DATA");
auto appInfo = pm.callObjectMethod("getApplicationInfo", "(Ljava/lang/String;I)Landroid/content/pm/ApplicationInfo;", packageName.object(), GET_META_DATA);
auto metaData = appInfo.getObjectField("metaData", "Landroid/os/Bundle;");
if (!metaData.isValid()) {
return defaultValue;
}
// TODO handle different type cases based on defaultValue.type()
auto value = metaData.callObjectMethod("getString", "(Ljava/lang/String;)Ljava/lang/String;", QAndroidJniObject::fromString(key).object());
if (value.isValid()) {
return value.toString();
}
return defaultValue;
}
#endif
QVariant ProbeSettings::value(const QString &key, const QVariant &defaultValue)
{
QByteArray v = s_probeSettings()->settings.value(key.toUtf8());
if (v.isEmpty()) {
const QByteArray cstr = "GAMMARAY_" + key.toLocal8Bit();
v = qgetenv(cstr);
}
#ifdef QT_ANDROIDEXTRAS_LIB
if (v.isEmpty()) {
return getPackageMetaData("com.kdab.gammaray." + key, defaultValue);
}
#endif
if (v.isEmpty())
return defaultValue;
switch (defaultValue.type()) {
case QVariant::String:
return QString::fromUtf8(v);
case QVariant::Bool:
return v == "true" || v == "1" || v == "TRUE";
case QVariant::Int:
return v.toInt();
default:
return v;
}
}
void ProbeSettings::receiveSettings()
{
auto t = new QThread;
QObject::connect(t, &QThread::finished, t, &QObject::deleteLater);
t->start();
auto receiver = new ProbeSettingsReceiver;
s_probeSettings()->receiver = receiver;
receiver->moveToThread(t);
receiver->waitForSettingsReceived();
}
qint64 ProbeSettings::launcherIdentifier()
{
bool ok;
const qint64 id = qgetenv("GAMMARAY_LAUNCHER_ID").toLongLong(&ok);
if (ok && id > 0)
return id;
return QCoreApplication::applicationPid();
}
void ProbeSettings::resetLauncherIdentifier()
{
// if we were launch by GammaRay, and we later try to re-attach, we need to make sure
// to not end up with an outdated launcher id
qputenv("GAMMARAY_LAUNCHER_ID", "");
}
void ProbeSettings::sendServerAddress(const QUrl &addr)
{
Q_ASSERT(s_probeSettings()->receiver);
QMetaObject::invokeMethod(s_probeSettings()->receiver, "sendServerAddress", Q_ARG(QUrl, addr));
}
void ProbeSettings::sendServerLaunchError(const QString &reason)
{
Q_ASSERT(s_probeSettings()->receiver);
QMetaObject::invokeMethod(s_probeSettings()->receiver, "sendServerLaunchError", Q_ARG(QString, reason));
}
#include "probesettings.moc"
|