-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsgeopackageprojectstorage.cpp
424 lines (370 loc) · 14.6 KB
/
qgsgeopackageprojectstorage.cpp
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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
/***************************************************************************
qgsgeopackageprojectstorage.cpp
---------------------
begin : March 2019
copyright : (C) 2019 by Alessandro Pasotti
email : elpaso at itopen dot it
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include "qgsgeopackageprojectstorage.h"
///@cond PRIVATE
#include <sqlite3.h>
#include <QUrlQuery>
#include <QUrl>
#include <QIODevice>
#include <QJsonDocument>
#include <QJsonObject>
#include <QFile>
#include "qgsmessagelog.h"
#include "qgssqliteutils.h"
#include "qgsreadwritecontext.h"
#include "qgsapplication.h"
#include "qgsogrutils.h"
#include "qgsproject.h"
static bool _parseMetadataDocument( const QJsonDocument &doc, QgsProjectStorage::Metadata &metadata )
{
if ( !doc.isObject() )
return false;
QJsonObject docObj = doc.object();
metadata.lastModified = QDateTime();
if ( docObj.contains( "last_modified_time" ) )
{
QString lastModifiedTimeStr = docObj["last_modified_time"].toString();
if ( !lastModifiedTimeStr.isEmpty() )
{
QDateTime lastModifiedUtc = QDateTime::fromString( lastModifiedTimeStr, Qt::ISODate );
lastModifiedUtc.setTimeSpec( Qt::UTC );
metadata.lastModified = lastModifiedUtc.toLocalTime();
}
}
return true;
}
static bool _projectsTableExists( const QString &database )
{
QString errCause;
bool ok { false };
sqlite3_database_unique_ptr db;
sqlite3_statement_unique_ptr statement;
int status = db.open_v2( database, SQLITE_OPEN_READWRITE, nullptr );
if ( status != SQLITE_OK )
{
errCause = QObject::tr( "There was an error opening the database <b>%1</b>: %2" )
.arg( database,
QString::fromUtf8( sqlite3_errmsg( db.get() ) ) );
}
else
{
statement = db.prepare( QStringLiteral( "SELECT count(*) FROM sqlite_master WHERE type ='table' AND name = 'qgis_projects'" ), status );
if ( status == SQLITE_OK )
{
if ( sqlite3_step( statement.get() ) == SQLITE_ROW )
{
ok = QString::fromUtf8( reinterpret_cast< const char * >( sqlite3_column_text( statement.get(), 0 ) ) ) == '1';
}
else
{
errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" )
.arg( database,
QString::fromUtf8( sqlite3_errmsg( db.get() ) ) );
}
}
else
{
errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" )
.arg( database,
QString::fromUtf8( sqlite3_errmsg( db.get() ) ) );
}
if ( ! errCause.isEmpty() )
QgsMessageLog::logMessage( errCause, QStringLiteral( "OGR" ), Qgis::MessageLevel::Info );
}
return ok;
}
QStringList QgsGeoPackageProjectStorage::listProjects( const QString &uri )
{
QStringList lst;
QString errCause;
QgsGeoPackageProjectUri projectUri = decodeUri( uri );
if ( !projectUri.valid || ! _projectsTableExists( projectUri.database ) )
return lst;
sqlite3_database_unique_ptr database;
sqlite3_statement_unique_ptr statement;
int status = database.open_v2( projectUri.database, SQLITE_OPEN_READWRITE, nullptr );
if ( status != SQLITE_OK )
{
errCause = QObject::tr( "There was an error opening the database <b>%1</b>: %2" )
.arg( projectUri.database,
QString::fromUtf8( sqlite3_errmsg( database.get() ) ) );
}
else
{
statement = database.prepare( QStringLiteral( "SELECT name FROM qgis_projects" ), status );
if ( status == SQLITE_OK )
{
while ( sqlite3_step( statement.get() ) == SQLITE_ROW )
{
lst << QString::fromUtf8( reinterpret_cast< const char * >( sqlite3_column_text( statement.get(), 0 ) ) );
}
}
else
{
errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" )
.arg( projectUri.database,
QString::fromUtf8( sqlite3_errmsg( database.get() ) ) );
}
}
if ( ! errCause.isEmpty() )
QgsMessageLog::logMessage( errCause, QStringLiteral( "OGR" ), Qgis::MessageLevel::Info );
return lst;
}
bool QgsGeoPackageProjectStorage::readProject( const QString &uri, QIODevice *device, QgsReadWriteContext &context )
{
QgsGeoPackageProjectUri projectUri = decodeUri( uri );
if ( !projectUri.valid )
{
context.pushMessage( QObject::tr( "Invalid URI for GeoPackage OGR provider: " ) + uri, Qgis::Critical );
return false;
}
QString errCause;
QString xml;
bool ok = false;
sqlite3_database_unique_ptr database;
sqlite3_statement_unique_ptr statement;
int status = database.open_v2( projectUri.database, SQLITE_OPEN_READWRITE, nullptr );
if ( status != SQLITE_OK )
{
context.pushMessage( QObject::tr( "Could not connect to the database: " ) + projectUri.database, Qgis::Critical );
return false;
}
else
{
statement = database.prepare( QStringLiteral( "SELECT content FROM qgis_projects WHERE name = %1" )
.arg( QgsSqliteUtils::quotedValue( projectUri.projectName ) ), status );
if ( status == SQLITE_OK )
{
if ( sqlite3_step( statement.get() ) == SQLITE_ROW )
{
xml = QString::fromUtf8( reinterpret_cast< const char * >( sqlite3_column_text( statement.get(), 0 ) ) );
QString hexEncodedContent( xml );
QByteArray binaryContent( QByteArray::fromHex( hexEncodedContent.toUtf8() ) );
device->write( binaryContent );
device->seek( 0 );
ok = true;
}
else
{
errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" )
.arg( projectUri.database,
QString::fromUtf8( sqlite3_errmsg( database.get() ) ) );
}
}
else
{
errCause = QObject::tr( "There was an error querying the database <b>%1</b>: %2" )
.arg( projectUri.database,
QString::fromUtf8( sqlite3_errmsg( database.get() ) ) );
}
}
// TODO: do not log if table does not exists
if ( ! errCause.isEmpty() )
QgsMessageLog::logMessage( errCause, QStringLiteral( "OGR" ), Qgis::MessageLevel::Info );
return ok;
}
bool QgsGeoPackageProjectStorage::writeProject( const QString &uri, QIODevice *device, QgsReadWriteContext &context )
{
QgsGeoPackageProjectUri projectUri = decodeUri( uri );
QString errCause;
if ( !QFile::exists( projectUri.database ) )
{
OGRSFDriverH hGpkgDriver = OGRGetDriverByName( "GPKG" );
if ( !hGpkgDriver )
{
errCause = QObject::tr( "GeoPackage driver not found." );
}
else
{
gdal::ogr_datasource_unique_ptr hDS( OGR_Dr_CreateDataSource( hGpkgDriver, projectUri.database.toUtf8().constData(), nullptr ) );
if ( !hDS )
errCause = QObject::tr( "Creation of database failed (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
}
}
if ( errCause.isEmpty() && !_projectsTableExists( projectUri.database ) )
{
errCause = _executeSql( projectUri.database, QStringLiteral( "CREATE TABLE qgis_projects(name TEXT PRIMARY KEY, metadata BLOB, content BLOB)" ) );
}
if ( !errCause.isEmpty() )
{
errCause = QObject::tr( "Unable to save project. It's not possible to create the destination table on the database. <b>%1</b>: %2" )
.arg( projectUri.database,
errCause );
context.pushMessage( errCause, Qgis::Critical );
return false;
}
// read from device and write to the table
QByteArray content = device->readAll();
QString metadataExpr = QStringLiteral( "{\"last_modified_time\": \"%1\", \"last_modified_user\": \"%2\" }" ).arg(
QDateTime::currentDateTime().toString( Qt::DateFormat::ISODate ),
QgsApplication::instance()->userLoginName()
);
QString sql;
if ( listProjects( uri ).contains( projectUri.projectName ) )
{
sql = QStringLiteral( "UPDATE qgis_projects SET metadata = %2, content = %3 WHERE name = %1" );
}
else
{
sql = QStringLiteral( "INSERT INTO qgis_projects VALUES (%1, %2, %3)" );
}
sql = sql.arg( QgsSqliteUtils::quotedIdentifier( projectUri.projectName ),
QgsSqliteUtils::quotedValue( metadataExpr ),
QgsSqliteUtils::quotedValue( QString::fromLatin1( content.toHex() ) )
);
errCause = _executeSql( projectUri.database, sql );
if ( !errCause.isEmpty() )
{
errCause = QObject::tr( "Unable to insert or update project (project=%1) in the destination table on the database: %2" )
.arg( uri,
errCause );
context.pushMessage( errCause, Qgis::Critical );
return false;
}
return true;
}
QString QgsGeoPackageProjectStorage::encodeUri( const QgsGeoPackageProjectUri &gpkgUri )
{
QUrl u;
QUrlQuery urlQuery;
u.setScheme( QStringLiteral( "geopackage" ) );
// Check for windows network shares: github issue #31310
QString database { gpkgUri.database };
if ( database.startsWith( QStringLiteral( "//" ) ) )
{
u.setPath( database.replace( '/', '\\' ) );
}
else
{
u.setPath( database );
}
if ( !gpkgUri.projectName.isEmpty() )
urlQuery.addQueryItem( QStringLiteral( "projectName" ), gpkgUri.projectName );
u.setQuery( urlQuery );
return QString::fromUtf8( u.toEncoded() );
}
QgsGeoPackageProjectUri QgsGeoPackageProjectStorage::decodeUri( const QString &uri )
{
QUrl url = QUrl::fromEncoded( uri.toUtf8() );
QUrlQuery urlQuery( url.query() );
const QString urlAsString( url.toString( ) );
QgsGeoPackageProjectUri gpkgUri;
// Check for windows paths: github issue #33057
const QRegularExpression winLocalPath { R"(^[A-Za-z]:)" };
// Check for windows network shares: github issue #31310
const QString path { ( winLocalPath.match( urlAsString ).hasMatch() ||
urlAsString.startsWith( QStringLiteral( "//" ) ) ) ?
urlAsString :
url.path() };
gpkgUri.valid = QFile::exists( path );
gpkgUri.database = path;
gpkgUri.projectName = urlQuery.queryItemValue( "projectName" );
return gpkgUri;
}
QString QgsGeoPackageProjectStorage::filePath( const QString &uri )
{
const QgsGeoPackageProjectUri gpkgUri { decodeUri( uri ) };
return gpkgUri.valid ? gpkgUri.database : QString();
}
QString QgsGeoPackageProjectStorage::_executeSql( const QString &uri, const QString &sql )
{
QgsGeoPackageProjectUri projectUri = decodeUri( uri );
if ( !projectUri.valid )
{
return QObject::tr( "Invalid URI for GeoPackage OGR provider: %1" ).arg( uri );
}
sqlite3_database_unique_ptr db;
sqlite3_statement_unique_ptr statement;
int status = db.open_v2( projectUri.database, SQLITE_OPEN_READWRITE, nullptr );
if ( status != SQLITE_OK )
{
return QObject::tr( "Could not connect to the database: %1" ).arg( projectUri.database );
}
QString errCause;
char *errmsg = nullptr;
( void )sqlite3_exec(
db.get(), /* An open database */
sql.toLocal8Bit(), /* SQL to be evaluated */
nullptr, /* Callback function */
nullptr, /* 1st argument to callback */
&errmsg /* Error msg written here */
);
if ( status != SQLITE_OK || errmsg )
{
errCause = QString::fromUtf8( errmsg );
}
return errCause;
}
bool QgsGeoPackageProjectStorage::removeProject( const QString &uri )
{
QgsGeoPackageProjectUri projectUri = decodeUri( uri );
QString errCause = _executeSql( projectUri.database, QStringLiteral( "DELETE FROM qgis_projects WHERE name = %1" ).arg( QgsSqliteUtils::quotedValue( projectUri.projectName ) ) );
if ( ! errCause.isEmpty() )
{
errCause = QObject::tr( "Could not remove project %1: %2" ).arg( uri, errCause );
QgsMessageLog::logMessage( errCause, QStringLiteral( "OGR" ), Qgis::MessageLevel::Warning );
}
else if ( QgsProject::instance()->fileName() == uri )
{
QgsMessageLog::logMessage( QStringLiteral( "Current project was removed from storage, marking it dirty." ), QStringLiteral( "OGR" ), Qgis::MessageLevel::Warning );
QgsProject::instance()->setDirty( true );
}
return errCause.isEmpty();
}
bool QgsGeoPackageProjectStorage::renameProject( const QString &uri, const QString &uriNew )
{
QgsGeoPackageProjectUri projectNewUri = decodeUri( uriNew );
QgsGeoPackageProjectUri projectUri = decodeUri( uri );
QString errCause = _executeSql( projectUri.database, QStringLiteral( "UPDATE qgis_projects SET name = %1 WHERE name = %1" )
.arg( QgsSqliteUtils::quotedValue( projectUri.projectName ) )
.arg( QgsSqliteUtils::quotedValue( projectNewUri.projectName ) ) );
if ( ! errCause.isEmpty() )
{
errCause = QObject::tr( "Could not rename project %1: %2" ).arg( uri, errCause );
QgsMessageLog::logMessage( errCause, QStringLiteral( "OGR" ), Qgis::MessageLevel::Warning );
}
return errCause.isEmpty();
}
bool QgsGeoPackageProjectStorage::readProjectStorageMetadata( const QString &uri, QgsProjectStorage::Metadata &metadata )
{
QgsGeoPackageProjectUri projectUri = decodeUri( uri );
if ( !projectUri.valid )
return false;
bool ok = false;
sqlite3_database_unique_ptr database;
sqlite3_statement_unique_ptr statement;
int status = database.open_v2( projectUri.database, SQLITE_OPEN_READWRITE, nullptr );
if ( status != SQLITE_OK )
{
return false;
}
else
{
statement = database.prepare( QStringLiteral( "SELECT metadata FROM qgis_projects WHERE name = %1" )
.arg( QgsSqliteUtils::quotedValue( projectUri.projectName ) ), status );
if ( status == SQLITE_OK )
{
if ( sqlite3_step( statement.get() ) == SQLITE_ROW )
{
QString metadataStr = QString::fromUtf8( reinterpret_cast< const char * >( sqlite3_column_text( statement.get(), 0 ) ) );
metadata.name = projectUri.projectName;
QJsonDocument doc( QJsonDocument::fromJson( metadataStr.toUtf8() ) );
ok = _parseMetadataDocument( doc, metadata );
}
}
}
return ok;
}
///@endcond