ctkPluginDatabase.cpp 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880
  1. /*=============================================================================
  2. Library: CTK
  3. Copyright (c) German Cancer Research Center,
  4. Division of Medical and Biological Informatics
  5. Licensed under the Apache License, Version 2.0 (the "License");
  6. you may not use this file except in compliance with the License.
  7. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. =============================================================================*/
  15. #include "ctkPluginDatabase_p.h"
  16. #include "ctkPluginDatabaseException.h"
  17. #include "ctkPlugin.h"
  18. #include "ctkPluginConstants.h"
  19. #include "ctkPluginException.h"
  20. #include "ctkPluginArchive_p.h"
  21. #include "ctkPluginStorage_p.h"
  22. #include "ctkPluginFrameworkUtil_p.h"
  23. #include "ctkPluginFrameworkContext_p.h"
  24. #include "ctkServiceException.h"
  25. #include <QApplication>
  26. #include <QFileInfo>
  27. #include <QUrl>
  28. #include <QDebug>
  29. //database table names
  30. #define PLUGINS_TABLE "Plugins"
  31. #define PLUGIN_RESOURCES_TABLE "PluginResources"
  32. //----------------------------------------------------------------------------
  33. enum TBindIndexes
  34. {
  35. EBindIndex=0,
  36. EBindIndex1,
  37. EBindIndex2,
  38. EBindIndex3,
  39. EBindIndex4,
  40. EBindIndex5,
  41. EBindIndex6,
  42. EBindIndex7
  43. };
  44. //----------------------------------------------------------------------------
  45. ctkPluginDatabase::ctkPluginDatabase(ctkPluginStorage* storage)
  46. :m_isDatabaseOpen(false), m_inTransaction(false), m_PluginStorage(storage)
  47. {
  48. }
  49. //----------------------------------------------------------------------------
  50. ctkPluginDatabase::~ctkPluginDatabase()
  51. {
  52. close();
  53. }
  54. //----------------------------------------------------------------------------
  55. void ctkPluginDatabase::open()
  56. {
  57. if (m_isDatabaseOpen)
  58. return;
  59. QString path;
  60. //Create full path to database
  61. if(m_databasePath.isEmpty ())
  62. m_databasePath = getDatabasePath();
  63. path = m_databasePath;
  64. QFileInfo dbFileInfo(path);
  65. if (!dbFileInfo.dir().exists())
  66. {
  67. if(!QDir::root().mkpath(dbFileInfo.path()))
  68. {
  69. close();
  70. QString errorText("Could not create database directory: %1");
  71. throw ctkPluginDatabaseException(errorText.arg(dbFileInfo.path()), ctkPluginDatabaseException::DB_CREATE_DIR_ERROR);
  72. }
  73. }
  74. m_connectionName = dbFileInfo.completeBaseName();
  75. QSqlDatabase database;
  76. if (QSqlDatabase::contains(m_connectionName))
  77. {
  78. database = QSqlDatabase::database(m_connectionName);
  79. }
  80. else
  81. {
  82. database = QSqlDatabase::addDatabase("QSQLITE", m_connectionName);
  83. database.setDatabaseName(path);
  84. }
  85. if (!database.isValid())
  86. {
  87. close();
  88. throw ctkPluginDatabaseException(QString("Invalid database connection: %1").arg(m_connectionName),
  89. ctkPluginDatabaseException::DB_CONNECTION_INVALID);
  90. }
  91. //Create or open database
  92. if (!database.isOpen())
  93. {
  94. if (!database.open())
  95. {
  96. close();
  97. throw ctkPluginDatabaseException(QString("Could not open database. ") + database.lastError().text(),
  98. ctkPluginDatabaseException::DB_SQL_ERROR);
  99. }
  100. }
  101. m_isDatabaseOpen = true;
  102. //Check if the sqlite version supports foreign key constraints
  103. QSqlQuery query(database);
  104. if (!query.exec("PRAGMA foreign_keys"))
  105. {
  106. close();
  107. throw ctkPluginDatabaseException(QString("Check for foreign key support failed."),
  108. ctkPluginDatabaseException::DB_SQL_ERROR);
  109. }
  110. if (!query.next())
  111. {
  112. close();
  113. throw ctkPluginDatabaseException(QString("SQLite db does not support foreign keys. It is either older than 3.6.19 or was compiled with SQLITE_OMIT_FOREIGN_KEY or SQLITE_OMIT_TRIGGER"),
  114. ctkPluginDatabaseException::DB_SQL_ERROR);
  115. }
  116. query.finish();
  117. query.clear();
  118. //Enable foreign key support
  119. if (!query.exec("PRAGMA foreign_keys = ON"))
  120. {
  121. close();
  122. throw ctkPluginDatabaseException(QString("Enabling foreign key support failed."),
  123. ctkPluginDatabaseException::DB_SQL_ERROR);
  124. }
  125. query.finish();
  126. //Check database structure (tables) and recreate tables if neccessary
  127. //If one of the tables is missing remove all tables and recreate them
  128. //This operation is required in order to avoid data coruption
  129. if (!checkTables())
  130. {
  131. if (dropTables())
  132. {
  133. createTables();
  134. }
  135. else
  136. {
  137. //dropTables() should've handled error message
  138. //and warning
  139. close();
  140. }
  141. }
  142. removeUninstalledPlugins();
  143. //Update database based on the recorded timestamps
  144. updateDB();
  145. }
  146. //----------------------------------------------------------------------------
  147. void ctkPluginDatabase::removeUninstalledPlugins()
  148. {
  149. checkConnection();
  150. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  151. QSqlQuery query(database);
  152. beginTransaction(&query, Write);
  153. try
  154. {
  155. QString statement = "DELETE FROM Plugins WHERE StartLevel==-2";
  156. executeQuery(&query, statement);
  157. }
  158. catch (...)
  159. {
  160. rollbackTransaction(&query);
  161. throw;
  162. }
  163. commitTransaction(&query);
  164. }
  165. //----------------------------------------------------------------------------
  166. void ctkPluginDatabase::updateDB()
  167. {
  168. checkConnection();
  169. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  170. QSqlQuery query(database);
  171. beginTransaction(&query, Write);
  172. QString statement = "SELECT ID, Location, LocalPath, Timestamp, SymbolicName, Version FROM Plugins WHERE State != ?";
  173. QList<QVariant> bindValues;
  174. bindValues.append(ctkPlugin::UNINSTALLED);
  175. QList<qlonglong> outdatedIds;
  176. QList<QPair<QString,QString> > outdatedPlugins;
  177. QStringList outdatedServiceNames;
  178. try
  179. {
  180. executeQuery(&query, statement, bindValues);
  181. while (query.next())
  182. {
  183. QFileInfo pluginInfo(query.value(EBindIndex2).toString());
  184. QDateTime pluginLastModified = pluginInfo.lastModified();
  185. // Make sure the QDateTime has the same accuracy as the one in the database
  186. pluginLastModified = getQDateTimeFromString(getStringFromQDateTime(pluginLastModified));
  187. if (pluginLastModified > getQDateTimeFromString(query.value(EBindIndex3).toString()))
  188. {
  189. outdatedIds.append(query.value(EBindIndex).toLongLong());
  190. outdatedPlugins.append(qMakePair(query.value(EBindIndex1).toString(), query.value(EBindIndex2).toString()));
  191. }
  192. }
  193. }
  194. catch (...)
  195. {
  196. rollbackTransaction(&query);
  197. throw;
  198. }
  199. query.finish();
  200. query.clear();
  201. try
  202. {
  203. statement = "DELETE FROM Plugins WHERE ID=?";
  204. QListIterator<qlonglong> idIter(outdatedIds);
  205. while (idIter.hasNext())
  206. {
  207. bindValues.clear();
  208. bindValues.append(idIter.next());
  209. executeQuery(&query, statement, bindValues);
  210. }
  211. }
  212. catch (...)
  213. {
  214. rollbackTransaction(&query);
  215. throw;
  216. }
  217. commitTransaction(&query);
  218. QListIterator<QPair<QString,QString> > locationIter(outdatedPlugins);
  219. while (locationIter.hasNext())
  220. {
  221. const QPair<QString,QString>& locations = locationIter.next();
  222. insertPlugin(QUrl(locations.first), locations.second, false);
  223. }
  224. }
  225. //----------------------------------------------------------------------------
  226. QLibrary::LoadHints ctkPluginDatabase::getPluginLoadHints() const
  227. {
  228. if (m_PluginStorage->getFrameworkContext()->props.contains(ctkPluginConstants::FRAMEWORK_PLUGIN_LOAD_HINTS))
  229. {
  230. QVariant loadHintsVariant = m_PluginStorage->getFrameworkContext()->props[ctkPluginConstants::FRAMEWORK_PLUGIN_LOAD_HINTS];
  231. if (loadHintsVariant.isValid())
  232. {
  233. return loadHintsVariant.value<QLibrary::LoadHints>();
  234. }
  235. }
  236. return QLibrary::LoadHints(0);
  237. }
  238. //----------------------------------------------------------------------------
  239. ctkPluginArchive* ctkPluginDatabase::insertPlugin(const QUrl& location, const QString& localPath, bool createArchive)
  240. {
  241. checkConnection();
  242. // Assemble the data for the sql record
  243. QFileInfo fileInfo(localPath);
  244. if (!fileInfo.exists())
  245. {
  246. throw std::invalid_argument((localPath + " does not exist").toStdString());
  247. }
  248. const QString libTimestamp = getStringFromQDateTime(fileInfo.lastModified());
  249. QString resourcePrefix = fileInfo.baseName();
  250. if (resourcePrefix.startsWith("lib"))
  251. {
  252. resourcePrefix = resourcePrefix.mid(3);
  253. }
  254. resourcePrefix.replace("_", ".");
  255. resourcePrefix = QString(":/") + resourcePrefix + "/";
  256. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  257. QSqlQuery query(database);
  258. beginTransaction(&query, Write);
  259. QString statement = "INSERT INTO Plugins(Location,LocalPath,SymbolicName,Version,State,LastModified,Timestamp,StartLevel,AutoStart)"
  260. "VALUES(?,?,?,?,?,'',?,-1,-1)";
  261. QList<QVariant> bindValues;
  262. bindValues.append(location.toString());
  263. bindValues.append(localPath);
  264. bindValues.append(QString("na"));
  265. bindValues.append(QString("na"));
  266. bindValues.append(ctkPlugin::INSTALLED);
  267. bindValues.append(libTimestamp);
  268. qlonglong pluginId = -1;
  269. try
  270. {
  271. executeQuery(&query, statement, bindValues);
  272. QVariant lastId = query.lastInsertId();
  273. if (lastId.isValid())
  274. {
  275. pluginId = lastId.toLongLong();
  276. }
  277. }
  278. catch (...)
  279. {
  280. rollbackTransaction(&query);
  281. throw;
  282. }
  283. // Load the plugin and cache the resources
  284. QPluginLoader pluginLoader;
  285. pluginLoader.setLoadHints(getPluginLoadHints());
  286. pluginLoader.setFileName(localPath);
  287. if (!pluginLoader.load())
  288. {
  289. rollbackTransaction(&query);
  290. ctkPluginException exc(QString("The plugin could not be loaded: %1").arg(localPath));
  291. exc.setCause(pluginLoader.errorString());
  292. throw exc;
  293. }
  294. QDirIterator dirIter(resourcePrefix, QDirIterator::Subdirectories);
  295. while (dirIter.hasNext())
  296. {
  297. QString resourcePath = dirIter.next();
  298. if (QFileInfo(resourcePath).isDir()) continue;
  299. QFile resourceFile(resourcePath);
  300. resourceFile.open(QIODevice::ReadOnly);
  301. QByteArray resourceData = resourceFile.readAll();
  302. resourceFile.close();
  303. statement = "INSERT INTO PluginResources(PluginID, ResourcePath, Resource) VALUES(?,?,?)";
  304. bindValues.clear();
  305. bindValues.append(QVariant::fromValue<qlonglong>(pluginId));
  306. bindValues.append(resourcePath.mid(resourcePrefix.size()-1));
  307. bindValues.append(resourceData);
  308. try
  309. {
  310. executeQuery(&query, statement, bindValues);
  311. }
  312. catch (...)
  313. {
  314. rollbackTransaction(&query);
  315. throw;
  316. }
  317. }
  318. pluginLoader.unload();
  319. try
  320. {
  321. ctkPluginArchive* archive = new ctkPluginArchive(m_PluginStorage, location, localPath,
  322. pluginId);
  323. statement = "UPDATE Plugins SET SymbolicName=?,Version=? WHERE ID=?";
  324. QString versionString = archive->getAttribute(ctkPluginConstants::PLUGIN_VERSION);
  325. bindValues.clear();
  326. bindValues.append(archive->getAttribute(ctkPluginConstants::PLUGIN_SYMBOLICNAME));
  327. bindValues.append(versionString.isEmpty() ? "0.0.0" : versionString);
  328. bindValues.append(pluginId);
  329. if (!createArchive)
  330. {
  331. delete archive;
  332. archive = 0;
  333. }
  334. executeQuery(&query, statement, bindValues);
  335. commitTransaction(&query);
  336. return archive;
  337. }
  338. catch (...)
  339. {
  340. rollbackTransaction(&query);
  341. throw;
  342. }
  343. }
  344. //----------------------------------------------------------------------------
  345. void ctkPluginDatabase::setStartLevel(long pluginId, int startLevel)
  346. {
  347. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  348. QSqlQuery query(database);
  349. QString statement = "UPDATE Plugins SET StartLevel=? WHERE ID=?";
  350. QList<QVariant> bindValues;
  351. bindValues.append(startLevel);
  352. bindValues.append(QVariant::fromValue(pluginId));
  353. executeQuery(&query, statement, bindValues);
  354. }
  355. //----------------------------------------------------------------------------
  356. void ctkPluginDatabase::setLastModified(long pluginId, const QDateTime& lastModified)
  357. {
  358. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  359. QSqlQuery query(database);
  360. QString statement = "UPDATE Plugins SET LastModified=? WHERE ID=?";
  361. QList<QVariant> bindValues;
  362. bindValues.append(getStringFromQDateTime(lastModified));
  363. bindValues.append(QVariant::fromValue(pluginId));
  364. executeQuery(&query, statement, bindValues);
  365. }
  366. //----------------------------------------------------------------------------
  367. void ctkPluginDatabase::setAutostartSetting(long pluginId, int autostart)
  368. {
  369. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  370. QSqlQuery query(database);
  371. QString statement = "UPDATE Plugins SET AutoStart=? WHERE ID=?";
  372. QList<QVariant> bindValues;
  373. bindValues.append(autostart);
  374. bindValues.append(QVariant::fromValue(pluginId));
  375. executeQuery(&query, statement, bindValues);
  376. }
  377. //----------------------------------------------------------------------------
  378. QStringList ctkPluginDatabase::findResourcesPath(long pluginId, const QString& path) const
  379. {
  380. checkConnection();
  381. QString statement = "SELECT SUBSTR(ResourcePath,?) FROM PluginResources WHERE PluginID=? AND SUBSTR(ResourcePath,1,?)=?";
  382. QString resourcePath = path.startsWith('/') ? path : QString("/") + path;
  383. if (!resourcePath.endsWith('/'))
  384. resourcePath += "/";
  385. QList<QVariant> bindValues;
  386. bindValues.append(resourcePath.size()+1);
  387. bindValues.append(qlonglong(pluginId));
  388. bindValues.append(resourcePath.size());
  389. bindValues.append(resourcePath);
  390. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  391. QSqlQuery query(database);
  392. executeQuery(&query, statement, bindValues);
  393. QSet<QString> paths;
  394. while (query.next())
  395. {
  396. QString currPath = query.value(EBindIndex).toString();
  397. QStringList components = currPath.split('/', QString::SkipEmptyParts);
  398. if (components.size() == 1)
  399. {
  400. paths << components.front();
  401. }
  402. else if (components.size() == 2)
  403. {
  404. paths << components.front() + "/";
  405. }
  406. }
  407. return paths.toList();
  408. }
  409. //----------------------------------------------------------------------------
  410. void ctkPluginDatabase::removeArchive(const ctkPluginArchive *pa)
  411. {
  412. checkConnection();
  413. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  414. QSqlQuery query(database);
  415. QString statement = "DELETE FROM Plugins WHERE ID=?";
  416. QList<QVariant> bindValues;
  417. bindValues.append(pa->getPluginId());
  418. executeQuery(&query, statement, bindValues);
  419. }
  420. //----------------------------------------------------------------------------
  421. void ctkPluginDatabase::executeQuery(QSqlQuery *query, const QString &statement, const QList<QVariant> &bindValues) const
  422. {
  423. Q_ASSERT(query != 0);
  424. bool success = false;
  425. enum {Prepare =0 , Execute=1};
  426. for (int stage=Prepare; stage <= Execute; ++stage)
  427. {
  428. if ( stage == Prepare)
  429. success = query->prepare(statement);
  430. else // stage == Execute
  431. success = query->exec();
  432. if (!success)
  433. {
  434. QString errorText = "Problem: Could not %1 statement: %2\n"
  435. "Reason: %3\n"
  436. "Parameters: %4\n";
  437. QString parameters;
  438. if (bindValues.count() > 0)
  439. {
  440. for (int i = 0; i < bindValues.count(); ++i)
  441. {
  442. parameters.append(QString("\n\t[") + QString::number(i) + "]: " + bindValues.at(i).toString());
  443. }
  444. }
  445. else
  446. {
  447. parameters = "None";
  448. }
  449. ctkPluginDatabaseException::Type errorType;
  450. int result = query->lastError().number();
  451. if (result == 26 || result == 11) //SQLILTE_NOTADB || SQLITE_CORRUPT
  452. {
  453. qWarning() << "ctkPluginFramework:- Database file is corrupt or invalid:" << getDatabasePath();
  454. errorType = ctkPluginDatabaseException::DB_FILE_INVALID;
  455. }
  456. else if (result == 8) //SQLITE_READONLY
  457. errorType = ctkPluginDatabaseException::DB_WRITE_ERROR;
  458. else
  459. errorType = ctkPluginDatabaseException::DB_SQL_ERROR;
  460. query->finish();
  461. query->clear();
  462. throw ctkPluginDatabaseException(errorText.arg(stage == Prepare ? "prepare":"execute")
  463. .arg(statement).arg(query->lastError().text()).arg(parameters), errorType);
  464. }
  465. if (stage == Prepare)
  466. {
  467. foreach(const QVariant &bindValue, bindValues)
  468. query->addBindValue(bindValue);
  469. }
  470. }
  471. }
  472. //----------------------------------------------------------------------------
  473. void ctkPluginDatabase::close()
  474. {
  475. if (m_isDatabaseOpen)
  476. {
  477. QSqlDatabase database = QSqlDatabase::database(m_connectionName, false);
  478. if (database.isValid())
  479. {
  480. if(database.isOpen())
  481. {
  482. database.close();
  483. m_isDatabaseOpen = false;
  484. return;
  485. }
  486. }
  487. else
  488. {
  489. throw ctkPluginDatabaseException(QString("Problem closing database: Invalid connection %1").arg(m_connectionName));
  490. }
  491. }
  492. }
  493. //----------------------------------------------------------------------------
  494. void ctkPluginDatabase::setDatabasePath(const QString &databasePath)
  495. {
  496. m_databasePath = QDir::toNativeSeparators(databasePath);
  497. }
  498. //----------------------------------------------------------------------------
  499. QString ctkPluginDatabase::getDatabasePath() const
  500. {
  501. QString path = m_databasePath;
  502. if(path.isEmpty())
  503. {
  504. path = QDir::homePath() + "/ctkpluginfw/plugins.db";
  505. qWarning() << "No database path set. Using default:" << path;
  506. }
  507. path = QDir::toNativeSeparators(path);
  508. qDebug() << "Using database:" << path;
  509. return path;
  510. }
  511. //----------------------------------------------------------------------------
  512. QByteArray ctkPluginDatabase::getPluginResource(long pluginId, const QString& res) const
  513. {
  514. checkConnection();
  515. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  516. QSqlQuery query(database);
  517. QString statement = "SELECT Resource FROM PluginResources WHERE PluginID=? AND ResourcePath=?";
  518. QString resourcePath = res.startsWith('/') ? res : QString("/") + res;
  519. QList<QVariant> bindValues;
  520. bindValues.append(qlonglong(pluginId));
  521. bindValues.append(resourcePath);
  522. executeQuery(&query, statement, bindValues);
  523. if (query.next())
  524. {
  525. return query.value(EBindIndex).toByteArray();
  526. }
  527. return QByteArray();
  528. }
  529. //----------------------------------------------------------------------------
  530. void ctkPluginDatabase::createTables()
  531. {
  532. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  533. QSqlQuery query(database);
  534. //Begin Transaction
  535. beginTransaction(&query, Write);
  536. QString statement("CREATE TABLE Plugins("
  537. "ID INTEGER PRIMARY KEY,"
  538. "Location TEXT NOT NULL UNIQUE,"
  539. "LocalPath TEXT NOT NULL UNIQUE,"
  540. "SymbolicName TEXT NOT NULL,"
  541. "Version TEXT NOT NULL,"
  542. "State INTEGER NOT NULL,"
  543. "LastModified TEXT NOT NULL,"
  544. "Timestamp TEXT NOT NULL,"
  545. "StartLevel INTEGER NOT NULL,"
  546. "AutoStart INTEGER NOT NULL)");
  547. try
  548. {
  549. executeQuery(&query, statement);
  550. }
  551. catch (...)
  552. {
  553. rollbackTransaction(&query);
  554. throw;
  555. }
  556. statement = "CREATE TABLE PluginResources("
  557. "PluginID INTEGER NOT NULL,"
  558. "ResourcePath TEXT NOT NULL, "
  559. "Resource BLOB NOT NULL,"
  560. "FOREIGN KEY(PluginID) REFERENCES Plugins(ID) ON DELETE CASCADE)";
  561. try
  562. {
  563. executeQuery(&query, statement);
  564. }
  565. catch (...)
  566. {
  567. rollbackTransaction(&query);
  568. throw;
  569. }
  570. try
  571. {
  572. commitTransaction(&query);
  573. }
  574. catch (...)
  575. {
  576. rollbackTransaction(&query);
  577. throw;
  578. }
  579. }
  580. //----------------------------------------------------------------------------
  581. bool ctkPluginDatabase::checkTables() const
  582. {
  583. bool bTables(false);
  584. QStringList tables = QSqlDatabase::database(m_connectionName).tables();
  585. if (tables.contains(PLUGINS_TABLE)
  586. && tables.contains(PLUGIN_RESOURCES_TABLE))
  587. {
  588. bTables = true;
  589. }
  590. return bTables;
  591. }
  592. //----------------------------------------------------------------------------
  593. bool ctkPluginDatabase::dropTables()
  594. {
  595. //Execute transaction for deleting the database tables
  596. QSqlDatabase database = QSqlDatabase::database(m_connectionName);
  597. QSqlQuery query(database);
  598. QStringList expectedTables;
  599. expectedTables << PLUGINS_TABLE << PLUGIN_RESOURCES_TABLE;
  600. if (database.tables().count() > 0)
  601. {
  602. beginTransaction(&query, Write);
  603. QStringList actualTables = database.tables();
  604. foreach(const QString expectedTable, expectedTables)
  605. {
  606. if (actualTables.contains(expectedTable))
  607. {
  608. try
  609. {
  610. executeQuery(&query, QString("DROP TABLE ") + expectedTable);
  611. }
  612. catch (...)
  613. {
  614. rollbackTransaction(&query);
  615. throw;
  616. }
  617. }
  618. try
  619. {
  620. commitTransaction(&query);
  621. }
  622. catch (...)
  623. {
  624. rollbackTransaction(&query);
  625. throw;
  626. }
  627. }
  628. }
  629. return true;
  630. }
  631. //----------------------------------------------------------------------------
  632. bool ctkPluginDatabase::isOpen() const
  633. {
  634. return m_isDatabaseOpen;
  635. }
  636. //----------------------------------------------------------------------------
  637. void ctkPluginDatabase::checkConnection() const
  638. {
  639. if(!m_isDatabaseOpen)
  640. {
  641. throw ctkPluginDatabaseException("Database not open.", ctkPluginDatabaseException::DB_NOT_OPEN_ERROR);
  642. }
  643. if (!QSqlDatabase::database(m_connectionName).isValid())
  644. {
  645. throw ctkPluginDatabaseException(QString("Database connection invalid: %1").arg(m_connectionName),
  646. ctkPluginDatabaseException::DB_CONNECTION_INVALID);
  647. }
  648. }
  649. //----------------------------------------------------------------------------
  650. void ctkPluginDatabase::beginTransaction(QSqlQuery *query, TransactionType type)
  651. {
  652. bool success;
  653. if (type == Read)
  654. success = query->exec(QLatin1String("BEGIN"));
  655. else
  656. success = query->exec(QLatin1String("BEGIN IMMEDIATE"));
  657. if (!success) {
  658. int result = query->lastError().number();
  659. if (result == 26 || result == 11) //SQLITE_NOTADB || SQLITE_CORRUPT
  660. {
  661. throw ctkPluginDatabaseException(QString("ctkPluginFramework: Database file is corrupt or invalid: %1").arg(getDatabasePath()),
  662. ctkPluginDatabaseException::DB_FILE_INVALID);
  663. }
  664. else if (result == 8) //SQLITE_READONLY
  665. {
  666. throw ctkPluginDatabaseException(QString("ctkPluginFramework: Insufficient permissions to write to database: %1").arg(getDatabasePath()),
  667. ctkPluginDatabaseException::DB_WRITE_ERROR);
  668. }
  669. else
  670. throw ctkPluginDatabaseException(QString("ctkPluginFramework: ") + query->lastError().text(),
  671. ctkPluginDatabaseException::DB_SQL_ERROR);
  672. }
  673. }
  674. //----------------------------------------------------------------------------
  675. void ctkPluginDatabase::commitTransaction(QSqlQuery *query)
  676. {
  677. Q_ASSERT(query != 0);
  678. query->finish();
  679. query->clear();
  680. if (!query->exec(QLatin1String("COMMIT")))
  681. {
  682. throw ctkPluginDatabaseException(QString("ctkPluginFramework: ") + query->lastError().text(),
  683. ctkPluginDatabaseException::DB_SQL_ERROR);
  684. }
  685. }
  686. //----------------------------------------------------------------------------
  687. void ctkPluginDatabase::rollbackTransaction(QSqlQuery *query)
  688. {
  689. Q_ASSERT(query !=0);
  690. query->finish();
  691. query->clear();
  692. if (!query->exec(QLatin1String("ROLLBACK")))
  693. {
  694. throw ctkPluginDatabaseException(QString("ctkPluginFramework: ") + query->lastError().text(),
  695. ctkPluginDatabaseException::DB_SQL_ERROR);
  696. }
  697. }
  698. //----------------------------------------------------------------------------
  699. QList<ctkPluginArchive*> ctkPluginDatabase::getPluginArchives() const
  700. {
  701. checkConnection();
  702. QSqlQuery query(QSqlDatabase::database(m_connectionName));
  703. QString statement("SELECT ID, Location, LocalPath, StartLevel, LastModified, AutoStart FROM Plugins WHERE State != ?");
  704. QList<QVariant> bindValues;
  705. bindValues.append(ctkPlugin::UNINSTALLED);
  706. executeQuery(&query, statement, bindValues);
  707. QList<ctkPluginArchive*> archives;
  708. while (query.next())
  709. {
  710. const long id = query.value(EBindIndex).toLongLong();
  711. const QUrl location(query.value(EBindIndex1).toString());
  712. const QString localPath(query.value(EBindIndex2).toString());
  713. if (id <= 0 || location.isEmpty() || localPath.isEmpty())
  714. {
  715. throw ctkPluginDatabaseException(QString("Database integrity corrupted, row %1 contains empty values.").arg(id),
  716. ctkPluginDatabaseException::DB_FILE_INVALID);
  717. }
  718. const int startLevel = query.value(EBindIndex3).toInt();
  719. const QDateTime lastModified = query.value(EBindIndex4).toDateTime();
  720. const int autoStart = query.value(EBindIndex5).toInt();
  721. try
  722. {
  723. ctkPluginArchive* pa = new ctkPluginArchive(m_PluginStorage, location, localPath, id,
  724. startLevel, lastModified, autoStart);
  725. archives.append(pa);
  726. }
  727. catch (const ctkPluginException& exc)
  728. {
  729. qWarning() << exc;
  730. }
  731. }
  732. return archives;
  733. }
  734. //----------------------------------------------------------------------------
  735. QString ctkPluginDatabase::getStringFromQDateTime(const QDateTime& dateTime) const
  736. {
  737. return dateTime.toString(Qt::ISODate);
  738. }
  739. //----------------------------------------------------------------------------
  740. QDateTime ctkPluginDatabase::getQDateTimeFromString(const QString& dateTimeString) const
  741. {
  742. return QDateTime::fromString(dateTimeString, Qt::ISODate);
  743. }