summaryrefslogtreecommitdiffstats
path: root/src/vsession.cpp
blob: b86f3147a2a43cacd9841435511487200b19e753 (plain) (blame)
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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
#include "config.h"

#include <QtXml>
#include <QDir>
#include <QApplication>
#include <QProcess>
#include <QDate>
#include <QThread>
#include <QStringList>
#include <QIcon>
#include <QMessageBox>
#include <QHostInfo> // available since Qt 4.7
#include <QList>
#include <QRegularExpression>
#include <unistd.h> // for getuid()
#include <sys/types.h> // for getuid(), getpwuid()
#include <pwd.h> // for getpwuid()
#include "globals.h"
#include "vsession.h"
#include "sessionsiconholder.h"
#include "userldapdata.h"
#include "virtualizer.h"

static QProcess _process;

static const QString VMWARE("vmware");
static const QString VIRTUALBOX("virtualbox");

struct IconMap {
    QString icon;
    QRegularExpression expr;
    IconMap(const QString &icon, const QString &regexp)
        : icon(icon), expr(regexp) {}
};

// It's first match wins, so put a check for windows95 before windows9
static const QList<IconMap> iconMapping(
{
    IconMap("dos", "^(ms)?dos"),
    IconMap("win311", "^win(dows)?3($|1)"),
    IconMap("win9x", "^win(dows)?(95|98|me|nt)"),
    IconMap("winxp", "^win(dows)?(xp|2003|2k3)"),
    IconMap("win2000", "^win(dows)?(2000|2k)"), // After win2k3!
    IconMap("win7", "^win(dows)?7"),
    IconMap("win8", "^win(dows)?8"),
    IconMap("win10", "^win(dows)?(9|10)"), // After win95!
    IconMap("osx", "^darwin"),
    IconMap("suse", "^opensuse"),
});

// These match via .startsWith and need to exist as a resource with this exact name
static const QStringList directOsNames(
{
    "amiga", "atari",
    "beos",
    "debian",
    "fedora", "freebsd",
    "gentoo",
    "macos",
    "opensolaris", "os2", "osx",
    "redhat", "riscos",
    "solaris", "suse",
    "ubuntu",
});

static const QRegularExpression cleanNameRegex("[^a-z0-9]");

bool VSession::init(const QDomElement& xml) {
    QDomElement settingsNode = this->doc_.createElement("settings");
    this->doc_.appendChild(settingsNode);
    eintrag_ = this->doc_.importNode(xml, true).toElement();
    return !settingsNode.appendChild(eintrag_).isNull() && !settingsNode.isNull();
}

void VSession::addNodeWithAttribute(const QString& nodeName,
                                 const QString& value,
                                 const QString& attribute,
                                 bool replace) {
    QDomElement node =
            eintrag_.firstChildElement(nodeName);

    if (replace == false || node.isNull()) {
        // create a new node
        node = this->doc_.createElement(nodeName);
        eintrag_.appendChild(node);
    }

    node.setAttribute(attribute, value);
}

QIcon VSession::icon() const {
    QString icon(getAttribute(QStringLiteral("icon")));
    SessionsIconHolder *iconHolder = SessionsIconHolder::get();
    if (icon.startsWith(QStringLiteral("http://")) || icon.startsWith(QStringLiteral("https://"))) {
       // try to load icon from url
       QIcon url_icon(iconHolder->getIcon(QUrl(icon)));
       if (!url_icon.isNull())
           return url_icon;
    }
    if (!icon.isEmpty()) {
        // See if we have a resource with this name, or if it's an absolute path
        QIcon res_icon(iconHolder->getIcon(icon));
        if (!res_icon.isNull())
            return res_icon;
    }
    // Everything failed, try to guess the OS
    QString os(this->os().toLower());
    os = os.replace(cleanNameRegex, QString());
    if (!os.isEmpty()) {
        // Now try known good OS names via .startsWith()
        for (const QString& str : directOsNames) {
            if (os.startsWith(str))
                return iconHolder->getIcon(str);
        }
        // Fuzzy matching via regex
        for (const IconMap& map : iconMapping) {
            if (map.expr.match(os).hasMatch())
                return iconHolder->getIcon(map.icon);
        }
        // Running out of ideas...
        if (os.startsWith(QStringLiteral("win")))
            return iconHolder->getIcon(QStringLiteral("windows"));
        if (os.contains(QStringLiteral("linux")))
            return iconHolder->getIcon(QStringLiteral("linux"));
    }
    // Fallback to generic virtualizer icon (if found)
    return iconHolder->getIcon(virtualizer());
}

