QGIS API Documentation  3.10.0-A Coruña (6c816b4204)
qgswfsdescribefeaturetype.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgswfsdescribefeaturetype.cpp
3  -------------------------
4  begin : December 20 , 2016
5  copyright : (C) 2007 by Marco Hugentobler (original code)
6  (C) 2012 by René-Luc D'Hont (original code)
7  (C) 2014 by Alessandro Pasotti (original code)
8  (C) 2017 by David Marteau
9  email : marco dot hugentobler at karto dot baug dot ethz dot ch
10  a dot pasotti at itopen dot it
11  david dot marteau at 3liz dot com
12  ***************************************************************************/
13 
14 /***************************************************************************
15  * *
16  * This program is free software; you can redistribute it and/or modify *
17  * it under the terms of the GNU General Public License as published by *
18  * the Free Software Foundation; either version 2 of the License, or *
19  * (at your option) any later version. *
20  * *
21  ***************************************************************************/
22 #include "qgswfsutils.h"
23 #include "qgsserverprojectutils.h"
25 #include "qgswfsparameters.h"
26 
27 #include "qgsproject.h"
28 #include "qgsvectorlayer.h"
30 
31 namespace QgsWfs
32 {
33 
34  void writeDescribeFeatureType( QgsServerInterface *serverIface, const QgsProject *project, const QString &version,
35  const QgsServerRequest &request, QgsServerResponse &response )
36  {
37 #ifdef HAVE_SERVER_PYTHON_PLUGINS
38  QgsAccessControl *accessControl = serverIface->accessControls();
39 #endif
40  QDomDocument doc;
41  const QDomDocument *describeDocument = nullptr;
42 
43 #ifdef HAVE_SERVER_PYTHON_PLUGINS
44  QgsServerCacheManager *cacheManager = serverIface->cacheManager();
45  if ( cacheManager && cacheManager->getCachedDocument( &doc, project, request, accessControl ) )
46  {
47  describeDocument = &doc;
48  }
49  else //describe feature xml not in cache. Create a new one
50  {
51  doc = createDescribeFeatureTypeDocument( serverIface, project, version, request );
52 
53  if ( cacheManager )
54  {
55  cacheManager->setCachedDocument( &doc, project, request, accessControl );
56  }
57  describeDocument = &doc;
58  }
59 #else
60  doc = createDescribeFeatureTypeDocument( serverIface, project, version, request );
61  describeDocument = &doc;
62 #endif
63  response.setHeader( "Content-Type", "text/xml; charset=utf-8" );
64  response.write( describeDocument->toByteArray() );
65  }
66 
67 
68  QDomDocument createDescribeFeatureTypeDocument( QgsServerInterface *serverIface, const QgsProject *project, const QString &version,
69  const QgsServerRequest &request )
70  {
71  Q_UNUSED( version )
72 
73  QDomDocument doc;
74 
75  QgsServerRequest::Parameters parameters = request.parameters();
76  QgsWfsParameters wfsParameters( QUrlQuery( request.url() ) );
77  QgsWfsParameters::Format oFormat = wfsParameters.outputFormat();
78 
79  // test oFormat
80  if ( oFormat == QgsWfsParameters::Format::NONE )
81  throw QgsBadRequestException( QStringLiteral( "Invalid WFS Parameter" ),
82  QStringLiteral( "OUTPUTFORMAT %1 is not supported" ).arg( wfsParameters.outputFormatAsString() ) );
83 
84 #ifdef HAVE_SERVER_PYTHON_PLUGINS
85  QgsAccessControl *accessControl = serverIface->accessControls();
86 #else
87  ( void )serverIface;
88 #endif
89 
90  //xsd:schema
91  QDomElement schemaElement = doc.createElement( QStringLiteral( "schema" )/*xsd:schema*/ );
92  schemaElement.setAttribute( QStringLiteral( "xmlns" ), QStringLiteral( "http://www.w3.org/2001/XMLSchema" ) );
93  schemaElement.setAttribute( QStringLiteral( "xmlns:xsd" ), QStringLiteral( "http://www.w3.org/2001/XMLSchema" ) );
94  schemaElement.setAttribute( QStringLiteral( "xmlns:ogc" ), OGC_NAMESPACE );
95  schemaElement.setAttribute( QStringLiteral( "xmlns:gml" ), GML_NAMESPACE );
96  schemaElement.setAttribute( QStringLiteral( "xmlns:qgs" ), QGS_NAMESPACE );
97  schemaElement.setAttribute( QStringLiteral( "targetNamespace" ), QGS_NAMESPACE );
98  schemaElement.setAttribute( QStringLiteral( "elementFormDefault" ), QStringLiteral( "qualified" ) );
99  schemaElement.setAttribute( QStringLiteral( "version" ), QStringLiteral( "1.0" ) );
100  doc.appendChild( schemaElement );
101 
102  //xsd:import
103  QDomElement importElement = doc.createElement( QStringLiteral( "import" )/*xsd:import*/ );
104  importElement.setAttribute( QStringLiteral( "namespace" ), GML_NAMESPACE );
105  if ( oFormat == QgsWfsParameters::Format::GML2 )
106  importElement.setAttribute( QStringLiteral( "schemaLocation" ), QStringLiteral( "http://schemas.opengis.net/gml/2.1.2/feature.xsd" ) );
107  else if ( oFormat == QgsWfsParameters::Format::GML3 )
108  importElement.setAttribute( QStringLiteral( "schemaLocation" ), QStringLiteral( "http://schemas.opengis.net/gml/3.1.1/base/gml.xsd" ) );
109  schemaElement.appendChild( importElement );
110 
111  QStringList typeNameList;
112  QDomDocument queryDoc;
113  QString errorMsg;
114  if ( queryDoc.setContent( parameters.value( QStringLiteral( "REQUEST_BODY" ) ), true, &errorMsg ) )
115  {
116  //read doc
117  QDomElement queryDocElem = queryDoc.documentElement();
118  QDomNodeList docChildNodes = queryDocElem.childNodes();
119  if ( docChildNodes.size() )
120  {
121  for ( int i = 0; i < docChildNodes.size(); i++ )
122  {
123  QDomElement docChildElem = docChildNodes.at( i ).toElement();
124  if ( docChildElem.tagName() == QLatin1String( "TypeName" ) )
125  {
126  QString typeName = docChildElem.text().trimmed();
127  if ( typeName.contains( ':' ) )
128  typeNameList << typeName.section( ':', 1, 1 );
129  else
130  typeNameList << typeName;
131  }
132  }
133  }
134  }
135  else
136  {
137  typeNameList = wfsParameters.typeNames();
138  }
139 
140  QStringList wfsLayerIds = QgsServerProjectUtils::wfsLayerIds( *project );
141  for ( int i = 0; i < wfsLayerIds.size(); ++i )
142  {
143  QgsMapLayer *layer = project->mapLayer( wfsLayerIds.at( i ) );
144  if ( !layer )
145  {
146  continue;
147  }
148 
149  QString name = layerTypeName( layer );
150 
151  if ( !typeNameList.isEmpty() && !typeNameList.contains( name ) )
152  {
153  continue;
154  }
155 #ifdef HAVE_SERVER_PYTHON_PLUGINS
156  if ( accessControl && !accessControl->layerReadPermission( layer ) )
157  {
158  if ( !typeNameList.isEmpty() )
159  {
160  throw QgsSecurityAccessException( QStringLiteral( "Feature access permission denied" ) );
161  }
162  else
163  {
164  continue;
165  }
166  }
167 #endif
168  QgsVectorLayer *vLayer = qobject_cast<QgsVectorLayer *>( layer );
169  QgsVectorDataProvider *provider = vLayer->dataProvider();
170  if ( !provider )
171  {
172  continue;
173  }
174  setSchemaLayer( schemaElement, doc, const_cast<QgsVectorLayer *>( vLayer ) );
175  }
176  return doc;
177  }
178 
179  void setSchemaLayer( QDomElement &parentElement, QDomDocument &doc, const QgsVectorLayer *layer )
180  {
181  const QgsVectorDataProvider *provider = layer->dataProvider();
182  if ( !provider )
183  {
184  return;
185  }
186 
187  QString typeName = layerTypeName( layer );
188 
189  //xsd:element
190  QDomElement elementElem = doc.createElement( QStringLiteral( "element" )/*xsd:element*/ );
191  elementElem.setAttribute( QStringLiteral( "name" ), typeName );
192  elementElem.setAttribute( QStringLiteral( "type" ), "qgs:" + typeName + "Type" );
193  elementElem.setAttribute( QStringLiteral( "substitutionGroup" ), QStringLiteral( "gml:_Feature" ) );
194  parentElement.appendChild( elementElem );
195 
196  //xsd:complexType
197  QDomElement complexTypeElem = doc.createElement( QStringLiteral( "complexType" )/*xsd:complexType*/ );
198  complexTypeElem.setAttribute( QStringLiteral( "name" ), typeName + "Type" );
199  parentElement.appendChild( complexTypeElem );
200 
201  //xsd:complexType
202  QDomElement complexContentElem = doc.createElement( QStringLiteral( "complexContent" )/*xsd:complexContent*/ );
203  complexTypeElem.appendChild( complexContentElem );
204 
205  //xsd:extension
206  QDomElement extensionElem = doc.createElement( QStringLiteral( "extension" )/*xsd:extension*/ );
207  extensionElem.setAttribute( QStringLiteral( "base" ), QStringLiteral( "gml:AbstractFeatureType" ) );
208  complexContentElem.appendChild( extensionElem );
209 
210  //xsd:sequence
211  QDomElement sequenceElem = doc.createElement( QStringLiteral( "sequence" )/*xsd:sequence*/ );
212  extensionElem.appendChild( sequenceElem );
213 
214  //xsd:element
215  if ( layer->isSpatial() )
216  {
217  QDomElement geomElem = doc.createElement( QStringLiteral( "element" )/*xsd:element*/ );
218  geomElem.setAttribute( QStringLiteral( "name" ), QStringLiteral( "geometry" ) );
219 
220  QgsWkbTypes::Type wkbType = layer->wkbType();
221  switch ( wkbType )
222  {
224  case QgsWkbTypes::Point:
225  geomElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "gml:PointPropertyType" ) );
226  break;
229  geomElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "gml:LineStringPropertyType" ) );
230  break;
233  geomElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "gml:PolygonPropertyType" ) );
234  break;
237  geomElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "gml:MultiPointPropertyType" ) );
238  break;
241  geomElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "gml:MultiLineStringPropertyType" ) );
242  break;
245  geomElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "gml:MultiPolygonPropertyType" ) );
246  break;
247  default:
248  geomElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "gml:GeometryPropertyType" ) );
249  break;
250  }
251  geomElem.setAttribute( QStringLiteral( "minOccurs" ), QStringLiteral( "0" ) );
252  geomElem.setAttribute( QStringLiteral( "maxOccurs" ), QStringLiteral( "1" ) );
253  sequenceElem.appendChild( geomElem );
254  }
255 
256  //Attributes
257  QgsFields fields = layer->fields();
258  //hidden attributes for this layer
259  const QSet<QString> &layerExcludedAttributes = layer->excludeAttributesWfs();
260  for ( int idx = 0; idx < fields.count(); ++idx )
261  {
262  const QgsField field = fields.at( idx );
263  QString attributeName = field.name();
264  //skip attribute if excluded from WFS publication
265  if ( layerExcludedAttributes.contains( attributeName ) )
266  {
267  continue;
268  }
269 
270  //xsd:element
271  QDomElement attElem = doc.createElement( QStringLiteral( "element" )/*xsd:element*/ );
272  attElem.setAttribute( QStringLiteral( "name" ), attributeName.replace( ' ', '_' ).replace( cleanTagNameRegExp, QString() ) );
273  QVariant::Type attributeType = field.type();
274  if ( attributeType == QVariant::Int )
275  {
276  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "int" ) );
277  }
278  else if ( attributeType == QVariant::UInt )
279  {
280  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "unsignedInt" ) );
281  }
282  else if ( attributeType == QVariant::LongLong )
283  {
284  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "long" ) );
285  }
286  else if ( attributeType == QVariant::ULongLong )
287  {
288  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "unsignedLong" ) );
289  }
290  else if ( attributeType == QVariant::Double )
291  {
292  if ( field.length() > 0 && field.precision() == 0 )
293  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "integer" ) );
294  else
295  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "decimal" ) );
296  }
297  else if ( attributeType == QVariant::Bool )
298  {
299  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "boolean" ) );
300  }
301  else if ( attributeType == QVariant::Date )
302  {
303  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "date" ) );
304  }
305  else if ( attributeType == QVariant::Time )
306  {
307  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "time" ) );
308  }
309  else if ( attributeType == QVariant::DateTime )
310  {
311  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "dateTime" ) );
312  }
313  else
314  {
315  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "string" ) );
316  }
317 
318  const QgsEditorWidgetSetup setup = field.editorWidgetSetup();
319  if ( setup.type() == QStringLiteral( "DateTime" ) )
320  {
321  QgsDateTimeFieldFormatter fieldFormatter;
322  const QVariantMap config = setup.config();
323  const QString fieldFormat = config.value( QStringLiteral( "field_format" ), fieldFormatter.defaultFormat( field.type() ) ).toString();
324  if ( fieldFormat == QStringLiteral( "yyyy-MM-dd" ) )
325  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "date" ) );
326  else if ( fieldFormat == QStringLiteral( "HH:mm:ss" ) )
327  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "time" ) );
328  else
329  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "dateTime" ) );
330  }
331  else if ( setup.type() == QStringLiteral( "Range" ) )
332  {
333  const QVariantMap config = setup.config();
334  if ( config.contains( QStringLiteral( "Precision" ) ) )
335  {
336  // if precision in range config is not the same as the attributePrec
337  // we need to update type
338  bool ok;
339  int configPrec( config[ QStringLiteral( "Precision" ) ].toInt( &ok ) );
340  if ( ok && configPrec != field.precision() )
341  {
342  if ( configPrec == 0 )
343  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "integer" ) );
344  else
345  attElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "decimal" ) );
346  }
347  }
348  }
349 
350  if ( !( field.constraints().constraints() & QgsFieldConstraints::Constraint::ConstraintNotNull ) )
351  {
352  attElem.setAttribute( QStringLiteral( "nillable" ), QStringLiteral( "true" ) );
353  }
354 
355  sequenceElem.appendChild( attElem );
356 
357  QString alias = field.alias();
358  if ( !alias.isEmpty() )
359  {
360  attElem.setAttribute( QStringLiteral( "alias" ), alias );
361  }
362  }
363  }
364 
365 } // namespace QgsWfs
virtual void setHeader(const QString &key, const QString &value)=0
Set Header entry Add Header entry to the response Note that it is usually an error to set Header afte...
Base class for all map layer types.
Definition: qgsmaplayer.h:79
QVariantMap config() const
QString name
Definition: qgsfield.h:58
int precision
Definition: qgsfield.h:55
void setSchemaLayer(QDomElement &parentElement, QDomDocument &doc, const QgsVectorLayer *layer)
const QString QGS_NAMESPACE
Definition: qgswfsutils.h:74
QString alias
Definition: qgsfield.h:59
QSet< QString > excludeAttributesWfs() const
A set of attributes that are not advertised in WFS requests with QGIS server.
Format outputFormat() const
Returns format.
QgsWkbTypes::Type wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
QString outputFormatAsString() const
Returns OUTPUTFORMAT parameter as a string.
void writeDescribeFeatureType(QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
Output WFS GetCapabilities response.
Container of fields for a vector layer.
Definition: qgsfields.h:42
QgsEditorWidgetSetup editorWidgetSetup() const
Gets the editor widget setup for the field.
Definition: qgsfield.cpp:438
virtual void write(const QString &data)
Write string This is a convenient method that will write directly to the underlying I/O device...
int count() const
Returns number of items.
Definition: qgsfields.cpp:133
bool isSpatial() const FINAL
Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeome...
QString layerTypeName(const QgsMapLayer *layer)
Returns typename from vector layer.
Definition: qgswfsutils.cpp:71
QgsField at(int i) const
Gets field at particular index (must be in range 0..N-1)
Definition: qgsfields.cpp:163
int length
Definition: qgsfield.h:54
static QString defaultFormat(QVariant::Type type)
Gets the default format in function of the type.
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:68
QgsFields fields() const FINAL
Returns the list of fields of this layer.
const QString & typeName
WMS implementation.
Definition: qgswfs.cpp:35
QgsServerRequest::Parameters parameters() const
Returns a map of query parameters with keys converted to uppercase.
const QString GML_NAMESPACE
Definition: qgswfsutils.h:72
A helper class that centralizes caches accesses given by all the server cache filter plugins...
Encapsulates a QGIS project, including sets of map layers and their styles, layouts, annotations, canvases, etc.
Definition: qgsproject.h:89
Format
Output format for the response.
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:48
bool getCachedDocument(QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl) const
Returns cached document (or 0 if document not in cache) like capabilities.
const QString OGC_NAMESPACE
Definition: qgswfsutils.h:73
QgsServerRequest Class defining request interface passed to services QgsService::executeRequest() met...
const QRegExp cleanTagNameRegExp("(?![\\\-]).")
bool layerReadPermission(const QgsMapLayer *layer) const
Returns the layer read right.
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins...
QgsFieldConstraints constraints
Definition: qgsfield.h:61
QDomDocument createDescribeFeatureTypeDocument(QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request)
Create get capabilities document.
Holder for the widget type and its configuration for a field.
SERVER_EXPORT QStringList wfsLayerIds(const QgsProject &project)
Returns the Layer ids list defined in a QGIS project as published in WFS.
Field formatter for a date time field.
bool setCachedDocument(const QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl) const
Updates or inserts the document in cache like capabilities.
virtual QgsServerCacheManager * cacheManager() const =0
Gets the registered server cache filters.
Exception thrown in case of malformed request.
A helper class that centralizes restrictions given by all the access control filter plugins...
QStringList typeNames() const
Returns TYPENAME parameter as list.
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
Exception thrown when data access violates access controls.
QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() m...
virtual QgsAccessControl * accessControls() const =0
Gets the registered access control filters.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer&#39;s data provider, it may be nullptr.
This is the base class for vector data providers.
Represents a vector layer which manages a vector based data sets.
Provides an interface to retrieve and manipulate WFS parameters received from the client...
QVariant::Type type
Definition: qgsfield.h:56
QMap< QString, QString > Parameters