WMS server: support multiple styles in GetStyles request

This code has been funded by Tuscany Region (Italy) - SITA (CIG: 6002233F59) and commissioned to Gis3W s.a.s.

Author: wonder-sk

python/core/symbology-ng/qgsrendererv2.sip

@@ -111,7 +111,11 @@ class QgsFeatureRendererV2
     virtual QDomElement save( QDomDocument& doc );
 
     //! create the SLD UserStyle element following the SLD v1.1 specs
-    virtual QDomElement writeSld( QDomDocument& doc, const QgsVectorLayer &layer ) const;
+    //! @deprecated since 2.8 - use the other override with styleName
+    virtual QDomElement writeSld( QDomDocument& doc, const QgsVectorLayer &layer ) const /Deprecated/;
+    //! create the SLD UserStyle element following the SLD v1.1 specs with the given name
+    //! @note added in 2.8
+    virtual QDomElement writeSld( QDomDocument& doc, const QString& styleName ) const;
 
     /** create a new renderer according to the information contained in
      * the UserStyle element of a SLD style document

src/core/qgsvectorlayer.cpp

@@ -2007,7 +2007,7 @@ bool QgsVectorLayer::writeSld( QDomNode& node, QDomDocument& doc, QString& error
 
   if ( hasGeometryType() )
   {
-    node.appendChild( mRendererV2->writeSld( doc, *this ) );
+    node.appendChild( mRendererV2->writeSld( doc, name() ) );
   }
   return true;
 }

src/core/symbology-ng/qgsrendererv2.cpp

@@ -488,11 +488,16 @@ QgsFeatureRendererV2* QgsFeatureRendererV2::loadSld( const QDomNode &node, QGis:
 }
 
 QDomElement QgsFeatureRendererV2::writeSld( QDomDocument& doc, const QgsVectorLayer &layer ) const
+{
+  return writeSld( doc, layer.name() );
+}
+
+QDomElement QgsFeatureRendererV2::writeSld( QDomDocument& doc, const QString& styleName ) const
 {
   QDomElement userStyleElem = doc.createElement( "UserStyle" );
 
   QDomElement nameElem = doc.createElement( "se:Name" );
-  nameElem.appendChild( doc.createTextNode( layer.name() ) );
+  nameElem.appendChild( doc.createTextNode( styleName ) );
   userStyleElem.appendChild( nameElem );
 
   QDomElement featureTypeStyleElem = doc.createElement( "se:FeatureTypeStyle" );

src/core/symbology-ng/qgsrendererv2.h

@@ -137,7 +137,11 @@ class CORE_EXPORT QgsFeatureRendererV2
     virtual QDomElement save( QDomDocument& doc );
 
     //! create the SLD UserStyle element following the SLD v1.1 specs
-    virtual QDomElement writeSld( QDomDocument& doc, const QgsVectorLayer &layer ) const;
+    //! @deprecated since 2.8 - use the other override with styleName
+    Q_DECL_DEPRECATED virtual QDomElement writeSld( QDomDocument& doc, const QgsVectorLayer &layer ) const;
+    //! create the SLD UserStyle element following the SLD v1.1 specs with the given name
+    //! @note added in 2.8
+    virtual QDomElement writeSld( QDomDocument& doc, const QString& styleName ) const;
 
     /** create a new renderer according to the information contained in
      * the UserStyle element of a SLD style document

src/server/qgswmsprojectparser.cpp

@@ -23,6 +23,7 @@
 #include "qgsmaplayerstylemanager.h"
 #include "qgsmapserviceexception.h"
 #include "qgspallabeling.h"
+#include "qgsrendererv2.h"
 #include "qgsvectorlayer.h"
 
 #include "qgscomposition.h"
@@ -41,6 +42,10 @@
 #include <QFileInfo>
 #include <QTextDocument>
 
+// style name to use for the unnamed style of layers (must not be empty name in WMS)
+// this implies that a layer style called "default" will not be usable in WMS server
+#define EMPTY_STYLE_NAME   "default"
+
 QgsWMSProjectParser::QgsWMSProjectParser( const QString& filePath )
     : QgsWMSConfigParser()
 {
@@ -119,7 +124,7 @@ QList<QgsMapLayer*> QgsWMSProjectParser::mapLayerFromStyle( const QString& lName
     if ( !styleName.isEmpty() )
     {
       // try to apply the specified style
-      if ( !ml->styleManager()->setCurrentStyle( styleName ) )
+      if ( !ml->styleManager()->setCurrentStyle( styleName != EMPTY_STYLE_NAME ? styleName : QString() ) )
         throw QgsMapServiceException( "StyleNotDefined", QString( "Style \"%1\" does not exist for layer \"%2\"" ).arg( styleName ).arg( lName ) );
     }
     return QList<QgsMapLayer*>() << ml;
@@ -901,10 +906,10 @@ void QgsWMSProjectParser::addDrawingOrder( QDomElement elem, bool useDrawingOrde
 
 void QgsWMSProjectParser::addLayerStyles( QgsMapLayer* currentLayer, QDomDocument& doc, QDomElement& layerElem, const QString& version ) const
 {
-  foreach ( const QString& styleName, currentLayer->styleManager()->styles() )
+  foreach ( QString styleName, currentLayer->styleManager()->styles() )
   {
     if ( styleName.isEmpty() )
-      continue; // do not explicitly list the default style with no name
+      styleName = EMPTY_STYLE_NAME;
 
     QDomElement styleElem = doc.createElement( "Style" );
     QDomElement styleNameElem = doc.createElement( "Name" );
@@ -1292,10 +1297,10 @@ void QgsWMSProjectParser::addLayers( QDomDocument &doc,
 
 void QgsWMSProjectParser::addOWSLayerStyles( QgsMapLayer* currentLayer, QDomDocument& doc, QDomElement& layerElem ) const
 {
-  foreach ( const QString& styleName, currentLayer->styleManager()->styles() )
+  foreach ( QString styleName, currentLayer->styleManager()->styles() )
   {
     if ( styleName.isEmpty() )
-      continue; // do not explicitly list the default style with no name
+      styleName = EMPTY_STYLE_NAME;
 
     QDomElement styleListElem = doc.createElement( "StyleList" );
     //only one default style in project file mode
@@ -1630,7 +1635,8 @@ QDomDocument QgsWMSProjectParser::getStyles( QStringList& layerList ) const
   {
     QString layerName;
     layerName = layerList.at( i );
-    QList<QgsMapLayer*> currentLayerList = mapLayerFromStyle( layerName, "", true );
+    // don't use a cache - we may be changing styles
+    QList<QgsMapLayer*> currentLayerList = mapLayerFromStyle( layerName, "", false );
     if ( currentLayerList.size() < 1 )
     {
       throw QgsMapServiceException( "Error", QString( "The layer for the TypeName '%1' is not found" ).arg( layerName ) );
@@ -1647,10 +1653,21 @@ QDomDocument QgsWMSProjectParser::getStyles( QStringList& layerList ) const
       QDomElement namedLayerNode = myDocument.createElement( "NamedLayer" );
       root.appendChild( namedLayerNode );
 
-      QString errorMsg;
-      if ( !layer->writeSld( namedLayerNode, myDocument, errorMsg ) )
+      // store the Name element
+      QDomElement nameNode = myDocument.createElement( "se:Name" );
+      nameNode.appendChild( myDocument.createTextNode( layerName ) );
+      namedLayerNode.appendChild( nameNode );
+
+      foreach ( QString styleName, layer->styleManager()->styles() )
       {
-        throw QgsMapServiceException( "Error", QString( "Could not get style because:\n%1" ).arg( errorMsg ) );
+        if ( layer->hasGeometryType() )
+        {
+          layer->styleManager()->setCurrentStyle( styleName );
+          if ( styleName.isEmpty() )
+            styleName = EMPTY_STYLE_NAME;
+          QDomElement styleElem = layer->rendererV2()->writeSld( myDocument, styleName );
+          namedLayerNode.appendChild( styleElem );
+        }
       }
     }
   }