-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsvirtuallayerprovider.cpp
648 lines (567 loc) · 16.9 KB
/
qgsvirtuallayerprovider.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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
/***************************************************************************
qgsvirtuallayerprovider.cpp Virtual layer data provider
begin : Jan, 2015
copyright : (C) 2015 Hugo Mercier, Oslandia
email : hugo dot mercier at oslandia dot com
***************************************************************************/
/***************************************************************************
* *
* 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. *
* *
***************************************************************************/
extern "C"
{
#include <sqlite3.h>
#include <spatialite.h>
}
#include <QUrl>
#include <stdexcept>
#include <qgsvirtuallayerprovider.h>
#include <qgsvirtuallayerdefinition.h>
#include <qgsvirtuallayerfeatureiterator.h>
#include <qgsvectorlayer.h>
#include <qgsmaplayerregistry.h>
#include <qgsdatasourceuri.h>
#include "qgsvirtuallayerprovider.h"
#include "qgsvirtuallayersqlitemodule.h"
#include "qgsvirtuallayerqueryparser.h"
const QString VIRTUAL_LAYER_KEY = "virtual";
const QString VIRTUAL_LAYER_DESCRIPTION = "Virtual layer data provider";
const QString VIRTUAL_LAYER_QUERY_VIEW = "_query";
static QString quotedColumn( QString name )
{
return "\"" + name.replace( "\"", "\"\"" ) + "\"";
}
#define PROVIDER_ERROR( msg ) do { mError = QgsError( msg, VIRTUAL_LAYER_KEY ); QgsDebugMsg( msg ); } while(0)
QgsVirtualLayerProvider::QgsVirtualLayerProvider( QString const &uri )
: QgsVectorDataProvider( uri )
, mValid( true )
, mCachedStatistics( false )
, mFeatureCount( 0 )
{
mError.clear();
QUrl url = QUrl::fromEncoded( uri.toUtf8() );
if ( !url.isValid() )
{
mValid = false;
PROVIDER_ERROR( "Malformed URL" );
return;
}
// xxxxx = open a virtual layer
// xxxxx?key=value&key=value = create a virtual layer
// ?key=value = create a temporary virtual layer
// read url
try
{
mDefinition = QgsVirtualLayerDefinition::fromUrl( url );
if ( mDefinition.sourceLayers().empty() && !mDefinition.filePath().isEmpty() && mDefinition.query().isEmpty() )
{
// open the file
mValid = openIt();
}
else
{
// create the file
mValid = createIt();
}
}
catch ( std::runtime_error& e )
{
mValid = false;
PROVIDER_ERROR( e.what() );
return;
}
if ( mDefinition.geometrySrid() != -1 )
{
mCrs = QgsCoordinateReferenceSystem( mDefinition.geometrySrid() );
}
}
bool QgsVirtualLayerProvider::loadSourceLayers()
{
Q_FOREACH ( const QgsVirtualLayerDefinition::SourceLayer &layer, mDefinition.sourceLayers() )
{
if ( layer.isReferenced() )
{
QgsMapLayer *l = QgsMapLayerRegistry::instance()->mapLayer( layer.reference() );
if ( !l )
{
PROVIDER_ERROR( QString( "Cannot find layer %1" ).arg( layer.reference() ) );
return false;
}
if ( l->type() != QgsMapLayer::VectorLayer )
{
PROVIDER_ERROR( QString( "Layer %1 is not a vector layer" ).arg( layer.reference() ) );
return false;
}
// add the layer to the list
QgsVectorLayer* vl = static_cast<QgsVectorLayer*>( l );
mLayers << SourceLayer( vl, layer.name() );
// connect to modification signals to invalidate statistics
connect( vl, SIGNAL( featureAdded( QgsFeatureId ) ), this, SLOT( invalidateStatistics() ) );
connect( vl, SIGNAL( featureDeleted( QgsFeatureId ) ), this, SLOT( invalidateStatistics() ) );
connect( vl, SIGNAL( geometryChanged( QgsFeatureId, QgsGeometry& ) ), this, SLOT( invalidateStatistics() ) );
}
else
{
mLayers << SourceLayer( layer.provider(), layer.source(), layer.name(), layer.encoding() );
}
}
return true;
}
bool QgsVirtualLayerProvider::openIt()
{
spatialite_init( 0 );
mPath = mDefinition.filePath();
try
{
QgsScopedSqlite p( mPath );
mSqlite = p;
}
catch ( std::runtime_error& e )
{
PROVIDER_ERROR( e.what() );
return false;
}
{
Sqlite::Query q( mSqlite.get(), "SELECT name FROM sqlite_master WHERE name='_meta'" );
if ( q.step() != SQLITE_ROW )
{
PROVIDER_ERROR( "No metadata tables!" );
return false;
}
}
// look for the correct version and the stored url
{
Sqlite::Query q( mSqlite.get(), "SELECT version, url FROM _meta" );
int version = 0;
if ( q.step() == SQLITE_ROW )
{
version = q.columnInt( 0 );
if ( version != VIRTUAL_LAYER_VERSION )
{
PROVIDER_ERROR( "Wrong virtual layer version!" );
return false;
}
mDefinition = QgsVirtualLayerDefinition::fromUrl( QUrl( q.columnText( 1 ) ) );
}
}
// overwrite the uri part of the definition
mDefinition.setFilePath( mPath );
// load source layers
if ( !loadSourceLayers() )
{
return false;
}
/* only one table */
if ( mDefinition.query().isEmpty() )
{
mTableName = mLayers[0].name;
}
else
{
mTableName = VIRTUAL_LAYER_QUERY_VIEW;
}
return true;
}
bool QgsVirtualLayerProvider::createIt()
{
using namespace QgsVirtualLayerQueryParser;
// consistency check
if ( mDefinition.sourceLayers().size() > 1 && mDefinition.query().isEmpty() )
{
PROVIDER_ERROR( QString( "Don't know how to join layers, please specify a query" ) );
return false;
}
if ( mDefinition.sourceLayers().empty() && mDefinition.filePath().isEmpty() && mDefinition.query().isEmpty() )
{
PROVIDER_ERROR( QString( "Please specify at least one source layer or a query" ) );
return false;
}
if ( !mDefinition.filePath().isEmpty() && mDefinition.hasReferencedLayers() )
{
PROVIDER_ERROR( QString( "Cannot store referenced layers" ) );
return false;
}
QVector<ColumnDef> gFields;
if ( !mDefinition.query().isEmpty() )
{
QStringList tables = referencedTables( mDefinition.query() );
Q_FOREACH ( const QString &tname, tables )
{
// is it in source layers ?
if ( mDefinition.hasSourceLayer( tname ) )
{
continue;
}
// is it in loaded layers ?
bool found = false;
Q_FOREACH ( const QgsMapLayer *l, QgsMapLayerRegistry::instance()->mapLayers() )
{
if ( l->type() != QgsMapLayer::VectorLayer )
continue;
const QgsVectorLayer* vl = static_cast<const QgsVectorLayer*>( l );
if (( vl->name() == tname ) || ( vl->name().toLower() == tname.toLower() ) || ( vl->id() == tname ) )
{
mDefinition.addSource( tname, vl->id() );
found = true;
break;
}
}
if ( !found )
{
PROVIDER_ERROR( QString( "Referenced table %1 in query not found!" ).arg( tname ) );
return false;
}
}
}
QString path;
mPath = mDefinition.filePath();
// use a temporary file if needed
if ( mPath.isEmpty() )
path = ":memory:";
else
path = mPath;
spatialite_init( 0 );
try
{
QgsScopedSqlite sqlite( path );
mSqlite = sqlite;
}
catch ( std::runtime_error& e )
{
PROVIDER_ERROR( e.what() );
return false;
}
resetSqlite();
initVirtualLayerMetadata( mSqlite.get() );
bool noGeometry = mDefinition.geometryWkbType() == QgsWKBTypes::NoGeometry;
// load source layers (and populate mLayers)
if ( !loadSourceLayers() )
{
return false;
}
// now create virtual tables based on layers
for ( int i = 0; i < mLayers.size(); i++ )
{
QgsVectorLayer* vlayer = mLayers.at( i ).layer;
QString vname = mLayers.at( i ).name;
if ( vlayer )
{
QString createStr = QString( "DROP TABLE IF EXISTS \"%1\"; CREATE VIRTUAL TABLE \"%1\" USING QgsVLayer(%2);" ).arg( vname, vlayer->id() );
Sqlite::Query::exec( mSqlite.get(), createStr );
}
else
{
QString provider = mLayers.at( i ).provider;
// double each single quote
provider.replace( "'", "''" );
QString source = mLayers.at( i ).source;
source.replace( "'", "''" );
QString encoding = mLayers.at( i ).encoding;
QString createStr = QString( "DROP TABLE IF EXISTS \"%1\"; CREATE VIRTUAL TABLE \"%1\" USING QgsVLayer('%2','%4',%3)" )
.arg( vname,
provider,
encoding,
source ); // source must be the last argument here, since it can contains '%x' strings that would be replaced
Sqlite::Query::exec( mSqlite.get(), createStr );
}
}
QgsFields tfields;
QList<QString> geometryFields;
if ( !mDefinition.query().isEmpty() )
{
// look for column types of the query
TableDef columns = columnDefinitionsFromQuery( mSqlite.get(), mDefinition.query() );
for ( int i = 0; i < columns.size(); i++ )
{
ColumnDef& c = columns[i];
if ( c.name().isEmpty() )
{
PROVIDER_ERROR( QString( "Result column #%1 has no name!" ).arg( i + 1 ) );
return false;
}
// then override types by the ones defined in the url
if ( mDefinition.fields().indexFromName( c.name() ) != -1 )
{
c.setScalarType( mDefinition.fields().field( c.name() ).type() );
}
if ( c.isGeometry() )
{
gFields << c;
}
// if the geometry field is not detected as a geometry, move it to the geometry fields
// with the provided type and srid
else if ( mDefinition.hasDefinedGeometry() && c.name() == mDefinition.geometryField() )
{
ColumnDef g;
g.setName( mDefinition.geometryField() );
g.setGeometry( mDefinition.geometryWkbType() );
g.setSrid( mDefinition.geometrySrid() );
gFields << g;
}
// default type: string
else if ( c.scalarType() == QVariant::Invalid )
{
c.setScalarType( QVariant::String );
}
else
{
tfields.append( QgsField( c.name(), c.scalarType() ) );
}
}
// process geometry field
if ( !noGeometry )
{
// no geometry field defined yet, take the first detected
if ( mDefinition.geometryField().isEmpty() )
{
if ( gFields.count() > 0 )
{
mDefinition.setGeometryField( gFields[0].name() );
mDefinition.setGeometryWkbType( gFields[0].wkbType() );
mDefinition.setGeometrySrid( gFields[0].srid() );
}
}
// a geometry field is named, but has no type yet
// look for a detected type
else if ( !mDefinition.hasDefinedGeometry() )
{
bool found = false;
for ( int i = 0; i < gFields.size(); i++ )
{
if ( gFields[i].name() == mDefinition.geometryField() )
{
// override the geometry type
mDefinition.setGeometryWkbType( gFields[i].wkbType() );
mDefinition.setGeometrySrid( gFields[i].srid() );
found = true;
break;
}
}
if ( !found )
{
PROVIDER_ERROR( "Cannot find the specified geometry field!" );
return false;
}
}
if ( !mDefinition.geometryField().isEmpty() && !mDefinition.hasDefinedGeometry() )
{
PROVIDER_ERROR( "Can't deduce the geometry type of the geometry field!" );
return false;
}
}
// save field definitions
mDefinition.setFields( tfields );
mTableName = VIRTUAL_LAYER_QUERY_VIEW;
// create a view
QString viewStr = QString( "DROP VIEW IF EXISTS %1; CREATE VIEW %1 AS %2" )
.arg( VIRTUAL_LAYER_QUERY_VIEW,
mDefinition.query() );
Sqlite::Query::exec( mSqlite.get(), viewStr );
}
else
{
// no query => implies we must only have one virtual table
mTableName = mLayers[0].name;
TableDef td = tableDefinitionFromVirtualTable( mSqlite.get(), mTableName );
Q_FOREACH ( const ColumnDef &c, td )
{
if ( !c.isGeometry() )
{
tfields.append( QgsField( c.name(), c.scalarType() ) );
}
else if ( !noGeometry )
{
mDefinition.setGeometryField( "geometry" );
mDefinition.setGeometryWkbType( c.wkbType() );
mDefinition.setGeometrySrid( c.srid() );
}
}
mDefinition.setFields( tfields );
}
// Save the definition back to the sqlite file
{
Sqlite::Query q( mSqlite.get(), "UPDATE _meta SET url=?" );
q.bind( mDefinition.toUrl().toString() );
q.step();
}
return true;
}
QgsVirtualLayerProvider::~QgsVirtualLayerProvider()
{
}
void QgsVirtualLayerProvider::resetSqlite()
{
bool hasSpatialrefsys = false;
{
Sqlite::Query q( mSqlite.get(), "SELECT name FROM sqlite_master WHERE name='spatial_ref_sys'" );
hasSpatialrefsys = q.step() == SQLITE_ROW;
}
QString sql = "DROP TABLE IF EXISTS _meta;";
if ( !hasSpatialrefsys )
{
sql += "SELECT InitSpatialMetadata(1);";
}
Sqlite::Query::exec( mSqlite.get(), sql );
}
QgsAbstractFeatureSource* QgsVirtualLayerProvider::featureSource() const
{
return new QgsVirtualLayerFeatureSource( this );
}
QString QgsVirtualLayerProvider::storageType() const
{
return "No storage per se, view data from other data sources";
}
QgsCoordinateReferenceSystem QgsVirtualLayerProvider::crs()
{
return mCrs;
}
QgsFeatureIterator QgsVirtualLayerProvider::getFeatures( const QgsFeatureRequest& request )
{
return QgsFeatureIterator( new QgsVirtualLayerFeatureIterator( new QgsVirtualLayerFeatureSource( this ), false, request ) );
}
QString QgsVirtualLayerProvider::subsetString()
{
return mSubset;
}
bool QgsVirtualLayerProvider::setSubsetString( const QString& subset, bool updateFeatureCount )
{
mSubset = subset;
if ( updateFeatureCount )
updateStatistics();
return true;
}
QGis::WkbType QgsVirtualLayerProvider::geometryType() const
{
return static_cast<QGis::WkbType>( mDefinition.geometryWkbType() );
}
long QgsVirtualLayerProvider::featureCount() const
{
if ( !mCachedStatistics )
{
updateStatistics();
}
return mFeatureCount;
}
QgsRectangle QgsVirtualLayerProvider::extent()
{
if ( !mCachedStatistics )
{
updateStatistics();
}
return mExtent;
}
void QgsVirtualLayerProvider::updateStatistics() const
{
bool hasGeometry = mDefinition.geometryWkbType() != QgsWKBTypes::NoGeometry;
QString subset = mSubset.isEmpty() ? "" : " WHERE " + mSubset;
QString sql = QString( "SELECT Count(*)%1 FROM %2%3" )
.arg( hasGeometry ? QString( ",Min(MbrMinX(%1)),Min(MbrMinY(%1)),Max(MbrMaxX(%1)),Max(MbrMaxY(%1))" ).arg( quotedColumn( mDefinition.geometryField() ) ) : "",
mTableName,
subset );
Sqlite::Query q( mSqlite.get(), sql );
if ( q.step() == SQLITE_ROW )
{
mFeatureCount = q.columnInt64( 0 );
if ( hasGeometry )
{
double x1, y1, x2, y2;
x1 = q.columnDouble( 1 );
y1 = q.columnDouble( 2 );
x2 = q.columnDouble( 3 );
y2 = q.columnDouble( 4 );
mExtent = QgsRectangle( x1, y1, x2, y2 );
}
mCachedStatistics = true;
}
}
void QgsVirtualLayerProvider::invalidateStatistics()
{
mCachedStatistics = false;
}
const QgsFields & QgsVirtualLayerProvider::fields() const
{
return mDefinition.fields();
}
bool QgsVirtualLayerProvider::isValid()
{
return mValid;
}
int QgsVirtualLayerProvider::capabilities() const
{
if ( !mDefinition.uid().isNull() )
{
return SelectAtId | SelectGeometryAtId;
}
return 0;
}
QString QgsVirtualLayerProvider::name() const
{
return VIRTUAL_LAYER_KEY;
}
QString QgsVirtualLayerProvider::description() const
{
return VIRTUAL_LAYER_DESCRIPTION;
}
QgsAttributeList QgsVirtualLayerProvider::pkAttributeIndexes()
{
if ( !mDefinition.uid().isNull() )
{
const QgsFields& fields = mDefinition.fields();
for ( int i = 0; i < fields.size(); i++ )
{
if ( fields.at( i ).name().toLower() == mDefinition.uid().toLower() )
{
QgsAttributeList l;
l << i;
return l;
}
}
}
return QgsAttributeList();
}
QSet<QString> QgsVirtualLayerProvider::layerDependencies() const
{
QSet<QString> deps;
Q_FOREACH ( const QgsVirtualLayerDefinition::SourceLayer& l, mDefinition.sourceLayers() )
{
if ( l.isReferenced() )
deps << l.reference();
}
return deps;
}
/**
* Class factory to return a pointer to a newly created
* QgsSpatiaLiteProvider object
*/
QGISEXTERN QgsVirtualLayerProvider *classFactory( const QString * uri )
{
return new QgsVirtualLayerProvider( *uri );
}
/** Required key function (used to map the plugin to a data store type)
*/
QGISEXTERN QString providerKey()
{
return VIRTUAL_LAYER_KEY;
}
/**
* Required description function
*/
QGISEXTERN QString description()
{
return VIRTUAL_LAYER_DESCRIPTION;
}
/**
* Required isProvider function. Used to determine if this shared library
* is a data provider plugin
*/
QGISEXTERN bool isProvider()
{
return true;
}
QGISEXTERN void cleanupProvider()
{
}