//----------------------------------------------------------------------------
void ctkPluginStorageSQL::open()
{
createDatabaseDirectory();
QSqlDatabase database = getConnection();
//Check if the sqlite version supports foreign key constraints
QSqlQuery query(database);
if (!query.exec("PRAGMA foreign_keys"))
{
close();
throw ctkPluginDatabaseException(QString("Check for foreign key support failed."),
ctkPluginDatabaseException::DB_SQL_ERROR);
}
if (!query.next())
{
close();
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"),
ctkPluginDatabaseException::DB_SQL_ERROR);
}
query.finish();
query.clear();
//Enable foreign key support
if (!query.exec("PRAGMA foreign_keys = ON"))
{
close();
throw ctkPluginDatabaseException(QString("Enabling foreign key support failed."),
ctkPluginDatabaseException::DB_SQL_ERROR);
}
query.finish();
//Check database structure (tables) and recreate tables if neccessary
//If one of the tables is missing remove all tables and recreate them
//This operation is required in order to avoid data coruption
if (!checkTables())
{
if (dropTables())
{
createTables();
}
else
{
//dropTables() should've handled error message
//and warning
close();
}
}
// silently remove any plugin marked as uninstalled
cleanupDB();
//Update database based on the recorded timestamps
updateDB();
initNextFreeIds();
}
/*!
Takes the \a helpData and generates a new documentation
set from it. The Qt compressed help file is written to \a
outputFileName. Returns true on success, otherwise false.
*/
bool QHelpGenerator::generate(QHelpDataInterface *helpData,
const QString &outputFileName)
{
emit progressChanged(0);
d->error.clear();
if (!helpData || helpData->namespaceName().isEmpty()) {
d->error = tr("Invalid help data!");
return false;
}
QString outFileName = outputFileName;
if (outFileName.isEmpty()) {
d->error = tr("No output file name specified!");
return false;
}
QFileInfo fi(outFileName);
if (fi.exists()) {
if (!fi.dir().remove(fi.fileName())) {
d->error = tr("The file %1 cannot be overwritten!").arg(outFileName);
return false;
}
}
setupProgress(helpData);
emit statusChanged(tr("Building up file structure..."));
bool openingOk = true;
{
QSqlDatabase db = QSqlDatabase::addDatabase(QLatin1String("QSQLITE"), QLatin1String("builder"));
db.setDatabaseName(outFileName);
openingOk = db.open();
if (openingOk)
d->query = new QSqlQuery(db);
}
if (!openingOk) {
d->error = tr("Cannot open data base file %1!").arg(outFileName);
cleanupDB();
return false;
}
d->query->exec(QLatin1String("PRAGMA synchronous=OFF"));
d->query->exec(QLatin1String("PRAGMA cache_size=3000"));
addProgress(1.0);
createTables();
insertFileNotFoundFile();
insertMetaData(helpData->metaData());
if (!registerVirtualFolder(helpData->virtualFolder(), helpData->namespaceName())) {
d->error = tr("Cannot register namespace %1!").arg(helpData->namespaceName());
cleanupDB();
return false;
}
addProgress(1.0);
emit statusChanged(tr("Insert custom filters..."));
foreach (const QHelpDataCustomFilter &f, helpData->customFilters()) {
if (!registerCustomFilter(f.name, f.filterAttributes, true)) {
cleanupDB();
return false;
}
}
addProgress(1.0);
int i = 1;
QList<QHelpDataFilterSection>::const_iterator it = helpData->filterSections().constBegin();
while (it != helpData->filterSections().constEnd()) {
emit statusChanged(tr("Insert help data for filter section (%1 of %2)...")
.arg(i++).arg(helpData->filterSections().count()));
insertFilterAttributes((*it).filterAttributes());
QByteArray ba;
QDataStream s(&ba, QIODevice::WriteOnly);
foreach (QHelpDataContentItem *itm, (*it).contents())
writeTree(s, itm, 0);
if (!insertFiles((*it).files(), helpData->rootPath(), (*it).filterAttributes())
|| !insertContents(ba, (*it).filterAttributes())
|| !insertKeywords((*it).indices(), (*it).filterAttributes())) {
cleanupDB();
return false;
}
++it;
}
cleanupDB();
emit progressChanged(100);
emit statusChanged(tr("Documentation successfully generated."));
return true;
}
//----------------------------------------------------------------------------
void ctkPluginStorageSQL::open()
{
if (m_isDatabaseOpen)
return;
QString path;
//Create full path to database
if(m_databasePath.isEmpty ())
m_databasePath = getDatabasePath();
path = m_databasePath;
QFileInfo dbFileInfo(path);
if (!dbFileInfo.dir().exists())
{
if(!QDir::root().mkpath(dbFileInfo.path()))
{
close();
QString errorText("Could not create database directory: %1");
throw ctkPluginDatabaseException(errorText.arg(dbFileInfo.path()), ctkPluginDatabaseException::DB_CREATE_DIR_ERROR);
}
}
m_connectionName = dbFileInfo.completeBaseName();
QSqlDatabase database;
if (QSqlDatabase::contains(m_connectionName))
{
database = QSqlDatabase::database(m_connectionName);
}
else
{
database = QSqlDatabase::addDatabase("QSQLITE", m_connectionName);
database.setDatabaseName(path);
}
if (!database.isValid())
{
close();
throw ctkPluginDatabaseException(QString("Invalid database connection: %1").arg(m_connectionName),
ctkPluginDatabaseException::DB_CONNECTION_INVALID);
}
//Create or open database
if (!database.isOpen())
{
if (!database.open())
{
close();
throw ctkPluginDatabaseException(QString("Could not open database. ") + database.lastError().text(),
ctkPluginDatabaseException::DB_SQL_ERROR);
}
}
m_isDatabaseOpen = true;
//Check if the sqlite version supports foreign key constraints
QSqlQuery query(database);
if (!query.exec("PRAGMA foreign_keys"))
{
close();
throw ctkPluginDatabaseException(QString("Check for foreign key support failed."),
ctkPluginDatabaseException::DB_SQL_ERROR);
}
if (!query.next())
{
close();
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"),
ctkPluginDatabaseException::DB_SQL_ERROR);
}
query.finish();
query.clear();
//Enable foreign key support
if (!query.exec("PRAGMA foreign_keys = ON"))
{
close();
throw ctkPluginDatabaseException(QString("Enabling foreign key support failed."),
ctkPluginDatabaseException::DB_SQL_ERROR);
}
query.finish();
//Check database structure (tables) and recreate tables if neccessary
//If one of the tables is missing remove all tables and recreate them
//This operation is required in order to avoid data coruption
if (!checkTables())
{
if (dropTables())
{
createTables();
}
else
{
//dropTables() should've handled error message
//and warning
close();
}
}
// silently remove any plugin marked as uninstalled
cleanupDB();
//Update database based on the recorded timestamps
updateDB();
initNextFreeIds();
}
