|
| 1 | +/*************************************************************************** |
| 2 | + qgsgeopackageprojectstorage.cpp |
| 3 | + --------------------- |
| 4 | + begin : March 2019 |
| 5 | + copyright : (C) 2019 by Alessandro Pasotti |
| 6 | + email : elpaso at itopen dot it |
| 7 | + *************************************************************************** |
| 8 | + * * |
| 9 | + * This program is free software; you can redistribute it and/or modify * |
| 10 | + * it under the terms of the GNU General Public License as published by * |
| 11 | + * the Free Software Foundation; either version 2 of the License, or * |
| 12 | + * (at your option) any later version. * |
| 13 | + * * |
| 14 | + ***************************************************************************/ |
| 15 | + |
| 16 | +#include "qgsgeopackageprojectstorage.h" |
| 17 | + |
| 18 | +#include <sqlite3.h> |
| 19 | +#include <QUrlQuery> |
| 20 | +#include <QUrl> |
| 21 | +#include <QIODevice> |
| 22 | +#include <QJsonDocument> |
| 23 | +#include <QJsonObject> |
| 24 | + |
| 25 | +#include "qgsmessagelog.h" |
| 26 | +#include "qgssqliteutils.h" |
| 27 | +#include "qgsreadwritecontext.h" |
| 28 | + |
| 29 | + |
| 30 | +static bool _parseMetadataDocument( const QJsonDocument &doc, QgsProjectStorage::Metadata &metadata ) |
| 31 | +{ |
| 32 | + if ( !doc.isObject() ) |
| 33 | + return false; |
| 34 | + |
| 35 | + QJsonObject docObj = doc.object(); |
| 36 | + metadata.lastModified = QDateTime(); |
| 37 | + if ( docObj.contains( "last_modified_time" ) ) |
| 38 | + { |
| 39 | + QString lastModifiedTimeStr = docObj["last_modified_time"].toString(); |
| 40 | + if ( !lastModifiedTimeStr.isEmpty() ) |
| 41 | + { |
| 42 | + QDateTime lastModifiedUtc = QDateTime::fromString( lastModifiedTimeStr, Qt::ISODate ); |
| 43 | + lastModifiedUtc.setTimeSpec( Qt::UTC ); |
| 44 | + metadata.lastModified = lastModifiedUtc.toLocalTime(); |
| 45 | + } |
| 46 | + } |
| 47 | + return true; |
| 48 | +} |
| 49 | + |
| 50 | +static bool _projectsTableExists( const QString &database ) |
| 51 | +{ |
| 52 | + QString errCause; |
| 53 | + bool ok { false }; |
| 54 | + sqlite3_database_unique_ptr db; |
| 55 | + sqlite3_statement_unique_ptr statement; |
| 56 | + |
| 57 | + int status = db.open_v2( database, SQLITE_OPEN_READWRITE, nullptr ); |
| 58 | + if ( status != SQLITE_OK ) |
| 59 | + { |
| 60 | + errCause = QObject::tr( "There was an error opening the database <b>%1</b>: %2" ) |
| 61 | + .arg( database, |
| 62 | + QString::fromUtf8( sqlite3_errmsg( db.get() ) ) ); |
| 63 | + } |
| 64 | + else |
| 65 | + { |
| 66 | + statement = db.prepare( QStringLiteral( "SELECT count(*) FROM sqlite_master WHERE type ='table' AND name = 'qgis_projects'"), status); |
| 67 | + if ( status == SQLITE_OK ) |
| 68 | + { |
| 69 | + if ( sqlite3_step( statement.get() ) == SQLITE_ROW ) |
| 70 | + { |
| 71 | + ok = QString::fromUtf8( reinterpret_cast< const char * >( sqlite3_column_text( statement.get(), 0 ) ) ) == '1'; |
| 72 | + } |
| 73 | + else |
| 74 | + { |
| 75 | + errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" ) |
| 76 | + .arg( database, |
| 77 | + QString::fromUtf8( sqlite3_errmsg( db.get() ) ) ); |
| 78 | + |
| 79 | + } |
| 80 | + } |
| 81 | + else |
| 82 | + { |
| 83 | + errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" ) |
| 84 | + .arg( database, |
| 85 | + QString::fromUtf8( sqlite3_errmsg( db.get() ) ) ); |
| 86 | + |
| 87 | + } |
| 88 | + if ( ! errCause.isEmpty() ) |
| 89 | + QgsMessageLog::logMessage(errCause, QStringLiteral("OGR"), Qgis::MessageLevel::Info ); |
| 90 | + } |
| 91 | + return ok; |
| 92 | +} |
| 93 | + |
| 94 | + |
| 95 | +QStringList QgsGeoPackageProjectStorage::listProjects(const QString& uri) |
| 96 | +{ |
| 97 | + QStringList lst; |
| 98 | + QString errCause; |
| 99 | + |
| 100 | + QgsGeoPackageProjectUri projectUri = decodeUri( uri ); |
| 101 | + if ( !projectUri.valid || ! _projectsTableExists(projectUri.database )) |
| 102 | + return lst; |
| 103 | + |
| 104 | + sqlite3_database_unique_ptr database; |
| 105 | + sqlite3_statement_unique_ptr statement; |
| 106 | + |
| 107 | + int status = database.open_v2( projectUri.database, SQLITE_OPEN_READWRITE, nullptr ); |
| 108 | + if ( status != SQLITE_OK ) |
| 109 | + { |
| 110 | + errCause = QObject::tr( "There was an error opening the database <b>%1</b>: %2" ) |
| 111 | + .arg( projectUri.database, |
| 112 | + QString::fromUtf8( sqlite3_errmsg( database.get() ) ) ); |
| 113 | + } |
| 114 | + else |
| 115 | + { |
| 116 | + statement = database.prepare( QStringLiteral( "SELECT name FROM qgis_projects"), status ); |
| 117 | + if ( status == SQLITE_OK ) |
| 118 | + { |
| 119 | + while( sqlite3_step( statement.get() ) == SQLITE_ROW ) |
| 120 | + { |
| 121 | + lst << QString::fromUtf8( reinterpret_cast< const char * >( sqlite3_column_text( statement.get(), 0 ) ) ); |
| 122 | + } |
| 123 | + } |
| 124 | + else |
| 125 | + { |
| 126 | + errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" ) |
| 127 | + .arg( projectUri.database, |
| 128 | + QString::fromUtf8( sqlite3_errmsg( database.get() ) ) ); |
| 129 | + } |
| 130 | + } |
| 131 | + if ( ! errCause.isEmpty() ) |
| 132 | + QgsMessageLog::logMessage(errCause, QStringLiteral("OGR"), Qgis::MessageLevel::Info ); |
| 133 | + return lst; |
| 134 | +} |
| 135 | + |
| 136 | +bool QgsGeoPackageProjectStorage::readProject(const QString& uri, QIODevice* device, QgsReadWriteContext& context) |
| 137 | +{ |
| 138 | + QgsGeoPackageProjectUri projectUri = decodeUri( uri ); |
| 139 | + if ( !projectUri.valid ) |
| 140 | + { |
| 141 | + context.pushMessage( QObject::tr( "Invalid URI for GeoPackage OGR provider: " ) + uri, Qgis::Critical ); |
| 142 | + return false; |
| 143 | + } |
| 144 | + |
| 145 | + QString errCause; |
| 146 | + QString xml; |
| 147 | + bool ok = false; |
| 148 | + sqlite3_database_unique_ptr database; |
| 149 | + sqlite3_statement_unique_ptr statement; |
| 150 | + |
| 151 | + int status = database.open_v2( projectUri.database, SQLITE_OPEN_READWRITE, nullptr ); |
| 152 | + if ( status != SQLITE_OK ) |
| 153 | + { |
| 154 | + context.pushMessage( QObject::tr( "Could not connect to the database: " ) + projectUri.database, Qgis::Critical ); |
| 155 | + return false; |
| 156 | + } |
| 157 | + else |
| 158 | + { |
| 159 | + statement = database.prepare( QStringLiteral("SELECT content FROM qgis_projects WHERE name = %1" ) |
| 160 | + .arg( QgsSqliteUtils::quotedValue( projectUri.projectName ) ), status ); |
| 161 | + if ( status == SQLITE_OK ) |
| 162 | + { |
| 163 | + if ( sqlite3_step( statement.get() ) == SQLITE_ROW ) |
| 164 | + { |
| 165 | + xml = QString::fromUtf8( reinterpret_cast< const char * >( sqlite3_column_text( statement.get(), 0 ) ) ); |
| 166 | + QString hexEncodedContent( xml ); |
| 167 | + QByteArray binaryContent( QByteArray::fromHex( hexEncodedContent.toUtf8() ) ); |
| 168 | + device->write( binaryContent ); |
| 169 | + device->seek( 0 ); |
| 170 | + ok = true; |
| 171 | + } |
| 172 | + else { |
| 173 | + errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" ) |
| 174 | + .arg( projectUri.database, |
| 175 | + QString::fromUtf8( sqlite3_errmsg( database.get() ) ) ); |
| 176 | + |
| 177 | + } |
| 178 | + } |
| 179 | + else |
| 180 | + { |
| 181 | + errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" ) |
| 182 | + .arg( projectUri.database, |
| 183 | + QString::fromUtf8( sqlite3_errmsg( database.get() ) ) ); |
| 184 | + } |
| 185 | + } |
| 186 | + // TODO: do not log if table does not exists |
| 187 | + if ( ! errCause.isEmpty() ) |
| 188 | + QgsMessageLog::logMessage(errCause, QStringLiteral("OGR"), Qgis::MessageLevel::Info ); |
| 189 | + |
| 190 | + return ok; |
| 191 | + |
| 192 | +} |
| 193 | + |
| 194 | +bool QgsGeoPackageProjectStorage::writeProject(const QString& uri, QIODevice* device, QgsReadWriteContext& context) |
| 195 | +{ |
| 196 | + QgsGeoPackageProjectUri projectUri = decodeUri( uri ); |
| 197 | + if ( !projectUri.valid ) |
| 198 | + { |
| 199 | + context.pushMessage( QObject::tr( "Invalid URI for GeoPackage OGR provider: " ) + uri, Qgis::Critical ); |
| 200 | + return false; |
| 201 | + } |
| 202 | + |
| 203 | + sqlite3_database_unique_ptr database; |
| 204 | + sqlite3_statement_unique_ptr statement; |
| 205 | + |
| 206 | + int status = database.open_v2( projectUri.database, SQLITE_OPEN_READWRITE, nullptr ); |
| 207 | + if ( status != SQLITE_OK ) |
| 208 | + { |
| 209 | + context.pushMessage( QObject::tr( "Could not connect to the database: " ) + projectUri.database, Qgis::Critical ); |
| 210 | + return false; |
| 211 | + } |
| 212 | + else |
| 213 | + { |
| 214 | + if ( !_projectsTableExists( projectUri.database ) ) |
| 215 | + { |
| 216 | + char *errmsg = nullptr; |
| 217 | + // try to create projects table |
| 218 | + ( void )sqlite3_exec( |
| 219 | + database.get(), /* An open database */ |
| 220 | + "CREATE TABLE qgis_projects(name TEXT PRIMARY KEY, metadata BLOB, content BLOB)" , /* SQL to be evaluated */ |
| 221 | + nullptr, /* Callback function */ |
| 222 | + nullptr, /* 1st argument to callback */ |
| 223 | + &errmsg /* Error msg written here */ |
| 224 | + ); |
| 225 | + if ( status != SQLITE_OK || errmsg ) |
| 226 | + { |
| 227 | + const QString errCause = QObject::tr( "Unable to save project. It's not possible to create the destination table on the database. <b>%1</b>: %2" ) |
| 228 | + .arg( projectUri.database, |
| 229 | + QString::fromUtf8( errmsg ) ); |
| 230 | + |
| 231 | + context.pushMessage( errCause, Qgis::Critical ); |
| 232 | + sqlite3_free( errmsg ); |
| 233 | + return false; |
| 234 | + } |
| 235 | + |
| 236 | + } |
| 237 | + |
| 238 | + |
| 239 | + // read from device and write to the table |
| 240 | + QByteArray content = device->readAll(); |
| 241 | + |
| 242 | + QString metadataExpr = QStringLiteral( "{\"last_modified_time\": \"%1\", \"last_modified_user\": \"%2\" }" ).arg( |
| 243 | + "2019-01-01", |
| 244 | + "username" |
| 245 | + ); |
| 246 | + QString sql; |
| 247 | + if ( listProjects( uri ).contains( projectUri.projectName ) ) |
| 248 | + { |
| 249 | + sql = QStringLiteral( "UPDATE qgis_projects SET metadata = %2, content = %3 WHERE name = %1"); |
| 250 | + } |
| 251 | + else |
| 252 | + { |
| 253 | + sql = QStringLiteral( "INSERT INTO qgis_projects VALUES (%1, %2, %3)"); |
| 254 | + } |
| 255 | + sql = sql.arg( QgsSqliteUtils::quotedIdentifier( projectUri.projectName), |
| 256 | + QgsSqliteUtils::quotedValue( metadataExpr ), |
| 257 | + QgsSqliteUtils::quotedValue(QString::fromAscii( content.toHex() )) |
| 258 | + ); |
| 259 | + char *errmsg = nullptr; |
| 260 | + ( void )sqlite3_exec( |
| 261 | + database.get(), /* An open database */ |
| 262 | + sql.toLocal8Bit(), /* SQL to be evaluated */ |
| 263 | + nullptr, /* Callback function */ |
| 264 | + nullptr, /* 1st argument to callback */ |
| 265 | + &errmsg /* Error msg written here */ |
| 266 | + ); |
| 267 | + if ( status != SQLITE_OK || errmsg ) |
| 268 | + { |
| 269 | + const QString errCause = QObject::tr( "Unable to insert or update project (project=%1) in the destination table on the database: %2" ) |
| 270 | + .arg( projectUri.database, |
| 271 | + QString::fromUtf8( errmsg ) ); |
| 272 | + |
| 273 | + context.pushMessage( errCause, Qgis::Critical ); |
| 274 | + sqlite3_free( errmsg ); |
| 275 | + return false; |
| 276 | + } |
| 277 | + return true; |
| 278 | + |
| 279 | + } |
| 280 | +} |
| 281 | + |
| 282 | +QString QgsGeoPackageProjectStorage::encodeUri(const QgsGeoPackageProjectUri& gpkgUri) |
| 283 | +{ |
| 284 | + QUrl u; |
| 285 | + QUrlQuery urlQuery; |
| 286 | + u.setScheme( QStringLiteral( "geopackage") ); |
| 287 | + u.setPath( gpkgUri.database ); |
| 288 | + if ( !gpkgUri.projectName.isEmpty() ) |
| 289 | + urlQuery.addQueryItem( QStringLiteral("projectName"), gpkgUri.projectName ); |
| 290 | + u.setQuery( urlQuery ); |
| 291 | + return QString::fromUtf8( u.toEncoded() ); |
| 292 | +} |
| 293 | + |
| 294 | + |
| 295 | +QgsGeoPackageProjectUri QgsGeoPackageProjectStorage::decodeUri(const QString& uri) |
| 296 | +{ |
| 297 | + // TODO check file exists |
| 298 | + QUrl url = QUrl::fromEncoded( uri.toUtf8() ); |
| 299 | + QUrlQuery urlQuery( url.query() ); |
| 300 | + |
| 301 | + QgsGeoPackageProjectUri gpkgUri; |
| 302 | + gpkgUri.valid = url.isValid(); |
| 303 | + |
| 304 | + gpkgUri.database = url.path(); |
| 305 | + gpkgUri.projectName = urlQuery.queryItemValue( "projectName" ); |
| 306 | + return gpkgUri; |
| 307 | +} |
| 308 | + |
| 309 | +bool QgsGeoPackageProjectStorage::removeProject(const QString& uri) |
| 310 | +{ |
| 311 | + return true; |
| 312 | +} |
| 313 | + |
| 314 | +bool QgsGeoPackageProjectStorage::renameProject(const QString& uri, const QString& uriNew) |
| 315 | +{ |
| 316 | + return true; |
| 317 | +} |
| 318 | + |
| 319 | +bool QgsGeoPackageProjectStorage::readProjectStorageMetadata(const QString& uri, QgsProjectStorage::Metadata& metadata) |
| 320 | +{ |
| 321 | + QgsGeoPackageProjectUri projectUri = decodeUri( uri ); |
| 322 | + if ( !projectUri.valid ) |
| 323 | + return false; |
| 324 | + |
| 325 | + bool ok = false; |
| 326 | + |
| 327 | + sqlite3_database_unique_ptr database; |
| 328 | + sqlite3_statement_unique_ptr statement; |
| 329 | + |
| 330 | + int status = database.open_v2( projectUri.database, SQLITE_OPEN_READWRITE, nullptr ); |
| 331 | + if ( status != SQLITE_OK ) |
| 332 | + { |
| 333 | + return false; |
| 334 | + } |
| 335 | + else |
| 336 | + { |
| 337 | + statement = database.prepare( QStringLiteral("SELECT metadata FROM qgis_projects WHERE name = %1" ) |
| 338 | + .arg( QgsSqliteUtils::quotedValue( projectUri.projectName ) ), status ); |
| 339 | + |
| 340 | + if ( status == SQLITE_OK ) |
| 341 | + { |
| 342 | + if ( sqlite3_step( statement.get() ) == SQLITE_ROW ) |
| 343 | + { |
| 344 | + QString metadataStr = QString::fromUtf8( reinterpret_cast< const char * >( sqlite3_column_text( statement.get(), 0 ) ) ); |
| 345 | + metadata.name = projectUri.projectName; |
| 346 | + QJsonDocument doc( QJsonDocument::fromJson( metadataStr.toUtf8() ) ); |
| 347 | + ok = _parseMetadataDocument( doc, metadata ); |
| 348 | + } |
| 349 | + } |
| 350 | + } |
| 351 | + |
| 352 | + return ok; |
| 353 | +} |
| 354 | + |
| 355 | + |
| 356 | +#ifdef HAVE_GUI |
| 357 | + |
| 358 | +#include "qgsgeopackageprojectstoragedialog.h" |
| 359 | + |
| 360 | +QString QgsGeoPackageProjectStorage::visibleName() |
| 361 | +{ |
| 362 | + return QObject::tr( "GeoPackage" ); |
| 363 | +} |
| 364 | + |
| 365 | +QString QgsGeoPackageProjectStorage::showLoadGui() |
| 366 | +{ |
| 367 | + QgsGeoPackageProjectStorageDialog dlg( false ); |
| 368 | + if ( !dlg.exec() ) |
| 369 | + return QString(); |
| 370 | + |
| 371 | + return dlg.currentProjectUri(); |
| 372 | +} |
| 373 | + |
| 374 | +QString QgsGeoPackageProjectStorage::showSaveGui() |
| 375 | +{ |
| 376 | + QgsGeoPackageProjectStorageDialog dlg( true ); |
| 377 | + if ( !dlg.exec() ) |
| 378 | + return QString(); |
| 379 | + |
| 380 | + return dlg.currentProjectUri(); |
| 381 | +} |
| 382 | + |
| 383 | +#endif |
0 commit comments