annotate installer.cpp @ 94:b2e0b5d4cc5a

Avoid creating more than one backup dir
author Chris Cannam
date Thu, 27 Feb 2020 15:04:53 +0000
parents 5ac455fba0ed
children 24d64a983fc8
rev   line source
Chris@66 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@66 2 /*
Chris@66 3 Copyright (c) 2020 Queen Mary, University of London
Chris@66 4
Chris@66 5 Permission is hereby granted, free of charge, to any person
Chris@66 6 obtaining a copy of this software and associated documentation
Chris@66 7 files (the "Software"), to deal in the Software without
Chris@66 8 restriction, including without limitation the rights to use, copy,
Chris@66 9 modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@66 10 of the Software, and to permit persons to whom the Software is
Chris@66 11 furnished to do so, subject to the following conditions:
Chris@66 12
Chris@66 13 The above copyright notice and this permission notice shall be
Chris@66 14 included in all copies or substantial portions of the Software.
Chris@66 15
Chris@66 16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@66 17 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@66 18 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@66 19 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
Chris@66 20 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@66 21 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@66 22 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@66 23
Chris@66 24 Except as contained in this notice, the names of the Centre for
Chris@66 25 Digital Music and Queen Mary, University of London shall not be
Chris@66 26 used in advertising or otherwise to promote the sale, use or other
Chris@66 27 dealings in this Software without prior written authorization.
Chris@66 28 */
Chris@33 29
Chris@33 30 #include <QApplication>
Chris@33 31 #include <QString>
Chris@33 32 #include <QFile>
Chris@33 33 #include <QDir>
Chris@33 34
Chris@42 35 #include <QDialog>
Chris@42 36 #include <QFrame>
Chris@42 37 #include <QVBoxLayout>
Chris@42 38 #include <QCheckBox>
Chris@42 39 #include <QDialogButtonBox>
Chris@46 40 #include <QLabel>
Chris@51 41 #include <QFont>
Chris@51 42 #include <QFontInfo>
Chris@67 43 #include <QTemporaryFile>
Chris@67 44 #include <QMutex>
Chris@67 45 #include <QMutexLocker>
Chris@67 46 #include <QProcess>
Chris@72 47 #include <QToolButton>
Chris@79 48 #include <QPushButton>
Chris@72 49 #include <QMessageBox>
Chris@74 50 #include <QSvgRenderer>
Chris@74 51 #include <QPainter>
Chris@74 52 #include <QFontMetrics>
Chris@79 53 #include <QSpacerItem>
Chris@81 54 #include <QProgressDialog>
Chris@81 55 #include <QThread>
Chris@86 56 #include <QDateTime>
Chris@42 57
Chris@41 58 #include <vamp-hostsdk/PluginHostAdapter.h>
Chris@41 59
Chris@43 60 #include <dataquay/BasicStore.h>
Chris@43 61 #include <dataquay/RDFException.h>
Chris@43 62
Chris@33 63 #include <iostream>
Chris@58 64 #include <memory>
Chris@43 65 #include <set>
Chris@43 66
Chris@51 67 #include "base/Debug.h"
Chris@51 68
Chris@79 69 #include "version.h"
Chris@79 70
Chris@33 71 using namespace std;
Chris@43 72 using namespace Dataquay;
Chris@32 73
Chris@42 74 QString
Chris@42 75 getDefaultInstallDirectory()
Chris@32 76 {
Chris@41 77 auto pathList = Vamp::PluginHostAdapter::getPluginPath();
Chris@41 78 if (pathList.empty()) {
Chris@51 79 SVCERR << "Failed to look up Vamp plugin path" << endl;
Chris@42 80 return QString();
Chris@41 81 }
Chris@41 82
Chris@42 83 auto firstPath = *pathList.begin();
Chris@42 84 QString target = QString::fromUtf8(firstPath.c_str(), firstPath.size());
Chris@42 85 return target;
Chris@42 86 }
Chris@42 87
Chris@42 88 QStringList
Chris@42 89 getPluginLibraryList()
Chris@42 90 {
Chris@33 91 QDir dir(":out/");
Chris@33 92 auto entries = dir.entryList({ "*.so", "*.dll", "*.dylib" });
Chris@33 93
Chris@33 94 for (auto e: entries) {
Chris@51 95 SVCERR << e.toStdString() << endl;
Chris@33 96 }
Chris@33 97
Chris@42 98 return entries;
Chris@42 99 }
Chris@33 100
Chris@50 101 void
Chris@50 102 loadLibraryRdf(BasicStore &store, QString filename)
Chris@50 103 {
Chris@50 104 QFile f(filename);
Chris@50 105 if (!f.open(QFile::ReadOnly | QFile::Text)) {
Chris@51 106 SVCERR << "Failed to open RDF resource file "
Chris@51 107 << filename.toStdString() << endl;
Chris@50 108 return;
Chris@50 109 }
Chris@50 110
Chris@50 111 QByteArray content = f.readAll();
Chris@50 112 f.close();
Chris@50 113
Chris@50 114 try {
Chris@50 115 store.importString(QString::fromUtf8(content),
Chris@50 116 Uri("file:" + filename),
Chris@50 117 BasicStore::ImportIgnoreDuplicates);
Chris@50 118 } catch (const RDFException &ex) {
Chris@51 119 SVCERR << "Failed to import RDF resource file "
Chris@51 120 << filename.toStdString() << ": " << ex.what() << endl;
Chris@50 121 }
Chris@50 122 }
Chris@50 123
Chris@43 124 unique_ptr<BasicStore>
Chris@43 125 loadLibrariesRdf()
Chris@43 126 {
Chris@43 127 unique_ptr<BasicStore> store(new BasicStore);
Chris@43 128
Chris@50 129 vector<QString> dirs { ":rdf/plugins", ":out" };
Chris@43 130
Chris@50 131 for (auto d: dirs) {
Chris@50 132 for (auto e: QDir(d).entryList({ "*.ttl", "*.n3" })) {
Chris@50 133 loadLibraryRdf(*store, d + "/" + e);
Chris@43 134 }
Chris@43 135 }
Chris@43 136
Chris@43 137 return store;
Chris@43 138 }
Chris@43 139
Chris@43 140 struct LibraryInfo {
Chris@43 141 QString id;
Chris@43 142 QString fileName;
Chris@43 143 QString title;
Chris@43 144 QString maker;
Chris@43 145 QString description;
Chris@78 146 QString page;
Chris@47 147 QStringList pluginTitles;
Chris@67 148 map<QString, int> pluginVersions; // id -> version
Chris@74 149 QString licence;
Chris@43 150 };
Chris@43 151
Chris@74 152 QString
Chris@74 153 identifyLicence(QString libraryBasename)
Chris@74 154 {
Chris@74 155 QString licenceFile = QString(":out/%1_COPYING.txt").arg(libraryBasename);
Chris@74 156
Chris@74 157 QFile f(licenceFile);
Chris@74 158 if (!f.open(QFile::ReadOnly | QFile::Text)) {
Chris@74 159 SVCERR << "Failed to open licence file "
Chris@74 160 << licenceFile.toStdString() << endl;
Chris@74 161 return {};
Chris@74 162 }
Chris@74 163
Chris@74 164 QByteArray content = f.readAll();
Chris@74 165 f.close();
Chris@74 166
Chris@74 167 QString licenceText = QString::fromUtf8(content);
Chris@74 168
Chris@74 169 QString gpl = "GNU General Public License";
Chris@74 170 QString agpl = "GNU Affero General Public License";
Chris@74 171 QString apache = "Apache License";
Chris@74 172 QString mit = "MIT License";
Chris@74 173
Chris@82 174 // NB these are not expected to identify an arbitrary licence! We
Chris@74 175 // know we have only a limited set here. But we do want to
Chris@74 176 // determine this from the actual licence text included with the
Chris@74 177 // plugin distribution, not just from e.g. RDF metadata
Chris@74 178
Chris@74 179 if (licenceText.contains(gpl.toUpper(), Qt::CaseSensitive)) {
Chris@74 180 if (licenceText.contains("Version 3, 29 June 2007")) {
Chris@74 181 return QString("%1, version 3").arg(gpl);
Chris@74 182 } else if (licenceText.contains("Version 2, June 1991")) {
Chris@74 183 return QString("%1, version 2").arg(gpl);
Chris@74 184 } else {
Chris@74 185 return gpl;
Chris@74 186 }
Chris@74 187 }
Chris@74 188 if (licenceText.contains(agpl.toUpper(), Qt::CaseSensitive)) {
Chris@74 189 return agpl;
Chris@74 190 }
Chris@74 191 if (licenceText.contains(apache)) {
Chris@74 192 return apache;
Chris@74 193 }
Chris@74 194 if (licenceText.contains("Permission is hereby granted, free of charge, to any person")) {
Chris@74 195 return mit;
Chris@74 196 }
Chris@74 197
Chris@74 198 SVCERR << "Didn't recognise licence for " << libraryBasename << endl;
Chris@74 199
Chris@74 200 return {};
Chris@74 201 }
Chris@74 202
Chris@43 203 vector<LibraryInfo>
Chris@43 204 getLibraryInfo(const Store &store, QStringList libraries)
Chris@43 205 {
Chris@43 206 /* e.g.
Chris@43 207
Chris@43 208 plugbase:library a vamp:PluginLibrary ;
Chris@43 209 vamp:identifier "qm-vamp-plugins" ;
Chris@43 210 dc:title "Queen Mary plugin set"
Chris@43 211 */
Chris@43 212
Chris@43 213 Triples tt = store.match(Triple(Node(),
Chris@43 214 Uri("a"),
Chris@43 215 store.expand("vamp:PluginLibrary")));
Chris@43 216
Chris@67 217 map<QString, QString> wanted; // basename -> full lib name
Chris@43 218 for (auto lib: libraries) {
Chris@43 219 wanted[QFileInfo(lib).baseName()] = lib;
Chris@43 220 }
Chris@43 221
Chris@43 222 vector<LibraryInfo> results;
Chris@43 223
Chris@43 224 for (auto t: tt) {
Chris@43 225
Chris@43 226 Node libId = store.complete(Triple(t.subject(),
Chris@43 227 store.expand("vamp:identifier"),
Chris@43 228 Node()));
Chris@43 229 if (libId.type != Node::Literal) {
Chris@43 230 continue;
Chris@43 231 }
Chris@43 232 auto wi = wanted.find(libId.value);
Chris@43 233 if (wi == wanted.end()) {
Chris@43 234 continue;
Chris@43 235 }
Chris@74 236
Chris@50 237 Node title = store.complete(Triple(t.subject(),
Chris@50 238 store.expand("dc:title"),
Chris@50 239 Node()));
Chris@50 240 if (title.type != Node::Literal) {
Chris@50 241 continue;
Chris@50 242 }
Chris@50 243
Chris@43 244 LibraryInfo info;
Chris@43 245 info.id = wi->first;
Chris@43 246 info.fileName = wi->second;
Chris@50 247 info.title = title.value;
Chris@43 248
Chris@43 249 Node maker = store.complete(Triple(t.subject(),
Chris@43 250 store.expand("foaf:maker"),
Chris@43 251 Node()));
Chris@43 252 if (maker.type == Node::Literal) {
Chris@43 253 info.maker = maker.value;
Chris@46 254 } else if (maker != Node()) {
Chris@46 255 maker = store.complete(Triple(maker,
Chris@46 256 store.expand("foaf:name"),
Chris@46 257 Node()));
Chris@46 258 if (maker.type == Node::Literal) {
Chris@46 259 info.maker = maker.value;
Chris@46 260 }
Chris@43 261 }
Chris@46 262
Chris@43 263 Node desc = store.complete(Triple(t.subject(),
Chris@43 264 store.expand("dc:description"),
Chris@43 265 Node()));
Chris@43 266 if (desc.type == Node::Literal) {
Chris@43 267 info.description = desc.value;
Chris@43 268 }
Chris@78 269
Chris@78 270 Node page = store.complete(Triple(t.subject(),
Chris@78 271 store.expand("foaf:page"),
Chris@78 272 Node()));
Chris@79 273 if (page.type == Node::URI) {
Chris@79 274 info.page = page.value;
Chris@78 275 }
Chris@43 276
Chris@47 277 Triples pp = store.match(Triple(t.subject(),
Chris@47 278 store.expand("vamp:available_plugin"),
Chris@47 279 Node()));
Chris@47 280 for (auto p: pp) {
Chris@47 281 Node ptitle = store.complete(Triple(p.object(),
Chris@47 282 store.expand("dc:title"),
Chris@47 283 Node()));
Chris@47 284 if (ptitle.type == Node::Literal) {
Chris@47 285 info.pluginTitles.push_back(ptitle.value);
Chris@47 286 }
Chris@67 287
Chris@67 288 Node pident = store.complete(Triple(p.object(),
Chris@67 289 store.expand("vamp:identifier"),
Chris@67 290 Node()));
Chris@67 291 Node pversion = store.complete(Triple(p.object(),
Chris@67 292 store.expand("owl:versionInfo"),
Chris@67 293 Node()));
Chris@67 294 if (pident.type == Node::Literal &&
Chris@67 295 pversion.type == Node::Literal) {
Chris@67 296 bool ok = false;
Chris@67 297 int version = pversion.value.toInt(&ok);
Chris@67 298 if (ok) {
Chris@67 299 info.pluginVersions[pident.value] = version;
Chris@67 300 }
Chris@67 301 }
Chris@47 302 }
Chris@74 303
Chris@74 304 info.licence = identifyLicence(libId.value);
Chris@74 305 SVCERR << "licence = " << info.licence << endl;
Chris@47 306
Chris@43 307 results.push_back(info);
Chris@50 308 wanted.erase(libId.value);
Chris@43 309 }
Chris@43 310
Chris@50 311 for (auto wp: wanted) {
Chris@51 312 SVCERR << "Failed to find any RDF information about library "
Chris@51 313 << wp.second << endl;
Chris@50 314 }
Chris@50 315
Chris@43 316 return results;
Chris@43 317 }
Chris@43 318
Chris@67 319 struct TempFileDeleter {
Chris@67 320 ~TempFileDeleter() {
Chris@67 321 if (tempFile != "") {
Chris@67 322 QFile(tempFile).remove();
Chris@67 323 }
Chris@67 324 }
Chris@67 325 QString tempFile;
Chris@67 326 };
Chris@67 327
Chris@67 328 map<QString, int>
Chris@70 329 getLibraryPluginVersions(QString libraryFilePath)
Chris@67 330 {
Chris@67 331 static QMutex mutex;
Chris@67 332 static QString tempFileName;
Chris@67 333 static TempFileDeleter deleter;
Chris@67 334 static bool initHappened = false, initSucceeded = false;
Chris@67 335
Chris@67 336 QMutexLocker locker (&mutex);
Chris@67 337
Chris@67 338 if (!initHappened) {
Chris@67 339 initHappened = true;
Chris@67 340
Chris@67 341 QTemporaryFile tempFile;
Chris@67 342 tempFile.setAutoRemove(false);
Chris@67 343 if (!tempFile.open()) {
Chris@67 344 SVCERR << "ERROR: Failed to open a temporary file" << endl;
Chris@67 345 return {};
Chris@67 346 }
Chris@67 347
Chris@67 348 // We can't make the QTemporaryFile static, as it will hold
Chris@67 349 // the file open and that prevents us from executing it. Hence
Chris@67 350 // the separate deleter.
Chris@67 351
Chris@67 352 tempFileName = tempFile.fileName();
Chris@67 353 deleter.tempFile = tempFileName;
Chris@67 354
Chris@67 355 #ifdef Q_OS_WIN32
Chris@67 356 QString helperPath = ":out/get-version.exe";
Chris@67 357 #else
Chris@67 358 QString helperPath = ":out/get-version";
Chris@67 359 #endif
Chris@67 360 QFile helper(helperPath);
Chris@67 361 if (!helper.open(QFile::ReadOnly)) {
Chris@67 362 SVCERR << "ERROR: Failed to read helper code" << endl;
Chris@67 363 return {};
Chris@67 364 }
Chris@67 365 QByteArray content = helper.readAll();
Chris@67 366 helper.close();
Chris@67 367
Chris@67 368 if (tempFile.write(content) != content.size()) {
Chris@67 369 SVCERR << "ERROR: Incomplete write to temporary file" << endl;
Chris@67 370 return {};
Chris@67 371 }
Chris@67 372 tempFile.close();
Chris@67 373
Chris@67 374 if (!QFile::setPermissions
Chris@67 375 (tempFileName,
Chris@67 376 QFile::ReadOwner | QFile::WriteOwner | QFile::ExeOwner)) {
Chris@67 377 SVCERR << "ERROR: Failed to set execute permission on helper "
Chris@67 378 << tempFileName << endl;
Chris@67 379 return {};
Chris@67 380 }
Chris@67 381
Chris@67 382 initSucceeded = true;
Chris@67 383 }
Chris@67 384
Chris@67 385 if (!initSucceeded) {
Chris@67 386 return {};
Chris@67 387 }
Chris@67 388
Chris@67 389 QProcess process;
Chris@67 390 process.start(tempFileName, { libraryFilePath });
Chris@67 391
Chris@67 392 if (!process.waitForStarted()) {
Chris@67 393 QProcess::ProcessError err = process.error();
Chris@67 394 if (err == QProcess::FailedToStart) {
Chris@67 395 SVCERR << "Unable to start helper process " << tempFileName << endl;
Chris@67 396 } else if (err == QProcess::Crashed) {
Chris@67 397 SVCERR << "Helper process " << tempFileName
Chris@67 398 << " crashed on startup" << endl;
Chris@67 399 } else {
Chris@67 400 SVCERR << "Helper process " << tempFileName
Chris@67 401 << " failed on startup with error code " << err << endl;
Chris@67 402 }
Chris@67 403 return {};
Chris@67 404 }
Chris@67 405 process.waitForFinished();
Chris@67 406
Chris@67 407 QByteArray stdOut = process.readAllStandardOutput();
Chris@67 408 QByteArray stdErr = process.readAllStandardError();
Chris@67 409
Chris@67 410 QString errStr = QString::fromUtf8(stdErr);
Chris@67 411 if (!errStr.isEmpty()) {
Chris@67 412 SVCERR << "Note: Helper process stderr follows:" << endl;
Chris@67 413 SVCERR << errStr << endl;
Chris@67 414 SVCERR << "Note: Helper process stderr ends" << endl;
Chris@67 415 }
Chris@67 416
Chris@67 417 QStringList lines = QString::fromUtf8(stdOut).split
Chris@67 418 (QRegExp("[\\r\\n]+"), QString::SkipEmptyParts);
Chris@67 419 map<QString, int> versions;
Chris@67 420 for (QString line: lines) {
Chris@67 421 QStringList parts = line.split(":");
Chris@67 422 if (parts.size() != 2) {
Chris@67 423 SVCERR << "Unparseable output line: " << line << endl;
Chris@67 424 continue;
Chris@67 425 }
Chris@67 426 bool ok = false;
Chris@67 427 int version = parts[1].toInt(&ok);
Chris@67 428 if (!ok) {
Chris@67 429 SVCERR << "Unparseable version number in line: " << line << endl;
Chris@67 430 continue;
Chris@67 431 }
Chris@67 432 versions[parts[0]] = version;
Chris@67 433 }
Chris@67 434
Chris@67 435 return versions;
Chris@67 436 }
Chris@67 437
Chris@67 438 bool isLibraryNewer(map<QString, int> a, map<QString, int> b)
Chris@67 439 {
Chris@67 440 // a and b are maps from plugin id to plugin version for libraries
Chris@67 441 // A and B. (There is no overarching library version number.) We
Chris@67 442 // deem library A to be newer than library B if:
Chris@67 443 //
Chris@67 444 // 1. A contains a plugin id that is also in B, whose version in
Chris@67 445 // A is newer than that in B, or
Chris@67 446 //
Chris@67 447 // 2. B is not newer than A according to rule 1, and neither A or
Chris@67 448 // B is empty, and A contains a plugin id that is not in B, and B
Chris@67 449 // does not contain any plugin id that is not in A
Chris@67 450 //
Chris@67 451 // (The not-empty part of rule 2 is just to avoid false positives
Chris@67 452 // when a library or its metadata could not be read at all.)
Chris@67 453
Chris@67 454 auto containsANewerPlugin = [](const map<QString, int> &m1,
Chris@67 455 const map<QString, int> &m2) {
Chris@67 456 for (auto p: m1) {
Chris@67 457 if (m2.find(p.first) != m2.end() &&
Chris@67 458 p.second > m2.at(p.first)) {
Chris@67 459 return true;
Chris@67 460 }
Chris@67 461 }
Chris@67 462 return false;
Chris@67 463 };
Chris@67 464
Chris@67 465 auto containsANovelPlugin = [](const map<QString, int> &m1,
Chris@67 466 const map<QString, int> &m2) {
Chris@67 467 for (auto p: m1) {
Chris@67 468 if (m2.find(p.first) == m2.end()) {
Chris@67 469 return true;
Chris@67 470 }
Chris@67 471 }
Chris@67 472 return false;
Chris@67 473 };
Chris@67 474
Chris@67 475 if (containsANewerPlugin(a, b)) {
Chris@67 476 return true;
Chris@67 477 }
Chris@67 478
Chris@67 479 if (!containsANewerPlugin(b, a) &&
Chris@67 480 !a.empty() &&
Chris@67 481 !b.empty() &&
Chris@67 482 containsANovelPlugin(a, b) &&
Chris@67 483 !containsANovelPlugin(b, a)) {
Chris@67 484 return true;
Chris@67 485 }
Chris@67 486
Chris@67 487 return false;
Chris@67 488 }
Chris@67 489
Chris@67 490 QString
Chris@67 491 versionsString(const map<QString, int> &vv)
Chris@67 492 {
Chris@67 493 QStringList pv;
Chris@67 494 for (auto v: vv) {
Chris@67 495 pv.push_back(QString("%1:%2").arg(v.first).arg(v.second));
Chris@67 496 }
Chris@67 497 return "{ " + pv.join(", ") + " }";
Chris@67 498 }
Chris@67 499
Chris@75 500 enum class RelativeStatus {
Chris@75 501 New,
Chris@75 502 Same,
Chris@75 503 Upgrade,
Chris@75 504 Downgrade,
Chris@75 505 TargetNotLoadable
Chris@75 506 };
Chris@75 507
Chris@75 508 QString
Chris@75 509 relativeStatusLabel(RelativeStatus status) {
Chris@75 510 switch (status) {
Chris@76 511 case RelativeStatus::New: return QObject::tr("Not yet installed");
Chris@76 512 case RelativeStatus::Same: return QObject::tr("Already installed");
Chris@76 513 case RelativeStatus::Upgrade: return QObject::tr("Update");
Chris@76 514 case RelativeStatus::Downgrade: return QObject::tr("Newer version installed");
Chris@84 515 case RelativeStatus::TargetNotLoadable: return QObject::tr("Installed version not working");
Chris@79 516 default: return {};
Chris@75 517 }
Chris@75 518 }
Chris@75 519
Chris@75 520 RelativeStatus
Chris@75 521 getRelativeStatus(LibraryInfo info, QString targetDir)
Chris@75 522 {
Chris@75 523 QString destination = targetDir + "/" + info.fileName;
Chris@75 524
Chris@75 525 RelativeStatus status = RelativeStatus::New;
Chris@75 526
Chris@75 527 SVCERR << "\ngetRelativeStatus: " << info.fileName << ":\n";
Chris@75 528
Chris@75 529 if (QFileInfo(destination).exists()) {
Chris@75 530
Chris@75 531 auto installed = getLibraryPluginVersions(destination);
Chris@75 532
Chris@75 533 SVCERR << " * installed: " << versionsString(installed)
Chris@75 534 << "\n * packaged: " << versionsString(info.pluginVersions)
Chris@75 535 << endl;
Chris@75 536
Chris@75 537 status = RelativeStatus::Same;
Chris@75 538
Chris@75 539 if (installed.empty()) {
Chris@75 540 status = RelativeStatus::TargetNotLoadable;
Chris@75 541 }
Chris@75 542
Chris@75 543 if (isLibraryNewer(installed, info.pluginVersions)) {
Chris@75 544 status = RelativeStatus::Downgrade;
Chris@75 545 }
Chris@75 546
Chris@75 547 if (isLibraryNewer(info.pluginVersions, installed)) {
Chris@75 548 status = RelativeStatus::Upgrade;
Chris@75 549 }
Chris@75 550 }
Chris@75 551
Chris@75 552 SVCERR << " - relative status: " << relativeStatusLabel(status) << endl;
Chris@75 553
Chris@75 554 return status;
Chris@75 555 }
Chris@75 556
Chris@86 557 bool
Chris@86 558 backup(QString filePath, QString backupDir)
Chris@86 559 {
Chris@86 560 QFileInfo file(filePath);
Chris@86 561
Chris@86 562 if (!file.exists()) {
Chris@86 563 return true;
Chris@86 564 }
Chris@86 565
Chris@86 566 if (!QDir(backupDir).exists()) {
Chris@86 567 QDir().mkpath(backupDir);
Chris@86 568 }
Chris@86 569
Chris@86 570 QString backup = backupDir + "/" + file.fileName() + ".bak";
Chris@86 571 SVCERR << "Note: existing file " << filePath
Chris@86 572 << " found, backing up to " << backup << endl;
Chris@86 573 if (!QFile(filePath).rename(backup)) {
Chris@86 574 SVCERR << "Failed to move " << filePath.toStdString()
Chris@86 575 << " to backup " << backup.toStdString() << endl;
Chris@86 576 return false;
Chris@86 577 }
Chris@86 578
Chris@86 579 return true;
Chris@86 580 }
Chris@86 581
Chris@81 582 QString
Chris@75 583 installLibrary(LibraryInfo info, QString targetDir)
Chris@42 584 {
Chris@75 585 QString library = info.fileName;
Chris@52 586 QString source = ":out";
Chris@52 587 QFile f(source + "/" + library);
Chris@75 588 QString destination = targetDir + "/" + library;
Chris@94 589
Chris@94 590 static QString backupDirName;
Chris@94 591 if (backupDirName == "") {
Chris@94 592 // Static so as to be created once - don't go creating a
Chris@94 593 // second directory if the clock ticks over by one second
Chris@94 594 // between library installs
Chris@94 595 backupDirName =
Chris@94 596 QString("saved-%1").arg(QDateTime::currentDateTime().toString
Chris@94 597 ("yyyyMMdd-hhmmss"));
Chris@94 598 }
Chris@94 599 QString backupDir = targetDir + "/" + backupDirName;
Chris@67 600
Chris@86 601 if (!QDir(targetDir).exists()) {
Chris@86 602 QDir().mkpath(targetDir);
Chris@67 603 }
Chris@82 604
Chris@86 605 if (!backup(destination, backupDir)) {
Chris@86 606 return QObject::tr("Failed to move aside existing library");
Chris@86 607 }
Chris@52 608
Chris@51 609 SVCERR << "Copying " << library.toStdString() << " to "
Chris@51 610 << destination.toStdString() << "..." << endl;
Chris@42 611 if (!f.copy(destination)) {
Chris@51 612 SVCERR << "Failed to copy " << library.toStdString()
Chris@51 613 << " to target " << destination.toStdString() << endl;
Chris@81 614 return QObject::tr("Failed to copy library to destination directory");
Chris@42 615 }
Chris@42 616 if (!QFile::setPermissions
Chris@42 617 (destination,
Chris@42 618 QFile::ReadOwner | QFile::WriteOwner | QFile::ExeOwner |
Chris@42 619 QFile::ReadGroup | QFile::ExeGroup |
Chris@42 620 QFile::ReadOther | QFile::ExeOther)) {
Chris@51 621 SVCERR << "Failed to set permissions on "
Chris@51 622 << library.toStdString() << endl;
Chris@81 623 return QObject::tr("Failed to set correct permissions on installed library");
Chris@42 624 }
Chris@52 625
Chris@52 626 QString base = QFileInfo(library).baseName();
Chris@52 627 QDir dir(source);
Chris@52 628 auto entries = dir.entryList({ base + "*" });
Chris@52 629 for (auto e: entries) {
Chris@52 630 if (e == library) continue;
Chris@75 631 QString destination = targetDir + "/" + e;
Chris@86 632 if (!backup(destination, backupDir)) {
Chris@86 633 continue;
Chris@86 634 }
Chris@52 635 SVCERR << "Copying " << e.toStdString() << " to "
Chris@52 636 << destination.toStdString() << "..." << endl;
Chris@52 637 if (!QFile(source + "/" + e).copy(destination)) {
Chris@52 638 SVCERR << "Failed to copy " << e.toStdString()
Chris@52 639 << " to target " << destination.toStdString()
Chris@52 640 << " (ignoring)" << endl;
Chris@68 641 continue;
Chris@68 642 }
Chris@68 643 if (!QFile::setPermissions
Chris@68 644 (destination,
Chris@68 645 QFile::ReadOwner | QFile::WriteOwner |
Chris@68 646 QFile::ReadGroup |
Chris@68 647 QFile::ReadOther)) {
Chris@68 648 SVCERR << "Failed to set permissions on "
Chris@68 649 << destination.toStdString()
Chris@68 650 << " (ignoring)" << endl;
Chris@68 651 continue;
Chris@52 652 }
Chris@52 653 }
Chris@81 654
Chris@81 655 return {};
Chris@42 656 }
Chris@42 657
Chris@75 658 vector<LibraryInfo>
Chris@75 659 getUserApprovedPluginLibraries(vector<LibraryInfo> libraries,
Chris@75 660 QString targetDir)
Chris@42 661 {
Chris@42 662 QDialog dialog;
Chris@46 663
Chris@84 664 int fontHeight = QFontMetrics(dialog.font()).height();
Chris@84 665 int dpratio = dialog.devicePixelRatio();
Chris@84 666
Chris@46 667 auto mainLayout = new QGridLayout;
Chris@47 668 mainLayout->setSpacing(0);
Chris@46 669 dialog.setLayout(mainLayout);
Chris@46 670
Chris@46 671 int mainRow = 0;
Chris@46 672
Chris@74 673 auto selectionFrame = new QWidget;
Chris@74 674 mainLayout->addWidget(selectionFrame, mainRow, 0);
Chris@47 675 ++mainRow;
Chris@46 676
Chris@46 677 auto selectionLayout = new QGridLayout;
Chris@84 678 selectionLayout->setContentsMargins(0, 0, 0, 0);
Chris@84 679 selectionLayout->setSpacing(fontHeight / 6);
Chris@46 680 selectionFrame->setLayout(selectionLayout);
Chris@84 681
Chris@46 682 int selectionRow = 0;
Chris@84 683 int checkColumn = 0;
Chris@84 684 int titleColumn = 1;
Chris@84 685 int statusColumn = 2;
Chris@85 686 int infoColumn = 4; // column 3 is a small sliver of spacing
Chris@79 687
Chris@79 688 selectionLayout->addWidget
Chris@79 689 (new QLabel(QObject::tr("<b>Vamp Plugin Pack</b> v%1")
Chris@79 690 .arg(PACK_VERSION)),
Chris@84 691 selectionRow, titleColumn, 1, 3);
Chris@79 692 ++selectionRow;
Chris@79 693
Chris@79 694 selectionLayout->addWidget
Chris@79 695 (new QLabel(QObject::tr("Select the plugin libraries to install:")),
Chris@84 696 selectionRow, titleColumn, 1, 3);
Chris@79 697 ++selectionRow;
Chris@74 698
Chris@74 699 auto checkAll = new QCheckBox;
Chris@74 700 checkAll->setChecked(true);
Chris@84 701 selectionLayout->addWidget
Chris@84 702 (checkAll, selectionRow, checkColumn, Qt::AlignHCenter);
Chris@74 703 ++selectionRow;
Chris@74 704
Chris@85 705 auto checkArrow = new QLabel(
Chris@85 706 #ifdef Q_OS_MAC
Chris@85 707 "&nbsp;&nbsp;&#9660;"
Chris@85 708 #else
Chris@85 709 "&#9660;"
Chris@85 710 #endif
Chris@85 711 );
Chris@74 712 checkArrow->setTextFormat(Qt::RichText);
Chris@84 713 selectionLayout->addWidget
Chris@84 714 (checkArrow, selectionRow, checkColumn, Qt::AlignHCenter);
Chris@74 715 ++selectionRow;
Chris@42 716
Chris@67 717 map<QString, QCheckBox *> checkBoxMap; // filename -> checkbox
Chris@67 718 map<QString, LibraryInfo> libFileInfo; // filename -> info
Chris@76 719 map<QString, RelativeStatus> statuses; // filename -> status
Chris@43 720
Chris@67 721 map<QString, LibraryInfo, function<bool (QString, QString)>>
Chris@49 722 orderedInfo
Chris@49 723 ([](QString k1, QString k2) {
Chris@49 724 return k1.localeAwareCompare(k2) < 0;
Chris@49 725 });
Chris@43 726 for (auto info: libraries) {
Chris@43 727 orderedInfo[info.title] = info;
Chris@43 728 }
Chris@53 729
Chris@77 730 QPixmap infoMap(fontHeight * dpratio, fontHeight * dpratio);
Chris@77 731 QPixmap moreMap(fontHeight * dpratio * 2, fontHeight * dpratio * 2);
Chris@74 732 infoMap.fill(Qt::transparent);
Chris@74 733 moreMap.fill(Qt::transparent);
Chris@74 734 QSvgRenderer renderer(QString(":icons/scalable/info.svg"));
Chris@74 735 QPainter painter;
Chris@74 736 painter.begin(&infoMap);
Chris@74 737 renderer.render(&painter);
Chris@74 738 painter.end();
Chris@74 739 painter.begin(&moreMap);
Chris@74 740 renderer.render(&painter);
Chris@74 741 painter.end();
Chris@74 742
Chris@76 743 auto shouldCheck = [](RelativeStatus status) {
Chris@76 744 return (status == RelativeStatus::New ||
Chris@76 745 status == RelativeStatus::Upgrade ||
Chris@76 746 status == RelativeStatus::TargetNotLoadable);
Chris@76 747 };
Chris@76 748
Chris@43 749 for (auto ip: orderedInfo) {
Chris@46 750
Chris@46 751 auto cb = new QCheckBox;
Chris@84 752 selectionLayout->addWidget
Chris@84 753 (cb, selectionRow, checkColumn, Qt::AlignHCenter);
Chris@46 754
Chris@43 755 LibraryInfo info = ip.second;
Chris@72 756
Chris@76 757 auto shortLabel = new QLabel(info.title);
Chris@84 758 selectionLayout->addWidget(shortLabel, selectionRow, titleColumn);
Chris@76 759
Chris@75 760 RelativeStatus relativeStatus = getRelativeStatus(info, targetDir);
Chris@76 761 auto statusLabel = new QLabel(relativeStatusLabel(relativeStatus));
Chris@84 762 selectionLayout->addWidget(statusLabel, selectionRow, statusColumn);
Chris@76 763 cb->setChecked(shouldCheck(relativeStatus));
Chris@75 764
Chris@79 765 auto infoButton = new QToolButton;
Chris@79 766 infoButton->setAutoRaise(true);
Chris@79 767 infoButton->setIcon(infoMap);
Chris@79 768 infoButton->setIconSize(QSize(fontHeight, fontHeight));
Chris@77 769
Chris@77 770 #ifdef Q_OS_MAC
Chris@79 771 infoButton->setFixedSize(QSize(int(fontHeight * 1.2),
Chris@77 772 int(fontHeight * 1.2)));
Chris@79 773 infoButton->setStyleSheet("QToolButton { border: none; }");
Chris@77 774 #endif
Chris@77 775
Chris@84 776 selectionLayout->addWidget(infoButton, selectionRow, infoColumn);
Chris@46 777
Chris@46 778 ++selectionRow;
Chris@46 779
Chris@77 780 QString moreTitleText = QObject::tr("<b>%1</b><br><i>%2</i>")
Chris@72 781 .arg(info.title)
Chris@77 782 .arg(info.maker);
Chris@77 783
Chris@79 784 QString moreInfoText = info.description;
Chris@79 785
Chris@79 786 if (info.page != "") {
Chris@79 787 moreInfoText += QObject::tr("<br><a href=\"%1\">%2</a>")
Chris@79 788 .arg(info.page)
Chris@79 789 .arg(info.page);
Chris@79 790 }
Chris@79 791
Chris@79 792 moreInfoText += QObject::tr("<br><br>Library contains:<ul>");
Chris@73 793
Chris@73 794 int n = 0;
Chris@73 795 bool closed = false;
Chris@73 796 for (auto title: info.pluginTitles) {
Chris@73 797 if (n == 10 && info.pluginTitles.size() > 15) {
Chris@77 798 moreInfoText += QObject::tr("</ul>");
Chris@77 799 moreInfoText += QObject::tr("... and %n other plugins.<br><br>",
Chris@77 800 "",
Chris@77 801 info.pluginTitles.size() - n);
Chris@73 802 closed = true;
Chris@73 803 break;
Chris@73 804 }
Chris@77 805 moreInfoText += QObject::tr("<li>%1</li>").arg(title);
Chris@73 806 ++n;
Chris@73 807 }
Chris@73 808
Chris@73 809 if (!closed) {
Chris@77 810 moreInfoText += QObject::tr("</ul>");
Chris@73 811 }
Chris@74 812
Chris@74 813 if (info.licence != "") {
Chris@77 814 moreInfoText += QObject::tr("Provided under the %1.<br>")
Chris@77 815 .arg(info.licence);
Chris@74 816 }
Chris@72 817
Chris@79 818 QObject::connect(infoButton, &QAbstractButton::clicked,
Chris@72 819 [=]() {
Chris@74 820 QMessageBox mbox;
Chris@74 821 mbox.setIconPixmap(moreMap);
Chris@74 822 mbox.setWindowTitle(QObject::tr("Library contents"));
Chris@77 823 mbox.setText(moreTitleText);
Chris@77 824 mbox.setInformativeText(moreInfoText);
Chris@74 825 mbox.exec();
Chris@72 826 });
Chris@72 827
Chris@43 828 checkBoxMap[info.fileName] = cb;
Chris@67 829 libFileInfo[info.fileName] = info;
Chris@76 830 statuses[info.fileName] = relativeStatus;
Chris@42 831 }
Chris@42 832
Chris@79 833 selectionLayout->addItem(new QSpacerItem(1, (fontHeight*2) / 3),
Chris@79 834 selectionRow, 0);
Chris@79 835 ++selectionRow;
Chris@79 836
Chris@79 837 selectionLayout->addWidget
Chris@79 838 (new QLabel(QObject::tr("Installation will be to: %1").arg(targetDir)),
Chris@84 839 selectionRow, titleColumn, 1, 3);
Chris@79 840 ++selectionRow;
Chris@79 841
Chris@47 842 QObject::connect(checkAll, &QCheckBox::toggled,
Chris@72 843 [=](bool toCheck) {
Chris@47 844 for (auto p: checkBoxMap) {
Chris@47 845 p.second->setChecked(toCheck);
Chris@47 846 }
Chris@47 847 });
Chris@79 848
Chris@79 849 mainLayout->addItem(new QSpacerItem(1, fontHeight), mainRow, 0);
Chris@79 850 ++mainRow;
Chris@79 851
Chris@42 852 auto bb = new QDialogButtonBox(QDialogButtonBox::Ok |
Chris@76 853 QDialogButtonBox::Cancel |
Chris@76 854 QDialogButtonBox::Reset);
Chris@79 855 bb->button(QDialogButtonBox::Ok)->setText(QObject::tr("Install"));
Chris@74 856 mainLayout->addWidget(bb, mainRow, 0);
Chris@46 857 ++mainRow;
Chris@47 858
Chris@74 859 mainLayout->setRowStretch(0, 10);
Chris@74 860 mainLayout->setColumnStretch(0, 10);
Chris@74 861 selectionLayout->setColumnMinimumWidth(0, 50);
Chris@85 862 #ifdef Q_OS_MAC
Chris@85 863 selectionLayout->setColumnMinimumWidth(3, 10);
Chris@85 864 selectionLayout->setColumnMinimumWidth(5, 12);
Chris@85 865 #endif
Chris@74 866 selectionLayout->setColumnStretch(1, 10);
Chris@47 867
Chris@76 868 QObject::connect
Chris@76 869 (bb, &QDialogButtonBox::clicked,
Chris@76 870 [&](QAbstractButton *button) {
Chris@76 871
Chris@76 872 auto role = bb->buttonRole(button);
Chris@76 873
Chris@76 874 switch (role) {
Chris@76 875
Chris@76 876 case QDialogButtonBox::AcceptRole: {
Chris@76 877 bool downgrade = false;
Chris@76 878 for (const auto &p: checkBoxMap) {
Chris@76 879 if (p.second->isChecked() &&
Chris@76 880 statuses.at(p.first) == RelativeStatus::Downgrade) {
Chris@76 881 downgrade = true;
Chris@76 882 break;
Chris@76 883 }
Chris@76 884 }
Chris@76 885 if (downgrade) {
Chris@76 886 if (QMessageBox::warning
Chris@76 887 (bb, QObject::tr("Downgrade?"),
Chris@76 888 QObject::tr("You have asked to downgrade one or more plugin libraries that are already installed.<br><br>Are you sure?"),
Chris@76 889 QMessageBox::Ok | QMessageBox::Cancel,
Chris@76 890 QMessageBox::Cancel) == QMessageBox::Ok) {
Chris@76 891 dialog.accept();
Chris@76 892 }
Chris@76 893 } else {
Chris@76 894 dialog.accept();
Chris@76 895 }
Chris@76 896 break;
Chris@76 897 }
Chris@76 898
Chris@76 899 case QDialogButtonBox::RejectRole:
Chris@76 900 dialog.reject();
Chris@76 901 break;
Chris@76 902
Chris@76 903 case QDialogButtonBox::ResetRole:
Chris@76 904 for (const auto &p: checkBoxMap) {
Chris@76 905 p.second->setChecked(shouldCheck(statuses.at(p.first)));
Chris@76 906 }
Chris@76 907 break;
Chris@76 908
Chris@76 909 default:
Chris@76 910 SVCERR << "WARNING: Unexpected role " << role << endl;
Chris@76 911 }
Chris@76 912 });
Chris@53 913
Chris@70 914 if (dialog.exec() != QDialog::Accepted) {
Chris@51 915 SVCERR << "rejected" << endl;
Chris@70 916 return {};
Chris@42 917 }
Chris@42 918
Chris@75 919 vector<LibraryInfo> approved;
Chris@42 920 for (const auto &p: checkBoxMap) {
Chris@42 921 if (p.second->isChecked()) {
Chris@75 922 approved.push_back(libFileInfo[p.first]);
Chris@33 923 }
Chris@42 924 }
Chris@42 925
Chris@42 926 return approved;
Chris@42 927 }
Chris@42 928
Chris@42 929 int main(int argc, char **argv)
Chris@42 930 {
Chris@93 931 if (argc == 2 && (QString(argv[1]) == "--version" ||
Chris@93 932 QString(argv[1]) == "-v")) {
Chris@93 933 cerr << PACK_VERSION << endl;
Chris@93 934 exit(0);
Chris@93 935 }
Chris@93 936
Chris@42 937 QApplication app(argc, argv);
Chris@42 938
Chris@51 939 QApplication::setOrganizationName("sonic-visualiser");
Chris@51 940 QApplication::setOrganizationDomain("sonicvisualiser.org");
Chris@51 941 QApplication::setApplicationName(QApplication::tr("Vamp Plugin Pack Installer"));
Chris@51 942
Chris@77 943 QApplication::setAttribute(Qt::AA_UseHighDpiPixmaps);
Chris@77 944
Chris@51 945 #ifdef Q_OS_WIN32
Chris@51 946 QFont font(QApplication::font());
Chris@51 947 QString preferredFamily = "Segoe UI";
Chris@51 948 font.setFamily(preferredFamily);
Chris@51 949 if (QFontInfo(font).family() == preferredFamily) {
Chris@51 950 font.setPointSize(10);
Chris@51 951 QApplication::setFont(font);
Chris@51 952 }
Chris@77 953 #else
Chris@77 954 #ifdef Q_OS_MAC
Chris@77 955 QFont font(QApplication::font());
Chris@77 956 QString preferredFamily = "Lucida Grande";
Chris@77 957 font.setFamily(preferredFamily);
Chris@77 958 if (QFontInfo(font).family() == preferredFamily) {
Chris@85 959 font.setPointSize(12);
Chris@77 960 QApplication::setFont(font);
Chris@77 961 }
Chris@77 962 #endif
Chris@51 963 #endif
Chris@51 964
Chris@42 965 QString target = getDefaultInstallDirectory();
Chris@42 966 if (target == "") {
Chris@42 967 return 1;
Chris@42 968 }
Chris@42 969
Chris@42 970 QStringList libraries = getPluginLibraryList();
Chris@42 971
Chris@43 972 auto rdfStore = loadLibrariesRdf();
Chris@43 973
Chris@43 974 auto info = getLibraryInfo(*rdfStore, libraries);
Chris@43 975
Chris@75 976 vector<LibraryInfo> toInstall =
Chris@75 977 getUserApprovedPluginLibraries(info, target);
Chris@52 978
Chris@83 979 if (toInstall.empty()) { // Cancelled, or nothing selected
Chris@94 980 SVCERR << "No libraries selected for installation, nothing to do"
Chris@94 981 << endl;
Chris@83 982 return 0;
Chris@83 983 }
Chris@83 984
Chris@81 985 QProgressDialog progress(QObject::tr("Installing..."),
Chris@81 986 QObject::tr("Stop"), 0, toInstall.size() + 1);
Chris@81 987 progress.setMinimumDuration(0);
Chris@81 988
Chris@81 989 int pval = 0;
Chris@81 990 bool complete = true;
Chris@42 991
Chris@42 992 for (auto lib: toInstall) {
Chris@81 993 progress.setValue(++pval);
Chris@81 994 QThread::currentThread()->msleep(40);
Chris@81 995 app.processEvents();
Chris@81 996 if (progress.wasCanceled()) {
Chris@81 997 complete = false;
Chris@81 998 break;
Chris@81 999 }
Chris@81 1000 QString error = installLibrary(lib, target);
Chris@81 1001 if (error != "") {
Chris@81 1002 complete = false;
Chris@81 1003 if (QMessageBox::critical
Chris@81 1004 (&progress,
Chris@81 1005 QObject::tr("Install failed"),
Chris@81 1006 QObject::tr("Failed to install library \"%1\": %2")
Chris@81 1007 .arg(lib.title)
Chris@81 1008 .arg(error),
Chris@81 1009 QMessageBox::Abort | QMessageBox::Ignore,
Chris@81 1010 QMessageBox::Ignore) ==
Chris@81 1011 QMessageBox::Abort) {
Chris@81 1012 break;
Chris@81 1013 }
Chris@81 1014 }
Chris@81 1015 }
Chris@81 1016
Chris@81 1017 progress.hide();
Chris@81 1018
Chris@81 1019 if (complete) {
Chris@81 1020 QMessageBox::information
Chris@81 1021 (&progress,
Chris@81 1022 QObject::tr("Complete"),
Chris@81 1023 QObject::tr("Installation completed successfully"),
Chris@81 1024 QMessageBox::Ok,
Chris@81 1025 QMessageBox::Ok);
Chris@81 1026 } else {
Chris@81 1027 QMessageBox::information
Chris@81 1028 (&progress,
Chris@81 1029 QObject::tr("Incomplete"),
Chris@81 1030 QObject::tr("Installation was not complete. Exiting"),
Chris@81 1031 QMessageBox::Ok,
Chris@81 1032 QMessageBox::Ok);
Chris@33 1033 }
Chris@33 1034
Chris@83 1035 return (complete ? 0 : 2);
Chris@32 1036 }