22#include "qgsgeopackagedataitems.h"
24#include "qgsogrproviderutils.h"
38#include "moc_qgsfilebaseddataitemprovider.cpp"
40using namespace Qt::StringLiterals;
63 if ( mDetails.driverName() ==
"SQLite"_L1 )
65 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() ) );
67 else if ( mDetails.providerKey() ==
"ogr"_L1 )
76 QString relationError;
77 QList< QgsWeakRelation > relations;
80 relations = conn->relationships( QString(), mDetails.name() );
84 relationError = ex.
what();
87 if ( !relations.empty() || !relationError.isEmpty() )
89 auto relationsItem = std::make_unique< QgsRelationshipsItem >(
this,
mPath +
"/relations", conn->uri(), u
"ogr"_s, QString(), mDetails.name() );
91 relationsItem->setSortKey( QString( QChar( 0x11FFFF ) ) );
92 children.append( relationsItem.release() );
113 if ( mDetails.providerKey() ==
"ogr"_L1 )
118 parts.insert( u
"path"_s,
path() );
128 switch ( sublayer.
type() )
179 return mDetails.name();
194 mSublayers.append( sublayer );
205 res.reserve( mSublayers.size() );
221 , mExtraUriParts( extraUriParts )
236 QList< QgsProviderSublayerDetails>
sublayers;
239 QSet< QString > providers;
242 providers.insert( details.providerKey() );
245 for (
const QString &provider : std::as_const( providers ) )
249 if ( !mExtraUriParts.empty() )
251 QVariantMap uriParts = metadata->decodeUri(
path() );
252 for (
auto it = mExtraUriParts.constBegin(); it != mExtraUriParts.constEnd(); ++it )
254 uriParts.insert( it.key(), it.value() );
256 const QString updatedUri = metadata->encodeUri( uriParts );
267 else if ( mSublayers.empty() )
283 QMap< QStringList, QgsFileDataCollectionGroupItem * > groupItems;
288 if ( !sublayer.
path().isEmpty() )
290 QStringList currentPath;
291 QStringList remainingPaths = sublayer.
path();
294 while ( !remainingPaths.empty() )
296 currentPath << remainingPaths.takeAt( 0 );
298 auto it = groupItems.constFind( currentPath );
299 if ( it == groupItems.constEnd() )
303 groupItems.insert( currentPath, newGroupItem );
308 groupItem = newGroupItem;
312 groupItem = it.value();
331 mCachedCapabilities = conn->capabilities();
332 mCachedCapabilities2 = conn->capabilities2();
333 mHasCachedCapabilities =
true;
338 QStringList fieldDomains;
341 fieldDomains = conn->fieldDomainNames();
345 domainError = ex.
what();
348 if ( !fieldDomains.empty() || !domainError.isEmpty() )
350 auto domainsItem = std::make_unique< QgsFieldDomainsItem >(
this,
mPath +
"/domains", conn->uri(), u
"ogr"_s );
352 domainsItem->setSortKey( QString( QChar( 0xFFFF ) ) );
353 children.append( domainsItem.release() );
358 QString relationError;
359 QList< QgsWeakRelation > relations;
362 relations = conn->relationships();
366 relationError = ex.
what();
369 if ( !relations.empty() || !relationError.isEmpty() )
371 auto relationsItem = std::make_unique< QgsRelationshipsItem >(
this,
mPath +
"/relations", conn->uri(), u
"ogr"_s );
373 relationsItem->setSortKey( QString( QChar( 0x11FFFF ) ) );
374 children.append( relationsItem.release() );
390 if ( mHasCachedCapabilities )
393 if ( mHasCachedDropSupport )
394 return mCachedSupportsDrop;
399 mHasCachedDropSupport =
true;
400 if ( !QFileInfo(
path() ).isWritable() )
402 mCachedSupportsDrop =
false;
403 return mCachedSupportsDrop;
406 GDALDriverH hDriver = GDALIdentifyDriverEx(
path().toUtf8().constData(), GDAL_OF_VECTOR,
nullptr,
nullptr );
409 mCachedSupportsDrop =
false;
410 return mCachedSupportsDrop;
414 const QString driverName = GDALGetDriverShortName( hDriver );
415 if ( driverName ==
"PDF"_L1 || driverName ==
"DXF"_L1 )
417 mCachedSupportsDrop =
false;
418 return mCachedSupportsDrop;
422#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION( 3, 4, 0 )
423 const bool isSingleTableDriver = !GDALGetMetadataItem( hDriver, GDAL_DCAP_MULTIPLE_VECTOR_LAYERS,
nullptr );
425 const QFileInfo pathInfo(
path() );
426 const QString suffix = pathInfo.suffix().toLower();
430 if ( isSingleTableDriver )
432 mCachedSupportsDrop =
false;
433 return mCachedSupportsDrop;
437 mCachedSupportsDrop =
true;
438 return mCachedSupportsDrop;
445 collectionUri.
layerType = u
"collection"_s;
447 return { collectionUri };
453 if ( OGRGetDriverCount() == 0 )
458 CPLPushErrorHandler( CPLQuietErrorHandler );
460 GDALDriverH hDriver = GDALIdentifyDriverEx(
path().toUtf8().constData(), GDAL_OF_VECTOR,
nullptr,
nullptr );
461 CPLPopErrorHandler();
465 QgsDebugMsgLevel( u
"GDALIdentifyDriverEx error # %1 : %2 on %3"_s.arg( CPLGetLastErrorNo() ).arg( CPLGetLastErrorMsg() ).arg(
path() ), 2 );
469 const QString driverName = GDALGetDriverShortName( hDriver );
470 if ( driverName ==
"PDF"_L1 || driverName ==
"DXF"_L1 )
478 if ( driverName ==
"SQLite"_L1 )
494 parts.insert( u
"path"_s,
path() );
503 mHasCachedCapabilities =
true;
511 if ( mHasCachedCapabilities )
512 return mCachedCapabilities;
517 mCachedCapabilities = conn->capabilities();
518 mCachedCapabilities2 = conn->capabilities2();
519 mHasCachedCapabilities =
true;
521 return mCachedCapabilities;
526 if ( mHasCachedCapabilities )
527 return mCachedCapabilities2;
532 mCachedCapabilities = conn->capabilities();
533 mCachedCapabilities2 = conn->capabilities2();
534 mHasCachedCapabilities =
true;
536 return mCachedCapabilities2;
567 return createDataItemForPathPrivate( path, parentItem, &allowedProviders, queryFlags, extraUriParts );
570QgsDataItem *QgsFileBasedDataItemProvider::createDataItemForPathPrivate(
574 if ( path.isEmpty() )
577 const QFileInfo info( path );
578 QString suffix = info.suffix().toLower();
579 const QString
name = info.fileName();
582 if ( suffix.compare(
"gpkg"_L1, Qt::CaseInsensitive ) == 0 )
585 QgsGeoPackageCollectionItem *item =
new QgsGeoPackageCollectionItem( parentItem,
name, path );
589 else if ( suffix ==
"txt"_L1 )
597 else if ( suffix ==
"map"_L1 || suffix ==
"dat"_L1 )
599 if ( QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".tab" ) ) || QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".TAB" ) ) )
603 else if ( suffix ==
"dbf"_L1 || suffix ==
"shx"_L1 )
605 if ( QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".shp" ) ) || QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".SHP" ) ) )
614 else if ( path.endsWith(
".shp.zip"_L1, Qt::CaseInsensitive ) && GDALIdentifyDriverEx( path.toUtf8().constData(), GDAL_OF_VECTOR,
nullptr,
nullptr ) )
616 suffix = u
"shp.zip"_s;
623 QgsSettings settings;
626 if ( ( settings.
value( u
"qgis/scanItemsInBrowser2"_s,
"extension" ).toString() ==
"extension"_L1 )
632 QList<QgsProviderSublayerDetails> sublayers;
633 if ( !allowedProviders )
639 for (
const QString &provider : *allowedProviders )
643 if ( !extraUriParts.empty() )
645 QVariantMap uriParts = metadata->decodeUri( path );
646 for (
auto it = extraUriParts.constBegin(); it != extraUriParts.constEnd(); ++it )
648 uriParts.insert( it.key(), it.value() );
651 sublayers.append( metadata->querySublayers( metadata->encodeUri( uriParts ), queryFlags ) );
655 sublayers.append( metadata->querySublayers( path, queryFlags ) );
661 if ( sublayers.size() == 1
664 QgsProviderSublayerItem *item =
new QgsProviderSublayerItem( parentItem,
name, sublayers.at( 0 ), path );
668 else if ( !sublayers.empty() )
670 QgsFileDataCollectionItem *item =
new QgsFileDataCollectionItem( parentItem,
name, path, sublayers, extraUriParts );
682 QFileInfo info( path );
683 QString suffix = info.suffix().toLower();
685 QStringList dirExtensions = QgsOgrProviderUtils::directoryExtensions();
686 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.
T value(const QString &dynamicKeyPart=QString()) const
Returns settings value.
static const QgsSettingsEntryStringList * settingsScanItemsFastScanUris
Settings entry for fast scan URIs in browser.
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.