22#include "qgsgeopackagedataitems.h"
24#include "qgsogrproviderutils.h"
36#include "moc_qgsfilebaseddataitemprovider.cpp"
38using namespace Qt::StringLiterals;
61 if ( mDetails.driverName() ==
"SQLite"_L1 )
63 children.push_back(
new QgsFieldsItem(
this,
path() + u
"/columns/ "_s, QStringLiteral( R
"(dbname="%1")" ).arg( parent()->path().replace( '"', R
"(\")"_L1 ) ), u"spatialite"_s, QString(),
name() ) );
65 else if ( mDetails.providerKey() ==
"ogr"_L1 )
74 QString relationError;
75 QList< QgsWeakRelation > relations;
78 relations = conn->relationships( QString(), mDetails.name() );
82 relationError = ex.
what();
85 if ( !relations.empty() || !relationError.isEmpty() )
87 auto relationsItem = std::make_unique< QgsRelationshipsItem >(
this,
mPath +
"/relations", conn->uri(), u
"ogr"_s, QString(), mDetails.name() );
89 relationsItem->setSortKey( QString( QChar( 0x11FFFF ) ) );
90 children.append( relationsItem.release() );
111 if ( mDetails.providerKey() ==
"ogr"_L1 )
116 parts.insert( u
"path"_s,
path() );
126 switch ( sublayer.
type() )
177 return mDetails.name();
192 mSublayers.append( sublayer );
203 res.reserve( mSublayers.size() );
219 , mExtraUriParts( extraUriParts )
234 QList< QgsProviderSublayerDetails>
sublayers;
237 QSet< QString > providers;
240 providers.insert( details.providerKey() );
243 for (
const QString &provider : std::as_const( providers ) )
247 if ( !mExtraUriParts.empty() )
249 QVariantMap uriParts = metadata->decodeUri(
path() );
250 for (
auto it = mExtraUriParts.constBegin(); it != mExtraUriParts.constEnd(); ++it )
252 uriParts.insert( it.key(), it.value() );
254 const QString updatedUri = metadata->encodeUri( uriParts );
265 else if ( mSublayers.empty() )
281 QMap< QStringList, QgsFileDataCollectionGroupItem * > groupItems;
286 if ( !sublayer.
path().isEmpty() )
288 QStringList currentPath;
289 QStringList remainingPaths = sublayer.
path();
292 while ( !remainingPaths.empty() )
294 currentPath << remainingPaths.takeAt( 0 );
296 auto it = groupItems.constFind( currentPath );
297 if ( it == groupItems.constEnd() )
301 groupItems.insert( currentPath, newGroupItem );
306 groupItem = newGroupItem;
310 groupItem = it.value();
329 mCachedCapabilities = conn->capabilities();
330 mCachedCapabilities2 = conn->capabilities2();
331 mHasCachedCapabilities =
true;
336 QStringList fieldDomains;
339 fieldDomains = conn->fieldDomainNames();
343 domainError = ex.
what();
346 if ( !fieldDomains.empty() || !domainError.isEmpty() )
348 auto domainsItem = std::make_unique< QgsFieldDomainsItem >(
this,
mPath +
"/domains", conn->uri(), u
"ogr"_s );
350 domainsItem->setSortKey( QString( QChar( 0xFFFF ) ) );
351 children.append( domainsItem.release() );
356 QString relationError;
357 QList< QgsWeakRelation > relations;
360 relations = conn->relationships();
364 relationError = ex.
what();
367 if ( !relations.empty() || !relationError.isEmpty() )
369 auto relationsItem = std::make_unique< QgsRelationshipsItem >(
this,
mPath +
"/relations", conn->uri(), u
"ogr"_s );
371 relationsItem->setSortKey( QString( QChar( 0x11FFFF ) ) );
372 children.append( relationsItem.release() );
388 if ( mHasCachedCapabilities )
391 if ( mHasCachedDropSupport )
392 return mCachedSupportsDrop;
397 mHasCachedDropSupport =
true;
398 if ( !QFileInfo(
path() ).isWritable() )
400 mCachedSupportsDrop =
false;
401 return mCachedSupportsDrop;
404 GDALDriverH hDriver = GDALIdentifyDriverEx(
path().toUtf8().constData(), GDAL_OF_VECTOR,
nullptr,
nullptr );
407 mCachedSupportsDrop =
false;
408 return mCachedSupportsDrop;
412 const QString driverName = GDALGetDriverShortName( hDriver );
413 if ( driverName ==
"PDF"_L1 || driverName ==
"DXF"_L1 )
415 mCachedSupportsDrop =
false;
416 return mCachedSupportsDrop;
420#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION( 3, 4, 0 )
421 const bool isSingleTableDriver = !GDALGetMetadataItem( hDriver, GDAL_DCAP_MULTIPLE_VECTOR_LAYERS,
nullptr );
423 const QFileInfo pathInfo(
path() );
424 const QString suffix = pathInfo.suffix().toLower();
428 if ( isSingleTableDriver )
430 mCachedSupportsDrop =
false;
431 return mCachedSupportsDrop;
435 mCachedSupportsDrop =
true;
436 return mCachedSupportsDrop;
443 collectionUri.
layerType = u
"collection"_s;
445 return { collectionUri };
451 if ( OGRGetDriverCount() == 0 )
456 CPLPushErrorHandler( CPLQuietErrorHandler );
458 GDALDriverH hDriver = GDALIdentifyDriverEx(
path().toUtf8().constData(), GDAL_OF_VECTOR,
nullptr,
nullptr );
459 CPLPopErrorHandler();
463 QgsDebugMsgLevel( u
"GDALIdentifyDriverEx error # %1 : %2 on %3"_s.arg( CPLGetLastErrorNo() ).arg( CPLGetLastErrorMsg() ).arg(
path() ), 2 );
467 const QString driverName = GDALGetDriverShortName( hDriver );
468 if ( driverName ==
"PDF"_L1 || driverName ==
"DXF"_L1 )
476 if ( driverName ==
"SQLite"_L1 )
492 parts.insert( u
"path"_s,
path() );
501 mHasCachedCapabilities =
true;
509 if ( mHasCachedCapabilities )
510 return mCachedCapabilities;
515 mCachedCapabilities = conn->capabilities();
516 mCachedCapabilities2 = conn->capabilities2();
517 mHasCachedCapabilities =
true;
519 return mCachedCapabilities;
524 if ( mHasCachedCapabilities )
525 return mCachedCapabilities2;
530 mCachedCapabilities = conn->capabilities();
531 mCachedCapabilities2 = conn->capabilities2();
532 mHasCachedCapabilities =
true;
534 return mCachedCapabilities2;
565 return createDataItemForPathPrivate( path, parentItem, &allowedProviders, queryFlags, extraUriParts );
568QgsDataItem *QgsFileBasedDataItemProvider::createDataItemForPathPrivate(
572 if ( path.isEmpty() )
575 const QFileInfo info( path );
576 QString suffix = info.suffix().toLower();
577 const QString
name = info.fileName();
580 if ( suffix.compare(
"gpkg"_L1, Qt::CaseInsensitive ) == 0 )
583 QgsGeoPackageCollectionItem *item =
new QgsGeoPackageCollectionItem( parentItem,
name, path );
587 else if ( suffix ==
"txt"_L1 )
595 else if ( suffix ==
"map"_L1 || suffix ==
"dat"_L1 )
597 if ( QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".tab" ) ) || QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".TAB" ) ) )
601 else if ( suffix ==
"dbf"_L1 || suffix ==
"shx"_L1 )
603 if ( QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".shp" ) ) || QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".SHP" ) ) )
612 else if ( path.endsWith(
".shp.zip"_L1, Qt::CaseInsensitive ) && GDALIdentifyDriverEx( path.toUtf8().constData(), GDAL_OF_VECTOR,
nullptr,
nullptr ) )
614 suffix = u
"shp.zip"_s;
621 QgsSettings settings;
624 if ( ( settings.
value( u
"qgis/scanItemsInBrowser2"_s,
"extension" ).toString() ==
"extension"_L1 )
625 || ( parentItem && settings.
value( u
"qgis/scanItemsFastScanUris"_s, QStringList() ).toStringList().contains( parentItem->
path() ) ) )
630 QList<QgsProviderSublayerDetails> sublayers;
631 if ( !allowedProviders )
637 for (
const QString &provider : *allowedProviders )
641 if ( !extraUriParts.empty() )
643 QVariantMap uriParts = metadata->decodeUri( path );
644 for (
auto it = extraUriParts.constBegin(); it != extraUriParts.constEnd(); ++it )
646 uriParts.insert( it.key(), it.value() );
649 sublayers.append( metadata->querySublayers( metadata->encodeUri( uriParts ), queryFlags ) );
653 sublayers.append( metadata->querySublayers( path, queryFlags ) );
659 if ( sublayers.size() == 1
662 QgsProviderSublayerItem *item =
new QgsProviderSublayerItem( parentItem,
name, sublayers.at( 0 ), path );
666 else if ( !sublayers.empty() )
668 QgsFileDataCollectionItem *item =
new QgsFileDataCollectionItem( parentItem,
name, path, sublayers, extraUriParts );
680 QFileInfo info( path );
681 QString suffix = info.suffix().toLower();
683 QStringList dirExtensions = QgsOgrProviderUtils::directoryExtensions();
684 return dirExtensions.contains( suffix );
@ Files
Can provides items which corresponds to files.
@ Directories
Can provides items which corresponds to directories.
@ NotPopulated
Children not yet created.
@ Populated
Children created.
@ Fertile
Can create children. Even items without this capability may have children, but cannot create them,...
@ RefreshChildrenWhenItemIsRefreshed
When the item is refreshed, all its populated children will also be refreshed in turn.
@ ItemRepresentsFile
Item's path() directly represents a file on disk.
@ Fast
CreateChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,...
@ Archive
File archive type (e.g. vsizip).
QFlags< DataItemProviderCapability > DataItemProviderCapabilities
Capabilities for data item providers.
@ FastScan
Indicates that the provider must scan for sublayers using the fastest possible approach – e....
@ ResolveGeometryType
Attempt to resolve the geometry type for vector sublayers.
BrowserLayerType
Browser item layer types.
@ Point
Vector point layer.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer.
@ Polygon
Vector polygon layer.
@ Vector
Generic vector layer.
@ VectorTile
Vector tile layer.
@ TableLayer
Vector non-spatial layer.
@ PointCloud
Point cloud layer.
QFlags< SublayerQueryFlag > SublayerQueryFlags
Sublayer query flags.
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
QFlags< DatabaseProviderConnectionCapability2 > DatabaseProviderConnectionCapabilities2
Provides common functionality for database based connections.
Qgis::DatabaseProviderConnectionCapabilities2 capabilities2() const
Returns extended connection capabilities.
@ CreateVectorTable
Can CREATE a vector (or aspatial) table/layer.
@ RetrieveRelationships
Can retrieve relationships from the database.
@ ListFieldDomains
Can return a list of field domain names via fieldDomainNames().
QFlags< Capability > Capabilities
Capabilities capabilities() const
Returns connection capabilities.
QgsDataCollectionItem(QgsDataItem *parent, const QString &name, const QString &path=QString(), const QString &providerKey=QString())
Constructor for QgsDataCollectionItem, with the specified parent item.
Base class for all items in the model.
QVector< QgsDataItem * > children() const
Qgis::BrowserItemCapabilities mCapabilities
QgsDataItem(Qgis::BrowserItemType type, QgsDataItem *parent, const QString &name, const QString &path, const QString &providerKey=QString())
Constructor for QgsDataItem, with the specified parent item.
QString name() const
Returns the name of the item (the displayed text for the item).
virtual void setState(Qgis::BrowserItemState state)
Set item state.
virtual void setCapabilities(Qgis::BrowserItemCapabilities capabilities)
Sets the capabilities for the data item.
virtual void addChildItem(QgsDataItem *child, bool refresh=false)
Inserts a new child item.
QgsDataItem * parent() const
Gets item parent.
QString providerKey() const
Returns the provider key that created this item (e.g.
virtual Qgis::BrowserItemCapabilities capabilities2() const
Returns the capabilities for the data item.
Stores the component parts of a data source URI (e.g.
QString uri(bool expandAuthConfig=true) const
Returns the complete URI as a string.
void setDatabase(const QString &database)
Sets the URI database name.
A browser item which contains a collection of field items.
static QgsDataItem * createLayerItemForPath(const QString &path, QgsDataItem *parentItem, const QStringList &providers, const QVariantMap &extraUriParts, Qgis::SublayerQueryFlags queryFlags)
Static method to create a data item for sublayers corresponding to a file-like path.
Qgis::DataItemProviderCapabilities capabilities() const override
Returns combination of flags from QgsDataProvider::DataCapabilities.
QString name() override
Human-readable name of the provider name.
bool handlesDirectoryPath(const QString &path) override
Returns true if the provider will handle the directory at the specified path.
QgsDataItem * createDataItem(const QString &path, QgsDataItem *parentItem) override
Create a new instance of QgsDataItem (or nullptr) for given path and parent item.
A data collection item for grouping of the content in file based data collections (e....
QgsFileDataCollectionGroupItem(QgsDataItem *parent, const QString &groupName, const QString &path)
Constructor for QgsFileDataCollectionGroupItem.
void appendSublayer(const QgsProviderSublayerDetails &sublayer)
Adds a sublayer to the group.
QgsMimeDataUtils::UriList mimeUris() const override
Returns mime URIs for the data item, most data providers will only return a single URI but some data ...
bool hasDragEnabled() const override
Returns true if the item may be dragged.
bool hasDragEnabled() const override
Returns true if the item may be dragged.
QVector< QgsDataItem * > createChildren() override
Create children.
QgsAbstractDatabaseProviderConnection::Capabilities databaseConnectionCapabilities() const
Returns the associated connection capabilities, if a databaseConnection() is available.
QgsFileDataCollectionItem(QgsDataItem *parent, const QString &name, const QString &path, const QList< QgsProviderSublayerDetails > &sublayers, const QVariantMap &extraUriParts=QVariantMap())
Constructor for QgsFileDataCollectionItem.
QgsMimeDataUtils::UriList mimeUris() const override
Returns mime URIs for the data item, most data providers will only return a single URI but some data ...
QList< QgsProviderSublayerDetails > sublayers() const
Returns the sublayers.
bool canAddVectorLayers() const
Returns true if the file is likely to support addition of vector layers.
QgsAbstractDatabaseProviderConnection * databaseConnection() const override
For data items that represent a DB connection or one of its children, this method returns a connectio...
Qgis::DatabaseProviderConnectionCapabilities2 databaseConnectionCapabilities2() const
Returns extended connection capabilities, if a databaseConnection() is available.
static Qgis::VsiHandlerType vsiHandlerType(const QString &prefix)
Returns the VSI handler type for a given VSI prefix.
static QString vsiPrefixForPath(const QString &path)
Returns a the vsi prefix which corresponds to a file path, or an empty string if the path is not asso...
static QStringList multiLayerFileExtensions()
Returns a list of file extensions which potentially contain multiple layers representing GDAL raster ...
QString uri() const
Returns layer uri or empty string if layer cannot be created.
QgsLayerItem(QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, Qgis::BrowserLayerType layerType, const QString &providerKey)
Constructor for QgsLayerItem.
QList< QgsMimeDataUtils::Uri > UriList
Custom exception class for provider connection related exceptions.
QList< QgsProviderSublayerDetails > querySublayers(const QString &uri, Qgis::SublayerQueryFlags flags=Qgis::SublayerQueryFlags(), QgsFeedback *feedback=nullptr) const
Queries the specified uri and returns a list of any valid sublayers found in the dataset which can be...
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
Contains details about a sub layer available from a dataset.
QStringList path() const
Returns the path to the sublayer.
Qgis::LayerType type() const
Returns the layer type.
Qgis::WkbType wkbType() const
Returns the layer's WKB type, or QgsWkbTypes::Unknown if the WKB type is not application or unknown.
QString uri() const
Returns the layer's URI.
QgsMimeDataUtils::Uri toMimeUri() const
Converts the sublayer details to a QgsMimeDataUtils::Uri representing the sublayer.
QString name() const
Returns the layer's name.
A generic data item for file based layers.
QString layerName() const override
Returns the layer name.
QgsAbstractDatabaseProviderConnection * databaseConnection() const override
For data items that represent a DB connection or one of its children, this method returns a connectio...
QVector< QgsDataItem * > createChildren() override
Create children.
QgsProviderSublayerItem(QgsDataItem *parent, const QString &name, const QgsProviderSublayerDetails &details, const QString &filePath)
Constructor for QgsProviderSublayerItem.
QgsProviderSublayerDetails sublayerDetails() const
Returns the sublayer details for the item.
static bool sublayerDetailsAreIncomplete(const QList< QgsProviderSublayerDetails > &details, QgsProviderUtils::SublayerCompletenessFlags flags=QgsProviderUtils::SublayerCompletenessFlags())
Returns true if the sublayer details are incomplete, and require a more in-depth scan.
@ IgnoreUnknownGeometryType
Indicates that an unknown geometry type should not be considered as incomplete.
@ IgnoreUnknownFeatureCount
Indicates that an unknown feature count should not be considered as incomplete.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
static bool isXmlStyleFile(const QString &path)
Tests if the file at path is a QGIS style XML file.
static Qgis::GeometryType geometryType(Qgis::WkbType type)
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a Polyg...
#define QgsDebugMsgLevel(str, level)
QString filePath
Path to file, if uri is associated with a file.
QString uri
Identifier of the data source recognized by its providerKey.
QString layerType
Type of URI.