Provide a public API for invalidating connections.

m-kuhn · m-kuhn · commit aeeca48ac92d · 2015-08-29T20:50:58.000+02:00
QgsVectorDataProvider::forceReload() is the virtual method. It is implemented in the OGR provider. See here for reference: http://gis.stackexchange.com/questions/159950/make-a-qgis-layer-update-from-a-changed-data-source
diff --git a/python/core/qgsvectordataprovider.sip b/python/core/qgsvectordataprovider.sip
@@ -320,6 +320,8 @@ class QgsVectorDataProvider : QgsDataProvider
      */
     virtual QgsTransaction* transaction() const;
 
+    virtual void forceReload();
+
   protected:
     void clearMinMaxCache();
     void fillMinMaxCache();
diff --git a/src/core/qgsvectordataprovider.h b/src/core/qgsvectordataprovider.h
@@ -371,6 +371,15 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider
      */
     virtual QgsTransaction* transaction() const { return 0; }
 
+    /**
+     * Forces a reload of the underlying datasource if the provider implements this
+     * method.
+     * In particular on the OGR provider, a pooled connection will be invalidated.
+     * This forces QGIS to reopen a file or connection.
+     * This can be required if the underlying file is replaced.
+     */
+    virtual void forceReload() {}
+
   protected:
     void clearMinMaxCache();
     void fillMinMaxCache();
diff --git a/src/providers/ogr/qgsogrprovider.cpp b/src/providers/ogr/qgsogrprovider.cpp
@@ -2439,6 +2439,11 @@ QByteArray QgsOgrProvider::quotedIdentifier( QByteArray field )
   return QgsOgrUtils::quotedIdentifier( field, ogrDriverName );
 }
 
+void QgsOgrProvider::forceReload()
+{
+  QgsOgrConnPool::instance()->invalidateConnections( filePath() );
+}
+
 QByteArray QgsOgrUtils::quotedIdentifier( QByteArray field, const QString& ogrDriverName )
 {
   if ( ogrDriverName == "MySQL" )
diff --git a/src/providers/ogr/qgsogrprovider.h b/src/providers/ogr/qgsogrprovider.h
@@ -263,6 +263,13 @@ class QgsOgrProvider : public QgsVectorDataProvider
 
     QByteArray quotedIdentifier( QByteArray field );
 
+    /**
+     * A forced reload invalidates the underlying connection.
+     * E.g. in case a shapefile is replaced, the old file will be closed
+     * and the new file will be opened.
+     */
+    void forceReload();
+
   protected:
     /** Loads fields from input file to member attributeFields */
     void loadFields();

Original file line number	Diff line number	Diff line change
`@@ -2439,6 +2439,11 @@ QByteArray QgsOgrProvider::quotedIdentifier( QByteArray field )`
`2439`	`2439`	`return QgsOgrUtils::quotedIdentifier( field, ogrDriverName );`
`2440`	`2440`	`}`
`2441`	`2441`
	`2442`	`+void QgsOgrProvider::forceReload()`
	`2443`	`+{`
	`2444`	`+ QgsOgrConnPool::instance()->invalidateConnections( filePath() );`
	`2445`	`+}`
	`2446`	`+`
`2442`	`2447`	`QByteArray QgsOgrUtils::quotedIdentifier( QByteArray field, const QString& ogrDriverName )`
`2443`	`2448`	`{`
`2444`	`2449`	`if ( ogrDriverName == "MySQL" )`