Cutelyst  2.5.0
Signals | Public Member Functions | Properties | Friends | List of all members
Cutelyst::Request Class Reference
Inheritance diagram for Cutelyst::Request:
Inheritance graph
[legend]

Signals

void webSocketBinaryFrame (const QByteArray &message, bool isLastFrame, Context *c)
 Emitted when the websocket receives a binary frame, this is usefull for parsing big chunks of data without waiting till the whole message arives.
 
void webSocketBinaryMessage (const QByteArray &message, Context *c)
 Emitted when the websocket receives a binary message, this accounts for all binary frames till the last one.
 
void webSocketClosed (quint16 closeCode, const QString &reason)
 Emitted when the websocket receives a close frame, including a close code and a reason.
 
void webSocketPong (const QByteArray &payload, Context *c)
 Emitted when the websocket receives a pong frame, which might include a payload.
 
void webSocketTextFrame (const QString &message, bool isLastFrame, Context *c)
 Emitted when the websocket receives a text frame, this is usefull for parsing big chunks of data without waiting till the whole message arives.
 
void webSocketTextMessage (const QString &message, Context *c)
 Emitted when the websocket receives a text message, this accounts for all text frames till the last one.
 

Public Member Functions

 Request (EngineRequest *engineRequest)
 
QHostAddress address () const
 
QString addressString () const
 
QStringList args () const
 
QStringList arguments () const
 
QString base () const
 
QIODevice * body () const
 
QVariant bodyData () const
 
QJsonArray bodyJsonArray () const
 
QJsonDocument bodyJsonDocument () const
 
QJsonObject bodyJsonObject () const
 
QString bodyParam (const QString &key, const QString &defaultValue=QString()) const
 
QString bodyParameter (const QString &key, const QString &defaultValue=QString()) const
 
ParamsMultiMap bodyParameters () const
 
QStringList bodyParameters (const QString &key) const
 
QVariantMap bodyParametersVariant () const
 
ParamsMultiMap bodyParams () const
 
QStringList bodyParams (const QString &key) const
 
QStringList captures () const
 
QString contentEncoding () const
 
QString contentType () const
 
QString cookie (const QString &name) const
 
QStringList cookies (const QString &name) const
 
ParamsMultiMap cookies () const
 
Engineengine () const
 
QString header (const QString &key) const
 
Headers headers () const
 
QString hostname () const
 
bool isDelete () const
 
bool isGet () const
 
bool isHead () const
 
bool isPatch () const
 
bool isPost () const
 
bool isPut () const
 
ParamsMultiMap mangleParams (const ParamsMultiMap &args, bool append=false) const
 
QString match () const
 
QString method () const
 
QString path () const
 
quint16 port () const
 
QString protocol () const
 
QString queryKeywords () const
 
QString queryParam (const QString &key, const QString &defaultValue=QString()) const
 
QString queryParameter (const QString &key, const QString &defaultValue=QString()) const
 
ParamsMultiMap queryParameters () const
 
QStringList queryParameters (const QString &key) const
 
QVariantMap queryParametersVariant () const
 
ParamsMultiMap queryParams () const
 
QStringList queryParams (const QString &key) const
 
QString referer () const
 
QString remoteUser () const
 
bool secure () const
 
void setArguments (const QStringList &arguments)
 
void setCaptures (const QStringList &captures)
 
void setMatch (const QString &match)
 
Uploadupload (const QString &name) const
 
QVector< Upload * > uploads () const
 
Uploads uploads (const QString &name) const
 
QMap< QString, Upload * > uploadsMap () const
 
QUrl uri () const
 
QUrl uriWith (const ParamsMultiMap &args, bool append=false) const
 
QString userAgent () const
 

Properties

QStringList args
 
QStringList arguments
 
QString base
 
QVariant bodyData
 
Cutelyst::ParamsMultiMap bodyParams
 
QString contentEncoding
 
QString contentType
 
QVariant headers
 
QString hostname
 
QString match
 
QString method
 
QString path
 
quint16 port
 
