QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
qgswfsparameters.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgswfsparameters.cpp
3 --------------------
4 begin : Sept 14, 2017
5 copyright : (C) 2017 by René-Luc Dhont
6 email : rldhont at 3liz dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#include "qgswfsparameters.h"
19#include "moc_qgswfsparameters.cpp"
20#include "qgsmessagelog.h"
21#include <QRegularExpression>
22#include <QRegularExpressionMatch>
23
24namespace QgsWfs
25{
26 //
27 // QgsWfsParameter
28 //
30 const QMetaType::Type type,
31 const QVariant defaultValue )
32 : QgsServerParameterDefinition( type, defaultValue )
33 , mName( name )
34 {
35 }
36
38 {
39 bool ok = false;
40 const int val = QgsServerParameterDefinition::toInt( ok );
41
42 if ( !ok )
43 {
44 raiseError();
45 }
46
47 return val;
48 }
49
51 {
52 QString value = toString();
53 const QStringList corners = mValue.toString().split( ',' );
54 if ( corners.size() == 5 )
55 {
56 value.resize( value.size() - corners[4].size() - 1 );
57 }
58
60 param.mValue = QVariant( value );
61
62 bool ok = false;
63 const QgsRectangle rectangle = param.toRectangle( ok );
64
65 if ( !ok )
66 {
67 const QString msg = QString( "%1 ('%2') cannot be converted into rectangle" ).arg( name( mName ), toString() );
69 }
70
71 return rectangle;
72 }
73
74 QStringList QgsWfsParameter::toStringListWithExp( const QString &exp ) const
75 {
76 QStringList theList;
77
78 const QString val = mValue.toString();
79 if ( val.isEmpty() )
80 return theList;
81
82 if ( exp.isEmpty() )
83 theList << val;
84 else
85 {
86 const QRegularExpression rx( exp );
87 QRegularExpressionMatchIterator matchIt = rx.globalMatch( val );
88 if ( !matchIt.hasNext() )
89 {
90 theList << val;
91 }
92 else
93 {
94 while ( matchIt.hasNext() )
95 {
96 const QRegularExpressionMatch match = matchIt.next();
97 if ( match.hasMatch() )
98 {
99 QStringList matches = match.capturedTexts();
100 matches.pop_front(); // remove whole match
101 theList.append( matches );
102 }
103 }
104 }
105 }
106
107 return theList;
108 }
109
111 {
112 const QString msg = QString( "%1 ('%2') cannot be converted into %3" ).arg( name( mName ), toString(), typeName() );
114 }
115
117 {
118 const QMetaEnum metaEnum( QMetaEnum::fromType<QgsWfsParameter::Name>() );
119 return metaEnum.valueToKey( name );
120 }
121
123 {
124 const QMetaEnum metaEnum( QMetaEnum::fromType<QgsWfsParameter::Name>() );
125 return ( QgsWfsParameter::Name ) metaEnum.keyToValue( name.toUpper().toStdString().c_str() );
126 }
127
128 //
129 // QgsWfsParameters
130 //
133 {
134 // Available version number
135 mVersions.append( QgsProjectVersion( 1, 0, 0 ) );
136 mVersions.append( QgsProjectVersion( 1, 1, 0 ) );
137
139 save( pOutputFormat );
140
142 save( pResultType );
143
145 save( pPropertyName );
146
148 QMetaType::Type::Int,
149 QVariant( -1 ) );
150 save( pMaxFeatures );
151
153 QMetaType::Type::Int,
154 QVariant( 0 ) );
155 save( pStartIndex );
156
158 save( pSrsName );
159
161 save( pTypeName );
162
164 save( pFeatureId );
165
167 save( pFilter );
168
170 save( pBbox );
171
173 save( pSortBy );
174
176 save( pExpFilter );
177
179 save( pGeometryName );
180 }
181
184 {
185 load( parameters.urlQuery() );
186 }
187
188 bool QgsWfsParameters::loadParameter( const QString &key, const QString &value )
189 {
190 bool loaded = false;
191
193 if ( name >= 0 )
194 {
195 mWfsParameters[name].mValue = value;
196 if ( ! mWfsParameters[name].isValid() )
197 {
198 mWfsParameters[name].raiseError();
199 }
200
201 loaded = true;
202 }
203
204 return loaded;
205 }
206
207 void QgsWfsParameters::save( const QgsWfsParameter &parameter )
208 {
209 mWfsParameters[ parameter.mName ] = parameter;
210 }
211
213 {
214 log( "WFS Request parameters:" );
215 const auto map = mWfsParameters.toStdMap();
216 for ( const auto &parameter : map )
217 {
218 const QString value = parameter.second.toString();
219
220 if ( ! value.isEmpty() )
221 {
222 const QString name = QgsWfsParameter::name( parameter.first );
223 log( QStringLiteral( " - %1 : %2" ).arg( name, value ) );
224 }
225 }
226
227 if ( !version().isEmpty() )
228 log( QStringLiteral( " - VERSION : %1" ).arg( version() ) );
229 }
230
232 {
233 return mWfsParameters[ QgsWfsParameter::OUTPUTFORMAT ].toString();
234 }
235
237 {
238 const QString fStr = outputFormatAsString();
239
240 if ( fStr.isEmpty() )
241 {
242 if ( versionAsNumber() >= QgsProjectVersion( 1, 1, 0 ) )
243 return Format::GML3;
244 else
245 return Format::GML2;
246 }
247
249 if ( fStr.compare( QLatin1String( "text/xml; subtype=gml/2.1.2" ), Qt::CaseInsensitive ) == 0 )
250 f = Format::GML2;
251 else if ( fStr.compare( QLatin1String( "text/xml; subtype=gml/3.1.1" ), Qt::CaseInsensitive ) == 0 )
252 f = Format::GML3;
253 else if ( fStr.compare( QLatin1String( "application/vnd.geo+json" ), Qt::CaseInsensitive ) == 0 ||
254 // Needs to check for space too, because a + sign in the query string is interpreted as a space
255 fStr.compare( QLatin1String( "application/vnd.geo json" ), Qt::CaseInsensitive ) == 0 ||
256 fStr.compare( QLatin1String( "application/geo+json" ), Qt::CaseInsensitive ) == 0 ||
257 fStr.compare( QLatin1String( "application/geo json" ), Qt::CaseInsensitive ) == 0 ||
258 fStr.compare( QLatin1String( "application/json" ), Qt::CaseInsensitive ) == 0 ||
259 fStr.compare( QLatin1String( "geojson" ), Qt::CaseInsensitive ) == 0
260 )
261 f = Format::GeoJSON;
262 else if ( fStr.compare( QLatin1String( "gml2" ), Qt::CaseInsensitive ) == 0 )
263 f = Format::GML2;
264 else if ( fStr.compare( QLatin1String( "gml3" ), Qt::CaseInsensitive ) == 0 )
265 f = Format::GML3;
266
267 if ( f == Format::NONE &&
268 request().compare( QLatin1String( "describefeaturetype" ), Qt::CaseInsensitive ) == 0 &&
269 fStr.compare( QLatin1String( "xmlschema" ), Qt::CaseInsensitive ) == 0 )
270 {
271 if ( versionAsNumber() >= QgsProjectVersion( 1, 1, 0 ) )
272 return Format::GML3;
273 else
274 return Format::GML2;
275 }
276
277 return f;
278 }
279
281 {
282 return mWfsParameters[ QgsWfsParameter::RESULTTYPE ].toString();
283 }
284
286 {
287 const QString rtStr = resultTypeAsString();
288 if ( rtStr.isEmpty() )
289 return ResultType::RESULTS;
290
292 if ( rtStr.compare( QLatin1String( "hits" ), Qt::CaseInsensitive ) == 0 )
293 rt = ResultType::HITS;
294 return rt;
295 }
296
298 {
299 return mWfsParameters[ QgsWfsParameter::PROPERTYNAME ].toStringListWithExp();
300 }
301
303 {
304 return mWfsParameters[ QgsWfsParameter::MAXFEATURES ].toString();
305 }
306
308 {
309 return mWfsParameters[ QgsWfsParameter::MAXFEATURES ].toInt();
310 }
311
313 {
314 return mWfsParameters[ QgsWfsParameter::STARTINDEX ].toString();
315 }
316
318 {
319 return mWfsParameters[ QgsWfsParameter::STARTINDEX ].toInt();
320 }
321
323 {
324 return mWfsParameters[ QgsWfsParameter::SRSNAME ].toString();
325 }
326
327 QStringList QgsWfsParameters::typeNames() const
328 {
329 return mWfsParameters[ QgsWfsParameter::TYPENAME ].toStringList();
330 }
331
333 {
334 return mWfsParameters[ QgsWfsParameter::FEATUREID ].toStringList();
335 }
336
337 QStringList QgsWfsParameters::filters() const
338 {
339 return mWfsParameters[ QgsWfsParameter::FILTER ].toStringListWithExp();
340 }
341
343 {
344 return mWfsParameters[ QgsWfsParameter::BBOX ].toString();
345 }
346
348 {
349 return mWfsParameters[ QgsWfsParameter::BBOX ].toRectangle();
350 }
351
352 QStringList QgsWfsParameters::sortBy() const
353 {
354 return mWfsParameters[ QgsWfsParameter::SORTBY ].toStringListWithExp();
355 }
356
358 {
359 return mWfsParameters[ QgsWfsParameter::EXP_FILTER ].toExpressionList();
360 }
361
363 {
364 return mWfsParameters[ QgsWfsParameter::GEOMETRYNAME ].toString();
365 }
366
368 {
369 const QString vStr = version();
371
372 if ( mVersions.contains( QgsProjectVersion( vStr ) ) )
373 version = QgsProjectVersion( vStr );
374 else
375 version = QgsProjectVersion( 1, 1, 0 ); // default value
376
377 return version;
378 }
379
380 void QgsWfsParameters::log( const QString &msg ) const
381 {
383 }
384}
@ Info
Information message.
Definition qgis.h:155
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
A class to describe the version of a project.
A rectangle specified with double values.
Q_INVOKABLE QString toString(int precision=16) const
Returns a string representation of form xmin,ymin : xmax,ymax Coordinates will be truncated to the sp...
Definition of a parameter with basic conversion methods.
QString toString(bool defaultValue=false) const
Converts the parameter into a string.
QString typeName() const
Returns the type of the parameter as a string.
static void raiseError(const QString &msg)
Raises an exception in case of an invalid parameters.
int toInt(bool &ok) const
Converts the parameter into an integer.
QgsRectangle toRectangle(bool &ok) const
Converts the parameter into a rectangle.
QgsServerParameters provides an interface to retrieve and manipulate global parameters received from ...
QString map() const
Returns MAP parameter as a string or an empty string if not defined.
virtual QString request() const
Returns REQUEST parameter as a string or an empty string if not defined.
QUrlQuery urlQuery() const
Returns a url query with underlying parameters.
void load(const QUrlQuery &query)
Loads new parameters.
virtual QString version() const
Returns VERSION parameter as a string or an empty string if not defined.
QString value(const QString &key) const
Returns the value of a parameter.
WFS parameter received from the client.
QgsWfsParameter::Name mName
Name
Available parameters for WFS requests.
int toInt() const
Converts the parameter into an integer.
QStringList toStringListWithExp(const QString &exp="\\‍(([^()]+)\\‍)") const
Converts the parameter into a list of string.
void raiseError() const
Raises an error in case of an invalid conversion.
QgsWfsParameter(const QgsWfsParameter::Name name=QgsWfsParameter::UNKNOWN, const QMetaType::Type type=QMetaType::Type::QString, const QVariant defaultValue=QVariant(""))
Constructor for QgsWfsParameter.
QgsRectangle toRectangle() const
Converts the parameter into a rectangle.
static QString name(const QgsWfsParameter::Name)
Converts a parameter's name into its string representation.
Provides an interface to retrieve and manipulate WFS parameters received from the client.
QgsWfsParameters()
Constructor for WFS parameters with default values only.
int startIndexAsInt() const
Returns STARTINDEX parameter as an int or its default value if not defined.
QString geometryNameAsString() const
Returns GEOMETRYNAME parameter as a string.
QStringList sortBy() const
Returns SORTBY parameter as list.
QStringList typeNames() const
Returns TYPENAME parameter as list.
QStringList expFilters() const
Returns EXP_FILTER parameter as list.
QString maxFeatures() const
Returns MAXFEATURES parameter as a string.
QStringList filters() const
Returns FILTER parameter as list.
QString srsName() const
Returns SRSNAME parameter as a string.
QString resultTypeAsString() const
Returns RESULTTYPE parameter as a string.
int maxFeaturesAsInt() const
Returns MAXFEATURES parameter as an int or its default value if not defined.
QString bbox() const
Returns BBOX if defined or an empty string.
void dump() const
Dumps parameters.
QString outputFormatAsString() const
Returns OUTPUTFORMAT parameter as a string.
ResultType resultType() const
Returns resultType.
QgsProjectVersion versionAsNumber() const
Returns VERSION parameter if defined or its default value.
QStringList featureIds() const
Returns FEATUREID parameter as list.
QString startIndex() const
Returns STARTINDEX parameter as a string.
Format
Output format for the response.
QgsRectangle bboxAsRectangle() const
Returns BBOX as a rectangle if defined and valid.
QStringList propertyNames() const
Returns PROPERTYNAME parameter as list.
Format outputFormat() const
Returns format.
WMS implementation.
Definition qgswfs.cpp:36