22#include "qgsgeopackagedataitems.h"
24#include "qgsogrproviderutils.h"
38#include "moc_qgsfilebaseddataitemprovider.cpp"
40using namespace Qt::StringLiterals;
43 =
new QgsSettingsEntryString( u
"scan-items"_s,
QgsSettingsTree::sTreeBrowser, u
"extension"_s, u
"Strategy used to scan file-based items in the browser. Set to \"extension\" to identify items by their file extension only, or \"contents\" to open each file and probe its actual contents (slower but more accurate)."_s );
66 if ( mDetails.driverName() ==
"SQLite"_L1 )
68 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() ) );
70 else if ( mDetails.providerKey() ==
"ogr"_L1 )
79 QString relationError;
80 QList< QgsWeakRelation > relations;
83 relations = conn->relationships( QString(), mDetails.name() );
87 relationError = ex.
what();
90 if ( !relations.empty() || !relationError.isEmpty() )
92 auto relationsItem = std::make_unique< QgsRelationshipsItem >(
this,
mPath +
"/relations", conn->uri(), u
"ogr"_s, QString(), mDetails.name() );
94 relationsItem->setSortKey( QString( QChar( 0x11FFFF ) ) );
95 children.append( relationsItem.release() );
116 if ( mDetails.providerKey() ==
"ogr"_L1 )
121 parts.insert( u
"path"_s,
path() );
131 switch ( sublayer.
type() )
182 return mDetails.name();
197 mSublayers.append( sublayer );
208 res.reserve( mSublayers.size() );
224 , mExtraUriParts( extraUriParts )
239 QList< QgsProviderSublayerDetails>
sublayers;
242 QSet< QString > providers;
245 providers.insert( details.providerKey() );
248 for (
const QString &provider : std::as_const( providers ) )
252 if ( !mExtraUriParts.empty() )
254 QVariantMap uriParts = metadata->decodeUri(
path() );
255 for (
auto it = mExtraUriParts.constBegin(); it != mExtraUriParts.constEnd(); ++it )
257 uriParts.insert( it.key(), it.value() );
259 const QString updatedUri = metadata->encodeUri( uriParts );
270 else if ( mSublayers.empty() )
286 QMap< QStringList, QgsFileDataCollectionGroupItem * > groupItems;
291 if ( !sublayer.
path().isEmpty() )
293 QStringList currentPath;
294 QStringList remainingPaths = sublayer.
path();
297 while ( !remainingPaths.empty() )
299 currentPath << remainingPaths.takeAt( 0 );
301 auto it = groupItems.constFind( currentPath );
302 if ( it == groupItems.constEnd() )
306 groupItems.insert( currentPath, newGroupItem );
311 groupItem = newGroupItem;
315 groupItem = it.value();
334 mCachedCapabilities = conn->capabilities();
335 mCachedCapabilities2 = conn->capabilities2();
336 mHasCachedCapabilities =
true;
341 QStringList fieldDomains;
344 fieldDomains = conn->fieldDomainNames();
348 domainError = ex.
what();
351 if ( !fieldDomains.empty() || !domainError.isEmpty() )
353 auto domainsItem = std::make_unique< QgsFieldDomainsItem >(
this,
mPath +
"/domains", conn->uri(), u
"ogr"_s );
355 domainsItem->setSortKey( QString( QChar( 0xFFFF ) ) );
356 children.append( domainsItem.release() );
361 QString relationError;
362 QList< QgsWeakRelation > relations;
365 relations = conn->relationships();
369 relationError = ex.
what();
372 if ( !relations.empty() || !relationError.isEmpty() )
374 auto relationsItem = std::make_unique< QgsRelationshipsItem >(
this,
mPath +
"/relations", conn->uri(), u
"ogr"_s );
376 relationsItem->setSortKey( QString( QChar( 0x11FFFF ) ) );
377 children.append( relationsItem.release() );
393 if ( mHasCachedCapabilities )
396 if ( mHasCachedDropSupport )
397 return mCachedSupportsDrop;
402 mHasCachedDropSupport =
true;
403 if ( !QFileInfo(
path() ).isWritable() )
405 mCachedSupportsDrop =
false;
406 return mCachedSupportsDrop;
409 GDALDriverH hDriver = GDALIdentifyDriverEx(
path().toUtf8().constData(), GDAL_OF_VECTOR,
nullptr,
nullptr );
412 mCachedSupportsDrop =
false;
413 return mCachedSupportsDrop;
417 const QString driverName = GDALGetDriverShortName( hDriver );
418 if ( driverName ==
"PDF"_L1 || driverName ==
"DXF"_L1 )
420 mCachedSupportsDrop =
false;
421 return mCachedSupportsDrop;
425#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION( 3, 4, 0 )
426 const bool isSingleTableDriver = !GDALGetMetadataItem( hDriver, GDAL_DCAP_MULTIPLE_VECTOR_LAYERS,
nullptr );
428 const QFileInfo pathInfo(
path() );
429 const QString suffix = pathInfo.suffix().toLower();
433 if ( isSingleTableDriver )
435 mCachedSupportsDrop =
false;
436 return mCachedSupportsDrop;
440 mCachedSupportsDrop =
true;
441 return mCachedSupportsDrop;
448 collectionUri.
layerType = u
"collection"_s;
450 return { collectionUri };
456 if ( OGRGetDriverCount() == 0 )
461 CPLPushErrorHandler( CPLQuietErrorHandler );
463 GDALDriverH hDriver = GDALIdentifyDriverEx(
path().toUtf8().constData(), GDAL_OF_VECTOR,
nullptr,
nullptr );
464 CPLPopErrorHandler();
468 QgsDebugMsgLevel( u
"GDALIdentifyDriverEx error # %1 : %2 on %3"_s.arg( CPLGetLastErrorNo() ).arg( CPLGetLastErrorMsg() ).arg(
path() ), 2 );
472 const QString driverName = GDALGetDriverShortName( hDriver );
473 if ( driverName ==
"PDF"_L1 || driverName ==
"DXF"_L1 )
481 if ( driverName ==
"SQLite"_L1 )
497 parts.insert( u
"path"_s,
path() );
506 mHasCachedCapabilities =
true;
514 if ( mHasCachedCapabilities )
515 return mCachedCapabilities;
520 mCachedCapabilities = conn->capabilities();
521 mCachedCapabilities2 = conn->capabilities2();
522 mHasCachedCapabilities =
true;
524 return mCachedCapabilities;
529 if ( mHasCachedCapabilities )
530 return mCachedCapabilities2;
535 mCachedCapabilities = conn->capabilities();
536 mCachedCapabilities2 = conn->capabilities2();
537 mHasCachedCapabilities =
true;
539 return mCachedCapabilities2;
570 return createDataItemForPathPrivate( path, parentItem, &allowedProviders, queryFlags, extraUriParts );
573QgsDataItem *QgsFileBasedDataItemProvider::createDataItemForPathPrivate(
577 if ( path.isEmpty() )
580 const QFileInfo info( path );
581 QString suffix = info.suffix().toLower();
582 const QString
name = info.fileName();
585 if ( suffix.compare(
"gpkg"_L1, Qt::CaseInsensitive ) == 0 )
588 QgsGeoPackageCollectionItem *item =
new QgsGeoPackageCollectionItem( parentItem,
name, path );
592 else if ( suffix ==
"txt"_L1 )
600 else if ( suffix ==
"map"_L1 || suffix ==
"dat"_L1 )
602 if ( QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".tab" ) ) || QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".TAB" ) ) )
606 else if ( suffix ==
"dbf"_L1 || suffix ==
"shx"_L1 )
608 if ( QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".shp" ) ) || QFile::exists( QDir( info.path() ).filePath( info.baseName() +
".SHP" ) ) )
617 else if ( path.endsWith(
".shp.zip"_L1, Qt::CaseInsensitive ) && GDALIdentifyDriverEx( path.toUtf8().constData(), GDAL_OF_VECTOR,
nullptr,
nullptr ) )
619 suffix = u
"shp.zip"_s;
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.
static const QgsSettingsEntryString * settingsScanItemsInBrowser
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.
static QgsSettingsTreeNode * sTreeBrowser
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.