QString protocol
 
Cutelyst::ParamsMultiMap queryParams
 
QString referer
 
QString remoteUser
 
bool secure
 
QUrl uri
 
QString userAgent
 

Friends

class Application
 
class Context
 
class Dispatcher
 
class DispatchType
 

Detailed Description

Definition at line 42 of file request.h.

Constructor & Destructor Documentation

◆ Request()

Request::Request ( Cutelyst::EngineRequest engineRequest)

Constructs a new Request object.

Definition at line 32 of file request.cpp.

Member Function Documentation

◆ address()

QHostAddress Request::address ( ) const

Returns the address of the client

Definition at line 44 of file request.cpp.

Referenced by Cutelyst::Session::isValid().

◆ addressString()

QString Request::addressString ( ) const

Returns the address as string of the client.

When using IPv6 sockets to listen to both IPv4 and IPv6 sockets the output of QHostAddress might be something like "::ffff:127.0.0.1", which is not a bug and a valid address, but from an application point of view this might not be interesting to have, so this function checks if it's possible to convert to an IPv4 address and returns "127.0.0.1".

Definition at line 50 of file request.cpp.

References base(), hostname(), match(), path(), port(), and uri().

Referenced by Cutelyst::CSRFProtection::checkPassed(), and Cutelyst::Application::loadTranslationsFromDirs().

◆ args()

QStringList Cutelyst::Request::args ( ) const
inline

Shortcut for arguments()

◆ arguments()

QStringList Cutelyst::Request::arguments ( ) const

Returns a list of string containing the arguments. For example, if your action was

class foo : public Cutelyst::Controller
{
public:
C_ATTR(bar, :Local)
void bar(Context *c);
};

and the URI for the request was http://.../foo/bar/bah, the string bah would be the first and only argument.

Arguments get automatically URI-unescaped for you.

Referenced by setArguments(), and setMatch().

◆ base()

QString Cutelyst::Request::base ( ) const

Returns Contains the URI base. This will always have a trailing slash. Note that the URI scheme (e.g., http vs. https) must be determined through heuristics; depending on your server configuration, it may be incorrect. See secure() for more info.

If your application was queried with the URI http://localhost:3000/some/path then base is http://localhost:3000/.

Referenced by addressString().

◆ body()

QIODevice * Request::body ( ) const

Returns the message body of the request as passed by the Engine, this can even be a file if the Engine wants to.

Definition at line 191 of file request.cpp.

References bodyData().

Referenced by Cutelyst::Context::Context().

◆ bodyData()

QVariant Cutelyst::Request::bodyData ( ) const

Returns a QVariant representation of POST/PUT body data that is not classic HTML form data, such as JSON, XML, etc. By default, Cutelyst will parse incoming data of the type 'application/json' and return access to that data via this method.

You may define addition data_handlers.

If the POST is malformed in some way (such as undefined or not content that matches the content-type) we return a null QVariant.

If the POSTed content type does not match an available data handler, this will also return a null QVariant.

Referenced by body(), bodyJsonArray(), bodyJsonDocument(), bodyJsonObject(), and engine().

◆ bodyJsonArray()

QJsonArray Request::bodyJsonArray ( ) const

When request Content-Type is 'application/json' this will contain the parsed JSON representation array.

Definition at line 216 of file request.cpp.

References bodyData().

◆ bodyJsonDocument()

QJsonDocument Request::bodyJsonDocument ( ) const

When request Content-Type is 'application/json' this will contain the parsed JSON representation document.

Definition at line 206 of file request.cpp.

References bodyData().

◆ bodyJsonObject()

QJsonObject Request::bodyJsonObject ( ) const

When request Content-Type is 'application/json' this will contain the parsed JSON representation object.

Definition at line 211 of file request.cpp.

References bodyData().

◆ bodyParam()

QString Cutelyst::Request::bodyParam ( const QString &  key,
const QString &  defaultValue = QString() 
) const
inline

Convenience method for geting a single body value passing a key and an optional default value

Definition at line 533 of file request.h.