QString VSession::toXml() const {
    QDomDocument doc(doc_);

    QDomNode xmlNode = doc.createProcessingInstruction(
            "xml", "version=\"1.0\" encoding=\"UTF-8\"");
    doc.insertBefore(xmlNode, doc.firstChild());
    QString image(this->getAttribute(QStringLiteral("image_name")));
    QDomElement path = doc.firstChildElement(QStringLiteral("settings"))
            .firstChildElement(QStringLiteral("eintrag"))
            .appendChild(doc.createElement(QStringLiteral("image_path")))
            .toElement();
    if (QFileInfo(image).isRelative()) {
        // make path to image absolute
        path.setAttribute(QStringLiteral("param"), Config::get(Config::BASEDIR) + "/" + image);
    } else {
        path.setAttribute(QStringLiteral("param"), image);
    }
    return doc.toString();
}

QString VSession::getAttribute(const QString &nodeName,
                                const QString &attribute) const {
    return eintrag_.firstChildElement(nodeName).attribute(attribute);
}

QList<QString> VSession::keywords() const {
    return this->keywords_;
}

void VSession::readKeywords() {
    QDomNode keywordsNode = eintrag_.namedItem(QStringLiteral("keywords"));
    for (QDomElement el(keywordsNode.firstChildElement(QStringLiteral("keyword")));
            !el.isNull();
            el = el.nextSiblingElement(QStringLiteral("keyword"))) {
        this->keywords_.append(el.text());
    }
}

bool VSession::containsKeywords(const QList<QString>& keywords) const {
    for (int j = 0; j < keywords.length(); ++j) {
        if (!this->shortDescription().contains(keywords[j], Qt::CaseInsensitive)
                && !this->description().contains(keywords[j], Qt::CaseInsensitive)
                && !this->getAttribute(QStringLiteral("creator"), QStringLiteral("param")).contains(keywords[j], Qt::CaseInsensitive)) {
            bool match = false;
            for (int i = 0; i < this->keywords().length(); ++i) {
                if (this->keywords()[i].contains(keywords[j], Qt::CaseInsensitive)) {
                    match = true;
                    break;
                }
            }
            if (!match)
                return false;
        }
    }
    return true;
}

QString VSession::getNodeText(const QString& nodeName) const {
    return this->doc_.namedItem(nodeName).toText().data();
}

bool VSession::isActive() const {
    QString value(getAttribute(QStringLiteral("active")));
    // Is disabled completely
    if (value.compare("false") == 0) {
        if (g_debugMode) qDebug() << "'" << shortDescription() << "' not active. Reason: active == false";
        return false;
    }
    // Filter by LDAP data
    if (!UserLdapData::isEmpty()) {
        QDomElement el(eintrag_.namedItem(QStringLiteral("filters")).firstChildElement(QStringLiteral("filter")));
        if (!el.isNull()) {
            for (; !el.isNull(); el = el.nextSiblingElement(QStringLiteral("filter"))) {
                if (el.attribute(QStringLiteral("type")) != QStringLiteral("LDAP"))
                    continue;
                if (UserLdapData::isAllowed(el.firstChildElement(QStringLiteral("key")).text(), el.firstChildElement(QStringLiteral("value")).text()))
                    return true;
            }
            return false;
        }
    }

    return true;
}

bool VSession::isLocked() const {
    // default to false
    return getAttribute(QStringLiteral("locked")).compare(QStringLiteral("true")) == 0;
}

QString VSession::checkCanRunInternal() const {
    if (getAttribute(QStringLiteral("image_name")).isEmpty())
        return QObject::trUtf8("XML error: image_name is empty");
    const Virtualizer* virt = Virtualizer::get(virtualizer());
    if (!virt->isAvailable)
        return QObject::trUtf8("Virtualizer '%1' is not enabled.").arg(virt->id);
    // Seems OK
    return QString();
}

