Correctly resolve paths for raster image fill symbol layers

nyalldawson · nyalldawson · commit da4d93775826 · 2018-01-29T20:51:36.000+11:00
diff --git a/python/core/symbology/qgsfillsymbollayer.sip.in b/python/core/symbology/qgsfillsymbollayer.sip.in
@@ -760,6 +760,14 @@ class QgsRasterFillSymbolLayer: QgsImageFillSymbolLayer
 
     static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
 
+    static void resolvePaths( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving );
+%Docstring
+Turns relative paths in properties map to absolute when reading and vice versa when writing.
+Used internally when reading/writing symbols.
+
+.. versionadded:: 3.0
+%End
+
     virtual QString layerType() const;
 
     virtual void renderPolygon( const QPolygonF &points, QList<QPolygonF> *rings, QgsSymbolRenderContext &context );
diff --git a/src/core/symbology/qgsfillsymbollayer.cpp b/src/core/symbology/qgsfillsymbollayer.cpp
@@ -3622,6 +3622,18 @@ QgsSymbolLayer *QgsRasterFillSymbolLayer::create( const QgsStringMap &properties
   return symbolLayer;
 }
 
+void QgsRasterFillSymbolLayer::resolvePaths( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving )
+{
+  QgsStringMap::iterator it = properties.find( QStringLiteral( "imageFile" ) );
+  if ( it != properties.end() )
+  {
+    if ( saving )
+      it.value() = pathResolver.writePath( it.value() );
+    else
+      it.value() = pathResolver.readPath( it.value() );
+  }
+}
+
 bool QgsRasterFillSymbolLayer::setSubSymbol( QgsSymbol *symbol )
 {
   Q_UNUSED( symbol );
@@ -3770,7 +3782,7 @@ void QgsRasterFillSymbolLayer::applyDataDefinedSettings( QgsSymbolRenderContext
   if ( hasFileExpression )
   {
     context.setOriginalValueVariable( mImageFilePath );
-    file = mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyFile, context.renderContext().expressionContext(), file );
+    file = context.renderContext().pathResolver().readPath( mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyFile, context.renderContext().expressionContext(), file ) );
   }
   applyPattern( mBrush, file, width, opacity, context );
 }
diff --git a/src/core/symbology/qgsfillsymbollayer.h b/src/core/symbology/qgsfillsymbollayer.h
@@ -693,6 +693,13 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer
 
     static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
 
+    /**
+     * Turns relative paths in properties map to absolute when reading and vice versa when writing.
+     * Used internally when reading/writing symbols.
+     * \since QGIS 3.0
+     */
+    static void resolvePaths( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving );
+
     // implemented from base classes
     QString layerType() const override;
     void renderPolygon( const QPolygonF &points, QList<QPolygonF> *rings, QgsSymbolRenderContext &context ) override;
diff --git a/src/core/symbology/qgssymbollayerregistry.cpp b/src/core/symbology/qgssymbollayerregistry.cpp
@@ -52,7 +52,7 @@ QgsSymbolLayerRegistry::QgsSymbolLayerRegistry()
   addSymbolLayerType( new QgsSymbolLayerMetadata( QStringLiteral( "ShapeburstFill" ), QObject::tr( "Shapeburst fill" ), QgsSymbol::Fill,
                       QgsShapeburstFillSymbolLayer::create ) );
   addSymbolLayerType( new QgsSymbolLayerMetadata( QStringLiteral( "RasterFill" ), QObject::tr( "Raster image fill" ), QgsSymbol::Fill,
-                      QgsRasterFillSymbolLayer::create ) );
+                      QgsRasterFillSymbolLayer::create, nullptr, QgsRasterFillSymbolLayer::resolvePaths ) );
   addSymbolLayerType( new QgsSymbolLayerMetadata( QStringLiteral( "SVGFill" ), QObject::tr( "SVG fill" ), QgsSymbol::Fill,
                       QgsSVGFillSymbolLayer::create, QgsSVGFillSymbolLayer::createFromSld, QgsSVGFillSymbolLayer::resolvePaths ) );
   addSymbolLayerType( new QgsSymbolLayerMetadata( QStringLiteral( "CentroidFill" ), QObject::tr( "Centroid fill" ), QgsSymbol::Fill,

Original file line number	Diff line number	Diff line change
`@@ -3622,6 +3622,18 @@ QgsSymbolLayer *QgsRasterFillSymbolLayer::create( const QgsStringMap &properties`
`3622`	`3622`	`return symbolLayer;`
`3623`	`3623`	`}`
`3624`	`3624`
	`3625`	`+void QgsRasterFillSymbolLayer::resolvePaths( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving )`
	`3626`	`+{`
	`3627`	`+ QgsStringMap::iterator it = properties.find( QStringLiteral( "imageFile" ) );`
	`3628`	`+ if ( it != properties.end() )`
	`3629`	`+ {`
	`3630`	`+ if ( saving )`
	`3631`	`+ it.value() = pathResolver.writePath( it.value() );`
	`3632`	`+ else`
	`3633`	`+ it.value() = pathResolver.readPath( it.value() );`
	`3634`	`+ }`
	`3635`	`+}`
	`3636`	`+`
`3625`	`3637`	`bool QgsRasterFillSymbolLayer::setSubSymbol( QgsSymbol *symbol )`
`3626`	`3638`	`{`
`3627`	`3639`	`Q_UNUSED( symbol );`
`@@ -3770,7 +3782,7 @@ void QgsRasterFillSymbolLayer::applyDataDefinedSettings( QgsSymbolRenderContext`
`3770`	`3782`	`if ( hasFileExpression )`
`3771`	`3783`	`{`
`3772`	`3784`	`context.setOriginalValueVariable( mImageFilePath );`
`3773`		`- file = mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyFile, context.renderContext().expressionContext(), file );`
	`3785`	`+ file = context.renderContext().pathResolver().readPath( mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyFile, context.renderContext().expressionContext(), file ) );`
`3774`	`3786`	`}`
`3775`	`3787`	`applyPattern( mBrush, file, width, opacity, context );`
`3776`	`3788`	`}`