Referenced by Cutelyst::CSRFProtection::checkPassed(), and engine().

◆ bodyParameter()

QString Cutelyst::Request::bodyParameter ( const QString &  key,
const QString &  defaultValue = QString() 
) const
inline

Convenience method for geting a single body value passing a key and an optional default value

Definition at line 527 of file request.h.

References bodyParams().

◆ bodyParameters() [1/2]

ParamsMultiMap Request::bodyParameters ( ) const

Returns a Map of body (POST/PUT) parameters when content type is application/x-www-form-urlencoded

Definition at line 226 of file request.cpp.

Referenced by bodyParameters(), bodyParametersVariant(), Cutelyst::Application::loadTranslationsFromDirs(), and Cutelyst::Validator::validate().

◆ bodyParameters() [2/2]

QStringList Request::bodyParameters ( const QString &  key) const

Convenience method for geting all body values passing a key

Note
Unlike QMap::values() this return values in insertion order.

Definition at line 235 of file request.cpp.

References bodyParameters().

◆ bodyParametersVariant()

QVariantMap Request::bodyParametersVariant ( ) const

Returns a QVariantMap of body (POST/PUT) parameters, this method is expensive as it creates the map each time it's called, cache it's result instead of calling multiple times

Definition at line 221 of file request.cpp.

References bodyParameters().

◆ bodyParams() [1/2]

ParamsMultiMap Cutelyst::Request::bodyParams ( ) const
inline

Short for bodyParameters()

Referenced by bodyParameter().

◆ bodyParams() [2/2]

QStringList Cutelyst::Request::bodyParams ( const QString &  key) const
inline

Convenience method for geting all body values passing a key

Note
Unlike QMap::values() this return values in insertion order.

Definition at line 536 of file request.h.

◆ captures()

QStringList Request::captures ( ) const

Captures

Definition at line 173 of file request.cpp.

Referenced by Cutelyst::ActionChain::doExecute(), and setCaptures().

◆ contentEncoding()

QString Cutelyst::Request::contentEncoding ( ) const
inline

Returns the Content-Encoding header

Referenced by queryParams().

◆ contentType()

QString Cutelyst::Request::contentType ( ) const
inline

Returns the Content-Type header

Referenced by engine(), and queryParams().

◆ cookie()

QString Request::cookie ( const QString &  name) const

Returns the cookie with the given name

Definition at line 284 of file request.cpp.

Referenced by Cutelyst::CSRFProtection::checkPassed(), Cutelyst::LangSelect::fromPath(), and Cutelyst::Session::isValid().

◆ cookies() [1/2]

QStringList Request::cookies ( const QString &  name) const

Returns a list of cookies that match with the given name

Note
Unlike QMap::values() this return values in insertion order.

Definition at line 294 of file request.cpp.

◆ cookies() [2/2]

Cutelyst::ParamsMultiMap Request::cookies ( ) const

Returns all the cookies from the request

Definition at line 311 of file request.cpp.

References headers(), and method().

Referenced by engine().

◆ engine()

Engine * Request::engine ( ) const

◆ header()

QString Cutelyst::Request::header ( const QString &  key) const
inline

Short for headers().header(key);

Definition at line 557 of file request.h.

References referer(), and userAgent().

Referenced by Cutelyst::CSRFProtection::checkPassed(), Cutelyst::LangSelect::fromPath(), and Cutelyst::StaticCompressed::setup().

◆ headers()

Headers Cutelyst::Request::headers ( ) const

Returns the HTTP request headers

Referenced by cookies().

◆ hostname()

QString Cutelyst::Request::hostname ( ) const

Returns the hostname of the client, or null if not found or an error has happened.

This functions makes blocking call to do a reverse DNS lookup if the engine didn't set the hostname.

Referenced by addressString().

◆ isDelete()

bool Request::isDelete ( ) const

Returns true if the request method is DELETE.

Definition at line 362 of file request.cpp.

References protocol(), and remoteUser().

◆ isGet()

bool Request::isGet ( ) const

