19#include <nlohmann/json.hpp>
21#include "inja/inja.hpp"
36using namespace Qt::StringLiterals;
38using namespace nlohmann;
45 const auto constParameters {
parameters( context ) };
46 for (
const auto &p : constParameters )
49 result[p.name()] = p.value( context );
52 const auto match {
path().match( sanitizedPath ) };
53 if ( match.hasMatch() )
55 const auto constNamed {
path().namedCaptureGroups() };
57 for (
const auto &name : constNamed )
59 if ( !name.isEmpty() )
60 result[name] = QUrlQuery( match.captured( name ) ).toString();
91 for (
auto it = constContentTypes.constBegin(); it != constContentTypes.constEnd(); ++it )
93 const auto constValues = it.value();
94 for (
const auto &value : constValues )
96 if ( accept.contains( value, Qt::CaseSensitivity::CaseInsensitive ) )
111 switch ( contentType )
114 data[
"handler"] =
schema( context );
115 if ( !htmlMetadata.is_null() )
117 data[
"metadata"] = htmlMetadata;
148 if ( match.captured().count() > 0 )
150 url.setPath( urlBasePath + match.captured( 0 ) );
154 url.setPath( urlBasePath );
158 const auto suffixLength { QFileInfo( url.path() ).suffix().length() };
159 if ( suffixLength > 0 )
161 auto path { url.path() };
162 path.truncate(
path.length() - ( suffixLength + 1 ) );
167 url.setPath( url.path() + extraPath );
171 if ( !extension.isEmpty() )
174 QString
path { url.path() };
175 while (
path.endsWith(
'/' ) )
179 url.setPath(
path +
'.' + extension );
189 QDateTime time { QDateTime::currentDateTime() };
190 time.setTimeSpec( Qt::TimeSpec::UTC );
191 data[
"timeStamp"] = time.toString( Qt::DateFormat::ISODate ).toStdString();
214 {
"title", title !=
"" ? title :
linkTitle() },
226 if ( !profileStr.isEmpty() )
228 hrefStr +=
"&profile="_L1 + profileStr;
231 QString titleStr = !title.isEmpty() ? title : QString::fromStdString(
linkTitle() );
232 titleStr.replace(
'\\',
"\\\\"_L1 );
233 titleStr.replace(
'"',
"\\\""_L1 );
235 QString linkStr = u
"<%1>; rel=\"%2\"; title=\"%3\"; type=\"%4\""_s.arg(
242 if ( !profileStr.isEmpty() )
244 linkStr += u
"; profile=\"%1\""_s.arg( profileStr );
253 json
links = json::array();
254 const QList<QgsServerOgcApi::ContentType> constCts {
contentTypes() };
255 for (
const auto &ct : constCts )
269 const QRegularExpressionMatch match {
path().match( context.
request()->
url().path() ) };
270 if ( !match.hasMatch() )
274 const QString collectionId { match.captured( u
"collectionId"_s ) };
289 path +=
"/ogc/templates"_L1;
301 if ( !QFile::exists(
path ) )
308 if ( !f.open( QFile::ReadOnly | QFile::Text ) )
317 QFileInfo pathInfo {
path };
318 Environment env { QString( pathInfo.dir().path() + QDir::separator() ).toStdString() };
323 env.add_callback(
"json_dump", 0, [data]( Arguments & ) {
return data.dump(); } );
326 env.add_callback(
"path_append", 1, [context]( Arguments &args ) {
328 QFileInfo fi { url.path() };
329 auto suffix { fi.suffix() };
330 auto fName { fi.filePath() };
331 if ( !suffix.isEmpty() )
333 fName.chop( suffix.length() + 1 );
336 while ( fName.endsWith(
'/' ) )
340 fName +=
'/' + QString::fromStdString( args.at( 0 )->get<std::string>() );
341 if ( !suffix.isEmpty() )
343 fName +=
'.' + suffix;
346 url.setPath( fi.filePath() );
347 return url.toString().toStdString();
351 env.add_callback(
"path_chomp", 1, []( Arguments &args ) {
352 QUrl url { QString::fromStdString( args.at( 0 )->get<std::string>() ) };
353 QFileInfo fi { url.path() };
354 auto suffix { fi.suffix() };
355 auto fName { fi.filePath() };
356 fName.chop( suffix.length() + 1 );
358 const thread_local QRegularExpression segmentRx( R
"raw(\/[^/]+$)raw" );
359 fName = fName.replace( segmentRx, QString() );
360 if ( !suffix.isEmpty() )
362 fName +=
'.' + suffix;
365 url.setPath( fi.filePath() );
366 return url.toString().toStdString();
371 env.add_callback(
"links_filter", 3, []( Arguments &args ) {
372 json
links = args.at( 0 )->get<json>();
373 if ( !
links.is_array() )
375 links = json::array();
377 std::string key { args.at( 1 )->get<std::string>() };
378 std::string value { args.at( 2 )->get<std::string>() };
379 json result = json::array();
380 for (
const auto &l :
links )
382 if ( l[key] == value )
384 result.push_back( l );
391 env.add_callback(
"content_type_name", 1, []( Arguments &args ) {
397 env.add_callback(
"nl2br", 1, []( Arguments &args ) {
398 QString text { QString::fromStdString( args.at( 0 )->get<std::string>() ) };
399 return text.replace(
'\n',
"<br>"_L1 ).toStdString();
405 env.add_callback(
"component_parameter", 1, [data]( Arguments &args ) {
406 json ret = json::array();
407 json ref = args.at( 0 )->get<json>();
408 if ( !ref.is_object() )
414 QString name = QString::fromStdString( ref[
"$ref"] );
415 name = name.split(
'/' ).last();
416 ret.push_back( data[
"components"][
"parameters"][name.toStdString()] );
418 catch ( std::exception & )
427 env.add_callback(
"static", 1, [context]( Arguments &args ) {
428 auto asset( args.at( 0 )->get<std::string>() );
431 if ( matchedPath ==
'/' )
435 return matchedPath.toStdString() +
"/static/" + asset;
440 env.add_callback(
"starts_with", 2, []( Arguments &args ) {
return string_view::starts_with( args.at( 0 )->get<std::string_view>(), args.at( 1 )->get<std::string_view>() ); } );
443 env.add_callback(
"if_nullptr_null_str", 1, []( Arguments &args ) {
444 json jsonValue = args.at( 0 )->get<json>();
446 switch ( jsonValue.type() )
449 case json::value_t::string:
450 out = jsonValue.get<std::string>();
453 case json::value_t::array:
454 case json::value_t::object:
455 if ( jsonValue.is_null() )
461 out = jsonValue.dump();
468 out = jsonValue.dump();
474 env.add_callback(
"escape", 1, []( Arguments &args ) {
475 std::string str { args.at( 0 )->get<std::string>() };
477 escaped.reserve( str.size() );
478 for (
const char c : str )
483 escaped.append(
"&" );
486 escaped.append(
"<" );
489 escaped.append(
">" );
492 escaped.append(
""" );
495 escaped.append(
"'" );
498 escaped.push_back(
c );
504 context.
response()->
write( env.render_file( pathInfo.fileName().toStdString(), data ) );
506 catch ( std::exception &e )
517 bool found {
false };
519 const QString extension { QFileInfo( request->
url().path() ).suffix().toUpper() };
520 if ( !extension.isEmpty() )
522 static QMetaEnum metaEnum { QMetaEnum::fromType<QgsServerOgcApi::ContentType>() };
524 const int ct { metaEnum.keyToValue( extension.toLocal8Bit().constData(), &ok ) };
537 if ( ( extension.compare( u
"JSONFG"_s, Qt::CaseSensitivity::CaseInsensitive ) == 0 ) || ( extension.compare( u
"JSONFG-PLUS"_s, Qt::CaseSensitivity::CaseInsensitive ) == 0 ) )
544 if ( extension.compare( u
"FGB"_s, Qt::CaseSensitivity::CaseInsensitive ) == 0 )
556 const QString accept { request->
header( u
"Accept"_s ) };
557 if ( !found && !accept.isEmpty() )
560 if ( !ctFromAccept.isEmpty() )
563 auto it = constContentTypes.constBegin();
564 while ( !found && it != constContentTypes.constEnd() )
566 int idx = it.value().indexOf( ctFromAccept );
584 bool found {
false };
587 const QList<QgsServerOgcApi::ContentType> constCt {
contentTypes() };
588 for (
const auto &ct : constCt )
610 if ( profile.compare(
"RFC7946"_L1, Qt::CaseSensitivity::CaseInsensitive ) == 0 )
615 else if ( profile.compare(
"JSON-FG"_L1, Qt::CaseSensitivity::CaseInsensitive ) == 0 )
620 else if ( profile.compare(
"JSON-FG-PLUS"_L1, Qt::CaseSensitivity::CaseInsensitive ) == 0 )
625 else if ( profile.compare(
"REL-AS-KEY"_L1, Qt::CaseSensitivity::CaseInsensitive ) == 0 )
630 else if ( profile.compare(
"REL-AS-URI"_L1, Qt::CaseSensitivity::CaseInsensitive ) == 0 )
635 else if ( profile.compare(
"REL-AS-LINK"_L1, Qt::CaseSensitivity::CaseInsensitive ) == 0 )
650 const QStringList profileStrings { request->
queryParameter( u
"profile"_s ).split(
',', Qt::SkipEmptyParts ) };
651 QList<QgsServerOgcApi::Profile> profiles;
652 if ( !profileStrings.isEmpty() )
654 for (
const auto &profileString : std::as_const( profileStrings ) )
660 profiles.push_back( p );
673 QString
path { url.path() };
674 const QFileInfo fi {
path };
675 const QString suffix { fi.suffix() };
676 if ( !suffix.isEmpty() )
678 path.chop( suffix.length() + 1 );
680 while (
path.endsWith(
'/' ) )
684 const thread_local QRegularExpression re( R
"raw(\/[^/]+$)raw" );
685 for (
int i = 0; i < levels; i++ )
687 path =
path.replace( re, QString() );
690 QUrlQuery query( result );
691 QList<QPair<QString, QString>> qi;
692 const auto constItems { query.queryItems() };
693 for (
const auto &i : constItems )
695 if ( i.first.compare( u
"MAP"_s, Qt::CaseSensitivity::CaseInsensitive ) == 0 )
701 if ( !
path.endsWith(
'/' ) )
705 QUrlQuery resultQuery;
706 resultQuery.setQueryItems( qi );
707 result.setQuery( resultQuery );
708 result.setPath(
path );
709 return result.toString();
715 if ( mapLayers.count() != 1 )
717 throw QgsServerApiNotFoundError( u
"Collection with given id (%1) was not found or multiple matches were found"_s.arg( collectionId ) );
719 return mapLayers.first();
725 = { {
"description",
"An error occurred." }, {
"content", { {
"application/json", { {
"schema", { {
"$ref",
"#/components/schemas/exception" } } } } }, {
"text/html", { {
"schema", { {
"type",
"string" } } } } } } } };
736 mContentTypes.clear();
@ Warning
Warning message.
@ Critical
Critical/error message.
@ Info
Information message.
static json jsonFromVariant(const QVariant &v)
Converts a QVariant v to a json object.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true, const char *file=__builtin_FILE(), const char *function=__builtin_FUNCTION(), int line=__builtin_LINE(), Qgis::StringFormat format=Qgis::StringFormat::PlainText)
Adds a message to the log instance (and creates it if necessary).
QList< QgsMapLayer * > mapLayersByShortName(const QString &shortName) const
Retrieves a list of matching registered layers by layer shortName.
Bad request error API exception.
Encapsulates the resources for a particular client request.
const QgsProject * project() const
Returns the (possibly NULL) project.
QgsServerResponse * response() const
Returns the server response object.
QString handlerPath() const
Returns the handler component of the URL path, i.e.
const QgsServerRequest * request() const
Returns the server request object.
QgsServerInterface * serverInterface() const
Returns the server interface.
QString apiRootPath() const
Returns the API root path.
const QString matchedPath() const
Returns the initial part of the incoming request URL path that matches the API root path.
Internal server error API exception.
Not found error API exception.
Raised when the client requested a method that is not yet implemented.
virtual QgsServerSettings * serverSettings()=0
Returns the server settings.
void jsonDump(json &data, const QgsServerApiContext &context, const QString &contentType=u"application/json"_s) const
Writes data to the context response stream as JSON (indented if debug is active), an optional content...
std::string href(const QgsServerApiContext &context, const QString &extraPath=QString(), const QString &extension=QString()) const
Returns an URL to self, to be used for links to the current resources and as a base for constructing ...
virtual const QString templatePath(const QgsServerApiContext &context) const
Returns the HTML template path for the handler in the given context.
virtual const QString staticPath(const QgsServerApiContext &context) const
Returns the absolute path to the base directory where static resources for this handler are stored in...
virtual QVariantMap values(const QgsServerApiContext &context) const
Analyzes the incoming request context and returns the validated parameter map, throws QgsServerApiBad...
static QgsServerOgcApi::Profile profileFromString(const QString &profile, bool &ok)
Returns the Profile from the string representation in profile, or Profile::None if the string was not...
QString headerLink(const QgsServerApiContext &context, const QgsServerOgcApi::Rel &linkType=QgsServerOgcApi::Rel::self, const QgsServerOgcApi::ContentType contentType=QgsServerOgcApi::ContentType::JSON, const QgsServerOgcApi::Profile &profile=QgsServerOgcApi::Profile::Unset, const QString &title="") const
Builds and returns a header link to the resource.
json jsonTags() const
Returns tags as JSON.
void htmlDump(const json &data, const QgsServerApiContext &context) const
Writes data as HTML to the response stream in context using a template.
virtual QgsServerOgcApi::ContentType defaultContentType() const
Returns the default response content type in case the client did not specifically ask for any particu...
QgsServerOgcApi::ContentType contentTypeFromRequest(const QgsServerRequest *request) const
Returns the content type from the request.
virtual QgsServerOgcApi::Rel linkType() const =0
Main role for the resource link.
virtual ~QgsServerOgcApiHandler()
virtual json schema(const QgsServerApiContext &context) const
Returns handler information from the context for the OPENAPI description (id, description and other m...
virtual QStringList tags() const
Tags.
void setContentTypes(const QList< QgsServerOgcApi::ContentType > &contentTypes)
Set the content types to contentTypes.
void write(json &data, const QgsServerApiContext &context, const json &htmlMetadata=nullptr) const
Writes data to the context response stream, content-type is calculated from the context request,...
QList< QgsServerOgcApi::ContentType > contentTypes() const
Returns the list of content types this handler can serve, default to JSON and HTML.
virtual std::string linkTitle() const =0
Title for the handler link.
virtual QList< QgsServerQueryStringParameter > parameters(const QgsServerApiContext &context) const
Returns a list of query string parameters.
virtual std::string operationId() const =0
Returns the operation id for template file names and other internal references.
static json defaultResponse()
Returns the defaultResponse as JSON.
QgsVectorLayer * layerFromContext(const QgsServerApiContext &context) const
Returns a vector layer instance from the "collectionId" parameter of the path in the given context,...
QList< QgsServerOgcApi::Profile > profilesFromRequest(const QgsServerRequest *request) const
Return a list of the profiles in the request, extracted from the "profile" query parameter.
QString contentTypeForAccept(const QString &accept) const
Looks for the first ContentType match in the accept header and returns its mime type,...
virtual void handleRequest(const QgsServerApiContext &context) const
Handles the request within its context.
json link(const QgsServerApiContext &context, const QgsServerOgcApi::Rel &linkType=QgsServerOgcApi::Rel::self, const QgsServerOgcApi::ContentType contentType=QgsServerOgcApi::ContentType::JSON, const std::string &title="") const
Builds and returns a link to the resource.
json links(const QgsServerApiContext &context) const
Returns all the links for the given request context.
static QString parentLink(const QUrl &url, int levels=1)
Returns a link to the parent page up to levels in the HTML hierarchy from the given url,...
virtual QRegularExpression path() const =0
URL pattern for this handler, named capture group are automatically extracted and returned by values(...
void setContentTypesInt(const QList< int > &contentTypes)
Set the content types to contentTypes.
static QgsVectorLayer * layerFromCollectionId(const QgsServerApiContext &context, const QString &collectionId)
Returns a vector layer from the collectionId in the given context.
static QUrl sanitizeUrl(const QUrl &url)
Returns a sanitized url with extra slashes removed and the path URL component that always starts with...
static QString contentTypeToExtension(const QgsServerOgcApi::ContentType &ct)
Returns the file extension for a ct (Content-Type).
static const QMap< QgsServerOgcApi::ContentType, QStringList > contentTypeMimes()
Returns a map of contentType => list of mime types.
ContentType
Media types used for content negotiation, insert more specific first.
@ SCHEMA_JSON
"application/schema+json"
@ OPENAPI3
"application/openapi+json;version=3.0"
@ FLATGEOBUF
"application/flatgeobuf"
static QString contentTypeToString(const QgsServerOgcApi::ContentType &ct)
Returns the string representation of a ct (Content-Type) attribute.
static QString profileToString(const QgsServerOgcApi::Profile &profile)
Returns a string representation of the profile.
@ alternate
Refers to a substitute for this context.
@ self
Conveys an identifier for the link’s context.
static std::string contentTypeToStdString(const QgsServerOgcApi::ContentType &ct)
Returns the string representation of a ct (Content-Type) attribute.
static std::string mimeType(const QgsServerOgcApi::ContentType &contentType)
Returns the mime-type for the contentType or an empty string if not found.
@ Rfc7946
GeoJSON profile according to RFC7946.
@ RelAsUri
JSON responses that include URI for referenced resources http://www.opengis.net/def/profile/ogc/0/rel...
@ JsonFg
JSON Feature Geometry profile according to OGC API - Features 1.0.
@ RelAsLink
JSON responses that include links for referenced resources http://www.opengis.net/def/profile/ogc/0/r...
@ RelAsKey
JSON responses that include key for referenced resources http://www.opengis.net/def/profile/ogc/0/rel...
@ JsonFgPlus
JSON Feature Geometry profile with GeoJSON compatibility extensions.
static std::string relToString(const QgsServerOgcApi::Rel &rel)
Returns the string representation of rel attribute, to be used or "rel" link attribute in an OGC API ...
static const QHash< QgsServerOgcApi::ContentType, QList< QgsServerOgcApi::ContentType > > contentTypeAliases()
Returns contentType specializations (e.g.
static QgsServerOgcApi::ContentType contentTypeFromExtension(const std::string &extension)
Returns the Content-Type value corresponding to extension.
Defines requests passed to QgsService classes.
const QString queryParameter(const QString &name, const QString &defaultValue=QString()) const
Returns the query string parameter with the given name from the request URL, a defaultValue can be sp...
virtual QString header(const QString &name) const
Returns the header value.
QUrl url() const
Returns the request URL as seen by QGIS server.
virtual void write(const QString &data)
Write string This is a convenient method that will write directly to the underlying I/O device.
virtual void setHeader(const QString &key, const QString &value)=0
Set a single header value replacing any existing value(s) for the same key.
virtual void setStatusCode(int code)=0
Set the http status code.
QString apiResourcesDirectory() const
Returns the server-wide base directory where HTML templates and static assets (e.g.
Represents a vector layer which manages a vector based dataset.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
#define BUILTIN_UNREACHABLE