int VSession::priority() const {
    int prio = getAttribute(QStringLiteral("priority")).toInt();
    if (g_templateHandling == TEMPLATES_BUMP && isTemplate()) {
        prio -= 500;
    }
    if (g_forLocationHandling != LOCATION_IGNORE && isForLocation()) {
        prio -= 1000;
    }
    return prio;
}

bool VSession::run() const {
    if (_process.state() != QProcess::NotRunning) {
        qDebug() << "Cannot start vsession while old one is still running";
        return false;
    }
    if (g_debugMode) {
        qDebug() << "Sarting session " << shortDescription() << " ...";
    }

    if (g_noVtx && needsVtx()) {
        QMessageBox::warning(nullptr, QObject::trUtf8("Warning"),
                QObject::trUtf8("The selected session is based on a 64 bit operating system,"
                        " but this computer doesn't seem to support this (VT-x/AMD-V not"
                        " supported by CPU, or disabled in BIOS). You will probably get an"
                        " error message while the virtualizer is initializing."));
    }

    QString command = getAttribute(QStringLiteral("command"));
    if (!command.isEmpty()) {
        return QProcess::startDetached(command);
    }

    // write xml to temporary file
    QTemporaryFile tmpfile(QDir::tempPath() + QStringLiteral("/vmchooser-XXXXXX.xml"));
    if (!tmpfile.open() ||
        tmpfile.write(this->toXml().toUtf8()) == -1) {
        qDebug() << "Error writing xml to file" << tmpfile.fileName();
        return false;
    }
    // Docs say we should call fileName() before closing to prevent deletion
    QString tmpFileName = tmpfile.fileName();
    tmpfile.setAutoRemove(false);
    tmpfile.close();

    QObject::connect(&_process, QOverload<int, QProcess::ExitStatus>::of(&QProcess::finished), QApplication::instance(), &QCoreApplication::quit);
    _process.start(Config::get(Config::RUNSCRIPT), QStringList(tmpFileName));
    _process.waitForStarted(10);
    if (_process.state() == QProcess::Starting || _process.state() == QProcess::Running)
        return true;
    else
        return false;
}

int VSession::type() const {
    return Session::VSESSION;
}

QList<Session*> VSession::loadFromXmlDocument(const QDomDocument& doc) {
    QList<Session*> sessionList;
    if (doc.isNull())
        return sessionList;

    UserLdapData::init();
    QDomElement settingsNode = doc.firstChildElement(QStringLiteral("settings"));
    if (settingsNode.isNull())
        return sessionList;
    for (QDomElement el(settingsNode.firstChildElement(QStringLiteral("eintrag")));
            !el.isNull();
            el = el.nextSiblingElement(QStringLiteral("eintrag"))) {
        VSession* e = new VSession;
        if (e->init(el) && e->isActive()) {
            e->readKeywords();
            sessionList.append(e);
        } else {
            delete e;
        }
    }
    return sessionList;
}

bool VSession::needsVtx() const {
    QString type = virtualizer();
    return (type == VMWARE && os().endsWith(QStringLiteral("-64")))
            || (type == VIRTUALBOX && os().endsWith(QStringLiteral("_64"))); // Vbox 6.x DOES support 32bit VMs without VT-x, but if
    // the config enables any feature that cannot work without VT-x, it will silently enable it and then fail to start (i.e. IOAPIC)
    // TODO: qemu-kvm, ...
}

QVariant VSession::foregroundRole() const {
    if ((!g_noVtx || !needsVtx()) && canRun())
        return Session::foregroundRole();
    return QColor(180, 180, 180);
}

bool VSession::operator<(const Session& other) const {
    int p0 = this->priority();
    int p1 = other.priority();

    if (p0 < p1) return true;
    if (p0 == p1) {
        QString d0 = this->shortDescription();
        QString d1 = other.shortDescription();
        return d0.localeAwareCompare(d1) < 0;
    }
    return false;
}