Returns true if the request method is GET.

Definition at line 338 of file request.cpp.

◆ isHead()

bool Request::isHead ( ) const

Returns true if the request method is HEAD.

Definition at line 344 of file request.cpp.

◆ isPatch()

bool Request::isPatch ( ) const

Returns true if the request method is PATCH.

Definition at line 356 of file request.cpp.

◆ isPost()

bool Request::isPost ( ) const

Returns true if the request method is POST.

Definition at line 332 of file request.cpp.

◆ isPut()

bool Request::isPut ( ) const

Returns true if the request method is PUT.

Definition at line 350 of file request.cpp.

◆ mangleParams()

ParamsMultiMap Request::mangleParams ( const ParamsMultiMap args,
bool  append = false 
) const

Returns a ParamsMultiMap of parameters stemming from the current request's params, plus the ones supplied. Keys for which no current param exists will be added, keys with null values will be removed and keys with existing params will be replaced. Note that you can supply a true value as the final argument to change behavior with regards to existing parameters, appending values rather than replacing them.

A quick example:

// URI query params foo=1
ParamsMultiMap params = request->mangleParams({ {"foo", "2"} });
// Result is query params of foo=2

versus append mode:

// URI query params foo=1
ParamsMultiMap params = request->mangleParams({ {"foo", "2"} }, true);
// Result is query params of foo=1&foo=2

This is the code behind uriWith().

Definition at line 409 of file request.cpp.

References queryParams().

Referenced by uriWith().

◆ match()

QString Cutelyst::Request::match ( ) const

