-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
qgspostgresconn.cpp
2983 lines (2581 loc) · 99.3 KB
/
qgspostgresconn.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
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
qgspostgresconn.cpp - connection class to PostgreSQL/PostGIS
-------------------
begin : 2011/01/28
copyright : (C) 2011 by Juergen E. Fischer
email : jef at norbit dot de
***************************************************************************/
/***************************************************************************
* *
* 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 "qgspostgresconn.h"
#include "qgslogger.h"
#include "qgsdatasourceuri.h"
#include "qgsmessagelog.h"
#include "qgscredentials.h"
#include "qgsvectordataprovider.h"
#include "qgswkbtypes.h"
#include "qgssettings.h"
#include "qgsjsonutils.h"
#include "qgspostgresstringutils.h"
#include "qgspostgresconnpool.h"
#include "qgsvariantutils.h"
#include "qgsdbquerylog.h"
#include "qgsdbquerylog_p.h"
#include "qgsapplication.h"
#include <QApplication>
#include <QStringList>
#include <QThread>
#include <QFile>
#include <climits>
#include <nlohmann/json.hpp>
// for htonl
#ifdef Q_OS_WIN
#include <winsock.h>
#else
#include <netinet/in.h>
#endif
const int PG_DEFAULT_TIMEOUT = 30;
static QString quotedString( const QString &v )
{
QString result = v;
result.replace( '\'', QLatin1String( "''" ) );
if ( result.contains( '\\' ) )
return result.replace( '\\', QLatin1String( "\\\\" ) ).prepend( "E'" ).append( '\'' );
else
return result.prepend( '\'' ).append( '\'' );
}
QgsPostgresResult::~QgsPostgresResult()
{
if ( mRes )
::PQclear( mRes );
mRes = nullptr;
}
QgsPostgresResult &QgsPostgresResult::operator=( PGresult *result )
{
if ( mRes )
::PQclear( mRes );
mRes = result;
return *this;
}
QgsPostgresResult &QgsPostgresResult::operator=( const QgsPostgresResult &src )
{
if ( mRes )
::PQclear( mRes );
mRes = src.result();
return *this;
}
ExecStatusType QgsPostgresResult::PQresultStatus()
{
return mRes ? ::PQresultStatus( mRes ) : PGRES_FATAL_ERROR;
}
QString QgsPostgresResult::PQresultErrorMessage()
{
return mRes ? QString::fromUtf8( ::PQresultErrorMessage( mRes ) ) : QObject::tr( "no result buffer" );
}
int QgsPostgresResult::PQntuples()
{
Q_ASSERT( mRes );
return ::PQntuples( mRes );
}
QString QgsPostgresResult::PQgetvalue( int row, int col )
{
Q_ASSERT( mRes );
return PQgetisnull( row, col )
? QString()
: QString::fromUtf8( ::PQgetvalue( mRes, row, col ) );
}
bool QgsPostgresResult::PQgetisnull( int row, int col )
{
Q_ASSERT( mRes );
return ::PQgetisnull( mRes, row, col );
}
int QgsPostgresResult::PQnfields()
{
Q_ASSERT( mRes );
return ::PQnfields( mRes );
}
QString QgsPostgresResult::PQfname( int col )
{
Q_ASSERT( mRes );
return QString::fromUtf8( ::PQfname( mRes, col ) );
}
Oid QgsPostgresResult::PQftable( int col )
{
Q_ASSERT( mRes );
return ::PQftable( mRes, col );
}
int QgsPostgresResult::PQftablecol( int col )
{
Q_ASSERT( mRes );
return ::PQftablecol( mRes, col );
}
Oid QgsPostgresResult::PQftype( int col )
{
Q_ASSERT( mRes );
return ::PQftype( mRes, col );
}
int QgsPostgresResult::PQfmod( int col )
{
Q_ASSERT( mRes );
return ::PQfmod( mRes, col );
}
Oid QgsPostgresResult::PQoidValue()
{
Q_ASSERT( mRes );
return ::PQoidValue( mRes );
}
QgsPoolPostgresConn::QgsPoolPostgresConn( const QString &connInfo )
: mPgConn( QgsPostgresConnPool::instance()->acquireConnection( connInfo ) )
{
}
QgsPoolPostgresConn::~QgsPoolPostgresConn()
{
if ( mPgConn )
QgsPostgresConnPool::instance()->releaseConnection( mPgConn );
}
QMap<QString, QgsPostgresConn *> QgsPostgresConn::sConnectionsRO;
QMap<QString, QgsPostgresConn *> QgsPostgresConn::sConnectionsRW;
const int QgsPostgresConn::GEOM_TYPE_SELECT_LIMIT = 100;
QgsPostgresConn *QgsPostgresConn::connectDb( const QString &conninfo, bool readonly, bool shared, bool transaction, bool allowRequestCredentials )
{
QMap<QString, QgsPostgresConn *> &connections =
readonly ? QgsPostgresConn::sConnectionsRO : QgsPostgresConn::sConnectionsRW;
// This is called from may places where shared parameter cannot be forced to false (QgsVectorLayerExporter)
// and which is run in a different thread (drag and drop in browser)
if ( QApplication::instance()->thread() != QThread::currentThread() )
{
// sharing connection between threads is not safe
// See https://github.com/qgis/QGIS/issues/21205
QgsDebugMsgLevel( QStringLiteral( "refusing to use shared connection as we are not the main thread" ), 2 );
shared = false;
}
QgsPostgresConn *conn;
if ( shared )
{
QMap<QString, QgsPostgresConn *>::iterator it = connections.find( conninfo );
if ( it != connections.end() )
{
conn = *it;
QgsDebugMsgLevel(
QStringLiteral(
"Using cached (%3) connection for %1 (%2)"
)
.arg( conninfo )
.arg( reinterpret_cast<std::uintptr_t>( conn ) )
.arg( readonly ? "readonly" : "read-write" )
,
2
);
conn->mRef++;
return conn;
}
QgsDebugMsgLevel(
QStringLiteral(
"Cached (%2) connection for %1 not found"
)
.arg( conninfo )
.arg( readonly ? "readonly" : "read-write" )
,
2
);
}
conn = new QgsPostgresConn( conninfo, readonly, shared, transaction, allowRequestCredentials );
QgsDebugMsgLevel(
QStringLiteral(
"Created new (%4) connection %2 for %1%3"
)
.arg( conninfo )
.arg( reinterpret_cast<std::uintptr_t>( conn ) )
.arg( shared ? " (shared)" : "" )
.arg( readonly ? "readonly" : "read-write" )
,
2
);
// mRef will be set to 0 when the connection fails
if ( conn->mRef == 0 )
{
QgsDebugMsgLevel(
QStringLiteral(
"New (%3) connection %2 failed for conninfo %1"
)
.arg( conninfo )
.arg( reinterpret_cast<std::uintptr_t>( conn ) )
.arg( readonly ? "readonly" : "read-write" )
,
2
);
delete conn;
return nullptr;
}
if ( shared )
{
connections.insert( conninfo, conn );
QgsDebugMsgLevel(
QStringLiteral(
"Added connection %2 (for %1) in (%3) cache"
)
.arg( conninfo )
.arg( reinterpret_cast<std::uintptr_t>( conn ) )
.arg( readonly ? "readonly" : "read-write" )
,
2
);
}
return conn;
}
QgsPostgresConn *QgsPostgresConn::connectDb( const QgsDataSourceUri &uri, bool readonly, bool shared, bool transaction, bool allowRequestCredentials )
{
QgsPostgresConn *conn = QgsPostgresConn::connectDb( uri.connectionInfo( false ), readonly, shared, transaction, allowRequestCredentials );
if ( !conn )
{
return conn;
}
const QString sessionRoleKey = QStringLiteral( "session_role" );
if ( uri.hasParam( sessionRoleKey ) )
{
const QString sessionRole = uri.param( sessionRoleKey );
if ( !sessionRole.isEmpty() )
{
if ( !conn->setSessionRole( sessionRole ) )
{
QgsDebugMsgLevel(
QStringLiteral(
"Set session role failed for ROLE %1"
)
.arg( quotedValue( sessionRole ) )
,
2
);
conn->unref();
return nullptr;
}
}
}
else
{
conn->resetSessionRole();
}
return conn;
}
static void noticeProcessor( void *arg, const char *message )
{
Q_UNUSED( arg )
QString msg( QString::fromUtf8( message ) );
msg.chop( 1 );
QgsMessageLog::logMessage( QObject::tr( "NOTICE: %1" ).arg( msg ), QObject::tr( "PostGIS" ) );
}
QAtomicInt QgsPostgresConn::sNextCursorId = 0;
QgsPostgresConn::QgsPostgresConn( const QString &conninfo, bool readOnly, bool shared, bool transaction, bool allowRequestCredentials )
: mRef( 1 )
, mOpenCursors( 0 )
, mConnInfo( conninfo )
, mUri( conninfo )
, mGeosAvailable( false )
, mProjAvailable( false )
, mTopologyAvailable( false )
, mGotPostgisVersion( false )
, mPostgresqlVersion( 0 )
, mPostgisVersionMajor( 0 )
, mPostgisVersionMinor( 0 )
, mPointcloudAvailable( false )
, mRasterAvailable( false )
, mUseWkbHex( false )
, mReadOnly( readOnly )
, mSwapEndian( false )
, mShared( shared )
, mTransaction( transaction )
{
QgsDebugMsgLevel( QStringLiteral( "New PostgreSQL connection for " ) + conninfo, 2 );
// expand connectionInfo
QString expandedConnectionInfo = mUri.connectionInfo( true );
auto addDefaultTimeoutAndClientEncoding = []( QString & connectString )
{
if ( !connectString.contains( QStringLiteral( "connect_timeout=" ) ) )
{
// add default timeout
QgsSettings settings;
int timeout = settings.value( QStringLiteral( "PostgreSQL/default_timeout" ), PG_DEFAULT_TIMEOUT, QgsSettings::Providers ).toInt();
connectString += QStringLiteral( " connect_timeout=%1" ).arg( timeout );
}
connectString += QLatin1String( " client_encoding='UTF-8'" );
};
addDefaultTimeoutAndClientEncoding( expandedConnectionInfo );
std::unique_ptr<QgsDatabaseQueryLogWrapper> logWrapper = std::make_unique<QgsDatabaseQueryLogWrapper>( QStringLiteral( "libpq::PQconnectdb()" ), expandedConnectionInfo.toUtf8(), QStringLiteral( "postgres" ), QStringLiteral( "QgsPostgresConn" ), QGS_QUERY_LOG_ORIGIN_PG_CON );
mConn = PQconnectdb( expandedConnectionInfo.toUtf8() );
// remove temporary cert/key/CA if they exist
QgsDataSourceUri expandedUri( expandedConnectionInfo );
QStringList parameters;
parameters << QStringLiteral( "sslcert" ) << QStringLiteral( "sslkey" ) << QStringLiteral( "sslrootcert" );
const auto constParameters = parameters;
for ( const QString ¶m : constParameters )
{
if ( expandedUri.hasParam( param ) )
{
QString fileName = expandedUri.param( param );
fileName.remove( QStringLiteral( "'" ) );
QFile file( fileName );
// set minimal permission to allow removing on Win.
// On linux and Mac if file is set with QFile::ReadUser
// does not create problem removing certs
if ( !file.setPermissions( QFile::WriteOwner ) )
{
QString errorMsg = tr( "Cannot set WriteOwner permission to cert: %0 to allow removing it" ).arg( file.fileName() );
PQfinish();
logWrapper->setError( errorMsg );
QgsMessageLog::logMessage( tr( "Client security failure" ) + '\n' + errorMsg, tr( "PostGIS" ) );
mRef = 0;
return;
}
if ( !file.remove() )
{
QString errorMsg = tr( "Cannot remove cert: %0" ).arg( file.fileName() );
PQfinish();
logWrapper->setError( errorMsg );
QgsMessageLog::logMessage( tr( "Client security failure" ) + '\n' + errorMsg, tr( "PostGIS" ) );
mRef = 0;
return;
}
}
}
// check the connection status
if ( PQstatus() != CONNECTION_OK )
{
QString username = mUri.username();
QString password = mUri.password();
QgsCredentials::instance()->lock();
int i = 0;
while ( PQstatus() != CONNECTION_OK && i < 5 )
{
++i;
bool ok = QgsCredentials::instance()->get( conninfo, username, password, PQerrorMessage(), allowRequestCredentials );
if ( !ok )
{
break;
}
const QString errorMsg = PQerrorMessage();
PQfinish();
logWrapper->setError( errorMsg );
if ( !username.isEmpty() )
mUri.setUsername( username );
if ( !password.isEmpty() )
mUri.setPassword( password );
QgsDebugMsgLevel( "Connecting to " + mUri.connectionInfo( false ), 2 );
QString connectString = mUri.connectionInfo();
addDefaultTimeoutAndClientEncoding( connectString );
// use conninfo for log, connectString - can contain clear text username & password
logWrapper = std::make_unique<QgsDatabaseQueryLogWrapper>( QStringLiteral( "libpq::PQconnectdb()" ), conninfo, QStringLiteral( "postgres" ), QStringLiteral( "QgsPostgresConn" ), QGS_QUERY_LOG_ORIGIN_PG_CON );
mConn = PQconnectdb( connectString.toUtf8() );
}
if ( PQstatus() == CONNECTION_OK )
QgsCredentials::instance()->put( conninfo, username, password );
QgsCredentials::instance()->unlock();
}
if ( PQstatus() != CONNECTION_OK )
{
QString errorMsg = PQerrorMessage();
PQfinish();
logWrapper->setError( errorMsg );
QgsMessageLog::logMessage( tr( "Connection to database failed" ) + '\n' + errorMsg, tr( "PostGIS" ) );
mRef = 0;
return;
}
logWrapper = nullptr;
QgsDebugMsgLevel( QStringLiteral( "Connection to the database was successful" ), 2 );
mPostgresqlVersion = PQserverVersion( mConn );
if ( mPostgresqlVersion < 70400 )
{
deduceEndian();
}
else
{
// todo - use std::endian when we require C++20
int testInt = 1;
// mem addr: -->
// testInt(little-endian): 01 0...0 00
// testInt(big-endian): 00 0...0 01
// *char: ^^
mSwapEndian = *( char * )&testInt == 1;
}
/* Check to see if we have working PostGIS support */
if ( !postgisVersion().isNull() )
{
/* Check to see if we have GEOS support and if not, warn the user about
the problems they will see :) */
QgsDebugMsgLevel( QStringLiteral( "Checking for GEOS support" ), 3 );
if ( !hasGEOS() )
{
QgsMessageLog::logMessage( tr( "Your PostGIS installation has no GEOS support. Feature selection and identification will not work properly. Please install PostGIS with GEOS support (http://geos.refractions.net)" ), tr( "PostGIS" ) );
}
else
{
QgsDebugMsgLevel( QStringLiteral( "GEOS support available!" ), 3 );
}
}
if ( mPostgresqlVersion >= 90000 )
{
// Quoting floating point values, application name for PostgreSQL connection, etc in 1 request
QString sql;
sql += QLatin1String( "SET extra_float_digits=3;" );
sql += QStringLiteral( "SET application_name=%1;" ).arg( quotedValue( QgsApplication::applicationFullName() ) );
sql += QLatin1String( "SET datestyle='ISO';" );
// Set the PostgreSQL message level so that we don't get the
// 'there is no transaction in progress' warning.
#ifndef QGISDEBUG
sql += QLatin1String( "SET client_min_messages to error;" );
#endif
LoggedPQexecNR( "QgsPostgresConn", sql );
}
PQsetNoticeProcessor( mConn, noticeProcessor, nullptr );
}
QgsPostgresConn::~QgsPostgresConn()
{
Q_ASSERT( mRef == 0 );
if ( mConn )
::PQfinish( mConn );
mConn = nullptr;
}
void QgsPostgresConn::ref()
{
QMutexLocker locker( &mLock );
++mRef;
}
void QgsPostgresConn::unref()
{
QMutexLocker locker( &mLock );
if ( --mRef > 0 )
return;
if ( mShared )
{
QMap<QString, QgsPostgresConn *> &connections = mReadOnly ? sConnectionsRO : sConnectionsRW;
int removed = connections.remove( mConnInfo );
Q_ASSERT( removed == 1 );
QgsDebugMsgLevel(
QStringLiteral(
"Cached (%1) connection for %2 (%3) removed"
)
.arg( mReadOnly ? "readonly" : "read-write" )
.arg( mConnInfo )
.arg( reinterpret_cast<std::uintptr_t>( this ) )
,
2
);
}
// to avoid destroying locked mutex
locker.unlock();
delete this;
}
/* private */
QStringList QgsPostgresConn::supportedSpatialTypes() const
{
QStringList supportedSpatialTypes;
supportedSpatialTypes << quotedValue( "geometry" )
<< quotedValue( "geography" );
if ( hasPointcloud() )
{
supportedSpatialTypes << quotedValue( "pcpatch" );
supportedSpatialTypes << quotedValue( "pcpoint" );
}
if ( hasRaster() )
supportedSpatialTypes << quotedValue( "raster" );
if ( hasTopology() )
supportedSpatialTypes << quotedValue( "topogeometry" );
return supportedSpatialTypes;
}
/* private */
// TODO: deprecate this function
void QgsPostgresConn::addColumnInfo( QgsPostgresLayerProperty &layerProperty, const QString &schemaName, const QString &viewName, bool fetchPkCandidates )
{
// TODO: optimize this query when pk candidates aren't needed
// could use array_agg() and count()
// array output would look like this: "{One,tWo}"
QString sql = QStringLiteral( "SELECT attname, CASE WHEN typname in (%1) THEN 1 ELSE null END AS isSpatial FROM pg_attribute JOIN pg_type ON atttypid=pg_type.oid WHERE attrelid=regclass('%2.%3') AND NOT attisdropped AND attnum>0 ORDER BY attnum" )
.arg( supportedSpatialTypes().join( ',' ) )
.arg( quotedIdentifier( schemaName ),
quotedIdentifier( viewName ) );
QgsDebugMsgLevel( "getting column info: " + sql, 2 );
QgsPostgresResult colRes( LoggedPQexec( "QgsPostgresConn", sql ) );
layerProperty.pkCols.clear();
layerProperty.nSpCols = 0;
if ( colRes.PQresultStatus() == PGRES_TUPLES_OK )
{
for ( int i = 0; i < colRes.PQntuples(); i++ )
{
if ( fetchPkCandidates )
{
layerProperty.pkCols << colRes.PQgetvalue( i, 0 );
}
if ( colRes.PQgetisnull( i, 1 ) == 0 )
{
++layerProperty.nSpCols;
}
}
}
else
{
QgsMessageLog::logMessage( tr( "SQL: %1\nresult: %2\nerror: %3\n" ).arg( sql ).arg( colRes.PQresultStatus() ).arg( colRes.PQresultErrorMessage() ), tr( "PostGIS" ) );
}
}
bool QgsPostgresConn::getTableInfo( bool searchGeometryColumnsOnly, bool searchPublicOnly, bool allowGeometrylessTables, const QString &schema, const QString &name )
{
QMutexLocker locker( &mLock );
int nColumns = 0;
int foundInTables = 0;
QgsPostgresResult result;
QString query;
for ( int i = SctGeometry; i <= SctRaster; ++i )
{
QString sql, tableName, schemaName, columnName, typeName, sridName, gtableName, dimName;
if ( i == SctGeometry )
{
tableName = QStringLiteral( "l.f_table_name" );
schemaName = QStringLiteral( "l.f_table_schema" );
columnName = QStringLiteral( "l.f_geometry_column" );
typeName = QStringLiteral( "upper(l.type)" );
sridName = QStringLiteral( "l.srid" );
dimName = QStringLiteral( "l.coord_dimension" );
gtableName = QStringLiteral( "geometry_columns" );
}
// Geography since postgis 1.5
else if ( i == SctGeography
&& ( mPostgisVersionMajor >= 2
|| ( mPostgisVersionMajor == 1 && mPostgisVersionMinor >= 5 ) ) )
{
tableName = QStringLiteral( "l.f_table_name" );
schemaName = QStringLiteral( "l.f_table_schema" );
columnName = QStringLiteral( "l.f_geography_column" );
typeName = QStringLiteral( "upper(l.type)" );
sridName = QStringLiteral( "l.srid" );
dimName = QStringLiteral( "2" );
gtableName = QStringLiteral( "geography_columns" );
}
else if ( i == SctTopoGeometry )
{
if ( !hasTopology() )
continue;
schemaName = QStringLiteral( "l.schema_name" );
tableName = QStringLiteral( "l.table_name" );
columnName = QStringLiteral( "l.feature_column" );
typeName = "CASE "
"WHEN l.feature_type = 1 THEN 'MULTIPOINT' "
"WHEN l.feature_type = 2 THEN 'MULTILINESTRING' "
"WHEN l.feature_type = 3 THEN 'MULTIPOLYGON' "
"WHEN l.feature_type = 4 THEN 'GEOMETRYCOLLECTION' "
"END AS type";
sridName = QStringLiteral( "(SELECT srid FROM topology.topology t WHERE l.topology_id=t.id)" );
dimName = QStringLiteral( "2" );
gtableName = QStringLiteral( "topology.layer" );
}
else if ( i == SctPcPatch )
{
if ( !hasPointcloud() )
continue;
tableName = QStringLiteral( "l.\"table\"" );
schemaName = QStringLiteral( "l.\"schema\"" );
columnName = QStringLiteral( "l.\"column\"" );
typeName = QStringLiteral( "'POLYGON'" );
sridName = QStringLiteral( "l.srid" );
dimName = QStringLiteral( "2" );
gtableName = QStringLiteral( "pointcloud_columns" );
}
else if ( i == SctRaster )
{
if ( !hasRaster() )
continue;
tableName = QStringLiteral( "l.\"r_table_name\"" );
schemaName = QStringLiteral( "l.\"r_table_schema\"" );
columnName = QStringLiteral( "l.\"r_raster_column\"" );
typeName = QStringLiteral( "'RASTER'" );
sridName = QStringLiteral( "l.srid" );
dimName = QStringLiteral( "2" );
gtableName = QStringLiteral( "raster_columns" );
}
else
{
QgsMessageLog::logMessage( tr( "Unsupported spatial column type %1" )
.arg( displayStringForGeomType( ( QgsPostgresGeometryColumnType )i ) ) );
continue;
}
// The following query returns only tables that exist and the user has SELECT privilege on.
// Can't use regclass here because table must exist, else error occurs.
sql = QString( "SELECT %1,%2,%3,%4,%5,%6,c.relkind,obj_description(c.oid),"
"%10, "
"count(CASE WHEN t.typname IN (%9) THEN 1 ELSE NULL END) "
", %8 "
" FROM %7 l,pg_class c,pg_namespace n,pg_attribute a,pg_type t"
" WHERE c.relname=%1"
" AND %2=n.nspname"
" AND NOT a.attisdropped"
" AND a.attrelid=c.oid"
" AND a.atttypid=t.oid"
" AND a.attnum>0"
" AND n.oid=c.relnamespace"
" AND has_schema_privilege(n.nspname,'usage')"
" AND has_table_privilege(c.oid,'select')" // user has select privilege
)
.arg( tableName, schemaName, columnName, typeName, sridName, dimName, gtableName )
.arg( i )
.arg( supportedSpatialTypes().join( ',' ) )
.arg( mPostgresqlVersion >= 90000 ? "array_agg(a.attname ORDER BY a.attnum)" : "(SELECT array_agg(attname) FROM (SELECT unnest(array_agg(a.attname)) AS attname ORDER BY unnest(array_agg(a.attnum))) AS attname)" )
;
if ( searchPublicOnly )
sql += QLatin1String( " AND n.nspname='public'" );
if ( !schema.isEmpty() )
sql += QStringLiteral( " AND %1=%2" ).arg( schemaName, quotedString( schema ) );
if ( !name.isEmpty() )
sql += QStringLiteral( " AND %1=%2" ).arg( tableName, quotedString( name ) );
sql += QString( " GROUP BY 1,2,3,4,5,6,7,c.oid,11" );
foundInTables |= 1 << i;
if ( ! query.isEmpty() )
query += " UNION ";
query += sql;
}
query += QLatin1String( " ORDER BY 2,1,3" );
QgsDebugMsgLevel( "getting table info from layer registries: " + query, 2 );
result = LoggedPQexec( "QgsPostgresConn", query );
// NOTE: we intentionally continue if the query fails
// (for example because PostGIS is not installed)
if ( ! result.result() )
{
return false;
}
for ( int idx = 0; idx < result.PQntuples(); idx++ )
{
QString tableName = result.PQgetvalue( idx, 0 );
QString schemaName = result.PQgetvalue( idx, 1 );
QString column = result.PQgetvalue( idx, 2 );
QString type = result.PQgetvalue( idx, 3 );
QString ssrid = result.PQgetvalue( idx, 4 );
int dim = result.PQgetvalue( idx, 5 ).toInt();
QString relkind = result.PQgetvalue( idx, 6 );
bool isRaster = type == QLatin1String( "RASTER" );
QString comment = result.PQgetvalue( idx, 7 );
QString attributes = result.PQgetvalue( idx, 8 );
int nSpCols = result.PQgetvalue( idx, 9 ).toInt();
QgsPostgresGeometryColumnType columnType = SctNone;
int columnTypeInt = result.PQgetvalue( idx, 10 ).toInt();
if ( columnTypeInt == SctGeometry )
columnType = SctGeometry;
else if ( columnTypeInt == SctGeography )
columnType = SctGeography;
else if ( columnTypeInt == SctTopoGeometry )
columnType = SctTopoGeometry;
else if ( columnTypeInt == SctPcPatch )
columnType = SctPcPatch;
else if ( columnTypeInt == SctRaster )
columnType = SctRaster;
else
{
QgsDebugError( QStringLiteral( "Unhandled columnType index %1" )
. arg( columnTypeInt ) );
}
int srid = ssrid.isEmpty() ? std::numeric_limits<int>::min() : ssrid.toInt();
if ( ! isRaster && majorVersion() >= 2 && srid == 0 )
{
// 0 doesn't constraint => detect
srid = std::numeric_limits<int>::min();
}
#if 0
QgsDebugMsgLevel( QStringLiteral( "%1 : %2.%3.%4: %5 %6 %7 %8" )
.arg( gtableName )
.arg( schemaName ).arg( tableName ).arg( column )
.arg( type )
.arg( srid )
.arg( relkind )
.arg( dim ), 2 );
#endif
QgsPostgresLayerProperty layerProperty;
layerProperty.schemaName = schemaName;
layerProperty.tableName = tableName;
layerProperty.geometryColName = column;
layerProperty.geometryColType = columnType;
if ( dim == 3 && !type.endsWith( 'M' ) )
type += QLatin1Char( 'Z' );
else if ( dim == 4 )
type += QLatin1String( "ZM" );
layerProperty.types = QList<Qgis::WkbType>() << ( QgsPostgresConn::wkbTypeFromPostgis( type ) );
layerProperty.srids = QList<int>() << srid;
layerProperty.sql.clear();
layerProperty.relKind = relKindFromValue( relkind );
layerProperty.isRaster = isRaster;
layerProperty.tableComment = comment;
layerProperty.nSpCols = nSpCols;
if ( ( layerProperty.relKind == Qgis::PostgresRelKind::View )
|| ( layerProperty.relKind == Qgis::PostgresRelKind::MaterializedView )
|| ( layerProperty.relKind == Qgis::PostgresRelKind::ForeignTable ) )
{
// TODO: use std::transform
for ( const auto &a : QgsPostgresStringUtils::parseArray( attributes ) )
{
layerProperty.pkCols << a.toString();
}
}
if ( ( layerProperty.relKind == Qgis::PostgresRelKind::View
|| layerProperty.relKind == Qgis::PostgresRelKind::MaterializedView ) && layerProperty.pkCols.empty() )
{
//QgsDebugMsgLevel( QStringLiteral( "no key columns found." ), 2 );
continue;
}
mLayersSupported << layerProperty;
nColumns++;
}
//search for geometry columns in tables that are not in the geometry_columns metatable
if ( !searchGeometryColumnsOnly )
{
// Now have a look for spatial columns that aren't in the geometry_columns table.
QString sql = QStringLiteral( "SELECT"
" c.relname"
",n.nspname"
",a.attname"
",c.relkind"
",CASE WHEN t.typname IN (%1) THEN t.typname ELSE b.typname END AS coltype"
",obj_description(c.oid)"
" FROM pg_attribute a"
" JOIN pg_class c ON c.oid=a.attrelid"
" JOIN pg_namespace n ON n.oid=c.relnamespace"
" JOIN pg_type t ON t.oid=a.atttypid"
" LEFT JOIN pg_type b ON b.oid=t.typbasetype"
" WHERE c.relkind IN ('v','r','m','p','f')"
" AND has_schema_privilege( n.nspname, 'usage' )"
" AND has_table_privilege( c.oid, 'select' )"
" AND (t.typname IN (%1) OR b.typname IN (%1))" )
.arg( supportedSpatialTypes().join( ',' ) );
// user has select privilege
if ( searchPublicOnly )
sql += QLatin1String( " AND n.nspname='public'" );
if ( !schema.isEmpty() )
sql += QStringLiteral( " AND n.nspname=%1" ).arg( quotedString( schema ) );
if ( !name.isEmpty() )
sql += QStringLiteral( " AND c.relname=%1" ).arg( quotedString( name ) );
// skip columns of which we already derived information from the metadata tables
if ( nColumns > 0 )
{
if ( foundInTables & ( 1 << SctGeometry ) )
{
sql += QLatin1String( " AND NOT EXISTS (SELECT 1 FROM geometry_columns WHERE n.nspname=f_table_schema AND c.relname=f_table_name AND a.attname=f_geometry_column)" );
}
if ( foundInTables & ( 1 << SctGeography ) )
{
sql += QLatin1String( " AND NOT EXISTS (SELECT 1 FROM geography_columns WHERE n.nspname=f_table_schema AND c.relname=f_table_name AND a.attname=f_geography_column)" );
}
if ( foundInTables & ( 1 << SctPcPatch ) )
{
sql += QLatin1String( " AND NOT EXISTS (SELECT 1 FROM pointcloud_columns WHERE n.nspname=\"schema\" AND c.relname=\"table\" AND a.attname=\"column\")" );
}
if ( foundInTables & ( 1 << SctRaster ) )
{
sql += QLatin1String( " AND NOT EXISTS (SELECT 1 FROM raster_columns WHERE n.nspname=\"r_table_schema\" AND c.relname=\"r_table_name\" AND a.attname=\"r_raster_column\")" );
}
if ( foundInTables & ( 1 << SctTopoGeometry ) )
{
sql += QLatin1String( " AND NOT EXISTS (SELECT 1 FROM topology.layer WHERE n.nspname=\"schema_name\" AND c.relname=\"table_name\" AND a.attname=\"feature_column\")" );
}
}
QgsDebugMsgLevel( "getting spatial table info from pg_catalog: " + sql, 2 );
result = LoggedPQexec( QStringLiteral( "QgsPostgresConn" ), sql );
if ( result.PQresultStatus() != PGRES_TUPLES_OK )
{
QgsMessageLog::logMessage( tr( "Database connection was successful, but the accessible tables could not be determined. The error message from the database was:\n%1\n" )
.arg( result.PQresultErrorMessage() ),
tr( "PostGIS" ) );
LoggedPQexecNR( "QgsPostgresConn", QStringLiteral( "COMMIT" ) );
return false;
}
for ( int i = 0; i < result.PQntuples(); i++ )
{
// Have the column name, schema name and the table name. The concept of a
// catalog doesn't exist in PostgreSQL so we ignore that, but we
// do need to get the geometry type.
QString tableName = result.PQgetvalue( i, 0 ); // relname
QString schemaName = result.PQgetvalue( i, 1 ); // nspname
QString column = result.PQgetvalue( i, 2 ); // attname
QString relkind = result.PQgetvalue( i, 3 ); // relation kind
QString coltype = result.PQgetvalue( i, 4 ); // column type
QString comment = result.PQgetvalue( i, 5 ); // table comment
QgsPostgresLayerProperty layerProperty;
layerProperty.types = QList<Qgis::WkbType>() << Qgis::WkbType::Unknown;
layerProperty.srids = QList<int>() << std::numeric_limits<int>::min();
layerProperty.schemaName = schemaName;
layerProperty.tableName = tableName;
layerProperty.geometryColName = column;
layerProperty.relKind = relKindFromValue( relkind );
layerProperty.isRaster = coltype == QLatin1String( "raster" );
layerProperty.tableComment = comment;
if ( coltype == QLatin1String( "geometry" ) )
{
layerProperty.geometryColType = SctGeometry;
}
else if ( coltype == QLatin1String( "geography" ) )
{
layerProperty.geometryColType = SctGeography;
}
else if ( coltype == QLatin1String( "topogeometry" ) )
{
layerProperty.geometryColType = SctTopoGeometry;
}
else if ( coltype == QLatin1String( "pcpatch" ) ||
coltype == QLatin1String( "pcpoint" ) )
{
layerProperty.geometryColType = SctPcPatch;
}
else if ( coltype == QLatin1String( "raster" ) )
{
layerProperty.geometryColType = SctRaster;
}
else
{
Q_ASSERT( !"Unknown geometry type" );
}
// TODO: use knowledge from already executed query to count
// spatial fields and list attribute names...
addColumnInfo( layerProperty, schemaName, tableName,
layerProperty.relKind == Qgis::PostgresRelKind::View
|| layerProperty.relKind == Qgis::PostgresRelKind::MaterializedView
|| layerProperty.relKind == Qgis::PostgresRelKind::ForeignTable );
if ( ( layerProperty.relKind == Qgis::PostgresRelKind::View
|| layerProperty.relKind == Qgis::PostgresRelKind::MaterializedView ) && layerProperty.pkCols.empty() )
{
//QgsDebugMsgLevel( QStringLiteral( "no key columns found." ), 2 );
continue;
}
mLayersSupported << layerProperty;
nColumns++;
}
}
if ( allowGeometrylessTables )
{
QString sql = QStringLiteral( "SELECT "
"pg_class.relname"
",pg_namespace.nspname"
",pg_class.relkind"
",obj_description(pg_class.oid)"
",%1"
" FROM "
" pg_class"
",pg_namespace"
",pg_attribute a"
" WHERE pg_namespace.oid=pg_class.relnamespace"
" AND has_schema_privilege(pg_namespace.nspname,'usage')"
" AND has_table_privilege(pg_class.oid,'select')"
" AND pg_class.relkind IN ('v','r','m','p','f')"
" AND pg_class.oid = a.attrelid"
" AND NOT a.attisdropped"
" AND a.attnum > 0" )
.arg( mPostgresqlVersion >= 90000 ? "array_agg(a.attname ORDER BY a.attnum)" : "(SELECT array_agg(attname) FROM (SELECT unnest(array_agg(a.attname)) AS attname ORDER BY unnest(array_agg(a.attnum))) AS attname)" );