This contains the matching part of a Regex action. Otherwise it returns the same as 'action' (not a pointer but it's private name), except for default actions, which return an empty string.

Referenced by addressString(), and setMatch().

◆ method()

QString Cutelyst::Request::method ( ) const

Returns the request method (GET, POST, HEAD, etc).

Referenced by cookies().

◆ path()

QString Cutelyst::Request::path ( ) const

Returns the path, i.e. the part of the URI after base(), for the current request. for http://localhost/path/foo path will contain 'path/foo'

Referenced by addressString().

◆ port()

quint16 Cutelyst::Request::port ( ) const

Returns the originating port of the client

Referenced by addressString().

◆ protocol()

QString Cutelyst::Request::protocol ( ) const

Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.

Referenced by isDelete().

◆ queryKeywords()

QString Request::queryKeywords ( ) const

Contains the keywords portion of a query string, when no '=' signs are present.

  • http://localhost/path?some+keywords
    c->request()->queryKeywords() will contain 'some keywords'

Definition at line 248 of file request.cpp.

Referenced by engine().

◆ queryParam()

QString Cutelyst::Request::queryParam ( const QString &  key,
const QString &  defaultValue = QString() 
) const
inline

Convenience method for geting a single query value passing a key and an optional default value

Definition at line 545 of file request.h.

Referenced by engine(), Cutelyst::LangSelect::fromPath(), and Cutelyst::StatusMessage::load().

◆ queryParameter()

QString Cutelyst::Request::queryParameter ( const QString &  key,
const QString &  defaultValue = QString() 
) const
inline

Convenience method for geting a single query value passing a key and an optional default value

Definition at line 539 of file request.h.

References queryParams().

◆ queryParameters() [1/2]

ParamsMultiMap Request::queryParameters ( ) const

Returns a QMultiHash containing the query string parameters

Definition at line 262 of file request.cpp.

Referenced by Cutelyst::Application::loadTranslationsFromDirs(), queryParameters(), queryParametersVariant(), and Cutelyst::Validator::validate().

◆ queryParameters() [2/2]

QStringList Request::queryParameters ( const QString &  key) const

Convenience method for geting all query values passing a key

Note
Unlike QMap::values() this return values in insertion order.

Definition at line 271 of file request.cpp.

References queryParameters().

◆ queryParametersVariant()

QVariantMap Request::queryParametersVariant ( ) const

Returns a QVariantMap of query string parameters, this method is expensive as it creates the map each time it's called, cache it's result instead of calling multiple times

Definition at line 257 of file request.cpp.

References queryParameters().

◆ queryParams() [1/2]

ParamsMultiMap Cutelyst::Request::queryParams ( ) const
inline

Short for queryParameters()

Referenced by mangleParams(), and queryParameter().

◆ queryParams() [2/2]

QStringList Cutelyst::Request::queryParams ( const QString &  key) const
inline

Convenience method for geting all query values passing a key

Note
Unlike QMap::values() this return values in insertion order.

Definition at line 548 of file request.h.

References contentEncoding(), and contentType().

◆ referer()

QString Cutelyst::Request::referer ( ) const
inline

referer Shortcut for header("Referer")

Referenced by header().

◆ remoteUser()

QString Cutelyst::Request::remoteUser ( ) const

Returns the value of the REMOTE_USER environment variable.

Referenced by isDelete().

◆ secure()

bool Cutelyst::Request::secure ( ) const

Returns true or false to indicate that a connection is secure (https), The reliability of it may depend on your server configuration, Cutelyst relies on the Engine to set this information which is used to build up uri().scheme(). The Engine itself might not be aware of a front HTTP server with https enabled.

Referenced by setCaptures().

◆ setArguments()

void Request::setArguments ( const QStringList &  arguments)

Defines the arguments of the request Useful for custom dispatchers and/or actions

Definition at line 167 of file request.cpp.

References arguments().

Referenced by Cutelyst::ActionChain::doExecute(), Cutelyst::DispatchTypePath::match(), and Cutelyst::DispatchTypeChained::match().

◆ setCaptures()

void Request::setCaptures ( const QStringList &  captures)

Defines the arguments of the request Useful for custom dispatchers and/or actions

Definition at line 179 of file request.cpp.

References captures(), and secure().

Referenced by Cutelyst::DispatchTypeChained::match().

◆ setMatch()

void Request::setMatch ( const QString &  match)

Defines the matching part of the request Useful for custom dispatchers

Definition at line 155 of file request.cpp.

References arguments(), and match().

Referenced by Cutelyst::DispatchTypeChained::match(), and Cutelyst::DispatchTypePath::match().

◆ upload()

Upload * Cutelyst::Request::upload ( const QString &  name) const
inline

Returns the first Upload object for the given field, if no upload matches the field name this function returns 0.

Definition at line 566 of file request.h.

Referenced by Cutelyst::CSRFProtection::checkPassed(), and engine().

◆ uploads() [1/2]

QVector< Upload * > Request::uploads ( ) const

Returns a vector containing uploads as provided by a multipart/form-data content type

Definition at line 380 of file request.cpp.

Referenced by engine(), and Cutelyst::Application::loadTranslationsFromDirs().

◆ uploads() [2/2]

Uploads Request::uploads ( const QString &  name) const

Returns all (if any) Upload objects for the given field.

Definition at line 398 of file request.cpp.

References uploadsMap().

◆ uploadsMap()

QMap< QString, Cutelyst::Upload * > Request::uploadsMap ( ) const

Returns a map containing uploads, where their key is the field name.

Definition at line 389 of file request.cpp.

Referenced by engine(), and uploads().

◆ uri()

QUrl Cutelyst::Request::uri ( ) const

Returns the uri as close as possible to what the user has in his browser url.

Referenced by addressString(), and uriWith().

◆ uriWith()

QUrl Request::uriWith ( const ParamsMultiMap args,
bool  append = false 
) const

Returns a rewritten URI object for the current request. Key/value pairs passed in will override existing parameters. You can remove an existing parameter by passing in an undef value. Unmodified pairs will be preserved.

You may also pass an optional second parameter that puts uriWith() into append mode:

req->uriWith({ {"key", "value"} }, true);

See mangleParams() for an explanation of this behavior.

Definition at line 425 of file request.cpp.

References mangleParams(), and uri().

◆ userAgent()

QString Cutelyst::Request::userAgent ( ) const
inline

Returns the user agent (browser) version string.

Referenced by header().